gqlgen

package
Version: v1.42.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 26, 2022 License: Apache-2.0, BSD-3-Clause, Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package gqlgen contains an implementation of a gqlgen tracer, and functions to construct and configure the tracer. The tracer can be passed to the gqlgen handler (see package github.com/99designs/gqlgen/handler)

Warning: Data obfuscation hasn't been implemented for graphql queries yet, any sensitive data in the query will be sent to Datadog as the resource name of the span. To ensure no sensitive data is included in your spans, always use parameterized graphql queries with sensitive data in variables.

Example
package main

import (
	"log"
	"net/http"

	"github.com/99designs/gqlgen/example/todo"
	"github.com/99designs/gqlgen/graphql/handler"

	"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"

	gqlgentrace "gopkg.in/DataDog/dd-trace-go.v1/contrib/99designs/gqlgen"
)

func main() {
	tracer.Start()
	defer tracer.Stop()

	t := gqlgentrace.NewTracer(
		gqlgentrace.WithAnalytics(true),
		gqlgentrace.WithServiceName("todo.server"),
	)
	h := handler.NewDefaultServer(todo.NewExecutableSchema(todo.New()))
	h.Use(t)
	http.Handle("/query", h)
	log.Fatal(http.ListenAndServe(":8080", nil))
}
Output:

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewTracer

func NewTracer(opts ...Option) graphql.HandlerExtension

NewTracer creates a graphql.HandlerExtension instance that can be used with a graphql.handler.Server. Options can be passed in for further configuration.

Types

type Option

type Option func(t *config)

An Option configures the gqlgen integration.

func WithAnalytics

func WithAnalytics(on bool) Option

WithAnalytics enables or disables 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 WithServiceName

func WithServiceName(name string) Option

WithServiceName sets the given service name for the gqlgen server.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL