github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-28 09:28:55 -04:00
Code Issues Projects Releases Packages Wiki Activity

Upgrade ECS logging layout to latest version (#80500)

Browse source 
we use ECS layout in 8.x and there is a newer release for ecs logging library
This commit is contained in:
Przemyslaw Gomulka 2021-11-10 15:50:23 +01:00 • committed by GitHub
parent 425359babf
commit 170812143d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 19 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

2
build-tools-internal/version.properties
View file

@ -16,7 +16,7 @@ supercsv = 2.4.0
# when updating log4j, please update also docs/java-api/index.asciidoc # when updating log4j, please update also docs/java-api/index.asciidoc
log4j = 2.11.1 log4j = 2.11.1
slf4j = 1.6.2 slf4j = 1.6.2
ecsLogging = 0.1.3 ecsLogging = 1.2.0
# when updating the JNA version, also update the version in buildSrc/build.gradle # when updating the JNA version, also update the version in buildSrc/build.gradle
jna = 5.7.0-1 jna = 5.7.0-1

14
qa/logging-config/src/test/java/org/elasticsearch/common/logging/JsonLoggerTests.java
View file

@ -133,7 +133,7 @@ public class JsonLoggerTests extends ESTestCase {
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("data_stream.dataset", "deprecation.elasticsearch"), hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION), hasKey("ecs.version"),
hasEntry(DeprecatedMessage.KEY_FIELD_NAME, "a key"), hasEntry(DeprecatedMessage.KEY_FIELD_NAME, "a key"),
not(hasKey(DeprecatedMessage.X_OPAQUE_ID_FIELD_NAME)), not(hasKey(DeprecatedMessage.X_OPAQUE_ID_FIELD_NAME)),
hasEntry("elasticsearch.event.category", "other") hasEntry("elasticsearch.event.category", "other")
@ -171,7 +171,7 @@ public class JsonLoggerTests extends ESTestCase {
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.test"), hasEntry("log.logger", "org.elasticsearch.deprecation.test"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION), hasKey("ecs.version"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"), hasEntry("elasticsearch.cluster.name", "elasticsearch"),
hasEntry("elasticsearch.node.name", "sample-name"), hasEntry("elasticsearch.node.name", "sample-name"),
hasEntry("message", "deprecated message1"), hasEntry("message", "deprecated message1"),
@ -188,7 +188,7 @@ public class JsonLoggerTests extends ESTestCase {
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.test"), hasEntry("log.logger", "org.elasticsearch.deprecation.test"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION), hasKey("ecs.version"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"), hasEntry("elasticsearch.cluster.name", "elasticsearch"),
hasEntry("elasticsearch.node.name", "sample-name"), hasEntry("elasticsearch.node.name", "sample-name"),
hasEntry("message", "compatible API message"), hasEntry("message", "compatible API message"),
@ -240,7 +240,7 @@ public class JsonLoggerTests extends ESTestCase {
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.xcontent.ParseField"), hasEntry("log.logger", "org.elasticsearch.deprecation.xcontent.ParseField"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION), hasKey("ecs.version"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"), hasEntry("elasticsearch.cluster.name", "elasticsearch"),
hasEntry("elasticsearch.node.name", "sample-name"), hasEntry("elasticsearch.node.name", "sample-name"),
hasEntry("message", "Deprecated field [deprecated_name] used, expected [new_name] instead"), hasEntry("message", "Deprecated field [deprecated_name] used, expected [new_name] instead"),
@ -257,7 +257,7 @@ public class JsonLoggerTests extends ESTestCase {
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.xcontent.ParseField"), hasEntry("log.logger", "org.elasticsearch.deprecation.xcontent.ParseField"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION), hasKey("ecs.version"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"), hasEntry("elasticsearch.cluster.name", "elasticsearch"),
hasEntry("elasticsearch.node.name", "sample-name"), hasEntry("elasticsearch.node.name", "sample-name"),
hasEntry("message", "Deprecated field [deprecated_name2] used, expected [new_name] instead"), hasEntry("message", "Deprecated field [deprecated_name2] used, expected [new_name] instead"),
@ -274,7 +274,7 @@ public class JsonLoggerTests extends ESTestCase {
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("log.logger", "org.elasticsearch.deprecation.xcontent.ParseField"), hasEntry("log.logger", "org.elasticsearch.deprecation.xcontent.ParseField"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION), hasKey("ecs.version"),
hasEntry("elasticsearch.cluster.name", "elasticsearch"), hasEntry("elasticsearch.cluster.name", "elasticsearch"),
hasEntry("elasticsearch.node.name", "sample-name"), hasEntry("elasticsearch.node.name", "sample-name"),
hasEntry("message", "Deprecated field [compatible_deprecated_name] used, expected [new_name] instead"), hasEntry("message", "Deprecated field [compatible_deprecated_name] used, expected [new_name] instead"),
@ -327,7 +327,7 @@ public class JsonLoggerTests extends ESTestCase {
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("data_stream.dataset", "deprecation.elasticsearch"), hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("ecs.version", DeprecatedMessage.ECS_VERSION), hasKey("ecs.version"),
hasEntry(DeprecatedMessage.KEY_FIELD_NAME, "someKey"), hasEntry(DeprecatedMessage.KEY_FIELD_NAME, "someKey"),
hasEntry(DeprecatedMessage.X_OPAQUE_ID_FIELD_NAME, "someId"), hasEntry(DeprecatedMessage.X_OPAQUE_ID_FIELD_NAME, "someId"),
hasEntry("elasticsearch.event.category", "other") hasEntry("elasticsearch.event.category", "other")

1
server/licenses/ecs-logging-core-0.1.3.jar.sha1
View file

@ -1 +0,0 @@
e0f93944011bf9e9ba147a8b7e14aad2584b9123

1
server/licenses/ecs-logging-core-1.2.0.jar.sha1 Normal file
View file

@ -0,0 +1 @@
37a47ec302777aca9f8ea10b7316f3a79d5d6202

1
server/licenses/log4j2-ecs-layout-0.1.3.jar.sha1
View file

@ -1 +0,0 @@
5a46cc50b82d8bfbd2156a82558edc0eecb75821

1
server/licenses/log4j2-ecs-layout-1.2.0.jar.sha1 Normal file
View file

@ -0,0 +1 @@
ba51fb2064cd5f6bc136e95c1463e3e68d823403

3
server/src/main/java/org/elasticsearch/common/logging/DeprecatedMessage.java
View file

@ -21,7 +21,7 @@ import java.util.Locale;
public class DeprecatedMessage { public class DeprecatedMessage {
public static final String KEY_FIELD_NAME = "event.code"; public static final String KEY_FIELD_NAME = "event.code";
public static final String X_OPAQUE_ID_FIELD_NAME = "elasticsearch.http.request.x_opaque_id"; public static final String X_OPAQUE_ID_FIELD_NAME = "elasticsearch.http.request.x_opaque_id";
public static final String ECS_VERSION = "1.7"; public static final String ECS_VERSION = "1.2.0";
@SuppressLoggerChecks(reason = "safely delegates to logger") @SuppressLoggerChecks(reason = "safely delegates to logger")
public static ESLogMessage of(DeprecationCategory category, String key, String xOpaqueId, String messagePattern, Object... args) { public static ESLogMessage of(DeprecationCategory category, String key, String xOpaqueId, String messagePattern, Object... args) {
@ -44,7 +44,6 @@ public class DeprecatedMessage {
ESLogMessage esLogMessage = new ESLogMessage(messagePattern, args).field("data_stream.dataset", "deprecation.elasticsearch") ESLogMessage esLogMessage = new ESLogMessage(messagePattern, args).field("data_stream.dataset", "deprecation.elasticsearch")
.field("data_stream.type", "logs") .field("data_stream.type", "logs")
.field("data_stream.namespace", "default") .field("data_stream.namespace", "default")
.field("ecs.version", ECS_VERSION)
.field(KEY_FIELD_NAME, key) .field(KEY_FIELD_NAME, key)
.field("elasticsearch.event.category", category.name().toLowerCase(Locale.ROOT)); .field("elasticsearch.event.category", category.name().toLowerCase(Locale.ROOT));

2
server/src/main/java/org/elasticsearch/common/logging/ECSJsonLayout.java
View file

@ -48,6 +48,7 @@ public class ECSJsonLayout {
return EcsLayout.newBuilder() return EcsLayout.newBuilder()
.setConfiguration(getConfiguration()) .setConfiguration(getConfiguration())
.setServiceName("ES_ECS") .setServiceName("ES_ECS")
.setEventDataset(dataset)
.setStackTraceAsArray(false) .setStackTraceAsArray(false)
.setIncludeMarkers(true) .setIncludeMarkers(true)
.setAdditionalFields(additionalFields()) .setAdditionalFields(additionalFields())
@ -56,7 +57,6 @@ public class ECSJsonLayout {
private KeyValuePair[] additionalFields() { private KeyValuePair[] additionalFields() {
return new KeyValuePair[] { return new KeyValuePair[] {
new KeyValuePair("event.dataset", dataset),
new KeyValuePair("trace.id", "%trace_id"), new KeyValuePair("trace.id", "%trace_id"),
new KeyValuePair("elasticsearch.cluster.uuid", "%cluster_id"), new KeyValuePair("elasticsearch.cluster.uuid", "%cluster_id"),
new KeyValuePair("elasticsearch.node.id", "%node_id"), new KeyValuePair("elasticsearch.node.id", "%node_id"),

14
x-pack/plugin/deprecation/qa/rest/src/javaRestTest/java/org/elasticsearch/xpack/deprecation/DeprecationHttpIT.java
View file

@ -423,7 +423,7 @@ public class DeprecationHttpIT extends ESRestTestCase {
hasEntry("data_stream.dataset", "deprecation.elasticsearch"), hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("ecs.version", "1.7"), hasKey("ecs.version"),
hasEntry(KEY_FIELD_NAME, "deprecated_settings"), hasEntry(KEY_FIELD_NAME, "deprecated_settings"),
hasEntry("event.dataset", "deprecation.elasticsearch"), hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "WARN"), hasEntry("log.level", "WARN"),
@ -441,7 +441,7 @@ public class DeprecationHttpIT extends ESRestTestCase {
hasEntry("data_stream.dataset", "deprecation.elasticsearch"), hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("ecs.version", "1.7"), hasKey("ecs.version"),
hasEntry(KEY_FIELD_NAME, "deprecated_route_GET_/_test_cluster/deprecated_settings"), hasEntry(KEY_FIELD_NAME, "deprecated_route_GET_/_test_cluster/deprecated_settings"),
hasEntry("event.dataset", "deprecation.elasticsearch"), hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "WARN"), hasEntry("log.level", "WARN"),
@ -493,7 +493,7 @@ public class DeprecationHttpIT extends ESRestTestCase {
hasEntry("data_stream.dataset", "deprecation.elasticsearch"), hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("ecs.version", "1.7"), hasKey("ecs.version"),
hasEntry(KEY_FIELD_NAME, "deprecated_critical_settings"), hasEntry(KEY_FIELD_NAME, "deprecated_critical_settings"),
hasEntry("event.dataset", "deprecation.elasticsearch"), hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "CRITICAL"), hasEntry("log.level", "CRITICAL"),
@ -545,7 +545,7 @@ public class DeprecationHttpIT extends ESRestTestCase {
hasEntry("data_stream.dataset", "deprecation.elasticsearch"), hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("ecs.version", "1.7"), hasKey("ecs.version"),
hasEntry(KEY_FIELD_NAME, "deprecated_warn_settings"), hasEntry(KEY_FIELD_NAME, "deprecated_warn_settings"),
hasEntry("event.dataset", "deprecation.elasticsearch"), hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "WARN"), hasEntry("log.level", "WARN"),
@ -563,7 +563,7 @@ public class DeprecationHttpIT extends ESRestTestCase {
hasEntry("data_stream.dataset", "deprecation.elasticsearch"), hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("ecs.version", "1.7"), hasKey("ecs.version"),
hasEntry(KEY_FIELD_NAME, "deprecated_route_GET_/_test_cluster/deprecated_settings"), hasEntry(KEY_FIELD_NAME, "deprecated_route_GET_/_test_cluster/deprecated_settings"),
hasEntry("event.dataset", "deprecation.elasticsearch"), hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "WARN"), hasEntry("log.level", "WARN"),
@ -627,7 +627,7 @@ public class DeprecationHttpIT extends ESRestTestCase {
hasEntry("data_stream.dataset", "deprecation.elasticsearch"), hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("ecs.version", "1.7"), hasKey("ecs.version"),
hasEntry(KEY_FIELD_NAME, "compatible_key"), hasEntry(KEY_FIELD_NAME, "compatible_key"),
hasEntry("event.dataset", "deprecation.elasticsearch"), hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "CRITICAL"), hasEntry("log.level", "CRITICAL"),
@ -645,7 +645,7 @@ public class DeprecationHttpIT extends ESRestTestCase {
hasEntry("data_stream.dataset", "deprecation.elasticsearch"), hasEntry("data_stream.dataset", "deprecation.elasticsearch"),
hasEntry("data_stream.namespace", "default"), hasEntry("data_stream.namespace", "default"),
hasEntry("data_stream.type", "logs"), hasEntry("data_stream.type", "logs"),
hasEntry("ecs.version", "1.7"), hasKey("ecs.version"),
hasEntry(KEY_FIELD_NAME, "deprecated_route_GET_/_test_cluster/compat_only"), hasEntry(KEY_FIELD_NAME, "deprecated_route_GET_/_test_cluster/compat_only"),
hasEntry("event.dataset", "deprecation.elasticsearch"), hasEntry("event.dataset", "deprecation.elasticsearch"),
hasEntry("log.level", "CRITICAL"), hasEntry("log.level", "CRITICAL"),