strapi-plugin-prometheus-metrics's Introduction

strapi-plugin-prometheus-metrics

Adds Prometheus metrics to a Strapi instance using 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 to install.

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:

module.exports = {
  settings: {
  },
};

You would want to add

module.exports = {
  settings: {
    "prom": {
      "enabled": true,
      "metricsPath": "/metrics",
    },
  },
};

Configuration:

If your config/middleware.js you can configure keys like this:

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 see LICENSE.md

strapi-plugin-prometheus-metrics's People

Contributors

Stargazers

Watchers