Remove default .log suffix from event.dataset (#141)

elastic · Oct 19, 2021 · 5bfada3 · 5bfada3
1 parent c91dd98
commit 5bfada3
Show file tree

Hide file tree

Showing 12 changed files with 18 additions and 18 deletions.
diff --git a/docs/tab-widgets/ecs-encoder.asciidoc b/docs/tab-widgets/ecs-encoder.asciidoc
@@ -62,7 +62,7 @@ All you have to do is to use the `co.elastic.logging.logback.EcsEncoder` instead
 
 |`eventDataset`
 |String
-|`${serviceName}.log`
+|`${serviceName}`
 |Sets the `event.dataset` field used by the machine learning job of the Logs app to look for anomalies in the log rate.
 
 |`includeMarkers`
@@ -142,7 +142,7 @@ For example:
 
 |`eventDataset`
 |String
-|`${serviceName}.log`
+|`${serviceName}`
 |Sets the `event.dataset` field used by the machine learning job of the Logs app to look for anomalies in the log rate.
 
 |`includeMarkers`
@@ -229,7 +229,7 @@ For example:
 
 |`eventDataset`
 |String
-|`${serviceName}.log`
+|`${serviceName}`
 |Sets the `event.dataset` field used by the machine learning job of the Logs app to look for anomalies in the log rate.
 
 |`stackTraceAsArray`
@@ -289,7 +289,7 @@ co.elastic.logging.jul.EcsFormatter.serviceNodeName=my-app-cluster-node
 
 |`eventDataset`
 |String
-|`${serviceName}.log`
+|`${serviceName}`
 |Sets the `event.dataset` field used by the machine learning job of the Logs app to look for anomalies in the log rate.
 
 |`stackTraceAsArray`
@@ -349,7 +349,7 @@ class=co.elastic.logging.jboss.logmanager.EcsFormatter, properties={serviceName=
 
 |`eventDataset`
 |String
-|`${serviceName}.log`
+|`${serviceName}`
 |Sets the `event.dataset` field used by the machine learning job of the Logs app to look for anomalies in the log rate.
 
 |`stackTraceAsArray`

diff --git a/ecs-logging-core/src/main/java/co/elastic/logging/EcsJsonSerializer.java b/ecs-logging-core/src/main/java/co/elastic/logging/EcsJsonSerializer.java
@@ -294,7 +294,7 @@ public static StringBuilder getMessageStringBuilder() {
 
     public static String computeEventDataset(String eventDataset, String serviceName) {
         if (eventDataset == null && serviceName != null && !serviceName.isEmpty()) {
-            return serviceName + ".log";
+            return serviceName;
         }
         return eventDataset;
     }

diff --git a/ecs-logging-core/src/test/java/co/elastic/logging/AbstractEcsLoggingTest.java b/ecs-logging-core/src/test/java/co/elastic/logging/AbstractEcsLoggingTest.java
@@ -61,7 +61,7 @@ void testMetadata() throws Exception {
         assertThat(Instant.parse(getAndValidateLastLogLine().get("@timestamp").textValue())).isCloseTo(Instant.now(), within(1, ChronoUnit.MINUTES));
         assertThat(getAndValidateLastLogLine().get("log.level").textValue()).isIn("DEBUG", "FINE");
         assertThat(getAndValidateLastLogLine().get("log.logger")).isNotNull();
-        assertThat(getAndValidateLastLogLine().get("event.dataset").textValue()).isEqualTo("testdataset.log");
+        assertThat(getAndValidateLastLogLine().get("event.dataset").textValue()).isEqualTo("testdataset");
         assertThat(getAndValidateLastLogLine().get("ecs.version").textValue()).isEqualTo("1.2.0");
         validateLog(getAndValidateLastLogLine());
     }

diff --git a/ecs-logging-core/src/test/resources/spec/spec.json b/ecs-logging-core/src/test/resources/spec/spec.json
@@ -89,15 +89,15 @@
             "type": "string",
             "required": false,
             "url": "https://www.elastic.co/guide/en/ecs/current/ecs-event.html",
-            "default": "${service.name}.log OR ${service.name}.${appender.name}",
+            "default": "${service.name} OR ${service.name}.${appender.name}",
             "comment": [
                 "Configurable by users.",
                 "If the user manually configures the service name,",
-                "the logging library should set `event.dataset=${service.name}.log` if not explicitly configured otherwise.",
+                "the logging library should set `event.dataset=${service.name}` if not explicitly configured otherwise.",
                 "",
                 "When agents auto-configure the app to use an ECS logger,",
                 "they should set `event.dataset=${service.name}.${appender.name}` if the appender name is available in the logging library.",
-                "Otherwise, agents should also set `event.dataset=${service.name}.log`",
+                "Otherwise, agents should also set `event.dataset=${service.name}`",
                 "",
                 "The field helps to filter for different log streams from the same pod, for example and is required for log anomaly detection."
             ]

diff --git a/...-ecs-formatter/src/test/java/co/elastic/logging/jboss/logmanager/JBossLogManagerTest.java b/...-ecs-formatter/src/test/java/co/elastic/logging/jboss/logmanager/JBossLogManagerTest.java
@@ -90,7 +90,7 @@ void setUp() {
         formatter.setIncludeOrigin(true);
         formatter.setServiceName("test");
         formatter.setServiceNodeName("test-node");
-        formatter.setEventDataset("testdataset.log");
+        formatter.setEventDataset("testdataset");
         formatter.setAdditionalFields("key1=value1,key2=value2");
 
         logger.setLevel(Level.ALL);

diff --git a/jul-ecs-formatter/src/test/java/co/elastic/logging/jul/JulLoggingTest.java b/jul-ecs-formatter/src/test/java/co/elastic/logging/jul/JulLoggingTest.java
@@ -113,7 +113,7 @@ void setUp() {
         formatter.setIncludeOrigin(true);
         formatter.setServiceName("test");
         formatter.setServiceNodeName("test-node");
-        formatter.setEventDataset("testdataset.log");
+        formatter.setEventDataset("testdataset");
         formatter.setAdditionalFields("key1=value1,key2=value2");
 
         Handler handler = new InMemoryStreamHandler(out, formatter);

diff --git a/log4j-ecs-layout/src/test/java/co/elastic/logging/log4j/Log4jEcsLayoutTest.java b/log4j-ecs-layout/src/test/java/co/elastic/logging/log4j/Log4jEcsLayoutTest.java
@@ -53,7 +53,7 @@ void setUp() {
         ecsLayout.setServiceName("test");
         ecsLayout.setServiceNodeName("test-node");
         ecsLayout.setIncludeOrigin(true);
-        ecsLayout.setEventDataset("testdataset.log");
+        ecsLayout.setEventDataset("testdataset");
         ecsLayout.activateOptions();
         ecsLayout.setAdditionalField("key1=value1");
         ecsLayout.setAdditionalField("key2=value2");

diff --git a/log4j-ecs-layout/src/test/resources/log4j.xml b/log4j-ecs-layout/src/test/resources/log4j.xml
@@ -5,7 +5,7 @@
         <layout class="co.elastic.logging.log4j.EcsLayout">
             <param name="serviceName" value="test"/>
             <param name="serviceNodeName" value="test-node"/>
-            <param name="eventDataset" value="testdataset.log"/>
+            <param name="eventDataset" value="testdataset"/>
             <param name="includeOrigin" value="true"/>
             <param name="additionalField" value="key1=value1"/>
             <param name="additionalField" value="key2=value2"/>

diff --git a/log4j2-ecs-layout/src/test/java/co/elastic/logging/log4j2/Log4j2EcsLayoutTest.java b/log4j2-ecs-layout/src/test/java/co/elastic/logging/log4j2/Log4j2EcsLayoutTest.java
@@ -70,7 +70,7 @@ void setUp() {
                 .setServiceNodeName("test-node")
                 .setIncludeMarkers(true)
                 .setIncludeOrigin(true)
-                .setEventDataset("testdataset.log")
+                .setEventDataset("testdataset")
                 .setAdditionalFields(new KeyValuePair[]{
                         new KeyValuePair("cluster.uuid", "9fe9134b-20b0-465e-acf9-8cc09ac9053b"),
                         new KeyValuePair("node.id", "${node.id}"),

diff --git a/log4j2-ecs-layout/src/test/resources/log4j2-test.xml b/log4j2-ecs-layout/src/test/resources/log4j2-test.xml
@@ -6,7 +6,7 @@
     <Appenders>
         <List name="TestAppender">
             <EcsLayout serviceName="test" serviceNodeName="test-node" includeMarkers="true" includeOrigin="true"
-                       eventDataset="testdataset.log">
+                       eventDataset="testdataset">
                 <KeyValuePair key="cluster.uuid" value="9fe9134b-20b0-465e-acf9-8cc09ac9053b"/>
                 <KeyValuePair key="node.id" value="${node.id}"/>
                 <KeyValuePair key="empty" value="${empty}"/>

diff --git a/logback-ecs-encoder/src/test/java/co/elastic/logging/logback/EcsEncoderTest.java b/logback-ecs-encoder/src/test/java/co/elastic/logging/logback/EcsEncoderTest.java
@@ -49,7 +49,7 @@ void setUp() {
         ecsEncoder.setIncludeOrigin(true);
         ecsEncoder.addAdditionalField(new AdditionalField("key1", "value1"));
         ecsEncoder.addAdditionalField(new AdditionalField("key2", "value2"));
-        ecsEncoder.setEventDataset("testdataset.log");
+        ecsEncoder.setEventDataset("testdataset");
         ecsEncoder.start();
         appender.setEncoder(ecsEncoder);
         appender.start();

diff --git a/logback-ecs-encoder/src/test/resources/logback-config.xml b/logback-ecs-encoder/src/test/resources/logback-config.xml
@@ -7,7 +7,7 @@
             <includeMarkers>true</includeMarkers>
             <includeOrigin>true</includeOrigin>
             <topLevelLabel>top_level</topLevelLabel>
-            <eventDataset>testdataset.log</eventDataset>
+            <eventDataset>testdataset</eventDataset>
             <additionalField>
                 <key>key1</key>
                 <value>value1</value>