Instrumenting Beego with OpenTelemetry

Prerequisites

  • Go 1.13+

Resources

Introduction

In this tutorial we will instrument a basicopen in new window Beego app using OpenTelemetry instrumentation.

Instrumenting Beego app

git clone https://github.com/uptrace/uptrace-go.git
cd example/beego
  • Step 2. Install uptrace-go and Beego instrumentation:
go get github.com/uptrace/uptrace-go
go get go.opentelemetry.io/contrib/instrumentation/github.com/astaxie/beego/otelbeego
  • Step 3. Edit main.go to configure OpenTelemetry to export data to Uptrace:
import "github.com/uptrace/uptrace-go/uptrace"

uptrace.ConfigureOpentelemetry(&uptrace.Config{
	// copy your project DSN here or use UPTRACE_DSN env var
	// uptrace.WithDSN("https://<key>@api.uptrace.dev/<project_id>"),

	uptrace.WithServiceName("myservice"),
	uptrace.WithServiceVersion("1.0.0"),
})
  • Step 4. Edit main.go to instrument the Beego app:
import "go.opentelemetry.io/contrib/instrumentation/github.com/astaxie/beego/otelbeego"

// To enable tracing on template rendering, disable autorender and
// call otelbeego.Render manually.
beego.BConfig.WebConfig.AutoRender = false

mware := otelbeego.NewOTelBeegoMiddleWare("service-name")
beego.RunWithMiddleWares(":7777", mware)
UPTRACE_DSN="https://<token>@api.uptrace.dev/<project_id>" go run main.go

What is next?

By now, you should have a Django app with instrumented views. Next, instrumentopen in new window more operations (for example, database queries) or learn about OpenTelemetry API to create your own instrumentations.