nrecho

README

v3/integrations/nrecho-v4

Package nrecho instruments applications using https://github.com/labstack/echo v4.

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

For more information, see godocs.

Documentation

Overview

Package nrecho instruments applications using https://github.com/labstack/echo v4.

Use this package to instrument inbound requests handled by an echo.Echo instance.

e := echo.New()
// Add the nrecho middleware before other middlewares or routes:
e.Use(nrecho.Middleware(app))

Example: https://github.com/newrelic/go-agent/tree/master/v3/integrations/nrecho-v4/example/main.go

Index

• func FromContext(c echo.Context) *newrelic.Transaction
• func Middleware(app *newrelic.Application, opts ...ConfigOption) func(echo.HandlerFunc) echo.HandlerFunc
• func WrapRouter(engine *echo.Echo)
• type Config
• type ConfigOption
  • func WithSkipper(skipper Skipper) ConfigOption
• type Skipper

Functions

func FromContext

func FromContext(c echo.Context) *newrelic.Transaction

FromContext returns the Transaction from the context if present, and nil otherwise.

func Middleware

func Middleware(app *newrelic.Application, opts ...ConfigOption) func(echo.HandlerFunc) echo.HandlerFunc

Middleware creates Echo middleware with provided config that instruments requests.

e := echo.New()
// Add the nrecho middleware before other middlewares or routes:
e.Use(nrecho.MiddlewareWithConfig(nrecho.Config{App: app}))

func WrapRouter

func WrapRouter(engine *echo.Echo)

WrapRouter extracts API endpoints from the echo instance passed to it which is used to detect application URL mapping(api-endpoints) for provable security. In this version of the integration, this wrapper is only necessary if you are using the New Relic security agent integration [https://github.com/newrelic/go-agent/tree/master/v3/integrations/nrsecurityagent], but it may be enhanced to provide additional functionality in future releases.

 e := echo.New()
 ....
 ....
 ....

nrecho.WrapRouter(e)

Types

type Config

type Config struct {
	// App contains newrelic application.
	App *newrelic.Application

	// Skipper defines a function to skip middleware.
	Skipper Skipper
}

Config defines the config for the middleware.

type ConfigOption

type ConfigOption func(*Config)

func WithSkipper

func WithSkipper(skipper Skipper) ConfigOption

type Skipper

type Skipper func(c echo.Context) bool

Skipper defines a function to skip middleware. Returning true skips processing the middleware.