https://github.com/wirehead/strapi-plugin-prometheus-metrics
A Strapi plugin to add Prometheus metrics
https://github.com/wirehead/strapi-plugin-prometheus-metrics
Last synced: about 1 year ago
JSON representation
A Strapi plugin to add Prometheus metrics
- Host: GitHub
- URL: https://github.com/wirehead/strapi-plugin-prometheus-metrics
- Owner: wirehead
- License: other
- Created: 2020-03-07T18:49:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-18T01:21:42.000Z (about 5 years ago)
- Last Synced: 2025-04-01T10:03:20.368Z (over 1 year ago)
- Language: JavaScript
- Size: 20.5 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
# strapi-plugin-prometheus-metrics
[](https://circleci.com/gh/wirehead/strapi-plugin-prometheus-metrics)[](https://www.npmjs.com/package/strapi-plugin-prometheus-metrics)[](code_of_conduct.md)[](https://firstdonoharm.dev/)
Adds Prometheus metrics to a [Strapi](http://strapi.io/) instance using [prometheus-api-metrics](https://github.com/Zooz/prometheus-api-metrics).
Alternatively, it's a good extremely-simple example of how to add koa functionality to strapi.
## Release status
It's probably usable at this point.
## Installation
Use the package manager [npm](https://https://www.npmjs.com/) to install.
```bash
npm i strapi-plugin-prometheus-metrics
```
## Usage
You need to set the `settings.prom.enabled` key to true and also set a metrics path in `settings.prom.metricsPath`.
If your `config/middleware.js` looks something like this:
```javascript
module.exports = {
settings: {
},
};
````
You would want to add
```javascript
module.exports = {
settings: {
"prom": {
"enabled": true,
"metricsPath": "/metrics",
},
},
};
```
## Configuration:
If your `config/middleware.js` you can configure keys like this:
```javascript
module.exports = {
settings: {
"prom": {
"enabled": true,
"metricsPath": "/metrics",
"metricsPrefix": "foo"
},
},
};
```
Keys you can set are:
* `metricsPath` - The URL path the metrics are accessible under. The default is `/metrics`
* `defaultMetricsInterval` - The interval that metrics are collected over. The default is `10000`
* `durationBuckets` - An array of buckets that the response time is bucketed over, in seconds. The default is `[0.001, 0.005, 0.015, 0.05, 0.1, 0.2, 0.3, 0.4, 0.5]`
* `requestSizeBuckets` - An array of buckets that the request size is bucketed over, in bytes. The default is `[5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000]`
* `responseSizeBuckets` - An array of buckets that the response size is bucketed over, in bytes. The default is `[5, 10, 25, 50, 100, 250, 500, 1000, 2500, 5000, 10000]`
* `useUniqueHistogramName` - Set this key to use the project name (from the `package.json` file) as a prefix.
* `metricsPrefix` - Set this key to set a string that will be added with an undescore before the metrics name.
* `excludeRoutes` - Set this key to exclude routes from collection.
* `includeQueryParams` - A boolean that indicate if to include query params in route, the query parameters will be sorted in order to eliminate the number of unique labels.
## A few security concerns to think about
Generally, you want to be running strapi with some sort of front-end process (say Apache HTTPD or nginx), just as a matter of good practice. If you expose the `/metrics` endpoint to the world, it might leak some amount of information to an attacker.
Also, if you aren't careful with the includeQueryParams feature, it might leak more information than you intended.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Code of conduct
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
## License
[Hippocratic Open Source License 2.0](https://firstdonoharm.dev/) see LICENSE.md