@libp2p/prometheus-metrics


> Collect libp2p metrics for scraping by Prometheus or Graphana

About

Configure your libp2p node with Prometheus metrics:

``typescript
import { createLibp2p } from 'libp2p'
import { prometheusMetrics } from '@libp2p/prometheus-metrics'

const node = await createLibp2p({
metrics: prometheusMetrics()
})
`

Then use the prom-client module to supply metrics to the Prometheus/Graphana client using your http framework:

`JavaScript
import client from 'prom-client'

async function handler (request, h) {
return h.response(await client.register.metrics())
.type(client.register.contentType)
}
`

All Prometheus metrics are global so there's no other work required to extract them.

Queries

Some useful queries are:

$3

`
rate(libp2p_data_transfer_bytes_total[30s])
`

$3

`
rate(process_cpu_user_seconds_total[30s]) * 100
`

$3

`
nodejs_memory_usage_bytes
`

$3

`
libp2p_kad_dht_wan_query_time_seconds
`

or

`
libp2p_kad_dht_lan_query_time_seconds
`

$3

`
rate(libp2p_tcp_dialer_errors_total[30s])
`

Install

`console
$ npm i @libp2p/prometheus-metrics
``

API Docs

-

License

Licensed under either of

- Apache 2.0, (LICENSE-APACHE / )
- MIT (LICENSE-MIT / )

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.