Skip to content
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

trace-dispatcher: documentation #5635

Merged
merged 3 commits into from
Jan 22, 2024
Merged

trace-dispatcher: documentation #5635

merged 3 commits into from
Jan 22, 2024

Conversation

jutaro
Copy link
Contributor

@jutaro jutaro commented Jan 11, 2024

Complete rewrite of trace-dispatcher documentation.

@jutaro jutaro self-assigned this Jan 11, 2024
@jutaro jutaro marked this pull request as ready for review January 11, 2024 11:00
Copy link
Contributor

@NadiaYvette NadiaYvette left a comment

Choose a reason for hiding this comment

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

I found the explanation of the tracing system enlightening. It's great to have more code docs!

trace-dispatcher/doc/trace-dispatcher.md Outdated Show resolved Hide resolved
trace-dispatcher/doc/trace-dispatcher.md Outdated Show resolved Hide resolved

### Privacy
documentFor :: Namespace a -> Maybe Text
Copy link
Contributor

Choose a reason for hiding this comment

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

No default implementation like const Nothing? Do I have to provide that explicitly as a dev?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Has currently no default implementation. The idea was to motivate the writing of docu, but this can be changed?

trace-dispatcher/doc/trace-dispatcher.md Show resolved Hide resolved
trace-dispatcher/doc/trace-dispatcher.md Outdated Show resolved Hide resolved
trace-dispatcher/doc/trace-dispatcher.md Show resolved Hide resolved

2. __Trace-Forward Tracer:__ This is a network-only sink dedicated to forwarding messages using typed protocols over TCP or local sockets. It exclusively handles public traces and should be instantiated only once per application.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is forwarding over TCP an option, or has that been removed? A quick look of how I'd configure this came up empty...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can't see the relation of your question to this part. The configuration of the forwarder should be part of the other two documents: "cardano-tracer manual" and "quick start of new tracing for admins"

@jutaro jutaro force-pushed the jutaro/tracer-docs branch 2 times, most recently from ddd635a to 99e94d4 Compare January 17, 2024 10:10
@jutaro jutaro enabled auto-merge January 17, 2024 10:10
@jutaro jutaro added this pull request to the merge queue Jan 17, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Jan 17, 2024
@jutaro jutaro force-pushed the jutaro/tracer-docs branch 3 times, most recently from 576ab7c to 8afc2da Compare January 22, 2024 16:52
@jutaro jutaro enabled auto-merge January 22, 2024 16:56
@jutaro jutaro added this pull request to the merge queue Jan 22, 2024
Merged via the queue into master with commit 671afa2 Jan 22, 2024
20 checks passed
@jutaro jutaro deleted the jutaro/tracer-docs branch January 22, 2024 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants