thecodenebula/apollo-prometheus-plugin

An Apollo Plugin for Prometheus metrics

Apollo Prometheus Plugin

Install

npm install @thecodenebula/apollo-prometheus-plugin

Usage

import { ApolloServer, gql } from 'apollo-server-express';
import { prometheusPlugin } from 'apollo-prometheus-plugin';
import { Registry } from 'prom-client';
import { prometheusPlugin } from '@thecodenebula/apollo-prometheus-plugin';

const register = new Registry();

const app = express();

app.get('/metrics', (_, res) => res.send(register.metrics()));

const server = new ApolloServer({
  typeDefs,
  resolvers,
  plugins: [prometheusPlugin(register, { enableNodeMetrics: true })],
});

server.applyMiddleware({ app, path: '/' });
app.listen({ port: 8080 }, () => {
  console.log('Listening');
});

Available metrics and labels

metric	type	labels
errors_encountered	Counter	operationName operation error
requests_resolved	Counter	operationName operation
attributes_requested	Counter	fieldName parentType
resolver_time	Histogram	fieldName parentType returnType
total_request_time	Histogram	operationName operation

apollo-prometheus-plugin's Issues

Update to support prom-client 13.x

This plugin only supports precisely prom-client 12.0.0. It won't work with 11.x or the newer 13.x. It makes it quite difficult to use multiple plugins when they each have such specific and mutually exclusive prom-client requirements.

License

Could you define the license for it? By default is not usable.
Thank you!

Use with default Prom Client registry?

I'm unclear how to get this to work with the default global registry instead of having to create one. Why is the registry parameter not optional?