metrics

Documentation

Index

• Variables
• type Metrics
• type Options
• type PrometheusMetrics
  • func NewPrometheusMetrics(enabled bool) *PrometheusMetrics
  • func (p *PrometheusMetrics) IncErrorTypeCounter(err string, schemaID int)
  • func (p *PrometheusMetrics) IncHTTPRequestStat(start time.Time, schemaID int, statusCode int)
  • func (p *PrometheusMetrics) IncHTTPRequestTotalCountOnly(schemaID int, statusCode int)
  • func (p *PrometheusMetrics) StartService(logger *zerolog.Logger, options *Options) error

Variables

var (
	// Counter: Total number of errors
	TotalErrors = prometheus.NewCounter(
		prometheus.CounterOpts{
			Name: "wallarm_apifw_service_errors_total",
			Help: "Total number of errors occurred in the APIFW service.",
		})

	// Counter: Errors by types
	ErrorTypeCounter = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "wallarm_apifw_service_errors_by_type",
			Help: "Total number of errors by type and endpoint.",
		},
		[]string{"error_type", "schema_id"},
	)

	// Counter: Total number of HTTP requests
	HttpRequestsTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "wallarm_apifw_http_requests_total",
			Help: "Total number of HTTP requests",
		},
		[]string{"schema_id", "status_code"},
	)

	// Histogram: HTTP request duration
	HttpRequestDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "wallarm_apifw_http_request_duration_seconds",
			Help:    "HTTP request duration in seconds",
			Buckets: []float64{.001, .005, .025, .05, .25, .5, 1, 2.5, 5},
		},
		[]string{"schema_id"},
	)
)

Types

type Metrics

type Metrics interface {
	IncErrorTypeCounter(err string, schemaID int)
	IncHTTPRequestStat(start time.Time, schemaID int, statusCode int)
	IncHTTPRequestTotalCountOnly(schemaID int, statusCode int)
}

type Options

type Options struct {
	EndpointName string
	Host         string
	ReadTimeout  time.Duration
	WriteTimeout time.Duration
}

type PrometheusMetrics

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

func NewPrometheusMetrics

func NewPrometheusMetrics(enabled bool) *PrometheusMetrics

func (*PrometheusMetrics) IncErrorTypeCounter

func (p *PrometheusMetrics) IncErrorTypeCounter(err string, schemaID int)

func (*PrometheusMetrics) IncHTTPRequestStat

func (p *PrometheusMetrics) IncHTTPRequestStat(start time.Time, schemaID int, statusCode int)

func (*PrometheusMetrics) IncHTTPRequestTotalCountOnly

func (p *PrometheusMetrics) IncHTTPRequestTotalCountOnly(schemaID int, statusCode int)

func (*PrometheusMetrics) StartService

func (p *PrometheusMetrics) StartService(logger *zerolog.Logger, options *Options) error