metrics

Documentation

Index

• Constants
• func Client(opts ...Option) middleware.Middleware
• func DefaultRequestsCounter(meter metric.Meter, histogramName string) (metric.Int64Counter, error)
• func DefaultSecondsHistogram(meter metric.Meter, histogramName string) (metric.Float64Histogram, error)
• func DefaultSecondsHistogramView(histogramName string) metricsdk.View
• func EnableOTELExemplar() error
• func Server(opts ...Option) middleware.Middleware
• type Option
  • func WithRequests(c metric.Int64Counter) Option
  • func WithSeconds(histogram metric.Float64Histogram) Option

Constants

const (
	DefaultServerSecondsHistogramName = "server_requests_seconds_bucket"
	DefaultServerRequestsCounterName  = "server_requests_code_total"
	DefaultClientSecondsHistogramName = "client_requests_seconds_bucket"
	DefaultClientRequestsCounterName  = "client_requests_code_total"
)

Functions

func Client

func Client(opts ...Option) middleware.Middleware

Client is middleware client-side metrics.

func DefaultRequestsCounter

func DefaultRequestsCounter(meter metric.Meter, histogramName string) (metric.Int64Counter, error)

DefaultRequestsCounter return metric.Int64Counter for WithRequests suggest histogramName = <client/server>_requests_code_total

func DefaultSecondsHistogram

func DefaultSecondsHistogram(meter metric.Meter, histogramName string) (metric.Float64Histogram, error)

DefaultSecondsHistogram return metric.Float64Histogram for WithSeconds suggest histogramName = <client/server>_requests_seconds_bucket

func DefaultSecondsHistogramView

func DefaultSecondsHistogramView(histogramName string) metricsdk.View

DefaultSecondsHistogramView need register in sdkmetric.MeterProvider eg: view := SecondsHistogramView() mp := sdkmetric.NewMeterProvider(sdkmetric.WithView(view)) otel.SetMeterProvider(mp)

func EnableOTELExemplar

func EnableOTELExemplar() error

func Server

func Server(opts ...Option) middleware.Middleware

Server is middleware server-side metrics.

Types

type Option

type Option func(*options)

Option is metrics option.

func WithRequests

func WithRequests(c metric.Int64Counter) Option

WithRequests with requests counter.

func WithSeconds

func WithSeconds(histogram metric.Float64Histogram) Option

WithSeconds with seconds histogram. notice: the record unit in current middleware is s(Seconds)