# @libp2p/prometheus-metrics

> Collect libp2p metrics for scraping by Prometheus or Graphana

Latest version **5.0.29** (published 2026-08-31) · Apache-2.0 OR MIT license · 0 weekly downloads

## Install

```sh
npm install @libp2p/prometheus-metrics
pnpm add @libp2p/prometheus-metrics
yarn add @libp2p/prometheus-metrics
bun add @libp2p/prometheus-metrics
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.0.29 |
| Published | 2026-08-31 |
| First published | 2022-11-04 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 2 |
| Unpacked size | 87.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2578 |
| Maintainers | daviddias, alanshaw, achingbrain, vascosantos, npm-service-account-libp2p, jacobheun |

## Links

- npm: https://www.npmjs.com/package/@libp2p/prometheus-metrics
- Repository: https://github.com/libp2p/js-libp2p
- Homepage: https://github.com/libp2p/js-libp2p/tree/main/packages/metrics-prometheus#readme
- Issues: https://github.com/libp2p/js-libp2p/issues
- npm.io page: https://npm.io/package/@libp2p/prometheus-metrics

## Dependencies (2)

- [prom-client](https://npm.io/package/prom-client.md) ^15.1.3
- [@libp2p/interface](https://npm.io/package/@libp2p/interface.md) ^3.3.0

## Recent versions

- 5.0.29 (latest) — 2026-08-31
- 5.0.29-5cb617ae2 (next) — 2026-09-02
- 5.0.29-185d901cd — 2026-09-02
- 5.0.28-cef4d32cf — 2026-08-31
- 5.0.28-ac7305ccf — 2026-08-31
- 5.0.28-87dca02b0 — 2026-08-27
- 5.0.28-4a6c5d11a — 2026-08-27
- 5.0.28 — 2026-08-23
- 5.0.27-947d304ed — 2026-08-22
- 5.0.27-0967e75f5 — 2026-08-22
- 5.0.27-4dae661b4 — 2026-08-22
- 5.0.27-8786aa8d0 — 2026-08-20
- 5.0.27-55d7a539a — 2026-08-20
- 5.0.27-d5534174d — 2026-08-13
- 5.0.27-47cf9cdc1 — 2026-08-10
- … 910 more at https://npm.io/package/@libp2p/prometheus-metrics/versions

## README

# @libp2p/prometheus-metrics

[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amain)

> Collect libp2p metrics for scraping by Prometheus or Graphana

# About

<!--

!IMPORTANT!

Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.

To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts

To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.

-->

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:

### 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])
```

# Install

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

# API Docs

- <https://libp2p.github.io/js-libp2p/modules/_libp2p_prometheus-metrics.html>

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/metrics-prometheus/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/metrics-prometheus/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.

---
_Source: https://npm.io/package/@libp2p/prometheus-metrics · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._