feat: align console/file format to be more inline with kinesis format

this is to make easier parsing in ELK solutions
tomtom-international · Jan 18, 2021 · b8b69c3 · b8b69c3
1 parent 2fafe7f
commit b8b69c3
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 6 deletions.
diff --git a/james-agent/src/main/java/com/tomtom/james/publisher/ConsolePublisher.java b/james-agent/src/main/java/com/tomtom/james/publisher/ConsolePublisher.java
@@ -48,7 +48,7 @@ public String getId() {
     @Override
     public void initialize(EventPublisherConfiguration eventPublisherConfiguration) {
         ConsolePublisherConfiguration configuration = new ConsolePublisherConfiguration(eventPublisherConfiguration);
-        formatter = new JSONEventFormatter(configuration.isPrettifyJSON());
+        formatter = new JSONEventFormatter(configuration.isPrettifyJSON(), configuration.getEventType(), configuration.getEnvironment());
     }
 
     @Override

diff --git a/james-agent/src/main/java/com/tomtom/james/publisher/ConsolePublisherConfiguration.java b/james-agent/src/main/java/com/tomtom/james/publisher/ConsolePublisherConfiguration.java
@@ -18,6 +18,7 @@
 
 import com.tomtom.james.common.api.configuration.EventPublisherConfiguration;
 import com.tomtom.james.common.api.configuration.StructuredConfiguration;
+import java.util.Optional;
 
 class ConsolePublisherConfiguration {
 
@@ -34,4 +35,14 @@ boolean isPrettifyJSON() {
                 .orElse(false);
     }
 
+    public String getEventType() {
+        return configurationProperties.get("eventType")
+                            .map(StructuredConfiguration::asString)
+                            .orElse("james");
+    }
+
+    public Optional<String> getEnvironment() {
+        return configurationProperties.get("environment")
+                            .map(StructuredConfiguration::asString);
+    }
 }
diff --git a/james-agent/src/main/java/com/tomtom/james/publisher/FilePublisher.java b/james-agent/src/main/java/com/tomtom/james/publisher/FilePublisher.java
@@ -48,7 +48,7 @@ public String getId() {
     public void initialize(EventPublisherConfiguration eventPublisherConfiguration) {
         FilePublisherConfiguration configuration = new FilePublisherConfiguration(eventPublisherConfiguration);
         writer = createWriter(configuration);
-        formatter = new JSONEventFormatter(configuration.isPrettifyJSON());
+        formatter = new JSONEventFormatter(configuration.isPrettifyJSON(), configuration.getEventType(), configuration.getEnvironment());
     }
 
     @Override

diff --git a/james-agent/src/main/java/com/tomtom/james/publisher/FilePublisherConfiguration.java b/james-agent/src/main/java/com/tomtom/james/publisher/FilePublisherConfiguration.java
@@ -21,6 +21,7 @@
 
 import java.nio.file.FileSystems;
 import java.nio.file.Path;
+import java.util.Optional;
 
 class FilePublisherConfiguration {
 
@@ -49,4 +50,14 @@ private String defaultFilePath() {
         return path.normalize().toString();
     }
 
+    public String getEventType() {
+        return configurationProperties.get("eventType")
+                            .map(StructuredConfiguration::asString)
+                            .orElse("james");
+    }
+
+    public Optional<String> getEnvironment() {
+        return configurationProperties.get("environment")
+                            .map(StructuredConfiguration::asString);
+    }
 }
diff --git a/james-agent/src/main/java/com/tomtom/james/publisher/JSONEventFormatter.java b/james-agent/src/main/java/com/tomtom/james/publisher/JSONEventFormatter.java
@@ -22,22 +22,29 @@
 
 import java.io.IOException;
 import java.util.LinkedHashMap;
+import java.util.Optional;
 
 class JSONEventFormatter {
 
     private final ObjectMapper objectMapper = new ObjectMapper();
 
     private final boolean pretty;
+    private String type;
+    private Optional<String> environment;
 
-    JSONEventFormatter(boolean pretty) {
+    JSONEventFormatter(boolean pretty, String type, Optional<String> environment) {
         this.pretty = pretty;
+        this.type = type;
+        this.environment = environment;
         objectMapper.disable(SerializationFeature.FAIL_ON_EMPTY_BEANS);
     }
 
     String format(Event evt) {
         LinkedHashMap<String, Object> result = new LinkedHashMap<>();
-        result.put("timestamp", evt.getTimestamp().toString());
-        result.put("content", evt.getContent());
+        result.put("@timestamp", evt.getTimestamp().toString());
+        result.put("type", type);
+        environment.ifPresent(env -> result.put("environment", env));
+        result.putAll(evt.getContent());
 
         try {
             return pretty

diff --git a/james-agent/src/test/groovy/com/tomtom/james/publisher/ConsolePublisherSpec.groovy b/james-agent/src/test/groovy/com/tomtom/james/publisher/ConsolePublisherSpec.groovy
@@ -39,7 +39,7 @@ class ConsolePublisherSpec extends Specification {
         publisher.close()
 
         then:
-        1 * out.println { it.contains('"content":{"message":"event body"}') }
+        1 * out.println { it.contains('"type":"james","message":"event body"') }
 
         then:
         1 * out.flush()