Add support for sourced metrics. #6895

romanb · 2020-08-14T13:48:42Z

This is a little follow-up to the suggestion in #6870 for custom metric collectors. This PR introduces what I dubbed "sourced" counters or gauges via a custom collector. A sourced counter or gauge is a metric that obtains its values from an existing source, i.e. not from a prometheus-crate metric. It thus allows feeding existing counters and gauges into prometheus without having to duplicate them as prometheus-crate counters or gauges and without having to declare counters as gauges or making extra gymnastics with the counter API (i.e. get() + compute diff + inc_by() or reset() + inc_by() for every update). The first use-case are the bandwidth counters from libp2p. I hope I understood and incorporated the labeling mechanisms from the prometheus-crate correctly. This is how the libp2p bandwidth counters show up in the localhost /metrics endpoint:

# TYPE substrate_sub_libp2p_network_bytes_total counter
substrate_sub_libp2p_network_bytes_total{direction="in"} 1808817
substrate_sub_libp2p_network_bytes_total{direction="out"} 36561

A sourced metric is a metric that obtains its values from an existing source, rather than the values being independently recorded. It thus allows collecting metrics from existing counters or gauges without having to duplicate them in a dedicated prometheus counter or gauge (and hence another atomic value). The first use-case is to feed the bandwidth counters from libp2p directly into prometheus.

mxinden

Thanks for writing such an elaborate implementation!

mxinden · 2020-08-14T17:24:11Z

client/network/src/service.rs

 impl Metrics {
+	fn register_bandwidth(registry: &Registry, sinks: Arc<transport::BandwidthSinks>)


I am a bit torn whether this should be part of Metrics as in the end Metrics doesn't even keep a reference to the BandwidthSource. What do you think of doing the registration in the // Initialize the metrics. block above right away? Again, not sure that is easier to read.

I still think it preferable to not bury the definition of a metric in other control flow. Is 22be2f7 acceptable to you? (I.e. Metrics::register_bandwidth -> BandwidthCounters::register).

mxinden · 2020-08-14T17:34:33Z

utils/prometheus/src/sourced.rs

+				}
+			}
+
+			match self.desc.variable_labels.len().cmp(&label_values.len()) {


All rust-prometheus methods panic when providing unequal label keys and values. While not the greates UX, I would do the same (at least in debug mode) to stay consistent.

E.g. https://docs.rs/prometheus/0.7.0/prometheus/core/struct.MetricVec.html#method.with_label_values.

Done in 45b734c.

utils/prometheus/src/sourced.rs

romanb · 2020-08-17T07:50:31Z

@mxinden Thanks for the quick review. Let me know if there is anything else.

mxinden · 2020-08-17T15:03:27Z

client/network/src/service.rs

+		let metrics = match &params.metrics_registry {
+			Some(registry) => {
+				// Sourced metrics.
+				BandwidthCounters::register(registry, bandwidth.clone())?;


client/network/src/service.rs

Co-authored-by: Max Inden <mail@max-inden.de>

commit f8c83bd Author: Roman Borschel <romanb@users.noreply.github.com> Date: Tue Aug 18 07:59:32 2020 +0200 Add support for sourced metrics. (paritytech#6895) * Add support for sourced metrics. A sourced metric is a metric that obtains its values from an existing source, rather than the values being independently recorded. It thus allows collecting metrics from existing counters or gauges without having to duplicate them in a dedicated prometheus counter or gauge (and hence another atomic value). The first use-case is to feed the bandwidth counters from libp2p directly into prometheus. * Tabs, not spaces. * Tweak bandwidth counter registration. * Add debug assertion for variable labels and values. * Document monotonicity requirement for sourced counters. * CI * Update client/network/src/service.rs Co-authored-by: Max Inden <mail@max-inden.de> Co-authored-by: Max Inden <mail@max-inden.de> commit 8e1ed7d Author: Shawn Tabrizi <shawntabrizi@gmail.com> Date: Mon Aug 17 22:59:23 2020 +0200 WeightInfo for System, Timestamp, and Utility (paritytech#6868) * initial updates to system * fix compile * Update writer.rs * update weights * finish system weights * timestamp weights * utility weight * Fix overflow in weight calculations * add back weight notes * Update for whitelisted benchmarks * add trait bounds * Revert "add trait bounds" This reverts commit 12b08b7. * Update weights for unaccounted for read commit 399421a Author: Wei Tang <wei@that.world> Date: Mon Aug 17 21:07:30 2020 +0200 Derive Clone for AlwaysCanAuthor, NeverCanAuthor, CanAuthorWithNativeVersion (paritytech#6906) commit 287ecc2 Author: Wei Tang <wei@that.world> Date: Mon Aug 17 19:36:29 2020 +0200 pow: add access to pre-digest for algorithm verifiers (paritytech#6900) * pow: fetch pre-runtime digest to verifier * Add Other error type * Fix log target and change docs to refer to pre_runtime commit 488b7c7 Author: Wei Tang <wei@that.world> Date: Mon Aug 17 13:41:09 2020 +0200 babe, aura, pow: only call check_inherents if authoring version is compatible (paritytech#6862) * pow: check can_author_with before calling check_inherents * babe: check can_author_with before calling check_inherents * aura: check can_author_with before calling check_inherents * Fix node and node template compile * Add missing comma * Put each parameter on its own line * Add debug print * Fix line width too long * Fix pow line width issue commit fc743da Author: Pierre Krieger <pierre.krieger1708@gmail.com> Date: Mon Aug 17 11:19:16 2020 +0200 Add a DirectedGossip struct (paritytech#6803) * Add a DirectedGossip struct * Move protocol from prototype::new to biuld * More traits impls * Explain ordering * Apply suggestions from code review Co-authored-by: Toralf Wittner <tw@dtex.org> * Address concerns * Add basic test * Concerns * More concerns * Remove QueueSenderPrototype * Rename * Apply suggestions from code review Co-authored-by: Max Inden <mail@max-inden.de> Co-authored-by: Toralf Wittner <tw@dtex.org> Co-authored-by: parity-processbot <> Co-authored-by: Max Inden <mail@max-inden.de> commit 0079140 Author: Bastian Köcher <bkchr@users.noreply.github.com> Date: Sun Aug 16 00:05:36 2020 +0200 Don't take the origin in `can_set_code` (paritytech#6899) It makes no sense that `can_set_code` takes the origin for checking it. Everybody reusing this function is only interested in the other checks that are done by this function. The origin should be checked by every dispatchable individually. commit cd3b62b Author: Seun Lanlege <seunlanlege@gmail.com> Date: Sat Aug 15 10:08:31 2020 +0100 RpcHandlers Refactorings (paritytech#6846) * allow access to the underlying Pubsub instance from RpcHandlers * bump Cargo.lock * no more Arc<RpcHandlers> * bump Cargo.lock * Debug,. * Arc<RpcHandlers> * RpcHandler * RpcHandlers::io_handler * remove chain spec from cli * address pr comments * remove stray newline Co-authored-by: Ashley <ashley.ruglys@gmail.com> Co-authored-by: Tomasz Drwięga <tomasz@parity.io> Co-authored-by: Ashley <ashley.ruglys@gmail.com> commit eec7d71 Author: Max Inden <mail@max-inden.de> Date: Fri Aug 14 18:15:45 2020 +0200 client/authority-discovery: Revert query interval change (paritytech#6897) Revert the accidental query interval change from every one minute back to every 10 minutes. commit 13b0650 Author: Roman Borschel <romanb@users.noreply.github.com> Date: Fri Aug 14 10:41:47 2020 +0200 Update to libp2p-0.23. (paritytech#6870) * Update to libp2p-0.23. Thereby incorporate bandwidth measurement along the lines previously done by libp2p itself. * Tweak dependencies for wasm32 compilation. For wasm32 we need to enable unstable features to make `task::Builder::local` available. * Simplify dependencies. * Simplify. Leave the calculation of bytes sent/received per second to the outer layers of the code, subject to their own individual update intervals. * Cleanup * Re-add lost dev dependency. * Avoid division by zero. * Remove redundant metric. * Enable sending of noise legacy handshakes. * Add comment about monotonic gauge. * CI commit 0e703a5 Author: Alan Sapede <alan.sapede@gmail.com> Date: Fri Aug 14 04:15:59 2020 -0400 Adds debug logs to EVM frame (paritytech#6887) commit f16cbc1 Author: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Thu Aug 13 23:30:22 2020 +0200 More renaming to move away from phragmen. (paritytech#6886) commit 8993a75 Author: André Silva <123550+andresilva@users.noreply.github.com> Date: Thu Aug 13 19:38:14 2020 +0100 network: don't log re-discovered addresses (paritytech#6881) * network: move LruHashSet to network crate utils * network: don't log re-discovered external addresses * Update client/network/src/utils.rs Co-authored-by: mattrutherford <44339188+mattrutherford@users.noreply.github.com> Co-authored-by: mattrutherford <44339188+mattrutherford@users.noreply.github.com> commit 4d3c948 Author: Alexander Popiak <alexander.popiak@parity.io> Date: Thu Aug 13 18:54:05 2020 +0200 add runtime migrations to release notes/changelog (paritytech#6875) commit d019a66 Author: Wei Tang <wei@that.world> Date: Thu Aug 13 14:53:42 2020 +0200 pallet-evm: avoid double fee payment (paritytech#6858) * pallet-evm: avoid double fee payment * Only skip fee payment for successful calls commit ed4f7a1 Author: Bastian Köcher <bkchr@users.noreply.github.com> Date: Wed Aug 12 21:35:10 2020 +0200 Make `HexDisplay` useable in `no_std` (paritytech#6883) Actually I use this quite often when debugging some WASM bugs and there is no harm in enabling it by default. Before I just always copied it everytime I needed it. commit 473a23f Author: Max Inden <mail@max-inden.de> Date: Wed Aug 12 16:16:40 2020 +0200 client/authority-discovery: Introduce AuthorityDiscoveryService (paritytech#6760) * client/authority-discovery: Rename AuthorityDiscovery to XXXWorker * client/authority-discovery: Introduce AuthorityDiscoveryService Add a basic `AuthorityDiscoveryService` implementation which enables callers to get the addresses for a given `AuthorityId` from the local cache. * client/authority-discovery: Split into worker and service mod Move `Service` and `Worker` to their own Rust modules resulting in the following file structure. ├── build.rs ├── Cargo.toml └── src ├── error.rs ├── lib.rs ├── service.rs ├── tests.rs ├── worker │ ├── addr_cache.rs │ ├── schema │ │ └── dht.proto │ └── tests.rs └── worker.rs * client/authority-discovery: Cache PeerId -> AuthorityId mapping * client/authority-discovery: Update priority group on interval Instead of updating the authority discovery peerset priority group each time a new DHT value is found, update it regularly on an interval. This removes the need for deterministic random selection. Instead of trying to return a random stable set of `Multiaddr`s, the `AddrCache` now returns a random set on each call. * client/authority-discovery: Implement Service::get_authority_id * client/authority-discovery: Use HashMap instead of BTreeMap * client/authority-discovery: Rework priority group interval * client/authority-discovery: Fix comment * bin/node/cli: Update authority discovery constructor * client/authority-discovery: Fuse from_service receiver * client/authority-discovery: Remove Rng import * client/authority-discovery: Ignore Multiaddr without PeerId * client/authority-discovery/service: Add note on returned None * client/authority-discovery/addr_cache: Replace double clone with deref commit c495f89 Author: Cecile Tonglet <cecile@parity.io> Date: Wed Aug 12 16:07:11 2020 +0200 Add async test helper to timeout and provide a task_executor automatically (paritytech#6651) * Initial commit Forked at: 60e3a69 Parent branch: origin/master * Add async test helper to timeout and provide a task_executor automatically * simplify error message to avoid difference between CI and locally * forgot env var * Use runtime env var instead of build env var * Rename variable to SUBSTRATE_TEST_TIMEOUT * CLEANUP Forked at: 60e3a69 Parent branch: origin/master * Apply suggestions from code review Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Re-export from test-utils * Default value to 120 * fix wrong crate in ci * Revert "Default value to 120" This reverts commit 8e45871. * Fix version * WIP Forked at: 60e3a69 Parent branch: origin/master * WIP Forked at: 60e3a69 Parent branch: origin/master * WIP Forked at: 60e3a69 Parent branch: origin/master * remove feature flag * fix missing dependency * CLEANUP Forked at: 60e3a69 Parent branch: origin/master * fix test * Removed autotests=false * Some doc... * Apply suggestions from code review Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * WIP Forked at: 60e3a69 Parent branch: origin/master * WIP Forked at: 60e3a69 Parent branch: origin/master * Update test-utils/src/lib.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> commit 0c3cdf1 Author: mattrutherford <44339188+mattrutherford@users.noreply.github.com> Date: Wed Aug 12 12:53:21 2020 +0100 Implement tracing::Event handling & parent_id for spans and events (paritytech#6672) * implement events handling, implement parent_id for spans & events * add events to sp_io::storage * update test * add tests * adjust limit * let tracing crate handle parent_ids * re-enable current-id tracking * add test for threads with CurrentSpan * fix log level * remove redundant check for non wasm traces * remove duplicate definition in test * Adding conditional events API * prefer explicit parent_id over current, enhance test * limit changes to client::tracing event implementation * remove From impl due to fallback required on parent_id * implement SPAN_LIMIT change event log output * change version of tracing-core * update dependancies * revert limit * remove duplicate dependency * Apply suggestions from code review Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> Co-authored-by: Matt Rutherford <mattrutherford@users.noreply.github.com> Co-authored-by: Benjamin Kampmann <ben@parity.io> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> commit 5b809d2 Author: Wei Tang <wei@that.world> Date: Wed Aug 12 12:46:28 2020 +0200 pallet-evm: fix wrong logic in mutate_account_basic (paritytech#6786) * pallet-evm: fix wrong logic in mutate_account_basic * Add test for mutate account commit f6d66db Author: Pierre Krieger <pierre.krieger1708@gmail.com> Date: Wed Aug 12 11:58:01 2020 +0200 Add a warning if users pass --sentry or --sentry-nodes (paritytech#6779) * Add a warning if users pass --sentry or --sentry-nodes * Apply suggestions from code review Co-authored-by: Max Inden <mail@max-inden.de> * Fix text Co-authored-by: parity-processbot <> Co-authored-by: Max Inden <mail@max-inden.de> commit d7979d0 Author: Shaopeng Wang <spxwang@gmail.com> Date: Wed Aug 12 21:21:36 2020 +1200 Implement 'transactional' annotation for runtime functions. (paritytech#6763) * Implement 'transactional' annotation for runtime functions. * Allow function attributes for dispatchable calls in decl_module. * decl_module docs: add transactional function example. * decl_module docs: add function attributes notes. * Fix license header. commit d4efdf0 Author: Pierre Krieger <pierre.krieger1708@gmail.com> Date: Wed Aug 12 10:58:16 2020 +0200 Fuse the import queue receiver (paritytech#6876) * Fix the import queue receiver * Add logging commit a20fbd5 Author: André Silva <123550+andresilva@users.noreply.github.com> Date: Tue Aug 11 22:21:45 2020 +0100 docs: fix references to code of conduct document (paritytech#6879) commit e7cc595 Author: h4x3rotab <h4x3rotab@gmail.com> Date: Wed Aug 12 04:12:34 2020 +0800 Add Phala Network SS58 address type (paritytech#6758) commit fe3fc04 Author: André Silva <123550+andresilva@users.noreply.github.com> Date: Tue Aug 11 20:55:15 2020 +0100 docs: convert code of conduct to markdown (paritytech#6878) commit 72addfa Author: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Tue Aug 11 17:07:17 2020 +0200 Fix wrong staking doc about transaction payment. (paritytech#6873) * Fx paritytech#4616 * Fix paritytech#4616 commit 4064378 Author: André Silva <123550+andresilva@users.noreply.github.com> Date: Tue Aug 11 16:05:59 2020 +0100 grandpa: change some logging from trace to debug (paritytech#6872) * grandpa: change some logging from trace to debug * grandpa: cleanup unused import commit 6f57582 Author: Nikolay Volf <nikvolf@gmail.com> Date: Tue Aug 11 18:05:31 2020 +0300 Move to upstream wasmtime, refactor globals snapshot (paritytech#6759) * refactor globals snapshot * ignore test * update pwasm-utils ref * line width * add doc comment for internal struct * add explanation for iteration * Demote rustdoc to a comment * use 0.14 Co-authored-by: Sergei Shulepov <sergei@parity.io> commit a362997 Author: Arkadiy Paronyan <arkady.paronyan@gmail.com> Date: Tue Aug 11 16:12:30 2020 +0200 Block packet size limit (paritytech#6398) * Block packet size limit * Update client/network/src/protocol.rs Co-authored-by: Pierre Krieger <pierre.krieger1708@gmail.com> * Add block response limit Co-authored-by: Pierre Krieger <pierre.krieger1708@gmail.com>

romanb added B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. labels Aug 14, 2020

romanb requested a review from mxinden August 14, 2020 13:48

Tabs, not spaces.

b26aee3

mxinden reviewed Aug 14, 2020

View reviewed changes

Roman S. Borschel added 3 commits August 17, 2020 09:42

Tweak bandwidth counter registration.

22be2f7

Add debug assertion for variable labels and values.

45b734c

Document monotonicity requirement for sourced counters.

d341e21

Roman S. Borschel added 2 commits August 17, 2020 10:17

CI

d08fb2a

Merge branch 'master' into sourced-metrics

0c21a81

romanb mentioned this pull request Aug 17, 2020

Distribute the network future polling time more evenly #6903

Merged

mxinden approved these changes Aug 17, 2020

View reviewed changes

Update client/network/src/service.rs

aa3126a

Co-authored-by: Max Inden <mail@max-inden.de>

romanb merged commit f8c83bd into paritytech:master Aug 18, 2020

romanb deleted the sourced-metrics branch August 18, 2020 05:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for sourced metrics. #6895

Add support for sourced metrics. #6895

romanb commented Aug 14, 2020

mxinden left a comment

mxinden Aug 14, 2020

romanb Aug 17, 2020

mxinden Aug 14, 2020

romanb Aug 17, 2020

romanb commented Aug 17, 2020

mxinden Aug 17, 2020

		impl Metrics {
		fn register_bandwidth(registry: &Registry, sinks: Arc<transport::BandwidthSinks>)

Add support for sourced metrics. #6895

Add support for sourced metrics. #6895

Conversation

romanb commented Aug 14, 2020

mxinden left a comment

Choose a reason for hiding this comment

mxinden Aug 14, 2020

Choose a reason for hiding this comment

romanb Aug 17, 2020

Choose a reason for hiding this comment

mxinden Aug 14, 2020

Choose a reason for hiding this comment

romanb Aug 17, 2020

Choose a reason for hiding this comment

romanb commented Aug 17, 2020

mxinden Aug 17, 2020

Choose a reason for hiding this comment