Documentation ¶
Index ¶
- Constants
- Variables
- func CleanScope(requestInfo *request.RequestInfo) string
- func InstrumentHandlerFunc(verb, group, version, resource, subresource, scope, component string, ...) http.HandlerFunc
- func InstrumentRouteFunc(verb, group, version, resource, subresource, scope, component string, ...) restful.RouteFunction
- func MonitorRequest(req *http.Request, ...)
- func RecordFilterLatency(name string, elapsed time.Duration)
- func RecordLongRunning(req *http.Request, requestInfo *request.RequestInfo, component string, ...)
- func RecordRequestAbort(req *http.Request, requestInfo *request.RequestInfo)
- func RecordRequestTermination(req *http.Request, requestInfo *request.RequestInfo, component string, ...)
- func Register()
- func Reset()
- func UpdateInflightRequestMetrics(phase string, nonmutating, mutating int)
- type ResponseWriterDelegator
Constants ¶
const ( APIServerComponent string = "apiserver" OtherContentType string = "other" OtherRequestMethod string = "other" )
const ( // ReadOnlyKind is a string identifying read only request kind ReadOnlyKind = "readOnly" // MutatingKind is a string identifying mutating request kind MutatingKind = "mutating" // WaitingPhase is the phase value for a request waiting in a queue WaitingPhase = "waiting" // ExecutingPhase is the phase value for an executing request ExecutingPhase = "executing" )
Variables ¶
var ( // DroppedRequests is a number of requests dropped with 'Try again later' response" DroppedRequests = compbasemetrics.NewCounterVec( &compbasemetrics.CounterOpts{ Name: "apiserver_dropped_requests_total", Help: "Number of requests dropped with 'Try again later' response", StabilityLevel: compbasemetrics.ALPHA, }, []string{"request_kind"}, ) // TLSHandshakeErrors is a number of requests dropped with 'TLS handshake error from' error TLSHandshakeErrors = compbasemetrics.NewCounter( &compbasemetrics.CounterOpts{ Name: "apiserver_tls_handshake_errors_total", Help: "Number of requests dropped with 'TLS handshake error from' error", StabilityLevel: compbasemetrics.ALPHA, }, ) // RegisteredWatchers is a number of currently registered watchers splitted by resource. RegisteredWatchers = compbasemetrics.NewGaugeVec( &compbasemetrics.GaugeOpts{ Name: "apiserver_registered_watchers", Help: "Number of currently registered watchers for a given resources", StabilityLevel: compbasemetrics.ALPHA, }, []string{"group", "version", "kind"}, ) WatchEvents = compbasemetrics.NewCounterVec( &compbasemetrics.CounterOpts{ Name: "apiserver_watch_events_total", Help: "Number of events sent in watch clients", StabilityLevel: compbasemetrics.ALPHA, }, []string{"group", "version", "kind"}, ) WatchEventsSizes = compbasemetrics.NewHistogramVec( &compbasemetrics.HistogramOpts{ Name: "apiserver_watch_events_sizes", Help: "Watch event size distribution in bytes", Buckets: compbasemetrics.ExponentialBuckets(1024, 2.0, 8), StabilityLevel: compbasemetrics.ALPHA, }, []string{"group", "version", "kind"}, ) )
* By default, all the following metrics are defined as falling under * ALPHA stability level https://github.com/kubernetes/enhancements/blob/master/keps/sig-instrumentation/20190404-kubernetes-control-plane-metrics-stability.md#stability-classes) * * Promoting the stability level of the metric is a responsibility of the component owner, since it * involves explicitly acknowledging support for the metric across multiple releases, in accordance with * the metric stability policy.
Functions ¶
func CleanScope ¶
func CleanScope(requestInfo *request.RequestInfo) string
CleanScope returns the scope of the request.
func InstrumentHandlerFunc ¶
func InstrumentHandlerFunc(verb, group, version, resource, subresource, scope, component string, deprecated bool, removedRelease string, handler http.HandlerFunc) http.HandlerFunc
InstrumentHandlerFunc works like Prometheus' InstrumentHandlerFunc but adds some Kubernetes endpoint specific information.
func InstrumentRouteFunc ¶
func InstrumentRouteFunc(verb, group, version, resource, subresource, scope, component string, deprecated bool, removedRelease string, routeFunc restful.RouteFunction) restful.RouteFunction
InstrumentRouteFunc works like Prometheus' InstrumentHandlerFunc but wraps the go-restful RouteFunction instead of a HandlerFunc plus some Kubernetes endpoint specific information.
func MonitorRequest ¶
func MonitorRequest(req *http.Request, verb, group, version, resource, subresource, scope, component string, deprecated bool, removedRelease string, contentType string, httpCode, respSize int, elapsed time.Duration)
MonitorRequest handles standard transformations for client and the reported verb and then invokes Monitor to record a request. verb must be uppercase to be backwards compatible with existing monitoring tooling.
func RecordLongRunning ¶
func RecordLongRunning(req *http.Request, requestInfo *request.RequestInfo, component string, fn func())
RecordLongRunning tracks the execution of a long running request against the API server. It provides an accurate count of the total number of open long running requests. requestInfo may be nil if the caller is not in the normal request flow.
func RecordRequestAbort ¶
func RecordRequestAbort(req *http.Request, requestInfo *request.RequestInfo)
RecordRequestAbort records that the request was aborted possibly due to a timeout.
func RecordRequestTermination ¶
func RecordRequestTermination(req *http.Request, requestInfo *request.RequestInfo, component string, code int)
RecordRequestTermination records that the request was terminated early as part of a resource preservation or apiserver self-defense mechanism (e.g. timeouts, maxinflight throttling, proxyHandler errors). RecordRequestTermination should only be called zero or one times per request.
Types ¶
type ResponseWriterDelegator ¶
type ResponseWriterDelegator struct { http.ResponseWriter // contains filtered or unexported fields }
ResponseWriterDelegator interface wraps http.ResponseWriter to additionally record content-length, status-code, etc.
func (*ResponseWriterDelegator) ContentLength ¶
func (r *ResponseWriterDelegator) ContentLength() int
func (*ResponseWriterDelegator) Status ¶
func (r *ResponseWriterDelegator) Status() int
func (*ResponseWriterDelegator) Write ¶
func (r *ResponseWriterDelegator) Write(b []byte) (int, error)
func (*ResponseWriterDelegator) WriteHeader ¶
func (r *ResponseWriterDelegator) WriteHeader(code int)