aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/graph-gophers/graphql-go/trace/trace.go
blob: 68b856ae7199a22d80d72e95f317863e662f1642 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
package trace

import (
    "context"
    "fmt"

    "github.com/graph-gophers/graphql-go/errors"
    "github.com/graph-gophers/graphql-go/introspection"
    opentracing "github.com/opentracing/opentracing-go"
    "github.com/opentracing/opentracing-go/ext"
    "github.com/opentracing/opentracing-go/log"
)

type TraceQueryFinishFunc func([]*errors.QueryError)
type TraceFieldFinishFunc func(*errors.QueryError)

type Tracer interface {
    TraceQuery(ctx context.Context, queryString string, operationName string, variables map[string]interface{}, varTypes map[string]*introspection.Type) (context.Context, TraceQueryFinishFunc)
    TraceField(ctx context.Context, label, typeName, fieldName string, trivial bool, args map[string]interface{}) (context.Context, TraceFieldFinishFunc)
}

type OpenTracingTracer struct{}

func (OpenTracingTracer) TraceQuery(ctx context.Context, queryString string, operationName string, variables map[string]interface{}, varTypes map[string]*introspection.Type) (context.Context, TraceQueryFinishFunc) {
    span, spanCtx := opentracing.StartSpanFromContext(ctx, "GraphQL request")
    span.SetTag("graphql.query", queryString)

    if operationName != "" {
        span.SetTag("graphql.operationName", operationName)
    }

    if len(variables) != 0 {
        span.LogFields(log.Object("graphql.variables", variables))
    }

    return spanCtx, func(errs []*errors.QueryError) {
        if len(errs) > 0 {
            msg := errs[0].Error()
            if len(errs) > 1 {
                msg += fmt.Sprintf(" (and %d more errors)", len(errs)-1)
            }
            ext.Error.Set(span, true)
            span.SetTag("graphql.error", msg)
        }
        span.Finish()
    }
}

func (OpenTracingTracer) TraceField(ctx context.Context, label, typeName, fieldName string, trivial bool, args map[string]interface{}) (context.Context, TraceFieldFinishFunc) {
    if trivial {
        return ctx, noop
    }

    span, spanCtx := opentracing.StartSpanFromContext(ctx, label)
    span.SetTag("graphql.type", typeName)
    span.SetTag("graphql.field", fieldName)
    for name, value := range args {
        span.SetTag("graphql.args."+name, value)
    }

    return spanCtx, func(err *errors.QueryError) {
        if err != nil {
            ext.Error.Set(span, true)
            span.SetTag("graphql.error", err.Error())
        }
        span.Finish()
    }
}

func noop(*errors.QueryError) {}

type NoopTracer struct{}

func (NoopTracer) TraceQuery(ctx context.Context, queryString string, operationName string, variables map[string]interface{}, varTypes map[string]*introspection.Type) (context.Context, TraceQueryFinishFunc) {
    return ctx, func(errs []*errors.QueryError) {}
}

func (NoopTracer) TraceField(ctx context.Context, label, typeName, fieldName string, trivial bool, args map[string]interface{}) (context.Context, TraceFieldFinishFunc) {
    return ctx, func(err *errors.QueryError) {}
}