COSI-35: add-comments-for-log-levels

scality · Dec 18, 2024 · b02a854 · b02a854
1 parent f9f5345
commit b02a854
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 1 deletion.
diff --git a/helm/scality-cosi-driver/values.yaml b/helm/scality-cosi-driver/values.yaml
@@ -6,7 +6,13 @@ image:
 
 replicaCount: 1
 
-
+# Log levels define the verbosity of logs for various parts of the system.
+# Use these levels to control the detail included in the logs:
+# 1 - General configuration, routine logs
+# 2 - Steady-state operations, HTTP requests, system state changes (default)
+# 3 - Extended changes, additional system details
+# 4 - Debug-level logs, tricky logic areas
+# 5 - Trace-level logs, context for troubleshooting
 logLevels:
   driver: "2"
   sidecar: "2"

diff --git a/kustomize/overlays/debug/scality-cosi-driver.properties b/kustomize/overlays/debug/scality-cosi-driver.properties
@@ -1,2 +1,9 @@
+# Log levels define the verbosity of logs for various parts of the system.
+# Use these levels to control the detail included in the logs:
+# 1 - General configuration, routine logs
+# 2 - Steady-state operations, HTTP requests, system state changes (default)
+# 3 - Extended changes, additional system details
+# 4 - Debug-level logs, tricky logic areas
+# 5 - Trace-level logs, context for troubleshooting
 COSI_DRIVER_LOG_LEVEL=5
 OBJECTSTORAGE_PROVISIONER_SIDECAR_LOG_LEVEL=5
diff --git a/kustomize/overlays/dev/scality-cosi-driver.properties b/kustomize/overlays/dev/scality-cosi-driver.properties
@@ -1,2 +1,9 @@
+# Log levels define the verbosity of logs for various parts of the system.
+# Use these levels to control the detail included in the logs:
+# 1 - General configuration, routine logs
+# 2 - Steady-state operations, HTTP requests, system state changes (default)
+# 3 - Extended changes, additional system details
+# 4 - Debug-level logs, tricky logic areas
+# 5 - Trace-level logs, context for troubleshooting
 COSI_DRIVER_LOG_LEVEL=5
 OBJECTSTORAGE_PROVISIONER_SIDECAR_LOG_LEVEL=5
diff --git a/kustomize/overlays/production/scality-cosi-driver.properties b/kustomize/overlays/production/scality-cosi-driver.properties
@@ -1,2 +1,9 @@
+# Log levels define the verbosity of logs for various parts of the system.
+# Use these levels to control the detail included in the logs:
+# 1 - General configuration, routine logs
+# 2 - Steady-state operations, HTTP requests, system state changes (default)
+# 3 - Extended changes, additional system details
+# 4 - Debug-level logs, tricky logic areas
+# 5 - Trace-level logs, context for troubleshooting
 COSI_DRIVER_LOG_LEVEL=2
 OBJECTSTORAGE_PROVISIONER_SIDECAR_LOG_LEVEL=2