mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 16:57:58 +00:00
Add a readme about feature metered for sp-utils (#8736)
This commit is contained in:
committed by
GitHub
parent
68a740c071
commit
7c3a3f79ba
@@ -1,3 +1,20 @@
|
||||
Utilities Primitives for Substrate
|
||||
|
||||
License: Apache-2.0
|
||||
## Features
|
||||
|
||||
### metered
|
||||
|
||||
This feature changes the behaviour of the function `mpsc::tracing_unbounded`.
|
||||
With the disabled feature this function is an alias to `futures::channel::mpsc::unbounded`.
|
||||
However, when the feature is enabled it creates wrapper types to `UnboundedSender<T>`
|
||||
and `UnboundedReceiver<T>` to register every `send`/`received`/`dropped` action happened on
|
||||
the channel.
|
||||
|
||||
Also this feature creates and registers a prometheus vector with name `unbounded_channel_len` and labels:
|
||||
|
||||
| Label | Description |
|
||||
| ------------ | --------------------------------------------- |
|
||||
| entity | Name of channel passed to `tracing_unbounded` |
|
||||
| action | One of `send`/`received`/`dropped` |
|
||||
|
||||
License: Apache-2.0
|
||||
|
||||
Reference in New Issue
Block a user