otelgin

Documentation

Overview

Package otelgin instruments the github.com/gin-gonic/gin package.

Currently there are two ways the code can be instrumented. One is instrumenting the routing of a received message (the Middleware function) and instrumenting the response generation through template evaluation (the HTML function).

Index

• Constants
• func HTML(c *gin.Context, code int, name string, obj interface{})
• func Middleware(service string, opts ...Option) gin.HandlerFunc
• func SemVersion() string
• func Version() string
• type Filter
• type Option
  • func WithFilter(f ...Filter) Option
  • func WithPropagators(propagators propagation.TextMapPropagator) Option
  • func WithSpanNameFormatter(f func(r *http.Request) string) Option
  • func WithTracerProvider(provider oteltrace.TracerProvider) Option
• type SpanNameFormatter

Constants

const (

	// ScopeName is the instrumentation scope name.
	ScopeName = "github.com/dillonstreator/opentelemetry-go-contrib/instrumentation/github.com/gin-gonic/gin/otelgin"
)

Functions

func HTML

func HTML(c *gin.Context, code int, name string, obj interface{})

HTML will trace the rendering of the template as a child of the span in the given context. This is a replacement for gin.Context.HTML function - it invokes the original function after setting up the span.

func Middleware

func Middleware(service string, opts ...Option) gin.HandlerFunc

Middleware returns middleware that will trace incoming requests. The service parameter should describe the name of the (virtual) server handling the request.

func SemVersion

func SemVersion() string

SemVersion is the semantic version to be supplied to tracer/meter creation.

Deprecated: Use Version instead.

func Version

func Version() string

Version is the current release version of the gin instrumentation.

Types

type Filter

type Filter func(*http.Request) bool

Filter is a predicate used to determine whether a given http.request should be traced. A Filter must return true if the request should be traced.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option specifies instrumentation configuration options.

func WithFilter

func WithFilter(f ...Filter) Option

WithFilter adds a filter to the list of filters used by the handler. If any filter indicates to exclude a request then the request will not be traced. All filters must allow a request to be traced for a Span to be created. If no filters are provided then all requests are traced. Filters will be invoked for each processed request, it is advised to make them simple and fast.

func WithPropagators

func WithPropagators(propagators propagation.TextMapPropagator) Option

WithPropagators specifies propagators to use for extracting information from the HTTP requests. If none are specified, global ones will be used.

func WithSpanNameFormatter

func WithSpanNameFormatter(f func(r *http.Request) string) Option

WithSpanNameFormatter takes a function that will be called on every request and the returned string will become the Span Name.

func WithTracerProvider

func WithTracerProvider(provider oteltrace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.

type SpanNameFormatter

type SpanNameFormatter func(r *http.Request) string

SpanNameFormatter is used to set span name by http.request.