observe

Documentation

Overview

Package observe provides metric and tracing support for Go servers. It uses OpenTelemetry and the golang.org/x/exp/events package.

Index

• type Observer
  • func NewObserver(ctx context.Context, projectID, serverName string) (_ *Observer, err error)
  • func (o *Observer) Observe(h http.Handler) http.Handler

Types

type Observer

type Observer struct {

	// LogHandlerFunc is invoked in [Observer.Observe] to obtain an
	// [event.Handler] for logging to be added to the [event.Exporter] in
	// addition to the tracing and metrics handlers.
	LogHandlerFunc func(*http.Request) event.Handler
	// contains filtered or unexported fields
}

An Observer handles tracing and metrics exporting.

func NewObserver

func NewObserver(ctx context.Context, projectID, serverName string) (_ *Observer, err error)

NewObserver creates an Observer. The context is used to flush traces in AfterRequest, so it should be longer-lived than any request context. (We don't want to use the request context because we still want traces even if it is canceled or times out.)

func (*Observer) Observe

func (o *Observer) Observe(h http.Handler) http.Handler

Observe adds metrics and tracing to an http.Handler.