Add Exception Type and Message Fields

Fix and run the code and documentation generation for
the two new fields exception_type and exception_message.
Changes to the Python scripts are required for newer pyyaml
versions.

Signed-off-by: Karsten Schnitter <[email protected]>

Author: KarstenSchnitter

cf-java-logging-support-core/beats/app-logs/docs/fields.asciidoc

@@ -448,6 +448,28 @@ required: True
 The original log message that has been written by the application.
 
 
+==== exception_type
+
+type: string
+
+example: java.lang.NullPointerException
+
+required: False
+
+The Java class name of the logged exception when available.
+
+
+==== exception_message
+
+type: string
+
+example: Something went wrong
+
+required: False
+
+The message of the logged exception when available.
+
+
 ==== stacktrace
 
 type: array

cf-java-logging-support-core/beats/app-logs/etc/app-logs.template.json

@@ -63,6 +63,16 @@
           "index": "not_analyzed",
           "type": "string"
         },
+        "exception_message": {
+          "doc_values": true,
+          "index": "not_analyzed",
+          "type": "string"
+        },
+        "exception_type": {
+          "doc_values": true,
+          "index": "not_analyzed",
+          "type": "string"
+        },
         "layer": {
           "doc_values": true,
           "index": "not_analyzed",

cf-java-logging-support-core/beats/app-logs/etc/fields.yml

@@ -312,6 +312,20 @@ app-logs:
       description: |
         The original log message that has been written by the application.
 
+    - name: "exception_type"
+      type: string
+      required: false
+      example: "java.lang.NullPointerException"
+      description: |
+        The Java class name of the logged exception when available.
+
+    - name: "exception_message"
+      type: string
+      required: false
+      example: "Something went wrong"
+      description: |
+        The message of the logged exception when available.
+
     - name: "stacktrace"
       type: array
       required: false

cf-java-logging-support-core/beats/scripts/generate_fields_docs.py

@@ -71,7 +71,7 @@ def fields_to_asciidoc(input, output, beat):
 """.format(**dict))
 
 
-    docs = yaml.load(input)
+    docs = yaml.load(input, Loader=yaml.Loader)
 
     # fields file is empty
     if docs is None:

cf-java-logging-support-core/beats/scripts/generate_template.py

@@ -22,7 +22,7 @@ def fields_to_es_template(input, output, index):
     """
 
     # Custom properties
-    docs = yaml.load(input)
+    docs = yaml.load(input, Loader=yaml.Loader)
 
     # No fields defined, can't generate template
     if docs is None:

cf-java-logging-support-core/src/main/java/com/sap/hcp/cf/logging/common/Fields.java

@@ -44,6 +44,8 @@ public interface Fields {
   public String THREAD = "thread";
   public String LEVEL = "level";
   public String MSG = "msg";
+  public String EXCEPTION_TYPE = "exception_type";
+  public String EXCEPTION_MESSAGE = "exception_message";
   public String STACKTRACE = "stacktrace";
   public String CATEGORIES = "categories";
   public String CUSTOM_FIELDS = "#cf";