Documentation
¶
Overview ¶
Package metricsutil pkg/metricsutil/requests_in_flight_count_middleware.go c0-com-util
Package metricsutil pkg/metricsutil/status_response_writer.go c0-com-util
Package metricsutil pkg/metricsutil/victoria_metrics_int_gauge_wrapper.go c0-com-util
Package metricsutil pkg/metricsutil/victoria_metrics_uint_gauge_wrapper.go c0-com-util
Index ¶
- func AddMetricsHandler(mux *httputil.Router)
- func RequestDurationMiddleware(next http.Handler) http.Handler
- func ServeHTTPMetrics(log logrus.FieldLogger, addr string)
- func ServePProf(log logrus.FieldLogger, addr, serviceName string)
- type RequestsInFlightCountMiddleware
- type StatusResponseWriter
- type VictoriaMetricsIntGaugeWrapper
- type VictoriaMetricsUintGaugeWrapper
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddMetricsHandler ¶
AddMetricsHandler adds a prometheus-format Handle at '/metrics' to the provided serve mux.
func RequestDurationMiddleware ¶
RequestDurationMiddleware is a request duration tracking middleware.
func ServeHTTPMetrics ¶
func ServeHTTPMetrics(log logrus.FieldLogger, addr string)
ServeHTTPMetrics starts serving metrics on a given `addr`.
func ServePProf ¶
func ServePProf(log logrus.FieldLogger, addr, serviceName string)
ServePProf starts a pprof debug server on the given address. The serviceName is exposed at /debug/service so operators can identify which service a pprof endpoint belongs to.
Types ¶
type RequestsInFlightCountMiddleware ¶
type RequestsInFlightCountMiddleware struct {
// contains filtered or unexported fields
}
RequestsInFlightCountMiddleware is a middleware to track current requests-in-flight count.
func NewRequestsInFlightCountMiddleware ¶
func NewRequestsInFlightCountMiddleware() *RequestsInFlightCountMiddleware
NewRequestsInFlightCountMiddleware constructs `RequestsInFlightCountMiddleware`.
type StatusResponseWriter ¶
type StatusResponseWriter struct {
http.ResponseWriter
// contains filtered or unexported fields
}
StatusResponseWriter wraps `http.ResponseWriter` but stores status code on call to `WriteHeader`.
func NewStatusResponseWriter ¶
func NewStatusResponseWriter(w http.ResponseWriter) *StatusResponseWriter
NewStatusResponseWriter wraps `http.ResponseWriter` constructing `StatusResponseWriter`.
func (*StatusResponseWriter) StatusCode ¶
func (w *StatusResponseWriter) StatusCode() int
StatusCode gets status code from the writer.
func (*StatusResponseWriter) WriteHeader ¶
func (w *StatusResponseWriter) WriteHeader(statusCode int)
WriteHeader implements `http.ResponseWriter` storing the written status code.
type VictoriaMetricsIntGaugeWrapper ¶
type VictoriaMetricsIntGaugeWrapper struct {
// contains filtered or unexported fields
}
VictoriaMetricsIntGaugeWrapper wraps Victoria Metrics int gauge encapsulating all the needed logic to control the value.
func NewVictoriaMetricsIntGauge ¶
func NewVictoriaMetricsIntGauge(name string) *VictoriaMetricsIntGaugeWrapper
NewVictoriaMetricsIntGauge constructs new wrapper for Victoria Metric int gauge with the name `name`.
func (*VictoriaMetricsIntGaugeWrapper) Dec ¶
func (w *VictoriaMetricsIntGaugeWrapper) Dec()
Dec decrements gauge value.
func (*VictoriaMetricsIntGaugeWrapper) Inc ¶
func (w *VictoriaMetricsIntGaugeWrapper) Inc()
Inc increments gauge value.
func (*VictoriaMetricsIntGaugeWrapper) Set ¶
func (w *VictoriaMetricsIntGaugeWrapper) Set(val int64)
Set sets gauge value.
func (*VictoriaMetricsIntGaugeWrapper) Val ¶
func (w *VictoriaMetricsIntGaugeWrapper) Val() int64
Val gets gauge value.
type VictoriaMetricsUintGaugeWrapper ¶
type VictoriaMetricsUintGaugeWrapper struct {
// contains filtered or unexported fields
}
VictoriaMetricsUintGaugeWrapper wraps Victoria Metrics int gauge encapsulating all the needed logic to control the value.
func NewVictoriaMetricsUintGauge ¶
func NewVictoriaMetricsUintGauge(name string) *VictoriaMetricsUintGaugeWrapper
NewVictoriaMetricsUintGauge constructs new wrapper for Victoria Metric int gauge with the name `name`.
func (*VictoriaMetricsUintGaugeWrapper) Dec ¶
func (w *VictoriaMetricsUintGaugeWrapper) Dec()
Dec decrements gauge value.
func (*VictoriaMetricsUintGaugeWrapper) Inc ¶
func (w *VictoriaMetricsUintGaugeWrapper) Inc()
Inc increments gauge value.
func (*VictoriaMetricsUintGaugeWrapper) Set ¶
func (w *VictoriaMetricsUintGaugeWrapper) Set(val uint64)
Set sets gauge value.
func (*VictoriaMetricsUintGaugeWrapper) Val ¶
func (w *VictoriaMetricsUintGaugeWrapper) Val() uint64
Val gets gauge value.
Source Files