caddyprom

README

Prometheus metrics module for Caddy v2

This implements a Caddy v2 module that exposes metrics in the Prometheus format.

Usage

The simplest use could be in a Caddyfile like:

{
    order prometheus first
}

localhost

prometheus

Then, when using a Caddy server with this module enabled:

$ curl localhost/
$ curl localhost:9180/metrics
...
caddy_http_response_size_bytes_sum{code="418",method="get"} 42
...

License

The MIT License

Copyright (c) 2020 Dave Henderson

Documentation

Overview

Package caddyprom implements a metrics module for Caddy v2 that exports in the Prometheus text format.

The simplest use could be in a Caddyfile like:

{
    order prometheus first
}
localhost

prometheus

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) (err error)
  • func (m *Metrics) UnmarshalCaddyfile(d *caddyfile.Dispenser) error

Types

type Metrics

type Metrics struct {
	Addr string `json:"address,omitempty"`
	// contains filtered or unexported fields
}

Metrics -

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 -

func (Metrics) ServeHTTP

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

ServeHTTP - instrument the handler fulfils the caddyhttp.MiddlewareHandler interface

func (*Metrics) UnmarshalCaddyfile

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

UnmarshalCaddyfile -