Spring Batch MDC Logging

Question

I'm wanting to know how to log things such as the Job Name and Execution ID using MCD in Spring Batch.

Here's some code:

bootstrap.properties

this file has a list of items I currently log, and I've added execId as the 3rd element here.

logging.pattern.level=%5p [%X{X-B3-TraceId:-},%X{sessionId:-},%X{execId:-},%X{program:-},%X{mainframeId:-}]
spring.application.name=mcc
spring.profiles.active=globals,local,local-override

MCC Application

this file has my main method. When I manually set the field here with MDC.put("execId", "12345"); I see it in the log, but I don't understand how to put the actual information I need here.

@SpringBootApplication(exclude = {SecurityAutoConfiguration.class, ManagementWebSecurityAutoConfiguration.class})
public class MccApplication {

    public static void main(String[] args) {
        MDC.put("execId", "12345");
        SpringApplication.run(MccApplication.class, args);
    }

}

I would appreciate any insight :) Thank you.

so-random-dude · Accepted Answer · 2018-08-24T21:27:32.420

3

Disclaimer : I am not familiar with spring-batch

MDC will work for you to log Job Name and Execution ID along with the log statements because MDC has a thread affinity. So if you put something to MDC while in a thread, then that will be available to you (and to logback) through out the lifecycle of that thread. So if you put MDC.put("execId", "12345"); in your main method, that will only be available in the main thread.

The Job Name and Execution ID makes sense only in any child thread that the spring batch may spawn (I am running on wild assumptions here, as I am not familiar with spring batch). So add MDC.put("execId", "12345"); at the beginning point of your actual Job, not in the main() method.

edited Aug 24 '18 at 21:27

answered Aug 24 '18 at 19:54

so-random-dude

15,277
10
68
113

Thank you for your response and advice, I'll try your suggestions and post back here with my results – Josh Aug 24 '18 at 21:25
some interesting read here : http://shengwangi.blogspot.com/2015/09/using-log-mdc-in-multi-thread-helloworld-example.html – so-random-dude Aug 27 '18 at 02:18
1

Thank you for the link and input. I have a much more clear idea of what to do now. – Josh Aug 27 '18 at 21:07
@Josh Happy to help – so-random-dude Aug 27 '18 at 21:21

score 0 · Answer 2 · answered Jul 17 '23 at 16:09

You can fill the MDC in a listener, for example one that you add for each step. During the step's building (with its builder), do listener(logCompletingStepExecutionListener); with a (static-defined) listener like:

public class LogCompletingStepExecutionListener implements StepExecutionListener {

    private static final String LOG_MDC_CONTEXT_KEY_STEP_ID = "Step-ID";

    @Override
    public void beforeStep(StepExecution stepExecution) {
        StepExecutionListener.super.beforeStep(stepExecution);
        MDC.put(LOG_MDC_CONTEXT_KEY_STEP_ID, stepExecution.getStepName() + "_" + stepExecution.getJobExecutionId() + "_" + stepExecution.getId());
    }

    @Override
    public ExitStatus afterStep(StepExecution stepExecution) {
        MDC.remove(LOG_MDC_CONTEXT_KEY_STEP_ID);
        return StepExecutionListener.super.afterStep(stepExecution);
    }
}

As said by @so-random-dude , it will not comes in other threads. For multi-threaded jobs, see the TaskDecorator in https://stackoverflow.com/a/68347374/7251133 (I didn't test it).

Spring Batch MDC Logging

2 Answers2

Linked