otelgin

Documentation

Index

• Constants
• func HTML(c *gin.Context, code int, name string, obj interface{})
• func MeterMiddleware(service string) gin.HandlerFunc
• func SemVersion() string
• func TraceMiddleware(service string, opts ...Option) gin.HandlerFunc
• func Version() string
• type Filter
• type Option
  • func WithFilter(f Filter) Option
  • func WithPropagators(propagators propagation.TextMapPropagator) Option
  • func WithSpanNameGenerater(g SpanNameGenerater) Option
  • func WithTracerProvider(provider oteltrace.TracerProvider) Option
• type SpanNameGenerater

Constants

const (
	RequestCount          = "http.server.request_count"           // Incoming request count total
	RequestContentLength  = "http.server.request_content_length"  // Incoming request bytes total
	ResponseContentLength = "http.server.response_content_length" // Incoming response bytes total
	ServerLatency         = "http.server.duration"                // Incoming end to end duration, microseconds
)

Server HTTP metrics.

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 MeterMiddleware

func MeterMiddleware(service string) gin.HandlerFunc

func SemVersion

func SemVersion() string

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

func TraceMiddleware

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

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

func Version

func Version() string

Version is the current release version of the gin instrumentation.

Types

type Filter

type Filter func(c *gin.Context) bool

type Option

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

Option specifies instrumentation configuration options.

func WithFilter

func WithFilter(f Filter) Option

WithFilter use a filter to drop no need traces whitch return false.

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 WithSpanNameGenerater

func WithSpanNameGenerater(g SpanNameGenerater) Option

WithSpanNameGenerater set a generater to generate 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 SpanNameGenerater

type SpanNameGenerater func(c *gin.Context) string