ppbeego

ppbeego

This package instruments the beego/v2 package.

Installation

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

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

Usage

server

This package instruments inbound requests handled by a beego instance. Register the ServerFilterChain as the filter chain of the router to trace all handlers:

web.InsertFilterChain("/*", ppbeego.ServerFilterChain())

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/beego/beego/v2/server/web"
    "github.com/pinpoint-apm/pinpoint-go-agent"
    "github.com/pinpoint-apm/pinpoint-go-agent/plugin/beego"
)

func (m *MainController) Hello() {
    tracer := pinpoint.FromContext(m.Ctx.Request.Context())
    defer tracer.NewSpanEvent("f1").EndSpanEvent()

    m.Ctx.WriteString("hello, world!!")
}

func main() {
    //setup agent
 
	ctrl := &MainController{}
	web.Router("/hello", ctrl, "get:Hello")
	web.InsertFilterChain("/*", ppbeego.ServerFilterChain())
	web.Run("localhost:9000")
}

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

client

This package instruments outbound requests and add distributed tracing headers. Add the ClientFilterChain as the filter chain of the request.

req := httplib.Get("http://localhost:9090/")
req.AddFilters(ppbeego.ClientFilterChain(tracer))

import (
	"github.com/beego/beego/v2/client/httplib"
	"github.com/pinpoint-apm/pinpoint-go-agent"
	"github.com/pinpoint-apm/pinpoint-go-agent/plugin/beego"
)

func (m *MainController) Get() {
    tracer := pinpoint.FromContext(m.Ctx.Request.Context())

    req := httplib.Get("http://localhost:9090/")
    req.AddFilters(ppbeego.ClientFilterChain(tracer))
    str, _ := req.String()
    m.Ctx.WriteString(str)
}

Full Example Source

Config Options

• Http.Client.RecordRequestHeader
• Http.Client.RecordResponseHeader
• Http.Client.RecordRequestCookie