charts/*: default logFormat=StructuredJSON format (#2559)

jschaul · akshaymankar · web-flow · commit 986da6fe254d · 2022-07-14T17:50:17.000+02:00
* charts/*: default logFormat=StructuredJSON format This format was introduced in #1951 and #1959. * Hi CI * spar: Ensure integration test for testing logging works with StructuredJSON logs Co-authored-by: Akshay Mankar <akshay@wire.com>
diff --git a/changelog.d/2-features/charts-logging b/changelog.d/2-features/charts-logging
@@ -0,0 +1 @@
+charts/wire-server: default log format everywhere to StructuredJSON format (introduced in #1951 and #1959)
diff --git a/charts/brig/templates/configmap.yaml b/charts/brig/templates/configmap.yaml
@@ -10,8 +10,7 @@ metadata:
 data:
   {{- with .Values.config }}
   brig.yaml: |
-    logNetStrings: True # log using netstrings encoding:
-                        # http://cr.yp.to/proto/netstrings.txt
+    logNetStrings: {{ .logNetStrings }}
     logFormat: {{ .logFormat }}
     logLevel: {{ .logLevel }}
 
diff --git a/charts/brig/values.yaml b/charts/brig/values.yaml
@@ -17,7 +17,8 @@ metrics:
     enable: false
 config:
   logLevel: Info
-  logFormat: JSON
+  logFormat: StructuredJSON
+  logNetStrings: false
   cassandra:
     host: aws-cassandra
   elasticsearch:
diff --git a/charts/cannon/templates/configmap.yaml b/charts/cannon/templates/configmap.yaml
@@ -1,8 +1,9 @@
 apiVersion: v1
 data:
   cannon.yaml: |
-    logFormat: StructuredJSON
+    logFormat: {{ .Values.config.logFormat }}
     logLevel: {{ .Values.config.logLevel }}
+    logNetStrings: {{ .Values.config.logNetStrings }}
 
     cannon:
       host: 0.0.0.0
diff --git a/charts/cannon/values.yaml b/charts/cannon/values.yaml
@@ -9,6 +9,8 @@ nginzImage:
   pullPolicy: IfNotPresent
 config:
   logLevel: Info
+  logFormat: StructuredJSON
+  logNetStrings: false
 
   # See also the section 'Controlling the speed of websocket draining during
   # cannon pod replacement' in docs/how-to/install/configuration-options.rst
diff --git a/charts/cargohold/templates/configmap.yaml b/charts/cargohold/templates/configmap.yaml
@@ -4,8 +4,9 @@ metadata:
   name: "cargohold"
 data:
   cargohold.yaml: |
-    logNetStrings: True # log using netstrings encoding: http://cr.yp.to/proto/netstrings.txt
+    logFormat: {{ .Values.config.logFormat }}
     logLevel: {{ .Values.config.logLevel }}
+    logNetStrings: {{ .Values.config.logNetStrings }}
 
     cargohold:
       host: 0.0.0.0
diff --git a/charts/cargohold/values.yaml b/charts/cargohold/values.yaml
@@ -17,6 +17,8 @@ resources:
     cpu: "500m"
 config:
   logLevel: Info
+  logFormat: StructuredJSON
+  logNetStrings: false
   enableFederator: false # keep enableFederator default in sync with brig and galley chart's config.enableFederator as well as wire-server chart's tag.federator
   aws:
     region: "eu-west-1"
diff --git a/charts/federator/templates/configmap.yaml b/charts/federator/templates/configmap.yaml
@@ -37,8 +37,7 @@ data:
 
     {{- with .Values.config }}
 
-    logNetStrings: True # log using netstrings encoding:
-                        # http://cr.yp.to/proto/netstrings.txt
+    logNetStrings: {{ .logNetStrings }}
     logFormat: {{ .logFormat }}
     logLevel: {{ .logLevel }}
 
diff --git a/charts/federator/values.yaml b/charts/federator/values.yaml
@@ -24,7 +24,8 @@ resources:
     cpu: "500m"
 config:
   logLevel: Info
-  logFormat: JSON
+  logFormat: StructuredJSON
+  logNetStrings: false
   optSettings:
     # Defaults to using system CA store in the federator image for making
     # connections to remote federators.
diff --git a/charts/galley/templates/configmap.yaml b/charts/galley/templates/configmap.yaml
@@ -5,10 +5,9 @@ metadata:
 data:
   {{- with .Values.config }}
   galley.yaml: |
-    logNetStrings: True # log using netstrings encoding:
-                        # http://cr.yp.to/proto/netstrings.txt
-    logLevel: {{ .logLevel }}
     logFormat: {{ .logFormat }}
+    logLevel: {{ .logLevel }}
+    logNetStrings: {{ .logNetStrings }}
 
     galley:
       host: 0.0.0.0
diff --git a/charts/galley/values.yaml b/charts/galley/values.yaml
@@ -18,7 +18,8 @@ resources:
     cpu: "500m"
 config:
   logLevel: Info
-  logFormat: JSON
+  logFormat: StructuredJSON
+  logNetStrings: false
   cassandra:
     host: aws-cassandra
     replicaCount: 3
diff --git a/charts/gundeck/templates/configmap.yaml b/charts/gundeck/templates/configmap.yaml
@@ -5,8 +5,9 @@ metadata:
 data:
   {{- with .Values.config }}
   gundeck.yaml: |
-    logNetStrings: True # log using netstrings encoding: http://cr.yp.to/proto/netstrings.txt
+    logFormat: {{ .logFormat }}
     logLevel: {{ .logLevel }}
+    logNetStrings: {{ .logNetStrings }}
 
     gundeck:
       host: 0.0.0.0
diff --git a/charts/gundeck/values.yaml b/charts/gundeck/values.yaml
@@ -17,6 +17,8 @@ resources:
     cpu: "500m"
 config:
   logLevel: Info
+  logFormat: StructuredJSON
+  logNetStrings: false
   cassandra:
     host: aws-cassandra
   redis:
diff --git a/charts/proxy/templates/configmap.yaml b/charts/proxy/templates/configmap.yaml
@@ -4,8 +4,9 @@ metadata:
   name: "proxy"
 data:
   proxy.yaml: |
-    logNetStrings: True # log using netstrings encoding: http://cr.yp.to/proto/netstrings.txt
+    logFormat: {{ .Values.config.logFormat }}
     logLevel: {{ .Values.config.logLevel }}
+    logNetStrings: {{ .Values.config.logNetStrings }}
 
     host: 0.0.0.0
     port: {{ .Values.service.internalPort }}
diff --git a/charts/proxy/values.yaml b/charts/proxy/values.yaml
@@ -16,5 +16,7 @@ resources:
     memory: "512Mi"
     cpu: "500m"
 config:
-  logLevel: Debug
+  logLevel: Info
+  logFormat: StructuredJSON
+  logNetStrings: false
   proxy: {}
diff --git a/charts/spar/templates/configmap.yaml b/charts/spar/templates/configmap.yaml
@@ -5,8 +5,9 @@ metadata:
 data:
 {{- with .Values.config }}
   spar.yaml: |
-    logNetStrings: True # log using netstrings encoding (see http://cr.yp.to/proto/netstrings.txt)
+    logFormat: {{ .logFormat }}
     logLevel: {{ .logLevel }}
+    logNetStrings: {{ .logNetStrings }}
 
     brig:
       host: brig
diff --git a/charts/spar/values.yaml b/charts/spar/values.yaml
@@ -21,6 +21,8 @@ config:
   richInfoLimit: 5000
   maxScimTokens: 0
   logLevel: Info
+  logFormat: StructuredJSON
+  logNetStrings: false
   maxttlAuthreq: 7200
   maxttlAuthresp: 7200
   proxy: {}
diff --git a/services/spar/test-integration/Test/LoggingSpec.hs b/services/spar/test-integration/Test/LoggingSpec.hs
@@ -41,7 +41,7 @@ spec = describe "logging" $ do
       (out, _) <- capture $ do
         Log.fatal logger $ Log.msg ("hrgh\n\nwoaa" :: Text)
         Log.flush logger
-      out `shouldContain` "hrgh  woaa"
+      out `shouldContain` "hrgh"
       out `shouldNotContain` "hrgh\n\nwoaa"
   context "loglevel == debug" $ do
     it "400 on finalize-login causes log of entire request" $ do

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+charts/wire-server: default log format everywhere to StructuredJSON format (introduced in #1951 and #1959)`