sc_utils/
lib.rs

1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: Apache-2.0
5
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// 	http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18//! Utilities Primitives for Substrate
19//!
20//! This crate provides `mpsc::tracing_unbounded` function that returns wrapper types to
21//! `async_channel::Sender<T>` and `async_channel::Receiver<T>`, which register every
22//! `send`/`received`/`dropped` action happened on the channel.
23//!
24//! Also this wrapper creates and registers a prometheus vector with name `unbounded_channel_len`
25//! and labels:
26//!
27//! | Label        | Description                                   |
28//! | ------------ | --------------------------------------------- |
29//! | entity       | Name of channel passed to `tracing_unbounded` |
30//! | action       | One of `send`/`received`/`dropped`            |
31
32pub mod id_sequence;
33pub mod metrics;
34pub mod mpsc;
35pub mod notification;
36pub mod pubsub;
37pub mod status_sinks;