client_golang: github.com/prometheus/client_golang/prometheus/promhttp Index | Examples | Files

package promhttp

import "github.com/prometheus/client_golang/prometheus/promhttp"

Package promhttp provides tooling around HTTP servers and clients.

First, the package allows the creation of http.Handler instances to expose Prometheus metrics via HTTP. promhttp.Handler acts on the prometheus.DefaultGatherer. With HandlerFor, you can create a handler for a custom registry or anything that implements the Gatherer interface. It also allows the creation of handlers that act differently on errors or allow to log errors.

Second, the package provides tooling to instrument instances of http.Handler via middleware. Middleware wrappers follow the naming scheme InstrumentHandlerX, where X describes the intended use of the middleware. See each function's doc comment for specific details.

Finally, the package allows for an http.RoundTripper to be instrumented via middleware. Middleware wrappers follow the naming scheme InstrumentRoundTripperX, where X describes the intended use of the middleware. See each function's doc comment for specific details.

Index

Examples

Package Files

delegator.go delegator_1_8.go http.go instrument_client.go instrument_client_1_8.go instrument_server.go

func Handler Uses

func Handler() http.Handler

Handler returns an http.Handler for the prometheus.DefaultGatherer, using default HandlerOpts, i.e. it reports the first error as an HTTP error, it has no error logging, and it applies compression if requested by the client.

The returned http.Handler is already instrumented using the InstrumentMetricHandler function and the prometheus.DefaultRegisterer. If you create multiple http.Handlers by separate calls of the Handler function, the metrics used for instrumentation will be shared between them, providing global scrape counts.

This function is meant to cover the bulk of basic use cases. If you are doing anything that requires more customization (including using a non-default Gatherer, different instrumentation, and non-default HandlerOpts), use the HandlerFor function. See there for details.

func HandlerFor Uses

func HandlerFor(reg prometheus.Gatherer, opts HandlerOpts) http.Handler

HandlerFor returns an uninstrumented http.Handler for the provided Gatherer. The behavior of the Handler is defined by the provided HandlerOpts. Thus, HandlerFor is useful to create http.Handlers for custom Gatherers, with non-default HandlerOpts, and/or with custom (or no) instrumentation. Use the InstrumentMetricHandler function to apply the same kind of instrumentation as it is used by the Handler function.

func InstrumentHandlerCounter Uses

func InstrumentHandlerCounter(counter *prometheus.CounterVec, next http.Handler) http.HandlerFunc

InstrumentHandlerCounter is a middleware that wraps the provided http.Handler to observe the request result with the provided CounterVec. The CounterVec must have zero, one, or two non-const non-curried labels. For those, the only allowed label names are "code" and "method". The function panics otherwise. Partitioning of the CounterVec happens by HTTP status code and/or HTTP method if the respective instance label names are present in the CounterVec. For unpartitioned counting, use a CounterVec with zero labels.

If the wrapped Handler does not set a status code, a status code of 200 is assumed.

If the wrapped Handler panics, the Counter is not incremented.

See the example for InstrumentHandlerDuration for example usage.

func InstrumentHandlerDuration Uses

func InstrumentHandlerDuration(obs prometheus.ObserverVec, next http.Handler) http.HandlerFunc

InstrumentHandlerDuration is a middleware that wraps the provided http.Handler to observe the request duration with the provided ObserverVec. The ObserverVec must have zero, one, or two non-const non-curried labels. For those, the only allowed label names are "code" and "method". The function panics otherwise. The Observe method of the Observer in the ObserverVec is called with the request duration in seconds. Partitioning happens by HTTP status code and/or HTTP method if the respective instance label names are present in the ObserverVec. For unpartitioned observations, use an ObserverVec with zero labels. Note that partitioning of Histograms is expensive and should be used judiciously.

If the wrapped Handler does not set a status code, a status code of 200 is assumed.

If the wrapped Handler panics, no values are reported.

Note that this method is only guaranteed to never observe negative durations if used with Go1.9+.

Code:

inFlightGauge := prometheus.NewGauge(prometheus.GaugeOpts{
    Name: "in_flight_requests",
    Help: "A gauge of requests currently being served by the wrapped handler.",
})

counter := prometheus.NewCounterVec(
    prometheus.CounterOpts{
        Name: "api_requests_total",
        Help: "A counter for requests to the wrapped handler.",
    },
    []string{"code", "method"},
)

// duration is partitioned by the HTTP method and handler. It uses custom
// buckets based on the expected request duration.
duration := prometheus.NewHistogramVec(
    prometheus.HistogramOpts{
        Name:    "request_duration_seconds",
        Help:    "A histogram of latencies for requests.",
        Buckets: []float64{.25, .5, 1, 2.5, 5, 10},
    },
    []string{"handler", "method"},
)

// responseSize has no labels, making it a zero-dimensional
// ObserverVec.
responseSize := prometheus.NewHistogramVec(
    prometheus.HistogramOpts{
        Name:    "response_size_bytes",
        Help:    "A histogram of response sizes for requests.",
        Buckets: []float64{200, 500, 900, 1500},
    },
    []string{},
)

// Create the handlers that will be wrapped by the middleware.
pushHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("Push"))
})
pullHandler := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("Pull"))
})

// Register all of the metrics in the standard registry.
prometheus.MustRegister(inFlightGauge, counter, duration, responseSize)

// Instrument the handlers with all the metrics, injecting the "handler"
// label by currying.
pushChain := InstrumentHandlerInFlight(inFlightGauge,
    InstrumentHandlerDuration(duration.MustCurryWith(prometheus.Labels{"handler": "push"}),
        InstrumentHandlerCounter(counter,
            InstrumentHandlerResponseSize(responseSize, pushHandler),
        ),
    ),
)
pullChain := InstrumentHandlerInFlight(inFlightGauge,
    InstrumentHandlerDuration(duration.MustCurryWith(prometheus.Labels{"handler": "pull"}),
        InstrumentHandlerCounter(counter,
            InstrumentHandlerResponseSize(responseSize, pullHandler),
        ),
    ),
)

http.Handle("/metrics", Handler())
http.Handle("/push", pushChain)
http.Handle("/pull", pullChain)

if err := http.ListenAndServe(":3000", nil); err != nil {
    log.Fatal(err)
}

func InstrumentHandlerInFlight Uses

func InstrumentHandlerInFlight(g prometheus.Gauge, next http.Handler) http.Handler

InstrumentHandlerInFlight is a middleware that wraps the provided http.Handler. It sets the provided prometheus.Gauge to the number of requests currently handled by the wrapped http.Handler.

See the example for InstrumentHandlerDuration for example usage.

func InstrumentHandlerRequestSize Uses

func InstrumentHandlerRequestSize(obs prometheus.ObserverVec, next http.Handler) http.HandlerFunc

InstrumentHandlerRequestSize is a middleware that wraps the provided http.Handler to observe the request size with the provided ObserverVec. The ObserverVec must have zero, one, or two non-const non-curried labels. For those, the only allowed label names are "code" and "method". The function panics otherwise. The Observe method of the Observer in the ObserverVec is called with the request size in bytes. Partitioning happens by HTTP status code and/or HTTP method if the respective instance label names are present in the ObserverVec. For unpartitioned observations, use an ObserverVec with zero labels. Note that partitioning of Histograms is expensive and should be used judiciously.

If the wrapped Handler does not set a status code, a status code of 200 is assumed.

If the wrapped Handler panics, no values are reported.

See the example for InstrumentHandlerDuration for example usage.

func InstrumentHandlerResponseSize Uses

func InstrumentHandlerResponseSize(obs prometheus.ObserverVec, next http.Handler) http.Handler

InstrumentHandlerResponseSize is a middleware that wraps the provided http.Handler to observe the response size with the provided ObserverVec. The ObserverVec must have zero, one, or two non-const non-curried labels. For those, the only allowed label names are "code" and "method". The function panics otherwise. The Observe method of the Observer in the ObserverVec is called with the response size in bytes. Partitioning happens by HTTP status code and/or HTTP method if the respective instance label names are present in the ObserverVec. For unpartitioned observations, use an ObserverVec with zero labels. Note that partitioning of Histograms is expensive and should be used judiciously.

If the wrapped Handler does not set a status code, a status code of 200 is assumed.

If the wrapped Handler panics, no values are reported.

See the example for InstrumentHandlerDuration for example usage.

func InstrumentHandlerTimeToWriteHeader Uses

func InstrumentHandlerTimeToWriteHeader(obs prometheus.ObserverVec, next http.Handler) http.HandlerFunc

InstrumentHandlerTimeToWriteHeader is a middleware that wraps the provided http.Handler to observe with the provided ObserverVec the request duration until the response headers are written. The ObserverVec must have zero, one, or two non-const non-curried labels. For those, the only allowed label names are "code" and "method". The function panics otherwise. The Observe method of the Observer in the ObserverVec is called with the request duration in seconds. Partitioning happens by HTTP status code and/or HTTP method if the respective instance label names are present in the ObserverVec. For unpartitioned observations, use an ObserverVec with zero labels. Note that partitioning of Histograms is expensive and should be used judiciously.

If the wrapped Handler panics before calling WriteHeader, no value is reported.

Note that this method is only guaranteed to never observe negative durations if used with Go1.9+.

See the example for InstrumentHandlerDuration for example usage.

func InstrumentMetricHandler Uses

func InstrumentMetricHandler(reg prometheus.Registerer, handler http.Handler) http.Handler

InstrumentMetricHandler is usually used with an http.Handler returned by the HandlerFor function. It instruments the provided http.Handler with two metrics: A counter vector "promhttp_metric_handler_requests_total" to count scrapes partitioned by HTTP status code, and a gauge "promhttp_metric_handler_requests_in_flight" to track the number of simultaneous scrapes. This function idempotently registers collectors for both metrics with the provided Registerer. It panics if the registration fails. The provided metrics are useful to see how many scrapes hit the monitored target (which could be from different Prometheus servers or other scrapers), and how often they overlap (which would result in more than one scrape in flight at the same time). Note that the scrapes-in-flight gauge will contain the scrape by which it is exposed, while the scrape counter will only get incremented after the scrape is complete (as only then the status code is known). For tracking scrape durations, use the "scrape_duration_seconds" gauge created by the Prometheus server upon each scrape.

type HandlerErrorHandling Uses

type HandlerErrorHandling int

HandlerErrorHandling defines how a Handler serving metrics will handle errors.

const (
    // Serve an HTTP status code 500 upon the first error
    // encountered. Report the error message in the body.
    HTTPErrorOnError HandlerErrorHandling = iota
    // Ignore errors and try to serve as many metrics as possible.  However,
    // if no metrics can be served, serve an HTTP status code 500 and the
    // last error message in the body. Only use this in deliberate "best
    // effort" metrics collection scenarios. It is recommended to at least
    // log errors (by providing an ErrorLog in HandlerOpts) to not mask
    // errors completely.
    ContinueOnError
    // Panic upon the first error encountered (useful for "crash only" apps).
    PanicOnError
)

These constants cause handlers serving metrics to behave as described if errors are encountered.

type HandlerOpts Uses

type HandlerOpts struct {
    // ErrorLog specifies an optional logger for errors collecting and
    // serving metrics. If nil, errors are not logged at all.
    ErrorLog Logger
    // ErrorHandling defines how errors are handled. Note that errors are
    // logged regardless of the configured ErrorHandling provided ErrorLog
    // is not nil.
    ErrorHandling HandlerErrorHandling
    // If DisableCompression is true, the handler will never compress the
    // response, even if requested by the client.
    DisableCompression bool
    // The number of concurrent HTTP requests is limited to
    // MaxRequestsInFlight. Additional requests are responded to with 503
    // Service Unavailable and a suitable message in the body. If
    // MaxRequestsInFlight is 0 or negative, no limit is applied.
    MaxRequestsInFlight int
    // If handling a request takes longer than Timeout, it is responded to
    // with 503 ServiceUnavailable and a suitable Message. No timeout is
    // applied if Timeout is 0 or negative. Note that with the current
    // implementation, reaching the timeout simply ends the HTTP requests as
    // described above (and even that only if sending of the body hasn't
    // started yet), while the bulk work of gathering all the metrics keeps
    // running in the background (with the eventual result to be thrown
    // away). Until the implementation is improved, it is recommended to
    // implement a separate timeout in potentially slow Collectors.
    Timeout time.Duration
}

HandlerOpts specifies options how to serve metrics via an http.Handler. The zero value of HandlerOpts is a reasonable default.

type InstrumentTrace Uses

type InstrumentTrace struct {
    GotConn              func(float64)
    PutIdleConn          func(float64)
    GotFirstResponseByte func(float64)
    Got100Continue       func(float64)
    DNSStart             func(float64)
    DNSDone              func(float64)
    ConnectStart         func(float64)
    ConnectDone          func(float64)
    TLSHandshakeStart    func(float64)
    TLSHandshakeDone     func(float64)
    WroteHeaders         func(float64)
    Wait100Continue      func(float64)
    WroteRequest         func(float64)
}

InstrumentTrace is used to offer flexibility in instrumenting the available httptrace.ClientTrace hook functions. Each function is passed a float64 representing the time in seconds since the start of the http request. A user may choose to use separately buckets Histograms, or implement custom instance labels on a per function basis.

type Logger Uses

type Logger interface {
    Println(v ...interface{})
}

Logger is the minimal interface HandlerOpts needs for logging. Note that log.Logger from the standard library implements this interface, and it is easy to implement by custom loggers, if they don't do so already anyway.

type RoundTripperFunc Uses

type RoundTripperFunc func(req *http.Request) (*http.Response, error)

The RoundTripperFunc type is an adapter to allow the use of ordinary functions as RoundTrippers. If f is a function with the appropriate signature, RountTripperFunc(f) is a RoundTripper that calls f.

func InstrumentRoundTripperCounter Uses

func InstrumentRoundTripperCounter(counter *prometheus.CounterVec, next http.RoundTripper) RoundTripperFunc

InstrumentRoundTripperCounter is a middleware that wraps the provided http.RoundTripper to observe the request result with the provided CounterVec. The CounterVec must have zero, one, or two non-const non-curried labels. For those, the only allowed label names are "code" and "method". The function panics otherwise. Partitioning of the CounterVec happens by HTTP status code and/or HTTP method if the respective instance label names are present in the CounterVec. For unpartitioned counting, use a CounterVec with zero labels.

If the wrapped RoundTripper panics or returns a non-nil error, the Counter is not incremented.

See the example for ExampleInstrumentRoundTripperDuration for example usage.

func InstrumentRoundTripperDuration Uses

func InstrumentRoundTripperDuration(obs prometheus.ObserverVec, next http.RoundTripper) RoundTripperFunc

InstrumentRoundTripperDuration is a middleware that wraps the provided http.RoundTripper to observe the request duration with the provided ObserverVec. The ObserverVec must have zero, one, or two non-const non-curried labels. For those, the only allowed label names are "code" and "method". The function panics otherwise. The Observe method of the Observer in the ObserverVec is called with the request duration in seconds. Partitioning happens by HTTP status code and/or HTTP method if the respective instance label names are present in the ObserverVec. For unpartitioned observations, use an ObserverVec with zero labels. Note that partitioning of Histograms is expensive and should be used judiciously.

If the wrapped RoundTripper panics or returns a non-nil error, no values are reported.

Note that this method is only guaranteed to never observe negative durations if used with Go1.9+.

Code:

client := http.DefaultClient
client.Timeout = 1 * time.Second

inFlightGauge := prometheus.NewGauge(prometheus.GaugeOpts{
    Name: "client_in_flight_requests",
    Help: "A gauge of in-flight requests for the wrapped client.",
})

counter := prometheus.NewCounterVec(
    prometheus.CounterOpts{
        Name: "client_api_requests_total",
        Help: "A counter for requests from the wrapped client.",
    },
    []string{"code", "method"},
)

// dnsLatencyVec uses custom buckets based on expected dns durations.
// It has an instance label "event", which is set in the
// DNSStart and DNSDonehook functions defined in the
// InstrumentTrace struct below.
dnsLatencyVec := prometheus.NewHistogramVec(
    prometheus.HistogramOpts{
        Name:    "dns_duration_seconds",
        Help:    "Trace dns latency histogram.",
        Buckets: []float64{.005, .01, .025, .05},
    },
    []string{"event"},
)

// tlsLatencyVec uses custom buckets based on expected tls durations.
// It has an instance label "event", which is set in the
// TLSHandshakeStart and TLSHandshakeDone hook functions defined in the
// InstrumentTrace struct below.
tlsLatencyVec := prometheus.NewHistogramVec(
    prometheus.HistogramOpts{
        Name:    "tls_duration_seconds",
        Help:    "Trace tls latency histogram.",
        Buckets: []float64{.05, .1, .25, .5},
    },
    []string{"event"},
)

// histVec has no labels, making it a zero-dimensional ObserverVec.
histVec := prometheus.NewHistogramVec(
    prometheus.HistogramOpts{
        Name:    "request_duration_seconds",
        Help:    "A histogram of request latencies.",
        Buckets: prometheus.DefBuckets,
    },
    []string{},
)

// Register all of the metrics in the standard registry.
prometheus.MustRegister(counter, tlsLatencyVec, dnsLatencyVec, histVec, inFlightGauge)

// Define functions for the available httptrace.ClientTrace hook
// functions that we want to instrument.
trace := &InstrumentTrace{
    DNSStart: func(t float64) {
        dnsLatencyVec.WithLabelValues("dns_start")
    },
    DNSDone: func(t float64) {
        dnsLatencyVec.WithLabelValues("dns_done")
    },
    TLSHandshakeStart: func(t float64) {
        tlsLatencyVec.WithLabelValues("tls_handshake_start")
    },
    TLSHandshakeDone: func(t float64) {
        tlsLatencyVec.WithLabelValues("tls_handshake_done")
    },
}

// Wrap the default RoundTripper with middleware.
roundTripper := InstrumentRoundTripperInFlight(inFlightGauge,
    InstrumentRoundTripperCounter(counter,
        InstrumentRoundTripperTrace(trace,
            InstrumentRoundTripperDuration(histVec, http.DefaultTransport),
        ),
    ),
)

// Set the RoundTripper on our client.
client.Transport = roundTripper

resp, err := client.Get("http://google.com")
if err != nil {
    log.Printf("error: %v", err)
}
defer resp.Body.Close()

func InstrumentRoundTripperInFlight Uses

func InstrumentRoundTripperInFlight(gauge prometheus.Gauge, next http.RoundTripper) RoundTripperFunc

InstrumentRoundTripperInFlight is a middleware that wraps the provided http.RoundTripper. It sets the provided prometheus.Gauge to the number of requests currently handled by the wrapped http.RoundTripper.

See the example for ExampleInstrumentRoundTripperDuration for example usage.

func InstrumentRoundTripperTrace Uses

func InstrumentRoundTripperTrace(it *InstrumentTrace, next http.RoundTripper) RoundTripperFunc

InstrumentRoundTripperTrace is a middleware that wraps the provided RoundTripper and reports times to hook functions provided in the InstrumentTrace struct. Hook functions that are not present in the provided InstrumentTrace struct are ignored. Times reported to the hook functions are time since the start of the request. Only with Go1.9+, those times are guaranteed to never be negative. (Earlier Go versions are not using a monotonic clock.) Note that partitioning of Histograms is expensive and should be used judiciously.

For hook functions that receive an error as an argument, no observations are made in the event of a non-nil error value.

See the example for ExampleInstrumentRoundTripperDuration for example usage.

func (RoundTripperFunc) RoundTrip Uses

func (rt RoundTripperFunc) RoundTrip(r *http.Request) (*http.Response, error)

RoundTrip implements the RoundTripper interface.

Package promhttp imports 18 packages (graph) and is imported by 489 packages. Updated 2018-07-13. Refresh now. Tools for package owners.