Module org.elasticsearch.server

Package org.elasticsearch.common.logging.activity

Class ActivityLoggerContext

java.lang.Object

org.elasticsearch.common.logging.activity.ActivityLoggerContext

Direct Known Subclasses:

QueryLoggerContext

public abstract class ActivityLoggerContext
extends Object

Context for ActivityLogger. This class contains the information needed to log the query and is extended by specific logging contexts for each action. ActivityLogProducer uses the context data to compose fields for the log message.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ActivityLoggerContext.ShardInfo	Shard stats information.

Constructor Summary

Constructors

Constructor	Description
ActivityLoggerContext(Task task, String type, long tookInNanos)
ActivityLoggerContext(Task task, String type, long tookInNanos, Exception error)

Method Summary

Modifier and Type	Method	Description
String	getErrorMessage()
String	getErrorType()
String	getOpaqueId()
Optional<TaskId>	getParentTaskId()
long	getTaskId()
long	getTookInNanos()
String	getTraceId()
String	getType()
boolean	isSuccess()
boolean	isTimedOut()
Optional<ActivityLoggerContext.ShardInfo>	shardInfo()

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityLoggerContext

public ActivityLoggerContext(Task task,
 String type,
 long tookInNanos,
 @Nullable
 Exception error)

ActivityLoggerContext

public ActivityLoggerContext(Task task,
 String type,
 long tookInNanos)

Method Details

getTookInNanos

public long getTookInNanos()

isSuccess

public boolean isSuccess()

isTimedOut

public boolean isTimedOut()

getType

public String getType()

getErrorMessage

public String getErrorMessage()

getErrorType

public String getErrorType()

getOpaqueId

public String getOpaqueId()

getTraceId

public String getTraceId()

shardInfo

public Optional<ActivityLoggerContext.ShardInfo> shardInfo()

getTaskId

public long getTaskId()

getParentTaskId

public Optional<TaskId> getParentTaskId()