Eclipse Community Forums: Eclipse Scout » Does someone know how to add a custom to logger MDC

Home » Eclipse Projects » Eclipse Scout » Does someone know how to add a custom to logger MDC (Try adding a custom value to be put on logger MDC without success)

Does someone know how to add a custom to logger MDC [message #1841080]

Mon, 03 May 2021 06:36

Eclipse User

Here the step i have followed
1. Create a classe in app.server

@ApplicationScoped
public class MainGroupContextValueProvider implements IDiagnosticContextValueProvider {
	public static final String KEY = "group.name";

	@Override
	public String key() {
		return KEY;
	}

	@Override
	public String value() {
		final ISession session = ISession.CURRENT.get();
	    return session != null ? ((ServerSession)session).getUserMainGroup() : "DefaultUserGroup";
	}
}

getUserMainGroup is loaded from database in `execLoadSession` and setted into setSharedContextVariable to be accessible on Client side

2. Create a custom RunContext

@Replace
public class CustomServerRunContext extends ServerRunContext {
	@Override
	protected <RESULT> void interceptCallableChain(final CallableChain<RESULT> callableChain) {
		callableChain.add(new DiagnosticContextValueProcessor(BEANS.get(MainGroupContextValueProvider.class)));
		super.interceptCallableChain(callableChain);
	}
}

3. Add the custom value on config.properties.

<variable scope="context" name="mdcPattern" value="principal=%X{subject.principal.name}, group=%X{group.name}, scoutSession=%X{scout.session.id}, jobName=%X{scout.job.name}, cid=%X{scout.correlation.id}" />

When starting the application everything is correct, I have the default value of group "DefaultUserGroup" in the log. But I would expect to have another value when a user session is logged into the app. What did I forget? Is this the best way to go?

Thank you in advance.

Re: Does someone know how to add a custom to logger MDC [message #1841084 is a reply to message #1841080]

Mon, 03 May 2021 08:38

Eclipse User

Hi Seydou

The fact that you see "group=DefaultUserGroup" in your log output indicates that the MainGroupContextValueProvider is active and is correctly registered in your CustomServerRunContext. That ISession.CURRENT.get() is always null can only mean that the code is not executed in the context of a session.

I suspect that in your case, the order of the two lines in CustomServerRunContext#interceptCallableChain needs to be changed:

@Replace
public class CustomServerRunContext extends ServerRunContext {
	@Override
	protected <RESULT> void interceptCallableChain(final CallableChain<RESULT> callableChain) {
		super.interceptCallableChain(callableChain); // <-- call this first!
		callableChain.add(new DiagnosticContextValueProcessor(BEANS.get(MainGroupContextValueProvider.class)));
	}
}

The session itself is also handled by one of the processors in the chain (see the default implementation). If you add your own processor first, the particular processor that spans the session context is not active yet. By adding the default Scout processors first, you should be able to access the session as expected.

Regards,
Beat

Re: Does someone know how to add a custom to logger MDC [message #1841090 is a reply to message #1841084]

Mon, 03 May 2021 11:48

Eclipse User

Hi Beat,

Thank you for your quick response. I just try what you suggested and it work as expected.

Re: Does someone know how to add a custom to logger MDC [message #1842660 is a reply to message #1841090]

Sun, 27 June 2021 14:53

Eclipse User

Push your {user_id} into MDC e.g. MDC. put("user_id", "Pawel");
Include the MDC entry in your log statements.

Previous Topic:	REST with authentication
Next Topic:	Created Sessions Scout 11

Goto Forum:

-=] Back to Top [=-

Current Time: Sat Jul 12 08:19:31 EDT 2025

.:: Contact :: Home ::.

Breadcrumbs

Sign up to our Newsletter