metric

package
v0.0.0-...-6906e5f Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 32 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	RequestCounter                = "router.http.requests"                      // Incoming request count total
	ServerLatencyHistogram        = "router.http.request.duration_milliseconds" // Incoming end to end duration, milliseconds
	RequestContentLengthCounter   = "router.http.request.content_length"        // Incoming request bytes total
	ResponseContentLengthCounter  = "router.http.response.content_length"       // Outgoing response bytes total
	InFlightRequestsUpDownCounter = "router.http.requests.in_flight"            // Number of requests in flight
	RequestError                  = "router.http.requests.error"                // Total request error count

)

Server HTTP metrics.

View Source 
const (
	DefaultMinimumReadMemStatsInterval = 15 * time.Second

	AttributeGoInfoVersion = attribute.Key("version")
)
View Source 
const DefaultServerName = "cosmo-router"

DefaultServerName Default resource name.

Variables

View Source 
var (
	RequestCounterDescription = "Total number of requests"
	RequestCounterOptions     = []otelmetric.Int64CounterOption{
		otelmetric.WithDescription(RequestCounterDescription),
	}
	RequestErrorCounterDescription = "Total number of failed request"
	RequestErrorCounterOptions     = []otelmetric.Int64CounterOption{
		otelmetric.WithDescription(RequestErrorCounterDescription),
	}
	ServerLatencyHistogramDescription = "Server latency in milliseconds"
	ServerLatencyHistogramOptions     = []otelmetric.Float64HistogramOption{
		otelmetric.WithUnit("ms"),
		otelmetric.WithDescription(ServerLatencyHistogramDescription),
	}
	RequestContentLengthCounterDescription = "Total number of request bytes"
	RequestContentLengthCounterOptions     = []otelmetric.Int64CounterOption{
		otelmetric.WithUnit("bytes"),
		otelmetric.WithDescription(RequestContentLengthCounterDescription),
	}
	ResponseContentLengthCounterDescription = "Total number of response bytes"
	ResponseContentLengthCounterOptions     = []otelmetric.Int64CounterOption{
		otelmetric.WithUnit("bytes"),
		otelmetric.WithDescription(ResponseContentLengthCounterDescription),
	}
	InFlightRequestsUpDownCounterDescription = "Number of requests in flight"
	InFlightRequestsUpDownCounterOptions     = []otelmetric.Int64UpDownCounterOption{
		otelmetric.WithDescription(InFlightRequestsUpDownCounterDescription),
	}
)

Functions

func NewOtlpMeterProvider 

func NewOtlpMeterProvider(ctx context.Context, log *zap.Logger, c *Config, serviceInstanceID string) (*sdkmetric.MeterProvider, error)

func NewPrometheusMeterProvider 

func NewPrometheusMeterProvider(ctx context.Context, c *Config, serviceInstanceID string) (*sdkmetric.MeterProvider, *prometheus.Registry, error)

func NewPrometheusServer 

func NewPrometheusServer(logger *zap.Logger, listenAddr string, path string, registry *prometheus.Registry) *http.Server

Types

type Config 

type Config struct {
	// Name represents the service name for metrics. The default value is cosmo-router.
	Name string

	// Version represents the service version for metrics. The default value is dev.
	Version string

	// OpenTelemetry includes the OpenTelemetry configuration
	OpenTelemetry OpenTelemetry

	// Prometheus includes the Prometheus configuration
	Prometheus PrometheusConfig
}

Config represents the configuration for the agent.

func DefaultConfig 

func DefaultConfig(serviceVersion string) *Config

DefaultConfig returns the default config.

func (*Config) IsEnabled 

func (c *Config) IsEnabled() bool

type Measurements 

type Measurements struct {
	// contains filtered or unexported fields
}

Measurements holds the metrics for the request.

type Metrics 

type Metrics struct {
	// contains filtered or unexported fields
}

func (*Metrics) Flush 

func (h *Metrics) Flush(ctx context.Context) error

Flush flushes the metrics to the backend synchronously.

func (*Metrics) MeasureInFlight 

func (h *Metrics) MeasureInFlight(ctx context.Context, attr ...attribute.KeyValue) func()

func (*Metrics) MeasureLatency 

func (h *Metrics) MeasureLatency(ctx context.Context, requestStartTime time.Time, attr ...attribute.KeyValue)

func (*Metrics) MeasureRequestCount 

func (h *Metrics) MeasureRequestCount(ctx context.Context, attr ...attribute.KeyValue)

func (*Metrics) MeasureRequestError 

func (h *Metrics) MeasureRequestError(ctx context.Context, attr ...attribute.KeyValue)

func (*Metrics) MeasureRequestSize 

func (h *Metrics) MeasureRequestSize(ctx context.Context, contentLength int64, attr ...attribute.KeyValue)

func (*Metrics) MeasureResponseSize 

func (h *Metrics) MeasureResponseSize(ctx context.Context, size int64, attr ...attribute.KeyValue)

type NoopMetrics 

type NoopMetrics struct{}

func (NoopMetrics) Flush 

func (n NoopMetrics) Flush(ctx context.Context) error

func (NoopMetrics) MeasureInFlight 

func (n NoopMetrics) MeasureInFlight(ctx context.Context, attr ...attribute.KeyValue) func()

func (NoopMetrics) MeasureLatency 

func (n NoopMetrics) MeasureLatency(ctx context.Context, requestStartTime time.Time, attr ...attribute.KeyValue)

func (NoopMetrics) MeasureRequestCount 

func (n NoopMetrics) MeasureRequestCount(ctx context.Context, attr ...attribute.KeyValue)

func (NoopMetrics) MeasureRequestError 

func (n NoopMetrics) MeasureRequestError(ctx context.Context, attr ...attribute.KeyValue)

func (NoopMetrics) MeasureRequestSize 

func (n NoopMetrics) MeasureRequestSize(ctx context.Context, contentLength int64, attr ...attribute.KeyValue)

func (NoopMetrics) MeasureResponseSize 

func (n NoopMetrics) MeasureResponseSize(ctx context.Context, size int64, attr ...attribute.KeyValue)

type OpenTelemetry 

type OpenTelemetry struct {
	Enabled       bool
	RouterRuntime bool
	Exporters     []*OpenTelemetryExporter
	// TestReader is used for testing purposes. If set, the reader will be used instead of the configured exporters.
	TestReader sdkmetric.Reader
}

type OpenTelemetryExporter 

type OpenTelemetryExporter struct {
	Disabled bool
	Exporter otelconfig.Exporter
	Endpoint string
	// Headers represents the headers for HTTP transport.
	// For example:
	//  Authorization: 'Bearer <token>'
	Headers map[string]string
	// HTTPPath represents the path for OTLP HTTP transport.
	// For example
	// /v1/metrics
	HTTPPath string
}

func GetDefaultExporter 

func GetDefaultExporter(cfg *Config) *OpenTelemetryExporter

type Option 

type Option func(svr *Metrics)

func WithAttributes 

func WithAttributes(attrs ...attribute.KeyValue) Option

WithAttributes adds attributes to the base attributes

func WithLogger 

func WithLogger(logger *zap.Logger) Option

func WithOtlpMeterProvider 

func WithOtlpMeterProvider(otelMeterProvider *metric.MeterProvider) Option

func WithProcessStartTime 

func WithProcessStartTime(processStartTime time.Time) Option

func WithPromMeterProvider 

func WithPromMeterProvider(promMeterProvider *metric.MeterProvider) Option

func WithRouterRuntimeMetrics 

func WithRouterRuntimeMetrics(enableRuntime bool) Option

type OtlpMetricStore 

type OtlpMetricStore struct {
	// contains filtered or unexported fields
}

func (*OtlpMetricStore) Flush 

func (h *OtlpMetricStore) Flush(ctx context.Context) error

func (*OtlpMetricStore) MeasureInFlight 

func (h *OtlpMetricStore) MeasureInFlight(ctx context.Context, attr ...attribute.KeyValue) func()

func (*OtlpMetricStore) MeasureLatency 

func (h *OtlpMetricStore) MeasureLatency(ctx context.Context, requestStartTime time.Time, attr ...attribute.KeyValue)

func (*OtlpMetricStore) MeasureRequestCount 

func (h *OtlpMetricStore) MeasureRequestCount(ctx context.Context, attr ...attribute.KeyValue)

func (*OtlpMetricStore) MeasureRequestError 

func (h *OtlpMetricStore) MeasureRequestError(ctx context.Context, attr ...attribute.KeyValue)

func (*OtlpMetricStore) MeasureRequestSize 

func (h *OtlpMetricStore) MeasureRequestSize(ctx context.Context, contentLength int64, attr ...attribute.KeyValue)

func (*OtlpMetricStore) MeasureResponseSize 

func (h *OtlpMetricStore) MeasureResponseSize(ctx context.Context, size int64, attr ...attribute.KeyValue)

type PromMetricStore 

type PromMetricStore struct {
	// contains filtered or unexported fields
}

func (*PromMetricStore) Flush 

func (h *PromMetricStore) Flush(ctx context.Context) error

func (*PromMetricStore) MeasureInFlight 

func (h *PromMetricStore) MeasureInFlight(ctx context.Context, attr ...attribute.KeyValue) func()

func (*PromMetricStore) MeasureLatency 

func (h *PromMetricStore) MeasureLatency(ctx context.Context, requestStartTime time.Time, attr ...attribute.KeyValue)

func (*PromMetricStore) MeasureRequestCount 

func (h *PromMetricStore) MeasureRequestCount(ctx context.Context, attr ...attribute.KeyValue)

func (*PromMetricStore) MeasureRequestError 

func (h *PromMetricStore) MeasureRequestError(ctx context.Context, attr ...attribute.KeyValue)

func (*PromMetricStore) MeasureRequestSize 

func (h *PromMetricStore) MeasureRequestSize(ctx context.Context, contentLength int64, attr ...attribute.KeyValue)

func (*PromMetricStore) MeasureResponseSize 

func (h *PromMetricStore) MeasureResponseSize(ctx context.Context, size int64, attr ...attribute.KeyValue)

type PrometheusConfig 

type PrometheusConfig struct {
	Enabled    bool
	ListenAddr string
	Path       string
	// Metrics to exclude from Prometheus exporter
	ExcludeMetrics []*regexp.Regexp
	// Metric labels to exclude from Prometheus exporter
	ExcludeMetricLabels []*regexp.Regexp
	// TestRegistry is used for testing purposes. If set, the registry will be used instead of the default one.
	TestRegistry *prometheus.Registry
}

type RuntimeMetrics 

type RuntimeMetrics struct {
	// contains filtered or unexported fields
}

func NewRuntimeMetrics 

func NewRuntimeMetrics(logger *zap.Logger, meterProvider *metric.MeterProvider, baseAttributes []attribute.KeyValue, processStartTime time.Time) *RuntimeMetrics

func (*RuntimeMetrics) Start 

func (r *RuntimeMetrics) Start() error

func (*RuntimeMetrics) Stop 

func (r *RuntimeMetrics) Stop() error

type Store 

type Store interface {
	MeasureInFlight(ctx context.Context, attr ...attribute.KeyValue) func()
	MeasureRequestCount(ctx context.Context, attr ...attribute.KeyValue)
	MeasureRequestSize(ctx context.Context, contentLength int64, attr ...attribute.KeyValue)
	MeasureResponseSize(ctx context.Context, size int64, attr ...attribute.KeyValue)
	MeasureLatency(ctx context.Context, requestStartTime time.Time, attr ...attribute.KeyValue)
	MeasureRequestError(ctx context.Context, attr ...attribute.KeyValue)
	Flush(ctx context.Context) error
}

func NewNoopMetrics 

func NewNoopMetrics() Store

func NewOtlpMetricStore 

func NewOtlpMetricStore(logger *zap.Logger, meterProvider *metric.MeterProvider, baseAttributes []attribute.KeyValue) (Store, error)

func NewPromMetricStore 

func NewPromMetricStore(logger *zap.Logger, meterProvider *metric.MeterProvider, baseAttributes []attribute.KeyValue) (Store, error)

func NewStore 

func NewStore(opts ...Option) (Store, error)

NewStore creates a new metrics store instance. The store abstract OTEL and Prometheus metrics with a single interface.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.