Skip to content

Add --telemetry-service-name CLI flag for OpenTelemetry service name override#7903

Merged
mergify[bot] merged 2 commits into
sigp:unstablefrom
jimmygchen:add-telemetry-svc-name
Aug 20, 2025
Merged

Add --telemetry-service-name CLI flag for OpenTelemetry service name override#7903
mergify[bot] merged 2 commits into
sigp:unstablefrom
jimmygchen:add-telemetry-svc-name

Conversation

@jimmygchen

@jimmygchen jimmygchen commented Aug 20, 2025

Copy link
Copy Markdown
Member

Issue Addressed

Allows users to customize the OpenTelemetry service name instead of using the hardcoded default lighthouse. Defaults to 'lighthouse-bn' for beacon node, 'lighthouse-vc' for validator client, or 'lighthouse' for other subcommands.

This is useful when analysing traces from multiple nodes, see Grafana screenshot below with service name overrides in Kurtosis (ethereum-package PR: ethpandaops/ethereum-package#1160):

image

…e override

  Allows users to customize the OpenTelemetry service name instead of using
  the hardcoded defaults. Defaults to 'lighthouse-bn' for beacon node,
  'lighthouse-vc' for validator client, or 'lighthouse' for other subcommands.
@jimmygchen jimmygchen added ready-for-review The code is ready for review low-hanging-fruit Easy to resolve, get it before someone else does! tracing labels Aug 20, 2025
Comment thread book/src/help_vm_move.md
--telemetry-collector-url <URL>
URL of the OpenTelemetry collector to export tracing spans (e.g.,
http://localhost:4317). If not set, tracing export is disabled.
--telemetry-service-name <NAME>

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an orthogonal issue, but probably we don't want these flags displayed prominently on short-lived subcommands like lighthouse vm. I think Mac is going to look into hiding a lot of the irrelevant flags by default:

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah i agree and I thought about that too, the downside is we'd have to duplicate the flags in BN and VC. Would be good to hide them!

On a separate note, we also have a few minor flag usage issues we need to fix, e.g. bootnode panic if run in debug mode.

@michaelsproul michaelsproul left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Nice feature!

@michaelsproul michaelsproul added ready-for-merge This PR is ready to merge. and removed ready-for-review The code is ready for review labels Aug 20, 2025
mergify Bot added a commit that referenced this pull request Aug 20, 2025
mergify Bot added a commit that referenced this pull request Aug 20, 2025
@mergify mergify Bot merged commit 95882bf into sigp:unstable Aug 20, 2025
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

low-hanging-fruit Easy to resolve, get it before someone else does! ready-for-merge This PR is ready to merge. tracing

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants