Doc fixes for sc-telemetry & API struct rename (#7934)

* Doc fixes for sc-telemetry

* Fix flag to disable log reloading

* Forgot to reverse the conditions

* Apply suggestion

* Rename pattern to directives

* Rename GlobalLoggerBuilder to LoggerBuilder

* Return instead of expect

* Use transparent outside the enum

* Update client/tracing/src/logging/directives.rs

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>

Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>

substrate/client/telemetry/src/endpoints.rs

@@ -25,7 +25,8 @@ use serde::{Deserialize, Deserializer, Serialize};
 /// The URL string can be either a URL or a multiaddress.
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Hash)]
 pub struct TelemetryEndpoints(
-	#[serde(deserialize_with = "url_or_multiaddr_deser")] pub(crate) Vec<(Multiaddr, u8)>,
+	#[serde(deserialize_with = "url_or_multiaddr_deser")]
+	pub(crate) Vec<(Multiaddr, u8)>,
 );
 
 /// Custom deserializer for TelemetryEndpoints, used to convert urls or multiaddr to multiaddr.

substrate/client/telemetry/src/layer.rs

@@ -35,7 +35,7 @@ pub struct TelemetryLayer(Mutex<mpsc::Sender<(Id, u8, String)>>);
 impl TelemetryLayer {
 	/// Create a new [`TelemetryLayer`] and [`TelemetryWorker`].
 	///
-	/// If not provided, the `buffer_size` will be 16 by default.
+	/// The `buffer_size` defaults to 16.
 	///
 	/// The [`ExtTransport`] is used in WASM contexts where we need some binding between the
 	/// networking provided by the operating system or environment and libp2p.

substrate/client/telemetry/src/lib.rs

@@ -16,23 +16,23 @@
 // You should have received a copy of the GNU General Public License
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
-//! 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.
 
 #![warn(missing_docs)]
 
@@ -115,7 +115,7 @@ pub struct ConnectionMessage {
 
 /// Telemetry worker.
 ///
-/// It should be ran as a background task using the [`TelemetryWorker::run`] method. This method
+/// It should run as a background task using the [`TelemetryWorker::run`] method. This method
 /// will consume the object and any further attempts of initializing a new telemetry through its
 /// handle will fail (without being fatal).
 #[derive(Debug)]
@@ -143,7 +143,7 @@ impl TelemetryWorker {
 
 	/// Get a new [`TelemetryHandle`].
 	///
-	/// This is used when you want to register a new telemetry for a Substrate node.
+	/// This is used when you want to register with the [`TelemetryWorker`].
 	pub fn handle(&self) -> TelemetryHandle {
 		TelemetryHandle {
 			message_sender: self.register_sender.clone(),