graphql-otel

Version 0.1.1

Fixes:

1. Subspan attributes https://github.com/rocket-connect/graphql-otel/commit/012af0d2dc8c95e1dfa4eeaffceb8be365f57065

Additions:

1. Add GraphQL schema hash to span attributes https://github.com/rocket-connect/graphql-otel/commit/f76d391eaf2e63c830da8eb08f105afc7b280a75

This release increases open telemetry spec support by updating the span and attribute names to follow the suit of the specification:

https://opentelemetry.io/docs/specs/otel/trace/semantic_conventions/instrumentation/graphql/

graphql-otel offers the ability to record the args, result, and context and so we added some additions to the specification to support those needs:

https://github.com/open-telemetry/opentelemetry-specification/pull/3668

Bumps the open telemetry packages to the latest versions.

Adds the ability to include the resolver result in the span attributes:

const context = {
  GraphQLOTELContext: new GraphQLOTELContext({
    includeResult: true, // If true will add the result in the span attributes
  }),
};

This adds the ability to exclude keys from the span context attribute.

const context = {
  GraphQLOTELContext: new GraphQLOTELContext({
    includeContext: true,
    includeVariables: true,
    excludeKeysFromContext: ["database", 'headers', "token"], <--- large objects, sensitive information
  }),
};

This release adds the ability to append the GraphQL context and variables onto the trace attributes.

You can do this by setting either or both options:

new GraphQLOTELContext({
  includeContext: true,
  includeVariables: true,
});

You will then see the JSON string of variables and context in your trace attributes.

Commits

• e537b3b6696d7ddf8f0fe65c8932e242af4b17d2
• 0d9d08bdb28e7e182a6dbc20f447c2b503ece2d4
• 0d9d08bdb28e7e182a6dbc20f447c2b503ece2d4

Version 0.0.6 of graphql-otel, span events were introduced to propagate errors. However, at that time, the span status was not being set to error. Now, with the latest changes, you can filter queries that have resulted in errors using the status filter for GraphQL.

Commits:

• https://github.com/rocket-connect/graphql-otel/commit/7e82050d2b47c33253fb7c84316ae2dd48495339

This release propagates the errors that happen in the GraphQL resolver and appends them as an event on the trace.

This will better help users debug their GraphQL API.

• https://github.com/rocket-connect/graphql-otel/commit/a3f316fa8b59d12733c1cdf224870f3e9bfdd939