C. 🔮 Ergonomic Observability

[p-shahi]

eta: 2022Q4

Why: Though we already expose per-component metrics in js-libp2p, the overhead of recording metrics is high (excessive object allocation per metric to record). This will be helpful to our users who record metrics on the order of thousands/second.

Goal:
We make the lives of js-libp2p easier by adding an improved metrics API.

1. Ergonomic metrics API

Create an ergonomic, generalized metrics recording interface which addresses current allocation overhead and duplication of information. Do not bloat the browser bundle with prom-client.

Related Issues/Linked PRs:

js-libp2p-tcp

• feat!: add metrics js-libp2p-tcp#223
• Remove dynamic metric names js-libp2p-tcp#226
• fix: use labels to differentiate interfaces for metrics js-libp2p-tcp#230

js-libp2p-prometheus-metrics

• feat: register metrics with custom registry js-libp2p-prometheus-metrics#4
• fix: allow multiple consumers of metrics js-libp2p-prometheus-metrics#6

js-libp2p-interfaces

• feat!: return metrics objects from register instead of updating with an options object js-libp2p-interfaces#310

js-libp2p

• feat!: configure metrics implementation as a module instead of shipping a built-in version #1471

js-libp2p-kad-dht

• fix!: update to metrics v4 js-libp2p-kad-dht#398

js-libp2p-tracked-map

• fix!: update @libp2p/interface-metrics to v4 js-libp2p-tracked-map#12

js-libp2p-noise

• feat: add metrics ChainSafe/js-libp2p-noise#246

Todo:

js-libp2p-webtransport

• Export metrics js-libp2p-webtransport#33

js-libp2p-webrtc

• Export metrics js-libp2p-webrtc#64

js-libp2p-websockets

• Export metrics js-libp2p-websockets#197

js-libp2p-gossipsub

• Export Metrics  ChainSafe/js-libp2p-gossipsub#414

• add docs on how to enable metrics (mention in release notes)

• add blog post

[p-shahi]

@mpetrunic Let's use this tracking issue to help fill out the remaining metrics work

[mpetrunic]

• fix!: update to metrics v4 js-libp2p-kad-dht#398 - done
• fix!: update @libp2p/interface-metrics to v4 js-libp2p-tracked-map#12 - done
• feat: add metrics ChainSafe/js-libp2p-noise#224 - needs update

[BigLep]

@achingbrain : what's the done criteria for this issue and do we have the list of work items to get there? For work items, is it the list of related items/links, or are there additional items to add?

[mpetrunic]

@achingbrain : what's the done criteria for this issue and do we have the list of work items to get there? For work items, is it the list of related items/links, or are there additional items to add?

Look at related prs and issues in original description. Seems like only libp2p/js-libp2p-tcp#226 is left and it's waiting to be merged

[achingbrain]

@libp2p/tcp is leading the charge on the metrics integration, but once it's settled down similar metrics will also need to be added to other transports:

• @libp2p/websockets
• @libp2p/webtransport
• @libp2p/webrtc

We should also be collecting metrics from @chainsafe/gossipsub, I think that's the only other module with it's own metrics tracking, then I think we can call it done.

[BigLep]

Ok. To give clarity on what's remaining, please add the checklist and link to any related issues/PRs for those checklist items.

In terms of done criteria, is the current statement comprehensive of everything we need to do?

Create an ergonomic, generalized metrics recording interface which addresses current allocation overhead and duplication of information. Do not bloat the browser bundle with prom-client.

(As an outsider, I'm not really certain of what we're getting here, but if it it makes sense to maintainers and users, then that's fine.)

Is there other work we also need to account for concerning documentation, examples, etc?

[p-shahi]

I'm going to close this as done. The main feature has rolled out and we can track the remaining modules seperately