prommetrics

README

Metrics

This module enables prometheus metrics for Caddy.

Use

In your Caddyfile:

prometheus

For each virtual host that you want to see metrics for.

These are the (optional) parameters that can be used:

• use_caddy_addr - causes metrics to be exposed at the same address:port as Caddy itself. This can not be specified at the same time as address.
• address - the address where the metrics are exposed, the default is localhost:9180
• path - the path to serve collected metrics from, the default is /metrics
• hostname - the host parameter that can be found in the exported metrics, this defaults to the label specified for the server block

With caddyext you'll need to put this module early in the chain, so that the duration histogram actually makes sense. I've put it at number 0.

Metrics

The following metrics are exported:

• caddy_http_request_count_total{host, family, proto}
• caddy_http_request_duration_seconds{host, family, proto}
• caddy_http_response_latency_seconds{host, family, proto, status}
• caddy_http_response_size_bytes{host, family, proto, status}
• caddy_http_response_status_count_total{host, family, proto, status}

Each metric has the following labels:

• host which is the hostname used for the request/response,
• family which is the protocol family, either 1 (IP version 4) or 2 (IP version 6),
• proto which is the HTTP protocol major and minor version used: 1.x or 2 signifying HTTP/1.x or HTTP/2.

The response_* metrics have an extra label status which holds the status code.

Documentation

Index

• type Metrics
  • func (Metrics) CaddyModule() caddy.ModuleInfo
  • func (m *Metrics) Provision(ctx caddy.Context) error
  • func (m Metrics) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error
  • func (m *Metrics) UnmarshalCaddyfile(d *caddyfile.Dispenser) error
  • func (m Metrics) Validate() error

Types

type Metrics

type Metrics struct {
	// contains filtered or unexported fields
}

Metrics holds the prometheus configuration.

func (Metrics) CaddyModule

func (Metrics) CaddyModule() caddy.ModuleInfo

CaddyModule returns the Caddy module information.

func (*Metrics) Provision

func (m *Metrics) Provision(ctx caddy.Context) error

Provision implements caddy.Provisioner.

func (Metrics) ServeHTTP

func (m Metrics) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp.Handler) error

func (*Metrics) UnmarshalCaddyfile

func (m *Metrics) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

UnmarshalCaddyfile expects the following syntax:

prometheus {
	regex ^/([^/]*).*$
}

Or just:

prometheus

func (Metrics) Validate

func (m Metrics) Validate() error

Validate implements caddy.Validator.