nrgraphqlgo

package module
Version: v1.0.1 Latest Latest
Warning

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

Go to latest
Published: Jun 7, 2021 License: Apache-2.0 Imports: 5 Imported by: 1

README

v3/integrations/nrgraphqlgo GoDoc

Package nrgraphql instruments https://github.com/graphql-go/graphql applications.

import "github.com/newrelic/go-agent/v3/integrations/nrgraphqlgo"

Note that New Relic has support for more than one GraphQL framework, and both packages are named nrgraphql, so please ensure you are using the integration for the correct framework.

For more information, see godocs.

Documentation

Overview

Package nrgraphqlgo instruments https://github.com/graphql-go/graphql applications.

This package creates an Extension that adds segment instrumentation for each portion of the GraphQL execution (Parse, Validation, Execution, ResolveField) to your GraphQL request transactions. Errors in any of these steps will be noticed using NoticeError (https://godoc.org/github.com/newrelic/go-agent/v3/newrelic#Transaction.NoticeError)

Please note that you must also instrument your web request handlers and put the transaction into the context object in order to utilize this instrumentation. For example, you could use newrelic.WrapHandle (https://godoc.org/github.com/newrelic/go-agent/v3/newrelic#WrapHandle) or newrelic.WrapHandleFunc (https://godoc.org/github.com/newrelic/go-agent/v3/newrelic#WrapHandleFunc) or you could use a New Relic integration for the web framework you are using if it is available (for example, https://godoc.org/github.com/newrelic/go-agent/v3/integrations/nrgorilla)

For a complete example, including instrumenting a graphql-go-handler, see: https://github.com/newrelic/go-agent/tree/master/v3/integrations/nrgraphqlgo/example/main.go

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Extension

type Extension struct{}

Extension is an extension that creates segments for New Relic, tracking each step of the execution process

func (Extension) ExecutionDidStart

ExecutionDidStart is called before the execution begins

func (Extension) GetResult

func (Extension) GetResult(context.Context) interface{}

GetResult returns the data that the extension wants to add to the result - in this case, none

func (Extension) HasResult

func (Extension) HasResult() bool

HasResult returns true if the extension wants to add data to the result - this extension does not.

func (Extension) Init

Init is used to help you initialize the extension - in this case, a noop

func (Extension) Name

func (Extension) Name() string

Name returns the name of the extension

func (Extension) ParseDidStart

ParseDidStart is called before parsing starts

func (Extension) ResolveFieldDidStart

ResolveFieldDidStart is called at the start of the resolving of a field

func (Extension) ValidationDidStart

ValidationDidStart is called before the validation begins

Source Files

Directories

Path Synopsis
example module

Jump to

Keyboard shortcuts

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