hoistgqlgenerrors

README

hoist-gql-errors

hoist-gql-errors extracts GraphQL errors from the downstream response and record them as OpenTelemetry exception events.

It aims at that Datadog Error Tracking collects errors from OpenTelemetry traces.

Datadog Error Tracking needs error types, error messages, and error stacktraces on service entry spans (top-level spans).

In typical web applications, top-level spans mean spans that started on http.Handler. In addition, otelhttp.Handler will record no exceptions from downstream spans.

These facts mean that Datadog Error Tracking tracks no errors from the spans started by default setup with otelhttp.Handler.

hoist-gql-errors hoists (downstream) GraphQL errors and records them as service entry spans' errors, and then Datadog Error Tracking correctly collects them.

Synopsis

See examples on pkg.go.dev.

import (
  "net/http"

  "github.com/aereal/hoist-gql-errors"
)

func main() {
  var handler http.Handler
  var _ http.Handler = hoistgqlerrors.New()(handler)
}

Installation

go get github.com/aereal/hoist-gql-errors

License

See LICENSE file.

Documentation

Index

• func New(opts ...Option) func(http.Handler) http.Handler
• type EventOptionsBuilderFunc
• type Option
  • func WithEventOptions(opts ...trace.EventOption) Option
  • func WithEventOptionsBuilder(builderFunc EventOptionsBuilderFunc) Option
  • func WithHTTPConventionalAttributes() Option

Functions

func New

func New(opts ...Option) func(http.Handler) http.Handler

New returns the middleware function that extracts GraphQL errors from downstream http.Handler.

The extracted errors are recorded span's errors.

Types

type EventOptionsBuilderFunc

type EventOptionsBuilderFunc func(req *http.Request, statusCode int, responseHeader http.Header) []trace.EventOption

type Option

type Option func(*config)

func WithEventOptions

func WithEventOptions(opts ...trace.EventOption) Option

WithEventOptions returns an Option that passes given trace.EventOption to span.RecordError().

func WithEventOptionsBuilder

func WithEventOptionsBuilder(builderFunc EventOptionsBuilderFunc) Option

WithEventOptionsBuilder return an Option that uses the function to build attributes for the error events.

func WithHTTPConventionalAttributes

func WithHTTPConventionalAttributes() Option

WithHTTPConventionalAttributes return an Option that adds the attributes conforms to HTTP semantic conventions to the error events.