This repository was archived by the owner on Nov 15, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Doc fixes for sc-telemetry & API struct rename #7934
Merged
Merged
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
26c5ad4
Doc fixes for sc-telemetry
cecton 338c3bd
Fix flag to disable log reloading
cecton 9af21dd
Forgot to reverse the conditions
cecton fd8bbec
Apply suggestion
cecton 3d07bed
Rename pattern to directives
cecton f26a828
Rename GlobalLoggerBuilder to LoggerBuilder
cecton 5efdec6
Return instead of expect
cecton cb2cde9
Use transparent outside the enum
cecton daa6021
Update client/tracing/src/logging/directives.rs
cecton 7c5913c
Merge commit 0b0d124d5f9be89f614f2be8e9da038fcb9f540e (no conflict)
cecton f4d9f61
Merge commit 68d715719add5ed0473585f8ce38dd312a69a063 (no conflict)
cecton File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,21 @@ | ||
# sc-telemetry | ||
|
||
Substrate's client telemetry is a part of substrate that allows logging telemetry information | ||
with a [Polkadot telemetry](https://github.com/paritytech/substrate-telemetry). | ||
Substrate's client telemetry is a part of substrate that allows ingesting telemetry data | ||
with for example [Polkadot telemetry](https://github.com/paritytech/substrate-telemetry). | ||
|
||
It works using Tokio's [tracing](https://github.com/tokio-rs/tracing/). The telemetry | ||
information uses tracing's logging to report the telemetry which is then retrieved by a | ||
tracing's `Layer`. This layer will then send the data through an asynchronous channel and to a | ||
background task called [`TelemetryWorker`] which will send the information to the telemetry | ||
server. | ||
It works using Tokio's [tracing](https://github.com/tokio-rs/tracing/) library. The telemetry | ||
information uses tracing's logging to report the telemetry data which is then retrieved by a | ||
tracing `Layer`. This layer will then send the data through an asynchronous channel to a | ||
background task called [`TelemetryWorker`] which will send the information to the configured | ||
remote telemetry servers. | ||
|
||
If multiple substrate nodes are running, it uses a tracing's `Span` to identify which substrate | ||
node is reporting the telemetry. Every task spawned using sc-service's `TaskManager` | ||
automatically inherit this span. | ||
If multiple substrate nodes are running in the same process, it uses a `tracing::Span` to | ||
identify which substrate node is reporting the telemetry. Every task spawned using sc-service's | ||
`TaskManager` automatically inherit this span. | ||
|
||
Substrate's nodes initialize/register to the [`TelemetryWorker`] using a [`TelemetryHandle`]. | ||
Substrate's nodes initialize/register with the [`TelemetryWorker`] using a [`TelemetryHandle`]. | ||
This handle can be cloned and passed around. It uses an asynchronous channel to communicate with | ||
the running [`TelemetryWorker`] dedicated to registration. Registering a telemetry can happen at | ||
any point in time during the execution. | ||
the running [`TelemetryWorker`] dedicated to registration. Registering can happen at any point | ||
in time during the process execution. | ||
|
||
License: GPL-3.0-or-later WITH Classpath-exception-2.0 |
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh there it is @dvdplm . See! I knew I did it. It was just in another PR