org.adroitlogic.x.logging

Class CloseableLogContext

java.lang.Object

org.adroitlogic.x.logging.CloseableLogContext

All Implemented Interfaces:

Closeable, AutoCloseable, CloseableContext

public class CloseableLogContext
extends Object
implements CloseableContext

A Log context that holds the message diagnose context information for each log yet auto closes within a try block to make sure the diagnose context is cleared at the end of the logging process.

This provides 4 default diagnose context keys

Context Key	Meaning
xsn	The source of the log, this could be the name of the project for example, or system if it is a system generated log
xsv	The source version of the log, which could be the project version for example
host	The host from which this log is generated
ip	The IP address from which this log is generated

Apart from this any system property or environment variable set in the environment that starts with org_adroitlogic_logger is also included into the diagnose context with the respective key

Since:

17.01

Author:

Ruwan Linton

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTERNAL_FIELD_PREFIX Prefix to capture external fields
static String	SOURCE_NAME_KEY The thread context key used to include the project id argument
static String	SOURCE_VERSION_KEY The thread context key used to include the project version argument

Method Summary

Modifier and Type	Method and Description
void	close()
static CloseableContext	defaultContext()
static CloseableContext	forProject(String projectId, String version)
CloseableContext	mergeInto(CloseableContext ctx)
CloseableContext	put(String key, String value)
(package private) static CloseableLogContext	systemContext()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTERNAL_FIELD_PREFIX

public static final String EXTERNAL_FIELD_PREFIX

Prefix to capture external fields

See Also:

Constant Field Values

SOURCE_NAME_KEY

public static final String SOURCE_NAME_KEY

The thread context key used to include the project id argument

See Also:

Constant Field Values

SOURCE_VERSION_KEY

public static final String SOURCE_VERSION_KEY

The thread context key used to include the project version argument

See Also:

Constant Field Values

Method Detail

systemContext

static CloseableLogContext systemContext()

defaultContext

public static CloseableContext defaultContext()

forProject

public static CloseableContext forProject(String projectId,
                                          String version)

put

public CloseableContext put(String key,
                            String value)

Specified by:

put in interface CloseableContext

mergeInto

public CloseableContext mergeInto(CloseableContext ctx)

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException