Skip to content
Performance trace your Apollo GraphQL server with Opentracing
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create stale.yml Sep 12, 2018
src chore: update graphql-extensions Apr 9, 2019
.all-contributorsrc chore: add @frances3006 as a contributor Jan 9, 2019
.gitignore 🚀🚀🚀 Aug 19, 2018
.npmignore 🚀🚀🚀 Aug 19, 2018
.travis.yml add semantic release Aug 23, 2018
README.md chore: add @frances3006 as a contributor Jan 9, 2019
demo.png
package-lock.json chore(deps): update dependency @types/node to v11.13.6 Apr 19, 2019
package.json chore(deps): update dependency @types/node to v11.13.6 Apr 19, 2019
renovate.json chore: add semantic commit to renovate Aug 24, 2018
tsconfig.json 🚀🚀🚀 Aug 19, 2018

README.md

Apollo Opentracing npm version Build Status semantic-release All Contributors

Apollo Opentracing allows you to integrate open source baked performance tracing to your Apollo server based on industry standards for tracing.

  • 🚀 Request & Field level resolvers are traced out of the box
  • 🔍 Queries and results are logged, to make debugging easier
  • ⚙️ Select which requests you want to trace
  • 🔗 Spans transmitted through the HTTP Headers are picked up
  • 🔧 Use the opentracing compatible tracer you like, e.g.
  • 🦖 Support from node 6 on

Installation

Run npm install --save apollo-opentracing given that you already setup an opentracing tracer accordingly.

Setup

We need two types of tracer (which could be identical if you like):

  • server: Only used for the root (the first span we will start)
  • local: Used to start every other span
const { graphqlExpress } = require("apollo-server-express");
const {serverTracer, localTracer} = require("./tracer");
+const OpentracingExtension = require("apollo-opentracing").default;

app.use(
  "/graphql",
  bodyParser.json(),
  graphqlExpress({
    schema,
+   extensions: [() => new OpentracingExtension({
+     server: serverTracer,
+     local: localTracer,
+   })]
  })
)

Connecting Services

example image

To connect other services you need to use the opentracing inject function of your tracer. We pass the current span down to your resolvers as info.span, so you should use it.

You can also make use of it and add new logs or tags on the fly if you like. This may look something like this:

myFieldResolver(source, args, context, info) {
  const headers = {...};

  const parentSpan = info.span;
  // please use the same tracer you passed down to the extension
  const networkSpan = tracer.startSpan("NetworkRequest:" + endpoint, {
    childOf: parentSpan
  });

  // Let's transfer the span information to the headers
  tracer.inject(
    networkSpan,
    YourOpentracingImplementation.FORMAT_HTTP_HEADERS,
    headers
  );

  return doNetworkRequest(endpoint, headers).then(result => {
    networkSpan.finish()
    return result;
  }, err => {
    networkSpan.log({
      error: true,
      errorMessage: err
    });

    networkSpan.finish();
    return err;
  });
}

Selective Tracing

Sometimes you don't want to trace everything, so we provide ways to select if you want to start a span right now or not.

By Request

If you construct the extension with shouldTraceRequest you get the option to opt-in or out on a request basis. When you don't start the span for the request the field resolvers will also not be used.

The function is called with the same arguments as the requestDidStart function extensions can provide, which is documented here.

When the request is not traced there will also be no traces of the field resolvers.

By Field

There might be certain field resolvers that are not worth the tracing, e.g. when they get a value out of an object and need no further tracing. To control if you want a field resolver to be traced you can pass the shouldTraceFieldResolver option to the constructor. The function is called with the same arguments as your field resolver and you can get the name of the field by info.fieldName. When you return false no traces will be made of this field resolvers and all underlying ones.

Contributing

Please feel free to add issues with new ideas, bugs and anything that might come up. Let's make performance measurement to everyone <3

Contributors

Thanks goes to these wonderful people (emoji key):


Daniel Schmidt

💻 🤔

Ciaran Liedeman

🐛 💻 ⚠️

Jens Ulrich Hjuler Pedersen

🐛 🤔 👀

Francesca

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

You can’t perform that action at this time.