Module org.elasticsearch.server

Package org.elasticsearch.common.logging.activity

Interface ActivityLogProducer<Context extends ActivityLoggerContext>

Type Parameters:

Context - Specific logger context

All Known Implementing Classes:

SearchLogProducer

public interface ActivityLogProducer<Context extends ActivityLoggerContext>

Generic log producer class. Each log producer receives a context and decides whether to log, and at which level. Then it extracts logging information from the context and places it into the message. The producer defines which fields are included in the specific log message.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENT_DURATION_FIELD
static final String	EVENT_OUTCOME_FIELD
static final String	PARENT_NODE_ID_FIELD
static final String	PARENT_TASK_ID_FIELD
static final String	TASK_ID_FIELD
static final String	TRACE_ID_FIELD
static final String	X_OPAQUE_ID_FIELD

Method Summary

Modifier and Type	Method	Description
default String	loggerName()	Since we only have query logging for now, set it as the default logger name for convenience.
Optional<ESLogMessage>	produce(Context context, ActionLoggingFields additionalFields)	Produces a ESLogMessage if the producer decides to log, or nothing otherwise.
default ESLogMessage	produceCommon(Context context, String prefix, ActionLoggingFields additionalFields)	Produces a ESLogMessage with common fields.

Field Details

X_OPAQUE_ID_FIELD

static final String X_OPAQUE_ID_FIELD

See Also:

• Constant Field Values

EVENT_OUTCOME_FIELD

static final String EVENT_OUTCOME_FIELD

See Also:

• Constant Field Values

EVENT_DURATION_FIELD

static final String EVENT_DURATION_FIELD

See Also:

• Constant Field Values

TRACE_ID_FIELD

static final String TRACE_ID_FIELD

See Also:

• Constant Field Values

TASK_ID_FIELD

static final String TASK_ID_FIELD

See Also:

• Constant Field Values

PARENT_TASK_ID_FIELD

static final String PARENT_TASK_ID_FIELD

See Also:

• Constant Field Values

PARENT_NODE_ID_FIELD

static final String PARENT_NODE_ID_FIELD

See Also:

• Constant Field Values

Method Details

produce

Optional<ESLogMessage> produce(Context context,
 ActionLoggingFields additionalFields)

Produces a ESLogMessage if the producer decides to log, or nothing otherwise.

loggerName

default String loggerName()

Since we only have query logging for now, set it as the default logger name for convenience.

produceCommon

default ESLogMessage produceCommon(Context context,
 String prefix,
 ActionLoggingFields additionalFields)

Produces a ESLogMessage with common fields.