opencensus

Documentation

Overview

Package opencensus provides helpers for OpenCensus instrumentation.

Index

• func AddSpan(ctx context.Context, attributes ...trace.Attribute) (context.Context, func(error))
• func Middleware(handler http.Handler) http.Handler
• func Views() []*view.View
• type UseCaseMiddleware
  • func (mw UseCaseMiddleware) Wrap(u usecase.Interactor) usecase.Interactor

Functions

func AddSpan

func AddSpan(ctx context.Context, attributes ...trace.Attribute) (context.Context, func(error))

AddSpan starts OpenCensus trace span and returns updated context with callback to finish span.

Span is named by the parent function. Typically span should be finished with deferred statement.

var err error
ctx, finish := opencensus.AddSpan(ctx,
	trace.StringAttribute("key", "value"),
)
defer func() { finish(err) }()

func Middleware

func Middleware(handler http.Handler) http.Handler

Middleware instruments router with OpenCensus metrics.

func Views

func Views() []*view.View

Views lists OpenCensus views rendered as metrics.

Types

type UseCaseMiddleware

type UseCaseMiddleware struct {
	WithInput bool
}

UseCaseMiddleware is a tracing usecase middleware.

func (UseCaseMiddleware) Wrap

func (mw UseCaseMiddleware) Wrap(u usecase.Interactor) usecase.Interactor

Wrap makes an instrumented use case interactor.