nrpkgerrors

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: 4 Imported by: 2

README

v3/integrations/nrpkgerrors GoDoc

Package nrpkgerrors introduces support for https://github.com/pkg/errors.

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

For more information, see godocs.

Documentation

Overview

Package nrpkgerrors introduces support for https://github.com/pkg/errors.

This package improves the class and stack-trace fields of pkg/error errors when they are recorded with Transaction.NoticeError.

Example
package main

import (
	"github.com/newrelic/go-agent/v3/integrations/nrpkgerrors"
	newrelic "github.com/newrelic/go-agent/v3/newrelic"
	"github.com/pkg/errors"
)

type rootError string

func (e rootError) Error() string { return string(e) }

func makeRootError() error {
	return errors.WithStack(rootError("this is the original error"))
}

func main() {
	var txn *newrelic.Transaction
	e := errors.Wrap(makeRootError(), "extra information")
	// Wrap the error to record stack-trace and class type information from
	// the error's root cause.  Here, "rootError" will be recored as the
	// class and top stack-trace frame will be inside makeRootError().
	// Without nrpkgerrors.Wrap, "*errors.withStack" would be recorded as
	// the class and the top stack-trace frame would be site of the
	// NoticeError call.
	txn.NoticeError(nrpkgerrors.Wrap(e))
}
Output:

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func Wrap

func Wrap(e error) error

Wrap wraps a pkg/errors error so that when noticed by newrelic.Transaction.NoticeError it gives an improved stacktrace and class type.

Types

This section is empty.

Source Files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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