metrics-prometheus

@libp2p/prometheus-metrics

Collect libp2p metrics for scraping by Prometheus or Graphana

Table of contents

• Install
• Usage
  • Queries
    • Data sent/received
    • CPU usage
    • Memory usage
    • DHT query time
    • TCP transport dialer errors
• API Docs
• License
• Contribution

Install

$ npm i @libp2p/prometheus-metrics

Usage

Configure your libp2p node with Prometheus metrics:

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:

import client from 'prom-client'

async 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:

Data sent/received

rate(libp2p_data_transfer_bytes_total[30s])

CPU usage

rate(process_cpu_user_seconds_total[30s]) * 100

Memory usage

nodejs_memory_usage_bytes

DHT query time

libp2p_kad_dht_wan_query_time_seconds

or

libp2p_kad_dht_lan_query_time_seconds

TCP transport dialer errors

rate(libp2p_tcp_dialer_errors_total[30s])

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_prometheus_metrics.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/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.