graphql

Documentation

Overview

Package graphql provides functions to trace the graph-gophers/graphql-go package (https://github.com/graph-gophers/graphql-go).

We use the tracing mechanism available in the https://godoc.org/github.com/graph-gophers/graphql-go/trace subpackage. Create a new Tracer with `NewTracer` and pass it as an additional option to `MustParseSchema`.

Example

// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2016 Datadog, Inc.

package main

import (
	"log"
	"net/http"

	graphqltrace "gopkg.in/DataDog/dd-trace-go.v1/contrib/graph-gophers/graphql-go"

	graphql "github.com/graph-gophers/graphql-go"
	"github.com/graph-gophers/graphql-go/relay"
)

type resolver struct{}

func (*resolver) Hello() string { return "Hello, world!" }

func main() {
	s := `
		schema {
			query: Query
		}
		type Query {
			hello: String!
		}
	`
	schema := graphql.MustParseSchema(s, new(resolver),
		graphql.Tracer(graphqltrace.NewTracer()))
	http.Handle("/query", &relay.Handler{Schema: schema})
	log.Fatal(http.ListenAndServe(":8080", nil))

	// then:
	// $ curl -XPOST -d '{"query": "{ hello }"}' localhost:8080/query
}

Index

• func NewTracer(opts ...Option) tracer.Tracer
• type Option
  • func WithAnalytics(on bool) Option
  • func WithAnalyticsRate(rate float64) Option
  • func WithOmitTrivial() Option
  • func WithServiceName(name string) Option
  • func WithTraceVariables() Option
• type Tracer
  • func (t *Tracer) TraceField(ctx context.Context, _, typeName, fieldName string, trivial bool, ...) (context.Context, tracer.FieldFinishFunc)
  • func (t *Tracer) TraceQuery(ctx context.Context, queryString, operationName string, ...) (context.Context, tracer.QueryFinishFunc)

Examples

• Package

Functions

func NewTracer

func NewTracer(opts ...Option) tracer.Tracer

NewTracer creates a new Tracer.

Types

type Option

type Option = v2.Option

Option represents an option that can be used customize the Tracer.

func WithAnalytics

func WithAnalytics(on bool) Option

WithAnalytics enables Trace Analytics for all started spans.

func WithAnalyticsRate

func WithAnalyticsRate(rate float64) Option

WithAnalyticsRate sets the sampling rate for Trace Analytics events correlated to started spans.

func WithOmitTrivial

func WithOmitTrivial() Option

WithOmitTrivial enables omission of graphql fields marked as trivial. This also opts trivial fields out of Threat Detection (and blocking).

func WithServiceName

func WithServiceName(name string) Option

WithServiceName sets the given service name for the client.

func WithTraceVariables

func WithTraceVariables() Option

WithTraceVariables enables tracing of variables passed into GraphQL queries and resolvers.

type Tracer

type Tracer struct {
	tracer.Tracer
}

A Tracer implements the graphql-go/trace.Tracer interface by sending traces to the Datadog tracer.

func (*Tracer) TraceField

func (t *Tracer) TraceField(ctx context.Context, _, typeName, fieldName string, trivial bool, arguments map[string]interface{}) (context.Context, tracer.FieldFinishFunc)

TraceField traces a GraphQL field access.

func (*Tracer) TraceQuery

func (t *Tracer) TraceQuery(ctx context.Context, queryString, operationName string, variables map[string]interface{}, _ map[string]*introspection.Type) (context.Context, tracer.QueryFinishFunc)

TraceQuery traces a GraphQL query.