Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/slok/go-http-metrics

Go modular http middleware to measure HTTP requests independent of metrics backend (with Prometheus and OpenCensus as backend implementations) and http framework/library
https://github.com/slok/go-http-metrics

echo echo-framework gin gin-framework go golang http http-metrics http-middleware instrumentation metrics middleware observability opencensus opencensus-recorder prometheus

Last synced: 3 days ago
JSON representation

Go modular http middleware to measure HTTP requests independent of metrics backend (with Prometheus and OpenCensus as backend implementations) and http framework/library

Host: GitHub
URL: https://github.com/slok/go-http-metrics
Owner: slok
License: apache-2.0
Created: 2019-03-17T09:30:53.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-12-16T11:19:18.000Z (6 days ago)
Last Synced: 2024-12-16T11:27:02.357Z (6 days ago)
Topics: echo, echo-framework, gin, gin-framework, go, golang, http, http-metrics, http-middleware, instrumentation, metrics, middleware, observability, opencensus, opencensus-recorder, prometheus
Language: Go
Homepage:
Size: 563 KB
Stars: 401
Watchers: 5
Forks: 75
Open Issues: 22
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # go-http-metrics [![Build Status][github-actions-image]][github-actions-url] [![Go Report Card][goreport-image]][goreport-url] [![GoDoc][godoc-image]][godoc-url]

go-http-metrics knows how to measure http metrics in different metric formats and Go HTTP framework/libs. The metrics measured are based on [RED] and/or [Four golden signals], follow standards and try to be measured in a efficient way.

## Table of contents

- [Metrics](#metrics)

- [Metrics recorder implementations](#metrics-recorder-implementations)

- [Framework compatibility middlewares](#framework-compatibility-middlewares)

- [Getting Started](#getting-started)

- [Prometheus query examples](#prometheus-query-examples)

- [Options](#options)

  - [Middleware Options](#middleware-options)

  - [Prometheus recorder options](#prometheus-recorder-options)

  - [OpenCensus recorder options](#opencensus-recorder-options)

- [Benchmarks](#benchmarks)

## Metrics

The metrics obtained with this middleware are the [most important ones][red] for a HTTP service.

- Records the duration of the requests(with: code, handler, method).

- Records the count of the requests(with: code, handler, method).

- Records the size of the responses(with: code, handler, method).

- Records the number requests being handled concurrently at a given time a.k.a inflight requests (with: handler).

## Metrics recorder implementations

go-http-metrics is easy to extend to different metric backends by implementing `metrics.Recorder` interface.

- [Prometheus][prometheus-recorder]

- [OpenCensus][opencensus-recorder]

## Framework compatibility middlewares

The middleware is mainly focused to be compatible with Go std library using http.Handler, but it comes with helpers to get middlewares for other frameworks or libraries.

**When `go-http-metrics` is imported as a dependency, it will only import the libraries being used, this is safe because each lib/framework is in its own package. More information [here][import-information-1] and [here][import-information-2]**

- [Alice][alice-example]

- [Chi][chi-example]

- [Echo][echo-example]

- [Fasthttp][fasthttp-example]

- [Gin][gin-example]

- [Go http.Handler][default-example]

- [Go-restful][gorestful-example]

- [Goji][goji-example]

- [Gorilla][gorilla-example]

- [Httprouter][httprouter-example]

- [Iris][iris-example]

- [Negroni][negroni-example]

It supports any framework that supports http.Handler provider type middleware `func(http.Handler) http.Handler` (e.g Chi, Alice, Gorilla...). Use [`std.HandlerProvider`][handler-provider-docs]

## Getting Started

A simple example that uses Prometheus as the recorder with the standard Go handler.

```golang

package main

import (

    "log"

    "net/http"

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

    metrics "github.com/slok/go-http-metrics/metrics/prometheus"

    "github.com/slok/go-http-metrics/middleware"

    middlewarestd "github.com/slok/go-http-metrics/middleware/std"

)

func main() {

    // Create our middleware.

    mdlw := middleware.New(middleware.Config{

        Recorder: metrics.NewRecorder(metrics.Config{}),

    })

    // Our handler.

    h := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {

        w.WriteHeader(http.StatusOK)

        w.Write([]byte("hello world!"))

    })

    h = middlewarestd.Handler("", mdlw, h)

    // Serve metrics.

    log.Printf("serving metrics at: %s", ":9090")

    go http.ListenAndServe(":9090", promhttp.Handler())

    // Serve our handler.

    log.Printf("listening at: %s", ":8080")

    if err := http.ListenAndServe(":8080", h); err != nil {

        log.Panicf("error while serving: %s", err)

    }

}

```

For more examples check the [examples]. [default][default-example] and [custom][custom-example] are the examples for Go net/http std library users.

## Prometheus query examples

Get the request rate by handler:

```text

sum(

    rate(http_request_duration_seconds_count[30s])

) by (handler)

```

Get the request error rate:

```text

rate(http_request_duration_seconds_count{code=~"5.."}[30s])

```

Get percentile 99 of the whole service:

```text

histogram_quantile(0.99,

    rate(http_request_duration_seconds_bucket[5m]))

```

Get percentile 90 of each handler:

```text

histogram_quantile(0.9,

    sum(

        rate(http_request_duration_seconds_bucket[10m])

    ) by (handler, le)

)

```

## Options

### Middleware Options

The factory options are the ones that are passed in the moment of creating the middleware factory using the `middleware.Config` object.

#### Recorder

This is the implementation of the metrics backend, by default it's a dummy recorder.

#### Service

This is an optional argument that can be used to set a specific service on all the middleware metrics, this is helpful when the service uses multiple middlewares on the same app, for example for the HTTP api server and the metrics server. This also gives the ability to use the same recorder with different middlewares.

#### GroupedStatus

Storing all the status codes could increase the cardinality of the metrics, usually this is not a common case because the used status codes by a service are not too much and are finite, but some services use a lot of different status codes, grouping the status on the `\dxx` form could impact the performance (in a good way) of the queries on Prometheus (as they are already aggregated), on the other hand it losses detail. For example the metrics code `code="401"`, `code="404"`, `code="403"` with this enabled option would end being `code="4xx"` label. By default is disabled.

#### DisableMeasureSize

This setting will disable measuring the size of the responses. By default measuring the size is enabled.

#### DisableMeasureInflight

This settings will disable measuring the number of requests being handled concurrently by the handlers.

#### IgnoredPaths

This setting is a list of paths that will not be measured for the request duration and the response size. They will still be counted in the RequestsInflight metric.

#### Custom handler ID

One of the options that you need to pass when wrapping the handler with the middleware is `handlerID`, this has 2 working ways.

- If an empty string is passed `mdwr.Handler("", h)` it will get the `handler` label from the url path. This will create very high cardnialty on the metrics because `/p/123/dashboard/1`, `/p/123/dashboard/2` and `/p/9821/dashboard/1` would have different `handler` labels. **This method is only recomended when the URLs are fixed (not dynamic or don't have parameters on the path)**.

- If a predefined handler ID is passed, `mdwr.Handler("/p/:userID/dashboard/:page", h)` this will keep cardinality low because `/p/123/dashboard/1`, `/p/123/dashboard/2` and `/p/9821/dashboard/1` would have the same `handler` label on the metrics.

There are different parameters to set up your middleware factory, you can check everything on the [docs] and see the usage in the [examples].

### Prometheus recorder options

#### Prefix

This option will make exposed metrics have a `{PREFIX}_` in fornt of the metric. For example if a regular exposed metric is `http_request_duration_seconds_count` and I use `Prefix: batman` my exposed metric will be `batman_http_request_duration_seconds_count`. By default this will be disabled or empty, but can be useful if all the metrics of the app are prefixed with the app name.

#### DurationBuckets

DurationBuckets are the buckets used for the request duration histogram metric, by default it will use Prometheus defaults, this is from 5ms to 10s, on a regular HTTP service this is very common and in most cases this default works perfect, but on some cases where the latency is very low or very high due the nature of the service, this could be changed to measure a different range of time. Example, from 500ms to 320s `Buckets: []float64{.5, 1, 2.5, 5, 10, 20, 40, 80, 160, 320}`. Is not adviced to use more than 10 buckets.

#### SizeBuckets

This works the same as the `DurationBuckets` but for the metric that measures the size of the responses. It's measured in bytes and by default goes from 1B to 1GB.

#### Registry

The Prometheus registry to use, by default it will use Prometheus global registry (the default one on Prometheus library).

#### Label names

The label names of the Prometheus metrics can be configured using `HandlerIDLabel`, `StatusCodeLabel`, `MethodLabel`...

### OpenCensus recorder options

#### DurationBuckets

Same option as the Prometheus recorder.

#### SizeBuckets

Same option as the Prometheus recorder.

#### Label names

Same options as the Prometheus recorder.

#### UnregisterViewsBeforeRegister

This Option is used to unregister the Recorder views before are being registered, this is option is mainly due to the nature of OpenCensus implementation and the huge usage fo global state making impossible to run multiple tests. On regular usage of the library this setting is very rare that needs to be used.

[github-actions-image]: https://github.com/slok/go-http-metrics/workflows/CI/badge.svg

[github-actions-url]: https://github.com/slok/go-http-metrics/actions

[goreport-image]: https://goreportcard.com/badge/github.com/slok/go-http-metrics

[goreport-url]: https://goreportcard.com/report/github.com/slok/go-http-metrics

[godoc-image]: https://pkg.go.dev/badge/github.com/slok/go-http-metrics

[godoc-url]: https://pkg.go.dev/github.com/slok/go-http-metrics

[docs]: https://godoc.org/github.com/slok/go-http-metrics

[examples]: examples/

[red]: https://www.weave.works/blog/the-red-method-key-metrics-for-microservices-architecture/

[four golden signals]: https://landing.google.com/sre/book/chapters/monitoring-distributed-systems.html#xref_monitoring_golden-signals

[default-example]: examples/default

[custom-example]: examples/custom

[negroni-example]: examples/negroni

[httprouter-example]: examples/httprouter

[iris-example]: examples/iris

[gorestful-example]: examples/gorestful

[gin-example]: examples/gin

[echo-example]: examples/echo

[goji-example]: examples/goji

[chi-example]: examples/chi

[alice-example]: examples/alice

[gorilla-example]: examples/gorilla

[prometheus-recorder]: metrics/prometheus

[opencensus-recorder]: metrics/opencensus

[handler-provider-docs]: https://pkg.go.dev/github.com/slok/go-http-metrics/middleware/std#HandlerProvider

[fasthttp-example]: examples/fasthttp

[import-information-1]: https://github.com/slok/go-http-metrics/issues/46

[import-information-2]: https://github.com/slok/go-http-metrics-imports