nexus-plugin-prometheus

A nexus-framework plugin for reporting basic GraphQL metrics through Prometheus (via prom-client)

This nexus-framework plugin collects basics GraphQL metrics and reports them to a Prometheus server. The plugin utilizes the prom-client library to communicate with Prometheus and thus requires Nexus' instance of express to be provided to the plugin.

⚠️ This plugin does NOT support Nexus projects utilizing serverless Next.JS implementations!

Installation

This module is distributed via npm which is bundled with Node.js.

npm install --save nexus-plugin-prometheus

yarn add nexus-plugin-prometheus

Usage

Find a full example in the examples/basic-prometheus folder, which also includes a basic Grafana Dashboard and docker-compose file to fully illustrate the plugin in use.

Setup

Due to the middleware architecture of Nexus-framework plugins, it is vital that one use the nexus-plugin-prometheus first, so that no requests are culled by another plugin.

// app.ts

import { use, server } from 'nexus'
import { prometheus } from 'nexus-plugin-prometheus'

// Enables the Prometheus reporting plugin
use(
  prometheus({
    express: server.express, // inject Nexus express instance
  })
)

Prometheus will now be able to collect metrics from the servers /metrics url.

Running `collectDefaultMetrics` for collecting server metrics

Executing prom-client's collectDefaultMetrics method can be done by providing the plugin with a custom configureRegistry method.

For more information on configuring prom-client, see it's usage documentation.

// app.ts

import { use, server } from 'nexus'
import { prometheus } from 'nexus-plugin-prometheus'
import { Registry, collectDefaultMetrics } from 'prom-client'

// Define custom configuration of prom-client
function configureRegistry(): Registry[] {
  const register = new Registry()
  collectDefaultMetrics({ register })
  return [register]
}

// Enables the Prometheus reporting plugin
use(
  prometheus({
    express: server.express,
    configureRegistry, // provide custom
  })
)

Adding a prefix to my metrics

Executing prom-client's collectDefaultMetrics method with any additional configuration, such as a prefix, can be done by providing the plugin with a custom configureRegistry method.

For more information on configuring prom-client, see it's usage documentation.

// app.ts

import { use, server } from 'nexus'
import { prometheus } from 'nexus-plugin-prometheus'
import { Registry, collectDefaultMetrics } from 'prom-client'

// Define custom configuration of prom-client
function configureRegistry(): Registry[] {
  const register = new Registry()
  const prefix = 'my_application_'
  collectDefaultMetrics({ register, prefix })
  return [register]
}

// Enables the Prometheus reporting plugin
use(
  prometheus({
    express: server.express,
    configureRegistry, // provide custom
  })
)

Contributing

Please read CONTRIBUTING.md

Inspiration

Credits

Authored and maintained by Hays Clark.

To all contributors - Thank you!

License

Open-source under MIT License.

Uh oh, something went wrong!

Sorry about that. It is recommended that you enable "debug" and "allowExternalErrors" in your plugin. Additionally, if you are using other Nexus plugins, you may want to do the same for them.

// app.ts

import { use, server } from 'nexus'
import { prometheus } from 'nexus-plugin-prometheus'

// Enables the Prometheus reporting plugin
use(
  prometheus({
    express: server.express,
    debug: true,
    allowExternalErrors: true,
  })
)

If you are still stuck, please submit a bug report using the GitHub issue tracker.

I wish something was different…

Keen to hear all ideas! Create an enhancement request using the GitHub issue tracker.

Can I contribute code?

Yes please! See DEVELOPING.md.

My question isn't answered :(

Ask away using the GitHub issue tracker.

The automated release is failing 🚨

🚨 The automated release from the `alpha` branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the alpha branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

Good luck with your project ✨

Your semantic-release bot 📦🚀

haysclark / nexus-plugin-prometheus Goto Github PK