Add Graylog logging configuration #252

.gitignore

@@ -3,3 +3,6 @@
 # Demo database and file number directories
 *.db
 trackers/
+
+# Local IDE settings
+.vscode/settings.json

.vscode/launch.json

@@ -0,0 +1,45 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug executable 'numtracker'",
+            "cargo": {
+                "args": [
+                    "build",
+                    "--bin=numtracker",
+                    "--package=numtracker"
+                ],
+                "filter": {
+                    "name": "numtracker",
+                    "kind": "bin"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "type": "lldb",
+            "request": "launch",
+            "name": "Debug unit tests in executable 'numtracker'",
+            "cargo": {
+                "args": [
+                    "test",
+                    "--no-run",
+                    "--bin=numtracker",
+                    "--package=numtracker"
+                ],
+                "filter": {
+                    "name": "numtracker",
+                    "kind": "bin"
+                }
+            },
+            "args": [],
+            "cwd": "${workspaceFolder}"
+        }
+    ]
+}

Cargo.toml

@@ -41,6 +41,8 @@ dirs = { version = "6.0.0", optional = true }
 graphql_client = { version = "0.16.0", optional = true }
 openidconnect = { version = "4.0.0", optional = true }
 toml = { version = "1.0.0", optional = true }
+tracing-gelf = "0.9.0"
+thiserror = "2.0.18"
 
 [dev-dependencies]
 assert_matches = "1.5.0"

README.md

@@ -48,6 +48,25 @@ Additional logging output is available via `-v` verbose flags.
 | `-vv`  |Debug|
 | `-vvv` |Trace|
 
+### Graylog
+
+Logs can be sent to a [Graylog][_graylog] instance using the `--graylog` flag:
+
+```bash
+cargo run -- --graylog tcp://graylog.example.com:12201 serve
+```
+
+The minimum log level sent to Graylog can be set independently of the stderr
+output level using `--logging-level` (default: `INFO`):
+
+```bash
+cargo run -- --graylog tcp://graylog.example.com:12201 --logging-level WARN serve
+```
+
+Both options can also be set via environment variables:
+- `NUMTRACKER_GRAYLOG` — Graylog URL
+- `NUMTRACKER_GRAYLOG_LOG_LEVEL` — log level (`TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`)
+
 ## Schema
 
 The schema is available via the `schema` command. This is also available via the
@@ -405,4 +424,5 @@ $ numtracker client visit-directory i22 cm12345-6
 ```
 
 [_graphiql]:https://github.com/graphql/graphiql/
+[_graylog]:https://graylog.org/
 [_jq]:https://jqlang.github.io/jq/

helm/numtracker/templates/statefulset.yaml

@@ -47,6 +47,12 @@ spec:
             - name: NUMTRACKER_TRACING_LEVEL
               value: {{ .Values.numtracker.tracing.level }}
             {{- end }}
+            {{- if .Values.numtracker.graylog.enabled }}
+            - name: NUMTRACKER_GRAYLOG
+              value: {{ .Values.numtracker.graylog.host }}
+            - name: NUMTRACKER_GRAYLOG_LOG_LEVEL
+              value: {{ .Values.numtracker.graylog.level }}
+            {{- end }}
             {{- if .Values.numtracker.auth.enabled }}
             - name: NUMTRACKER_AUTH_HOST
               value: {{ .Values.numtracker.auth.host }}

helm/numtracker/values.yaml

@@ -24,6 +24,10 @@ numtracker:
     enabled: false
     level: DEBUG
     # host: OTEL compatible host
+  graylog:
+    enabled: false
+    level: INFO
+    # host: DAQ Graylog GELF TCP input eg. tcp://graylog-log-target.diamond.ac.uk:12231
   auth:
     enabled: false
     # host: OPA instance