-
Notifications
You must be signed in to change notification settings - Fork 106
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(traces): OTeL Traces implementation(duty flow) #1980
Open
oleg-ssvlabs
wants to merge
10
commits into
stage
Choose a base branch
from
traces
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.
+1,658
−318
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
changed the title
feat(traces): OTeL Traces implementation
feat(traces): OTeL Traces implementation(duty flow)
Jan 14, 2025
Codecov ReportAttention: Patch coverage is
Additional details and impacted files☔ View full report in Codecov by Sentry. |
oleg-ssvlabs
force-pushed
the
traces
branch
6 times, most recently
from
January 16, 2025 10:25
34dc244
to
819f619
Compare
oleg-ssvlabs
requested review from
moshe-blox,
y0sher,
zktaiga and
MatusKysel
January 16, 2025 12:43
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.
Description/Questions/Suggestions
Are both logs and events needed for recording of the same type of event? Should it be either-or? Example.
Is
Duty ID
as a Trace Attribute necessary? Currently bothSlot
andEpoch
attributes are added separately. Would it be better to just add aCommittee
attribute instead?Duty flows are separated into
Committee
versus everything else (method/function level). This is reflected in different span names. Should we keep separating them on a span level, or should we use the same names with attributes that help differentiate duties (likessv.runner.role,
etc)Span name examples:
ssv.validator.execute_committee_duty
ssv.validator.execute_duty
ssv.validator.start_committee_duty
ssv.validator.start_duty
There are three statuses for spans:
Ok
,Error
, andUnset
. Ideally, all spans should have their status explicitly set to eitherOk
orError
—Unset
is not expected. Please use Grafana UI and verify if we receive any of the spans inUnset
status.Look into namespaces for metrics, traces, and attributes. Namespaces should be consistent across all observability "primitives". There is a chance we have some inconsistencies
Example:
ssv.validator.duty
vs.ssv.duty
. IfDuty
belongs toValidator
, usessv.validator.duty
everywhere.OpenTelemetry Specification explains why
OK
status is used without a message. ("Description MUST be IGNORED for StatusCode Ok & Unset values."). Even if the message is set for OK statuses, it will be ignored by OTeL and not displayed in Grafana (yeah, SDKs could have been better here)Some libraries needs to be updated for proper context propagation, especially for methods that perform I/O (e.g., HTTP calls). Example:
p2p.Broadcast()
.Some enums in the libraries used by SSV Node lack a
String()
method, which complicates logging and tracing.Example:
types.PartialSigMsgType
(ssv-spec
lib). Something that should potentially be implemented by these libraries (we own source code)Should these enums be moved to the
spec types
package instead?