metrics

Documentation

Overview

Copyright paskal.maksim@gmail.com Licensed under the Apache License, Version 2.0 (the "License") you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func GetHandler() http.Handler
• func LogRequest(operation string, startTime time.Time)
• type Instrumenter
  • func NewInstrumenter(subsystemIdentifier string) *Instrumenter
  • func (i *Instrumenter) InstrumentedRoundTripper() http.RoundTripper
  • func (i *Instrumenter) InstrumentedRoundTripperWithTransport(defaultTransport http.RoundTripper) http.RoundTripper

Variables

var (
	KubernetesAPIRequest = promauto.NewCounterVec(prometheus.CounterOpts{
		Namespace: namespace,
		Name:      "apiserver_request_total",
		Help:      "The total number of kunernetes API requests",
	}, []string{"cluster", "code"})

	KubernetesAPIRequestDuration = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Namespace: namespace,
		Name:      "apiserver_request_duration",
		Help:      "The duration in seconds of kunernetes API requests",
	}, []string{"cluster"})

	WebRequest = promauto.NewCounterVec(prometheus.CounterOpts{
		Namespace: namespace,
		Name:      "request_total",
		Help:      "The total number of web requests",
	}, []string{"operation"})

	WebRequestDuration = promauto.NewHistogramVec(prometheus.HistogramOpts{
		Namespace: namespace,
		Name:      "request_duration",
		Help:      "The duration in seconds of web requests",
	}, []string{"operation"})

	CacheHits = promauto.NewCounterVec(prometheus.CounterOpts{
		Namespace: namespace,
		Name:      "cache_hits_total",
		Help:      "The total number of cache hits",
	}, []string{"operation"})

	CacheAdd = promauto.NewCounter(prometheus.CounterOpts{
		Namespace: namespace,
		Name:      "cache_add_total",
		Help:      "The total number of cache adds",
	})

	CacheRemoved = promauto.NewCounter(prometheus.CounterOpts{
		Namespace: namespace,
		Name:      "cache_remove_total",
		Help:      "The total number of cache removes",
	})
)

Functions

func GetHandler

func GetHandler() http.Handler

func LogRequest

func LogRequest(operation string, startTime time.Time)

Types

type Instrumenter

type Instrumenter struct {
	PathDetectionFunc func(r *http.Request) string
	// contains filtered or unexported fields
}

func NewInstrumenter

func NewInstrumenter(subsystemIdentifier string) *Instrumenter

New creates a new Instrumenter. The subsystemIdentifier will be used as part of the metric names (e.g. http_<identifier>_requests_total).

func (*Instrumenter) InstrumentedRoundTripper

func (i *Instrumenter) InstrumentedRoundTripper() http.RoundTripper

InstrumentedRoundTripper returns an instrumented round tripper.

func (*Instrumenter) InstrumentedRoundTripperWithTransport

func (i *Instrumenter) InstrumentedRoundTripperWithTransport(defaultTransport http.RoundTripper) http.RoundTripper