Package org.elasticsearch.common.logging

Class DeprecatedMessage

java.lang.Object

org.elasticsearch.common.logging.DeprecatedMessage

public class DeprecatedMessage
extends Object

A logger message used by DeprecationLogger, enriched with fields named following ECS conventions. Carries x-opaque-id field if provided in the headers. Will populate the x-opaque-id field in JSON logs.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ECS_VERSION
static final String	ELASTIC_ORIGIN_FIELD_NAME
static final String	KEY_FIELD_NAME
static final String	X_OPAQUE_ID_FIELD_NAME

Constructor Summary

Constructors

Constructor	Description
DeprecatedMessage()

Method Summary

Modifier and Type	Method	Description
static ESLogMessage	compatibleDeprecationMessage(String key, String xOpaqueId, String productOrigin, String messagePattern, Object... args)
static ESLogMessage	of(DeprecationCategory category, String key, String xOpaqueId, String productOrigin, String messagePattern, Object... args)

Methods inherited from class java.lang.Object

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

Field Details

ELASTIC_ORIGIN_FIELD_NAME

public static final String ELASTIC_ORIGIN_FIELD_NAME

See Also:

• Constant Field Values

KEY_FIELD_NAME

public static final String KEY_FIELD_NAME

See Also:

• Constant Field Values

X_OPAQUE_ID_FIELD_NAME

public static final String X_OPAQUE_ID_FIELD_NAME

See Also:

• Constant Field Values

ECS_VERSION

public static final String ECS_VERSION

See Also:

• Constant Field Values

Constructor Details

DeprecatedMessage

public DeprecatedMessage()

Method Details

of

public static ESLogMessage of(DeprecationCategory category,
 String key,
 String xOpaqueId,
 String productOrigin,
 String messagePattern,
 Object... args)

compatibleDeprecationMessage

public static ESLogMessage compatibleDeprecationMessage(String key,
 String xOpaqueId,
 String productOrigin,
 String messagePattern,
 Object... args)