ppecho

README

ppecho

This package instruments the labstack/echo package.

Installation

$ go get github.com/pinpoint-apm/pinpoint-go-agent/plugin/echo

import "github.com/pinpoint-apm/pinpoint-go-agent/plugin/echo"

Usage

This package instruments inbound requests handled by an echo.Router. Register the Middleware as the middleware of the router to trace all handlers:

e := echo.New()
e.Use(ppecho.Middleware())

Use WrapHandler to select the handlers you want to track:

e.GET("/hello", ppecho.WrapHandler(hello))

For each request, a pinpoint.Tracer is stored in the request context. By using the pinpoint.FromContext function, this tracer can be obtained in your handler. Alternatively, the context of the request may be propagated where the context that contains the pinpoint.Tracer is required.

package main

import (
    "github.com/labstack/echo"
    "github.com/pinpoint-apm/pinpoint-go-agent"
    "github.com/pinpoint-apm/pinpoint-go-agent/plugin/echo"
)

func hello(c echo.Context) error {
    return c.String(200, "Hello World!!")
}

func main() {
    ... //setup agent
	
    e := echo.New()
    e.Use(ppecho.Middleware())

    e.GET("/hello", hello)
    e.Start(":9000")
}

Full Example Source

This package supports URL Statistics feature. It aggregates response times, successes and failures for each router pattern.

Config Options

• Http.Server.StatusCodeErrors
• Http.Server.ExcludeUrl
• Http.Server.ExcludeMethod
• Http.Server.RecordRequestHeader
• Http.Server.RecordResponseHeader
• Http.Server.RecordRequestCookie
• Http.UrlStat.Enable
• Http.UrlStat.LimitSize

Documentation

Overview

Package ppecho instruments the labstack/echo package (https://github.com/labstack/echo).

This package instruments inbound requests handled by a echo.Router. Register the Middleware as the middleware of the router to trace all handlers:

e := echo.New()
e.Use(ppecho.Middleware())

Use WrapHandler to select the handlers you want to track:

e.GET("/hello", ppecho.WrapHandler(hello))

Index

• func Middleware() echo.MiddlewareFunc
• func WrapHandler(handler echo.HandlerFunc) echo.HandlerFunc

Functions

func Middleware

func Middleware() echo.MiddlewareFunc

Middleware returns an echo middleware that creates a pinpoint.Tracer that instruments the echo handler function.

func WrapHandler

func WrapHandler(handler echo.HandlerFunc) echo.HandlerFunc

WrapHandler wraps the given echo handler and adds the pinpoint.Tracer to the request's context. By using the pinpoint.FromContext function, this tracer can be obtained.