Add CorrelationId logic into Spring Starter

Open
#37 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
spring, spring-boot

Research direction

Look at the Spring Boot starter module in the project to understand its structure. Research how to create a Spring Boot auto-configuration that adds a correlation ID filter/interceptor and integrates with SLF4J's MDC. Check existing logging configuration to see how to automatically include the correlation ID in log patterns. A working implementation should provide a correlation ID that propagates through HTTP requests and appears in all log messages.

Written by the indexing model from the issue text.

Description

enhancement

One thing that is commonly required in FluentForms app server code is the need for a correlation id (an ID that is optionally provided by a caller that travels with and identifies a particular transaction). We have utilized such code in previous projects, however it would be nice if it could be incorporated into the Spring Boot starter so that it is easy and has a minimal amount of boilerplate code.

It would also be nice if it autoconfigures logging to incorporate the correlation id in all log messages. To do this, it could utilized SLF4J's Mapped Diagnostic Context (see here also).

Dominant language
Java
Stars
7
Forks
8
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from 4PointSolutions/FluentFormsAPI

All issues in 4PointSolutions/FluentFormsAPI

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.