-
Notifications
You must be signed in to change notification settings - Fork 3
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
Tracing Standards and Refactoring to Comply #235
Closed
Modularius
wants to merge
47
commits into
STFC-ICD-Research-and-Design:main
from
Modularius:Add-fields-to-spans
Closed
Tracing Standards and Refactoring to Comply #235
Modularius
wants to merge
47
commits into
STFC-ICD-Research-and-Design:main
from
Modularius:Add-fields-to-spans
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
This is quite a big PR which could quite easily be 8 individual PRs (general 1+3, 2, 4, 5, 6, docs, aggregator, simulator), making review much easier. Could this be split up as such? |
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.
Summary of changes
New document on tracing, and various changes to implement it and general refactoring.
General
TIMESTAMP_FORMAT
constant to common crate.SpannedAggregator
trait to encapsulate the span-aggregating behaviour ofdigitiser_aggregator::Frame
andnexus_writer::Run
, and implemented these indigitiser_aggregator
andnexus_writer
.FindSpan
andFindSpanMut
traits.record_metadata_fields_to_span
macro to populate spans which are setup to record metadata fields. Implemented innexus_writer
,digitiser_aggregator
andtrace_to_events
tracing.md
insimulator
,nexus_writer
,digitiser_aggregator
andtrace_to_events
.Docs
tracing.md
to thedocs
folder.Digitiser Aggregator
digitiser_aggregator::Cache
struct to useHashMap
rather thanVecDeque
Cache::push
returnsPartialFrame
asimpl SpannedAggregator
.Simulator
IntConstant
andTextConstant
JSON enums that can accept either a literal value or one specified by environment variables.EventList
andTrace
structs added.Instruction for review/testing
tracing.md
make sense, and is informative to a user familiar with the pipeline and with "some" knowledge of tracing/OpenTelemetry?Closes #153.