Add Graylog logging configuration #252 by Alexj9837 · Pull Request #264 · DiamondLightSource/numtracker

Alexj9837 · 2026-03-11T13:12:53Z

Summary

Add tracing-gelf layer to ship structured logs to a Graylog instance via GELF TCP
Expose --graylog <URL> and --logging-level <LEVEL> CLI flags (also via NUMTRACKER_GRAYLOG / NUMTRACKER_GRAYLOG_LOG_LEVEL env vars)
Add Graylog env var injection to Helm chart with numtracker.graylog.enabled/host/level values

ZohebShaikh

Looks good only few minor things

- Extract GraylogOptions into its own struct, independent of TracingOptions - Remove .vscode/launch.json (to be added in a separate PR) - Remove version/build additional_field calls from Graylog logger - Switch let-else to if-let in init_graylog - Warn when Graylog URL has no port rather than silently defaulting - Add reconnect loop so dropped connections recover automatically - Improve connection error messages to distinguish DNS failure from TCP errors

codecov · 2026-03-30T13:59:52Z

Codecov Report

❌ Patch coverage is 85.50725% with 20 lines in your changes missing coverage. Please review.
✅ Project coverage is 78.89%. Comparing base (b27d787) to head (ad9f941).

Files with missing lines	Patch %	Lines
src/logging.rs	80.20%	19 Missing ⚠️
src/main.rs	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #264      +/-   ##
==========================================
+ Coverage   76.44%   78.89%   +2.45%     
==========================================
  Files          13       13              
  Lines        1944     2080     +136     
==========================================
+ Hits         1486     1641     +155     
+ Misses        458      439      -19

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tpoliaw

Looks pretty good, thanks for looking at it. A couple of changes could make the error handling a bit cleaner and keep it more consistent with what is already there though.

tpoliaw · 2026-05-06T11:00:24Z

+#[derive(Debug, Parser)]
+pub struct GraylogOptions {
+    /// The hostname of the Graylog GELF TCP input
+    #[clap(long = "graylog-host", env = "NUMTRACKER_GRAYLOG_HOST")]


nit: you don't need to specify the option string if it matches the field names and underscores are replaced automatically

Suggested change

#[clap(long = "graylog-host", env = "NUMTRACKER_GRAYLOG_HOST")]

#[clap(long, env = "NUMTRACKER_GRAYLOG_HOST")]

tpoliaw · 2026-05-06T11:01:00Z

+    #[clap(
+        long = "graylog-port",
+        default_value_t = 12201,
+        env = "NUMTRACKER_GRAYLOG_PORT"
+    )]
+    pub(crate) graylog_port: u16,


nit: and here

Suggested change

#[clap(

long = "graylog-port",

default_value_t = 12201,

env = "NUMTRACKER_GRAYLOG_PORT"

)]

pub(crate) graylog_port: u16,

#[clap(long, default_value_t = 12201, env = "NUMTRACKER_GRAYLOG_PORT")]

pub(crate) graylog_port: u16,

tpoliaw · 2026-07-22T17:19:48Z

 }

-pub fn init(logging: Option<Level>, tracing: &TracingOptions) -> Result<(), ExporterBuildError> {
+fn init_graylog<S>(opts: &GraylogOptions) -> Result<Option<impl Layer<S>>, LoggingError>


It doesn't look like this method can ever fail. Do we need to return Result? And if not, do we need LoggingError?

tpoliaw · 2026-07-22T17:28:08Z

+where
+    S: Subscriber + for<'s> LookupSpan<'s>,
+{
+    if let Some(address) = opts.address() {


nit: Rather than putting the whole method in an if statement, you could use a let ... else check for the no-op case at the start and then shift everything else left.

let Some(address) = opts.address() else { return None; }; match Logger::builder() // everything else the same but dedented

tpoliaw · 2026-07-22T17:35:19Z

+                Ok(Some(
+                    logger
+                        .with_filter(LevelFilter::from_level(level))
+                        .with_filter(FilterFn::new(|m| {


Looking at the current logs in argocd, I think this would filter out the vast majority of the logging. It might be a good sign we should be logging more from numtracker directly but for now should we relax this a bit? The other loggers don't restrict messages to numtracker only.

tpoliaw · 2026-07-22T17:39:01Z

+        // Level defaults to INFO when not specified
+        assert_eq!(cli.graylog().level(), Level::INFO);
+
+        // Level can be overridden independently of host/port


nit: The rest of this test should probably be its own test

Alexj9837 marked this pull request as ready for review March 16, 2026 15:59

ZohebShaikh reviewed Mar 17, 2026

View reviewed changes

Comment thread src/cli/mod.rs Outdated

ZohebShaikh reviewed Mar 17, 2026

View reviewed changes

Comment thread .vscode/launch.json Outdated

ZohebShaikh reviewed Mar 17, 2026

View reviewed changes

Comment thread src/logging.rs Outdated

Comment thread src/logging.rs Outdated

Comment thread src/logging.rs Outdated

ZohebShaikh reviewed Mar 17, 2026

View reviewed changes

Comment thread src/logging.rs Outdated

Alexj9837 force-pushed the numtracker_graylog branch from bda4336 to 831a990 Compare March 18, 2026 15:44

Alexj9837 added 8 commits March 30, 2026 14:47

Add Graylog GELF logging layer

d4cd088

Add Graylog configuration to Helm chart

3a5641f

Document Graylog logging configuration

f0bb43a

Add VSCode debug launch config

ff2a5fe

changed to align with tracing

700688b

removing launch.json

27aa07c

Regenerate Cargo.lock after rebase onto main

0a86a82

Alexj9837 force-pushed the numtracker_graylog branch from 831a990 to 0a86a82 Compare March 30, 2026 13:56

Alexj9837 added 2 commits March 30, 2026 15:02

Fix clippy: use is_err() instead of matches!(result, Err(_))

9c231c4

Fix nightly rustfmt formatting

9092648

tpoliaw requested changes Mar 30, 2026

View reviewed changes

Alexj9837 added 2 commits April 20, 2026 16:06

Merge branch 'main' into numtracker_graylog

9683f4e

Add Graylog GELF logging layer

b172be8

Alexj9837 force-pushed the numtracker_graylog branch 3 times, most recently from 498354e to 59d5002 Compare April 20, 2026 15:36

Address PR review feedback on Graylog logging

926a966

Alexj9837 force-pushed the numtracker_graylog branch from 59d5002 to 926a966 Compare April 20, 2026 15:42

Alexj9837 added 4 commits July 14, 2026 12:35

Merge branch 'main' into numtracker_graylog

22cc68b

adding more test coverage

97c9ad0

removing changes to gitignore

2b91f78

Merge branch 'main' into numtracker_graylog

d8d7590

Alexj9837 requested a review from ZohebShaikh July 16, 2026 08:32

Merge branch 'main' into numtracker_graylog

2d90176

Alexj9837 requested a review from tpoliaw July 17, 2026 09:33

dan-fernandes reviewed Jul 22, 2026

View reviewed changes

Comment thread helm/numtracker/templates/deployment.yaml Outdated

dan-fernandes reviewed Jul 22, 2026

View reviewed changes

Comment thread README.md Outdated

wrapped value with a required and adding comment for env var priority.

ad9f941

Alexj9837 requested a review from dan-fernandes July 22, 2026 11:06

tpoliaw reviewed Jul 22, 2026

View reviewed changes

	#[clap(long = "graylog-host", env = "NUMTRACKER_GRAYLOG_HOST")]
	#[clap(long, env = "NUMTRACKER_GRAYLOG_HOST")]

Uh oh!

Conversation

Alexj9837 commented Mar 11, 2026

Summary

Uh oh!

Uh oh!

Uh oh!

ZohebShaikh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tpoliaw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tpoliaw May 6, 2026

Choose a reason for hiding this comment

Uh oh!

tpoliaw May 6, 2026

Choose a reason for hiding this comment

Uh oh!

tpoliaw Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

tpoliaw Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

tpoliaw Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

tpoliaw Jul 22, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov Bot commented Mar 30, 2026 •

edited

Loading