# egg-prometheus
> Prometheus plugin for Egg.js
Latest version **1.7.1** (published 2024-03-12) · MIT license · 0 weekly downloads
## Install
```sh
npm install egg-prometheus
pnpm add egg-prometheus
yarn add egg-prometheus
bun add egg-prometheus
```
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; has provenance; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.7.1 |
| Published | 2024-03-12 |
| First published | 2018-10-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 5 |
| Unpacked size | 32.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 40 |
| Author | gxcsoccer |
| Maintainers | gxcsoccer, fengmk2 |
| Keywords | egg, prometheus, metrics |
## Links
- npm: https://www.npmjs.com/package/egg-prometheus
- Repository: https://github.com/eggjs/egg-prometheus
- Homepage: https://github.com/eggjs/egg-prometheus#readme
- Issues: https://github.com/eggjs/egg/issues
- npm.io page: https://npm.io/package/egg-prometheus
## Dependencies (5)
- [sdk-base](https://npm.io/package/sdk-base.md) ^3.6.0
- [connection](https://npm.io/package/connection.md) ^1.0.0
- [await-first](https://npm.io/package/await-first.md) ^1.0.0
- [prom-client](https://npm.io/package/prom-client.md) ^11.5.0
- [cluster-client](https://npm.io/package/cluster-client.md) ^3.0.1
## Recent versions
- 1.7.1 (latest) — 2024-03-12
- 1.7.0 — 2023-12-16
- 1.6.1 — 2023-12-15
- 1.6.0 — 2023-12-15
- 1.5.0 — 2023-07-01
- 1.4.0 — 2019-10-31
- 1.3.0 — 2019-06-20
- 1.2.0 — 2019-06-19
- 1.1.0 — 2019-04-12
- 1.0.2 — 2018-11-02
- 1.0.1 — 2018-10-10
- 1.0.0 — 2018-10-09
## README
# egg-prometheus
Prometheus plugin for egg framework
[![NPM version][npm-image]][npm-url]
[](https://github.com/eggjs/egg-prometheus/actions/workflows/nodejs.yml)
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/egg-prometheus.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-prometheus
[codecov-image]: https://codecov.io/gh/eggjs/egg-prometheus/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/eggjs/egg-prometheus
[download-image]: https://img.shields.io/npm/dm/egg-prometheus.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-prometheus
[Prometheus](https://prometheus.io) plugin for egg framework
## Install
```bash
npm i egg-prometheus --save
```
## Usage
### Enable the plugin
Change `${app_root}/config/plugin.js` to enable Prometheus plugin:
```js
exports.prometheus = {
enable: true,
package: "egg-prometheus",
};
```
### Configuration
```js
exports.prometheus = {
timeout: 5000,
scrapePort: 3000,
scrapePath: '/metrics',
defaultHttpMetricsFilter: ({ method, status, routerName, path }) => true,
defaultLabels: { ... },
};
```
- `timeout`: metrics pull timeout
- `scrapePort`: the port to scrape metrics from
- `scrapePath`: the path to scrape metrics from
- `defaultLabels`: static labels may be applied to every metric emitted by a registry
- `defaultHttpMetricsFilter`: can custom filter default http metrics, return false can prevent metrics
## Default Metrics
- `http_response_time_ms summary`: ms to handle a request
- `http_request_rate counter`: number of requests to a route
while egg-rpc-base is enabled
- `rpc_consumer_response_time_ms summary`: ms of rpc time consuming
- `rpc_consumer_request_rate counter`: number of rpc calls
- `rpc_consumer_fail_response_time_ms summary`: ms of fail rpc time consuming
- `rpc_consumer_request_fail_rate counter`: number of fail rpc calls
- `rpc_consumer_request_size_bytes summary`: rpc request size in bytes
- `rpc_consumer_response_size_bytes summary`: rpc response size in bytes
- `rpc_provider_response_time_ms summary`: ms of request processed time
- `rpc_provider_request_rate counter`: number of rpc calls
- `rpc_provider_fail_response_time_ms summary`: ms of fail request processed time
- `rpc_provider_request_fail_rate counter`: number of fail rpc calls
## Custom Metrics
```js
// Here's an example senario:
// Some metric called 'pv' stands for 'page view'
// We are going to know its total count.
// To ensure that we know the pv of each visit source
// We define a label called from.
const counter = new app.prometheus.Counter({
name: "pv_total",
help: "custom counter",
labelNames: ["from"],
});
// To use the from label, we do as the following.
counter.labels(['google_com']).inc();
counter.labels(['facebook_com']).inc();
// Gauge
const gauge = new app.prometheus.Gauge({
name: "xxx_gauge",
help: "custom gauge",
labelNames: ["xxx"],
});
// Histogram
const histogram = new app.prometheus.Histogram({
name: "xxx_histogram",
help: "custom histogram",
labelNames: ["xxx"],
});
// Summary
const summary = new app.prometheus.Summary({
name: "xxx_summary",
help: "custom summary",
labelNames: ["xxx"],
});
```
## How to Contribute
Please let us know how can we help. Do check out [issues](https://github.com/eggjs/egg/issues) for bug reports or suggestions first.
To become a contributor, please follow our [contributing guide](https://github.com/eggjs/egg/blob/master/CONTRIBUTING.md).
## License
[MIT](LICENSE)
## Contributors
|[
gxcsoccer](https://github.com/gxcsoccer)
|[
xujihui1985](https://github.com/xujihui1985)
|[
popomore](https://github.com/popomore)
|[
nightink](https://github.com/nightink)
|[
sjfkai](https://github.com/sjfkai)
|[
jgchenu](https://github.com/jgchenu)
|
| :---: | :---: | :---: | :---: | :---: | :---: |
This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Fri Dec 15 2023 17:58:23 GMT+0800`.
---
_Source: https://npm.io/package/egg-prometheus · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._