Metrics usage examples - browser client about js-libp2p-gossipsub HOT 7 OPEN

Unfortunately there is no good documentation. And the MetricsRegister interface is very opinionated and overly dependent on https://github.com/ChainSafe/lodestar/blob/unstable/packages/beacon-node/src/metrics/utils/registryMetricCreator.ts#L12, requires implementing some specific methods (gauge, histogram, avgMinMax). This could/should be cleaned up cc @dapplion @tuyennhv

If you'd like an example, take a look here:
https://github.com/ChainSafe/lodestar/blob/unstable/packages/beacon-node/src/metrics/utils/registryMetricCreator.ts#L12
You can create a RegistryMetricCreator instance and pass that as the metricsRegister in the gossipsub constructor / init function.

Then, with a reference to the instance, you should be able to consume the metrics with methods described here: https://github.com/siimon/prom-client#register

from js-libp2p-gossipsub.

Thank you @wemeetagain

I'll have a look 👍

from js-libp2p-gossipsub.

Would you happen to know why the instrument types(Gauge, Histogram, AvgMinMax) and their config types are not exported? (Since they are being used in the exported MetricsRegister interface).

Since we are using this library in a browser application, we are not planning on adding a dependency to the promclient lib.

Thank you!

PS: For now, I have copied the types in my code just to get me going but I really wish I didn't have to do that :)

from js-libp2p-gossipsub.

@cristianmadularu the types you requested are now exported as of v10.1.0

from js-libp2p-gossipsub.

Thank you! :)

from js-libp2p-gossipsub.

We should drop avgMinMax and have a regular prometheus interface that's generic

from js-libp2p-gossipsub.

That would be very nice :) I would also suggest considering exposing an OTLP set of metrics in order to avoid being locked in any particular set of tools/vendors.

from js-libp2p-gossipsub.