Add support for service.node.name

docs/tab-widgets/ecs-encoder.asciidoc

@@ -39,6 +39,7 @@ All you have to do is to use the `co.elastic.logging.logback.EcsEncoder` instead
 ----
 <encoder class="co.elastic.logging.logback.EcsEncoder">
     <serviceName>my-application</serviceName>
+    <serviceNodeName>my-application-cluster-node</serviceNodeName>
 </encoder>
 ----
 
@@ -52,6 +53,11 @@ All you have to do is to use the `co.elastic.logging.logback.EcsEncoder` instead
 |
 |Sets the `service.name` field so you can filter your logs by a particular service
 
+|`serviceNodeName`
+|String
+|
+|Sets the `service.node.name` field so you can filter your logs by a particular node of your clustered service
+
 |`eventDataset`
 |String
 |`${serviceName}.log`
@@ -102,10 +108,10 @@ For example:
 <Configuration status="DEBUG">
     <Appenders>
         <Console name="LogToConsole" target="SYSTEM_OUT">
-            <EcsLayout serviceName="my-app"/>
+            <EcsLayout serviceName="my-app" serviceNodeName="my-app-cluster-node"/>
         </Console>
         <File name="LogToFile" fileName="logs/app.log">
-            <EcsLayout serviceName="my-app"/>
+            <EcsLayout serviceName="my-app" serviceNodeName="my-app-cluster-node"/>
         </File>
     </Appenders>
     <Loggers>
@@ -127,6 +133,11 @@ For example:
 |
 |Sets the `service.name` field so you can filter your logs by a particular service
 
+|`serviceNodeName`
+|String
+|
+|Sets the `service.node.name` field so you can filter your logs by a particular node of your clustered service
+
 |`eventDataset`
 |String
 |`${serviceName}.log`
@@ -180,12 +191,14 @@ For example:
         <param name="Target" value="System.out"/>
         <layout class="co.elastic.logging.log4j.EcsLayout">
             <param name="serviceName" value="my-app"/>
+            <param name="serviceNodeName" value="my-app-cluster-node"/>
         </layout>
     </appender>
     <appender name="LogToFile" class="org.apache.log4j.RollingFileAppender">
         <param name="File" value="logs/app.log"/>
         <layout class="co.elastic.logging.log4j.EcsLayout">
             <param name="serviceName" value="my-app"/>
+            <param name="serviceNodeName" value="my-app-cluster-node"/>
         </layout>
     </appender>
     <root>
@@ -207,6 +220,11 @@ For example:
 |
 |Sets the `service.name` field so you can filter your logs by a particular service
 
+|`serviceNodeName`
+|String
+|
+|Sets the `service.node.name` field so you can filter your logs by a particular node of your clustered service
+
 |`eventDataset`
 |String
 |`${serviceName}.log`
@@ -249,6 +267,7 @@ For example, in `$CATALINA_HOME/conf/logging.properties`:
 java.util.logging.ConsoleHandler.level = FINE
 java.util.logging.ConsoleHandler.formatter = co.elastic.logging.jul.EcsFormatter
 co.elastic.logging.jul.EcsFormatter.serviceName=my-app
+co.elastic.logging.jul.EcsFormatter.serviceNodeName=my-app-cluster-node
 ----
 
 **Layout Parameters**
@@ -261,6 +280,11 @@ co.elastic.logging.jul.EcsFormatter.serviceName=my-app
 |
 |Sets the `service.name` field so you can filter your logs by a particular service
 
+|`serviceNodeName`
+|String
+|
+|Sets the `service.node.name` field so you can filter your logs by a particular node of your clustered service
+
 |`eventDataset`
 |String
 |`${serviceName}.log`
@@ -301,7 +325,8 @@ Add the formatter to a handler in the logging subsystem:
 
 [source,bash]
 ----
-$WILDFLY_HOME/bin/jboss-cli.sh -c '/subsystem=logging/custom-formatter=ECS:add(module=co.elastic.logging.jboss-logmanager-ecs-formatter, class=co.elastic.logging.jboss.logmanager.EcsFormatter, properties={serviceName=my-app}),\
+$WILDFLY_HOME/bin/jboss-cli.sh -c '/subsystem=logging/custom-formatter=ECS:add(module=co.elastic.logging.jboss-logmanager-ecs-formatter,
+class=co.elastic.logging.jboss.logmanager.EcsFormatter, properties={serviceName=my-app,serviceNodeName=my-app-cluster-node}),\
                                    /subsystem=logging/console-handler=CONSOLE:write-attribute(name=named-formatter,value=ECS)'
 ----
 
@@ -315,6 +340,11 @@ $WILDFLY_HOME/bin/jboss-cli.sh -c '/subsystem=logging/custom-formatter=ECS:add(m
 |
 |Sets the `service.name` field so you can filter your logs by a particular service
 
+|`serviceNodeName`
+|String
+|
+|Sets the `service.node.name` field so you can filter your logs by a particular node of your clustered service
+
 |`eventDataset`
 |String
 |`${serviceName}.log`

ecs-logging-core/src/main/java/co/elastic/logging/EcsJsonSerializer.java

@@ -91,6 +91,12 @@ public static void serializeServiceName(StringBuilder builder, String serviceNam
         }
     }
 
+    public static void serializeServiceNodeName(StringBuilder builder, String serviceNodeName) {
+        if (serviceNodeName != null) {
+            builder.append("\"service.node.name\":\"").append(serviceNodeName).append("\",");
+        }
+    }
+
     public static void serializeEventDataset(StringBuilder builder, String eventDataset) {
         if (eventDataset != null) {
             builder.append("\"event.dataset\":\"").append(eventDataset).append("\",");

ecs-logging-core/src/test/java/co/elastic/logging/AbstractEcsLoggingTest.java

@@ -57,6 +57,7 @@ void testMetadata() throws Exception {
         debug("test");
         assertThat(getAndValidateLastLogLine().get("process.thread.name").textValue()).isEqualTo(Thread.currentThread().getName());
         assertThat(getAndValidateLastLogLine().get("service.name").textValue()).isEqualTo("test");
+        assertThat(getAndValidateLastLogLine().get("service.node.name").textValue()).isEqualTo("test-node");
         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();

jboss-logmanager-ecs-formatter/src/main/java/co/elastic/logging/jboss/logmanager/EcsFormatter.java

@@ -37,13 +37,15 @@
 public class EcsFormatter extends ExtFormatter {
 
     private String serviceName;
+    private String serviceNodeName;
     private String eventDataset;
     private List<AdditionalField> additionalFields = Collections.emptyList();
     private boolean includeOrigin;
     private boolean stackTraceAsArray;
 
     public EcsFormatter() {
         serviceName = getProperty("co.elastic.logging.jboss.logmanager.EcsFormatter.serviceName", null);
+        serviceNodeName = getProperty("co.elastic.logging.jboss.logmanager.EcsFormatter.serviceNodeName", null);
         eventDataset = getProperty("co.elastic.logging.jboss.logmanager.EcsFormatter.eventDataset", null);
         eventDataset = EcsJsonSerializer.computeEventDataset(eventDataset, serviceName);
         includeOrigin = Boolean.getBoolean(getProperty("co.elastic.logging.jboss.logmanager.EcsFormatter.includeOrigin", "false"));
@@ -58,6 +60,7 @@ public String format(ExtLogRecord record) {
         EcsJsonSerializer.serializeFormattedMessage(builder, record.getFormattedMessage());
         EcsJsonSerializer.serializeEcsVersion(builder);
         EcsJsonSerializer.serializeServiceName(builder, serviceName);
+        EcsJsonSerializer.serializeServiceNodeName(builder, serviceNodeName);
         EcsJsonSerializer.serializeEventDataset(builder, eventDataset);
         EcsJsonSerializer.serializeThreadName(builder, record.getThreadName());
         EcsJsonSerializer.serializeLoggerName(builder, record.getLoggerName());
@@ -91,6 +94,10 @@ public void setServiceName(final String serviceName) {
         eventDataset = EcsJsonSerializer.computeEventDataset(eventDataset, serviceName);
     }
 
+    public void setServiceNodeName(final String serviceNodeName) {
+        this.serviceNodeName = serviceNodeName;
+    }
+
     public void setStackTraceAsArray(final boolean stackTraceAsArray) {
         this.stackTraceAsArray = stackTraceAsArray;
     }

jboss-logmanager-ecs-formatter/src/test/java/co/elastic/logging/jboss/logmanager/JBossLogManagerTest.java

@@ -89,6 +89,7 @@ public JsonNode getLastLogLine() throws IOException {
     void setUp() {
         formatter.setIncludeOrigin(true);
         formatter.setServiceName("test");
+        formatter.setServiceNodeName("test-node");
         formatter.setEventDataset("testdataset.log");
         formatter.setAdditionalFields("key1=value1,key2=value2");
 

jul-ecs-formatter/src/main/java/co/elastic/logging/jul/EcsFormatter.java

@@ -40,6 +40,7 @@ public class EcsFormatter extends Formatter {
 
     private boolean stackTraceAsArray;
     private String serviceName;
+    private String serviceNodeName;
     private boolean includeOrigin;
     private String eventDataset;
     private List<AdditionalField> additionalFields = Collections.emptyList();
@@ -49,6 +50,7 @@ public class EcsFormatter extends Formatter {
      */
     public EcsFormatter() {
         serviceName = getProperty("co.elastic.logging.jul.EcsFormatter.serviceName", null);
+        serviceNodeName = getProperty("co.elastic.logging.jul.EcsFormatter.serviceNodeName", null);
         includeOrigin = Boolean.getBoolean(getProperty("co.elastic.logging.jul.EcsFormatter.includeOrigin", "false"));
         stackTraceAsArray = Boolean
                 .getBoolean(getProperty("co.elastic.logging.jul.EcsFormatter.stackTraceAsArray", "false"));
@@ -67,6 +69,7 @@ public String format(final LogRecord record) {
         EcsJsonSerializer.serializeAdditionalFields(builder, additionalFields);
         EcsJsonSerializer.serializeMDC(builder, mdcSupplier.getMDC());
         EcsJsonSerializer.serializeServiceName(builder, serviceName);
+        EcsJsonSerializer.serializeServiceNodeName(builder, serviceNodeName);
         EcsJsonSerializer.serializeEventDataset(builder, eventDataset);
         if (Thread.currentThread().getId() == record.getThreadID()) {
             EcsJsonSerializer.serializeThreadName(builder, Thread.currentThread().getName());
@@ -93,6 +96,10 @@ protected void setServiceName(final String serviceName) {
         this.serviceName = serviceName;
     }
 
+    protected void setServiceNodeName(final String serviceNodeName) {
+        this.serviceNodeName = serviceNodeName;
+    }
+
     protected void setStackTraceAsArray(final boolean stackTraceAsArray) {
         this.stackTraceAsArray = stackTraceAsArray;
     }

jul-ecs-formatter/src/test/java/co/elastic/logging/jul/JulLoggingTest.java

@@ -112,6 +112,7 @@ void setUp() {
 
         formatter.setIncludeOrigin(true);
         formatter.setServiceName("test");
+        formatter.setServiceNodeName("test-node");
         formatter.setEventDataset("testdataset.log");
         formatter.setAdditionalFields("key1=value1,key2=value2");
 

log4j-ecs-layout/src/main/java/co/elastic/logging/log4j/EcsLayout.java

@@ -40,6 +40,7 @@ public class EcsLayout extends Layout {
 
     private boolean stackTraceAsArray = false;
     private String serviceName;
+    private String serviceNodeName;
     private boolean includeOrigin;
     private String eventDataset;
     private List<AdditionalField> additionalFields = new ArrayList<AdditionalField>();
@@ -52,6 +53,7 @@ public String format(LoggingEvent event) {
         EcsJsonSerializer.serializeFormattedMessage(builder, event.getRenderedMessage());
         EcsJsonSerializer.serializeEcsVersion(builder);
         EcsJsonSerializer.serializeServiceName(builder, serviceName);
+        EcsJsonSerializer.serializeServiceNodeName(builder, serviceNodeName);
         EcsJsonSerializer.serializeEventDataset(builder, eventDataset);
         EcsJsonSerializer.serializeThreadName(builder, event.getThreadName());
         EcsJsonSerializer.serializeLoggerName(builder, event.categoryName);
@@ -99,6 +101,10 @@ public void setServiceName(String serviceName) {
         this.serviceName = serviceName;
     }
 
+    public void setServiceNodeName(String serviceNodeName) {
+        this.serviceNodeName = serviceNodeName;
+    }
+
     public void setIncludeOrigin(boolean includeOrigin) {
         this.includeOrigin = includeOrigin;
     }

log4j-ecs-layout/src/test/java/co/elastic/logging/log4j/Log4jEcsLayoutTest.java

@@ -51,6 +51,7 @@ void setUp() {
         logger.addAppender(appender);
         ecsLayout = new EcsLayout();
         ecsLayout.setServiceName("test");
+        ecsLayout.setServiceNodeName("test-node");
         ecsLayout.setIncludeOrigin(true);
         ecsLayout.setEventDataset("testdataset.log");
         ecsLayout.activateOptions();

log4j-ecs-layout/src/test/resources/log4j.xml

@@ -4,6 +4,7 @@
     <appender name="List" class="co.elastic.logging.log4j.ListAppender">
         <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="includeOrigin" value="true"/>
             <param name="additionalField" value="key1=value1"/>

log4j2-ecs-layout/src/main/java/co/elastic/logging/log4j2/EcsLayout.java

@@ -68,14 +68,17 @@ public class EcsLayout extends AbstractStringLayout {
     private final PatternFormatter[][] fieldValuePatternFormatter;
     private final boolean stackTraceAsArray;
     private final String serviceName;
+    private final String serviceNodeName;
     private final String eventDataset;
     private final boolean includeMarkers;
     private final boolean includeOrigin;
     private final ConcurrentMap<Class<? extends MultiformatMessage>, Boolean> supportsJson = new ConcurrentHashMap<Class<? extends MultiformatMessage>, Boolean>();
 
-    private EcsLayout(Configuration config, String serviceName, String eventDataset, boolean includeMarkers, KeyValuePair[] additionalFields, boolean includeOrigin, boolean stackTraceAsArray) {
+    private EcsLayout(Configuration config, String serviceName, String serviceNodeName, String eventDataset, boolean includeMarkers,
+                      KeyValuePair[] additionalFields, boolean includeOrigin, boolean stackTraceAsArray) {
         super(config, UTF_8, null, null);
         this.serviceName = serviceName;
+        this.serviceNodeName = serviceNodeName;
         this.eventDataset = eventDataset;
         this.includeMarkers = includeMarkers;
         this.includeOrigin = includeOrigin;
@@ -125,6 +128,7 @@ private StringBuilder toText(LogEvent event, StringBuilder builder, boolean gcFr
         serializeMessage(builder, gcFree, event.getMessage(), event.getThrown());
         EcsJsonSerializer.serializeEcsVersion(builder);
         EcsJsonSerializer.serializeServiceName(builder, serviceName);
+        EcsJsonSerializer.serializeServiceNodeName(builder, serviceNodeName);
         EcsJsonSerializer.serializeEventDataset(builder, eventDataset);
         EcsJsonSerializer.serializeThreadName(builder, event.getThreadName());
         EcsJsonSerializer.serializeLoggerName(builder, event.getLoggerName());
@@ -324,6 +328,8 @@ public static class Builder implements org.apache.logging.log4j.core.util.Builde
         private Configuration configuration;
         @PluginBuilderAttribute("serviceName")
         private String serviceName;
+        @PluginBuilderAttribute("serviceNodeName")
+        private String serviceNodeName;
         @PluginBuilderAttribute("eventDataset")
         private String eventDataset;
         @PluginBuilderAttribute("includeMarkers")
@@ -355,6 +361,10 @@ public String getServiceName() {
             return serviceName;
         }
 
+        public String getServiceNodeName() {
+            return serviceNodeName;
+        }
+
         public String getEventDataset() {
             return eventDataset;
         }
@@ -382,6 +392,11 @@ public EcsLayout.Builder setServiceName(final String serviceName) {
             return this;
         }
 
+        public EcsLayout.Builder setServiceNodeName(final String serviceNodeName) {
+            this.serviceNodeName = serviceNodeName;
+            return this;
+        }
+
         public EcsLayout.Builder setEventDataset(String eventDataset) {
             this.eventDataset = eventDataset;
             return this;
@@ -404,7 +419,8 @@ public EcsLayout.Builder setStackTraceAsArray(boolean stackTraceAsArray) {
 
         @Override
         public EcsLayout build() {
-            return new EcsLayout(getConfiguration(), serviceName, EcsJsonSerializer.computeEventDataset(eventDataset, serviceName), includeMarkers, additionalFields, includeOrigin, stackTraceAsArray);
+            return new EcsLayout(getConfiguration(), serviceName, serviceNodeName, EcsJsonSerializer.computeEventDataset(eventDataset, serviceName),
+                    includeMarkers, additionalFields, includeOrigin, stackTraceAsArray);
         }
 
         public boolean isStackTraceAsArray() {

log4j2-ecs-layout/src/test/java/co/elastic/logging/log4j2/Log4j2EcsLayoutTest.java

@@ -67,6 +67,7 @@ void setUp() {
         EcsLayout ecsLayout = EcsLayout.newBuilder()
                 .setConfiguration(ctx.getConfiguration())
                 .setServiceName("test")
+                .setServiceNodeName("test-node")
                 .setIncludeMarkers(true)
                 .setIncludeOrigin(true)
                 .setEventDataset("testdataset.log")

log4j2-ecs-layout/src/test/resources/log4j2-test.xml

@@ -5,7 +5,8 @@
     </Properties>
     <Appenders>
         <List name="TestAppender">
-            <EcsLayout serviceName="test" includeMarkers="true" includeOrigin="true" eventDataset="testdataset.log">
+            <EcsLayout serviceName="test" serviceNodeName="test-node" includeMarkers="true" includeOrigin="true"
+                       eventDataset="testdataset.log">
                 <KeyValuePair key="cluster.uuid" value="9fe9134b-20b0-465e-acf9-8cc09ac9053b"/>
                 <KeyValuePair key="node.id" value="${node.id}"/>
                 <KeyValuePair key="empty" value="${empty}"/>

logback-ecs-encoder/src/main/java/co/elastic/logging/logback/EcsEncoder.java

@@ -45,6 +45,7 @@ public class EcsEncoder extends EncoderBase<ILoggingEvent> {
     private static final Charset UTF_8 = Charset.forName("UTF-8");
     private boolean stackTraceAsArray = false;
     private String serviceName;
+    private String serviceNodeName;
     private String eventDataset;
     private boolean includeMarkers = false;
     private ThrowableProxyConverter throwableProxyConverter;
@@ -101,6 +102,7 @@ public byte[] encode(ILoggingEvent event) {
         EcsJsonSerializer.serializeEcsVersion(builder);
         serializeMarkers(event, builder);
         EcsJsonSerializer.serializeServiceName(builder, serviceName);
+        EcsJsonSerializer.serializeServiceNodeName(builder, serviceNodeName);
         EcsJsonSerializer.serializeEventDataset(builder, eventDataset);
         EcsJsonSerializer.serializeThreadName(builder, event.getThreadName());
         EcsJsonSerializer.serializeLoggerName(builder, event.getLoggerName());
@@ -151,6 +153,10 @@ public void setServiceName(String serviceName) {
         this.serviceName = serviceName;
     }
 
+    public void setServiceNodeName(String serviceNodeName) {
+        this.serviceNodeName = serviceNodeName;
+    }
+
     public void setIncludeMarkers(boolean includeMarkers) {
         this.includeMarkers = includeMarkers;
     }

logback-ecs-encoder/src/test/java/co/elastic/logging/logback/EcsEncoderTest.java

@@ -44,6 +44,7 @@ void setUp() {
         logger.addAppender(appender);
         EcsEncoder ecsEncoder = new EcsEncoder();
         ecsEncoder.setServiceName("test");
+        ecsEncoder.setServiceNodeName("test-node");
         ecsEncoder.setIncludeMarkers(true);
         ecsEncoder.setIncludeOrigin(true);
         ecsEncoder.addAdditionalField(new AdditionalField("key1", "value1"));

logback-ecs-encoder/src/test/resources/logback-config.xml

@@ -3,6 +3,7 @@
     <appender name="out" class="co.elastic.logging.logback.OutputStreamAppender">
         <encoder class="co.elastic.logging.logback.EcsEncoder">
             <serviceName>test</serviceName>
+            <serviceNodeName>test-node</serviceNodeName>
             <includeMarkers>true</includeMarkers>
             <includeOrigin>true</includeOrigin>
             <topLevelLabel>top_level</topLevelLabel>