Crate sc_telemetry

Substrate’s client telemetry is a part of substrate that allows ingesting telemetry data with for example Polkadot telemetry.

It works using Tokio’s 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 TelemetryWorkerHandle. 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.

Re-exports

• pub use log;
• pub use serde_json;

Macros

• telemetry
  Report a telemetry.

Structs

• ConnectionMessage
  Message sent when the connection (re-)establishes.
• SysInfo
  Hardware and software information for the node.
• Telemetry
  A telemetry instance that can be used to send telemetry messages.
• TelemetryConnectionNotifier
  Used to create a stream of events with only one event: when a telemetry connection (re-)establishes.
• TelemetryEndpoints
  List of telemetry servers we want to talk to. Contains the URL of the server, and the maximum verbosity level.
• TelemetryHandle
  Handle to a Telemetry.
• TelemetryWorker
  Telemetry worker.
• TelemetryWorkerHandle
  Handle to the TelemetryWorker thats allows initializing the telemetry for a Substrate node.

Enums

• Error

Constants

• CONSENSUS_DEBUG
  Consensus DEBUG log level.
• CONSENSUS_INFO
  Consensus INFO log level.
• CONSENSUS_TRACE
  Consensus TRACE log level.
• CONSENSUS_WARN
  Consensus WARN log level.
• SUBSTRATE_DEBUG
  Substrate DEBUG log level.
• SUBSTRATE_INFO
  Substrate INFO log level.

Type Definitions

• Result
• VerbosityLevel
  Telemetry message verbosity.