feat: add support for structure logs (#2342)

* add support for structure logs Signed-off-by: drfaust92 <[email protected]> * add support for structure logs Signed-off-by: drfaust92 <[email protected]> --------- Signed-off-by: drfaust92 <[email protected]>
SeleniumHQ · Aug 9, 2024 · 68ebfe1 · 68ebfe1
1 parent 547f97e
commit 68ebfe1
Show file tree

Hide file tree

Showing 12 changed files with 53 additions and 0 deletions.
diff --git a/Distributor/start-selenium-grid-distributor.sh b/Distributor/start-selenium-grid-distributor.sh
@@ -59,6 +59,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/EventBus/start-selenium-grid-eventbus.sh b/EventBus/start-selenium-grid-eventbus.sh
@@ -24,6 +24,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/Hub/start-selenium-grid-hub.sh b/Hub/start-selenium-grid-hub.sh
@@ -27,6 +27,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/NodeBase/start-selenium-node.sh b/NodeBase/start-selenium-node.sh
@@ -66,6 +66,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/NodeDocker/start-selenium-grid-docker.sh b/NodeDocker/start-selenium-grid-docker.sh
@@ -34,6 +34,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/Router/start-selenium-grid-router.sh b/Router/start-selenium-grid-router.sh
@@ -59,6 +59,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/SessionQueue/start-selenium-grid-session-queue.sh b/SessionQueue/start-selenium-grid-session-queue.sh
@@ -24,6 +24,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/Sessions/start-selenium-grid-sessions.sh b/Sessions/start-selenium-grid-sessions.sh
@@ -39,6 +39,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/Standalone/start-selenium-standalone.sh b/Standalone/start-selenium-standalone.sh
@@ -66,6 +66,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/StandaloneDocker/start-selenium-grid-docker.sh b/StandaloneDocker/start-selenium-grid-docker.sh
@@ -19,6 +19,11 @@ if [ ! -z "$SE_LOG_LEVEL" ]; then
   SE_OPTS="$SE_OPTS --log-level ${SE_LOG_LEVEL}"
 fi
 
+if [ ! -z "$SE_STRUCTURED_LOGS" ]; then
+  echo "Appending Selenium options: --structured-logs ${SE_STRUCTURED_LOGS}"
+  SE_OPTS="$SE_OPTS --structured-logs ${SE_STRUCTURED_LOGS}"
+fi
+
 if [ ! -z "$SE_EXTERNAL_URL" ]; then
   echo "Appending Selenium options: --external-url ${SE_EXTERNAL_URL}"
   SE_OPTS="$SE_OPTS --external-url ${SE_EXTERNAL_URL}"

diff --git a/charts/selenium-grid/templates/logging-configmap.yaml b/charts/selenium-grid/templates/logging-configmap.yaml
@@ -13,6 +13,7 @@ metadata:
     {{- end }}
 data:
   SE_LOG_LEVEL: "{{ default "INFO" .Values.global.seleniumGrid.logLevel }}"
+  SE_STRUCTURED_LOGS: "{{ default false .Values.global.seleniumGrid.structuredLogs }}"
 {{- if (eq (include "seleniumGrid.enableTracing" .) "true") }}
   SE_ENABLE_TRACING: "true"
   SE_OTEL_TRACES_EXPORTER: {{ .Values.tracing.exporter | quote }}

diff --git a/charts/selenium-grid/values.yaml b/charts/selenium-grid/values.yaml
@@ -29,6 +29,8 @@ global:
     stdoutProbeLog: false
     # specify how many old ReplicaSets for this Deployment you want to retain. The rest will be garbage-collected in the background.
     revisionHistoryLimit: 10
+    # Whether to enable structured logging
+    structuredLogs: false
 
 tls:
   # Name of external secret containing the TLS certificate and key