mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 01:47:55 +00:00
Chevdor
a30092ab42
* Add markdown linting - add linter default rules - adapt rules to current code - fix the code for linting to pass - add CI check fix #1243 * Fix markdown for Substrate * Fix tooling install * Fix workflow * Add documentation * Remove trailing spaces * Update .github/.markdownlint.yaml Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> * Fix mangled markdown/lists * Fix captalization issues on known words
22 lines
1.2 KiB
Markdown
22 lines
1.2 KiB
Markdown
# sc-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/) 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 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 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 can happen at any point
|
|
in time during the process execution.
|
|
|
|
License: GPL-3.0-or-later WITH Classpath-exception-2.0
|