Module org.elasticsearch.server

Package org.elasticsearch.common.logging.activity

Class QueryLogger<Context extends QueryLoggerContext>

java.lang.Object

org.elasticsearch.common.logging.activity.ActivityLogger<Context>

org.elasticsearch.common.logging.activity.QueryLogger<Context>

public class QueryLogger<Context extends QueryLoggerContext>
extends ActivityLogger<Context>

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<Boolean>	QUERY_LOGGER_ENABLED
static final Setting<Boolean>	QUERY_LOGGER_INCLUDE_USER
static final Setting<Level>	QUERY_LOGGER_LEVEL
static final Setting<Boolean>	QUERY_LOGGER_LOG_SYSTEM	Whether to log searches that target system indices.
static final String	QUERY_LOGGER_SETTINGS_PREFIX	Prefix for query log related settings
static final Setting<TimeValue>	QUERY_LOGGER_THRESHOLD

Fields inherited from class org.elasticsearch.common.logging.activity.ActivityLogger

enabled, logLevel, setincludeUserInformation, threshold

Constructor Summary

Constructors

Constructor	Description
QueryLogger(ClusterSettings settings, ActivityLogProducer<Context> producer, ActivityLogWriterProvider writerProvider, ActionLoggingFieldsProvider fieldsProvider)
QueryLogger(ClusterSettings settings, ActivityLogProducer<Context> producer, ActivityLogWriterProvider writerProvider, ActionLoggingFieldsProvider fieldsProvider, Predicate<String> systemChecker)

Method Summary

Modifier and Type	Method	Description
protected void	addFields(Context context, ESLogMessage logMessage)
void	setLogSystemSearches(boolean logSystemSearches)
protected boolean	shouldLog(Context context)

Methods inherited from class org.elasticsearch.common.logging.activity.ActivityLogger

getLogLevel, setLogLevel, wrap

Methods inherited from class java.lang.Object

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

Field Details

QUERY_LOGGER_SETTINGS_PREFIX

public static final String QUERY_LOGGER_SETTINGS_PREFIX

Prefix for query log related settings

See Also:

• Constant Field Values

QUERY_LOGGER_ENABLED

public static final Setting<Boolean> QUERY_LOGGER_ENABLED

QUERY_LOGGER_THRESHOLD

public static final Setting<TimeValue> QUERY_LOGGER_THRESHOLD

QUERY_LOGGER_LEVEL

public static final Setting<Level> QUERY_LOGGER_LEVEL

QUERY_LOGGER_INCLUDE_USER

public static final Setting<Boolean> QUERY_LOGGER_INCLUDE_USER

QUERY_LOGGER_LOG_SYSTEM

public static final Setting<Boolean> QUERY_LOGGER_LOG_SYSTEM

Whether to log searches that target system indices.

Constructor Details

QueryLogger

public QueryLogger(ClusterSettings settings,
 ActivityLogProducer<Context> producer,
 ActivityLogWriterProvider writerProvider,
 ActionLoggingFieldsProvider fieldsProvider)

QueryLogger

public QueryLogger(ClusterSettings settings,
 ActivityLogProducer<Context> producer,
 ActivityLogWriterProvider writerProvider,
 ActionLoggingFieldsProvider fieldsProvider,
 Predicate<String> systemChecker)

Method Details

shouldLog

protected boolean shouldLog(Context context)

Overrides:

shouldLog in class ActivityLogger<Context extends QueryLoggerContext>

setLogSystemSearches

public void setLogSystemSearches(boolean logSystemSearches)

addFields

protected void addFields(Context context,
 ESLogMessage logMessage)

Overrides:

addFields in class ActivityLogger<Context extends QueryLoggerContext>