-
Notifications
You must be signed in to change notification settings - Fork 95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: (metrics) integrate OTeL in duties and eth packages #1852
Open
oleg-ssvlabs
wants to merge
12
commits into
stage
Choose a base branch
from
otel-metrics
base: stage
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+497
−298
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oleg-ssvlabs
force-pushed
the
otel-metrics
branch
2 times, most recently
from
November 13, 2024 15:15
bb2739f
to
0c69041
Compare
oleg-ssvlabs
changed the title
WIP: OTeL metrics instrumentaion
OTeL metrics instrumentation - Duty Scheduler / Event Handler (Event Syncer)
Nov 13, 2024
oleg-ssvlabs
force-pushed
the
otel-metrics
branch
7 times, most recently
from
November 14, 2024 14:19
ec02308
to
46a4f2b
Compare
nkryuchkov
changed the title
OTeL metrics instrumentation - Duty Scheduler / Event Handler (Event Syncer)
feat: (metrics) integrate OTeL in duties and eth packages
Nov 14, 2024
oleg-ssvlabs
requested review from
moshe-blox,
MatusKysel,
iurii-ssv,
y0sher,
nkryuchkov and
zktaiga
November 15, 2024 08:58
oleg-ssvlabs
force-pushed
the
otel-metrics
branch
from
November 15, 2024 09:13
46a4f2b
to
ae64bad
Compare
oleg-ssvlabs
force-pushed
the
otel-metrics
branch
2 times, most recently
from
November 15, 2024 14:57
564b43f
to
5cb528b
Compare
oleg-ssvlabs
force-pushed
the
otel-metrics
branch
from
November 15, 2024 15:02
5cb528b
to
520454b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
The observability team is currently working on a metrics refactor to address various challenges with the current implementation. As part of this refactor, Prometheus SDKs are being replaced with OTeL SDKs, which are industry-leading in observability and provide an abstraction layer for various observability "backends". Additionally, OTeL SDKs will be used to implement Traces. This aspect should be taken into consideration.
Implementation
Central observability configurator was added (new root pkg
observability
). It looks simple, although it wasn't simple to decide what should "configurator" include mainly because OTeL supports two way of provider configuration - SDKs and environment variables and we want SSV Node users to be able to configure observability via native OTeL env vars. Some research showed that the vision of OTeL is "SDK first" meaning there are many features that aren't possible to configure via environment variables, yet possible via SDKs.However, the long-term aim is not to wrap OTeL environment variables into custom environment variables. Just FYI.Multiple components were instrumented, including the
Execution Client
,Event Syncer
, andDuty Scheduler
. The following metrics were introduced (either new or replacements for old ones) along with their attributes:ssv.el.latency.duration
(ssv.el.addr
attributre)ssv.el.syncing.distance
(ssv.el.addr
attributre)ssv.el.syncing.status
(ssv.el.addr
,ssv.el.status
attributre)ssv.el.syncing.last_processed_block
(ssv.el.addr
attributre)ssv.event_syncer.handler.events_processed
(ssv.event_syncer.event_name
attributre)ssv.event_syncer.handler.events_failed
(ssv.event_syncer.event_name
attribute attributre)ssv.event_syncer.handler.last_processed_block
ssv.operator.duty_scheduler.slot_ticker_delay.duration
ssv.operator.duty_scheduler.executions
(ssv.duty.type
attributre)ssv.operator.duty_scheduler.committee_executions
(ssv.runner.role
attributre)Conventions.md
which describes OTeL metric related conventions (mainly naming). Will continuously be updated. Conventions (are described in the document) are based on OTeL original conventions. Although, in some cases OTeL's ambiguity was tightened.