fiberprometheus

Documentation

Index

• Variables
• type FiberPrometheus
  • func New(serviceName string) *FiberPrometheus
  • func NewWith(serviceName, namespace, subsystem string) *FiberPrometheus
  • func NewWithLabels(labels map[string]string, namespace, subsystem string) *FiberPrometheus
  • func NewWithRegistry(registry prometheus.Registerer, serviceName, namespace, subsystem string, ...) *FiberPrometheus
  • func (ps *FiberPrometheus) Middleware(ctx *fiber.Ctx) error
  • func (ps *FiberPrometheus) RegisterAt(app fiber.Router, url string, handlers ...fiber.Handler)
  • func (ps *FiberPrometheus) SetSkipPaths(paths []string)

Variables

var DefaultBuckets = []float64{
	0.001,
	0.002,
	0.005,
	0.01,
	0.02,
	0.05,
	0.1,
	0.2,
	0.5,
	1.0,
	2.0,
	5.0,
	10.0,
	15.0,
	20.0,
	30.0,
	60.0,
}

var PreciseBuckets = []float64{
	0.000000001,
	0.000000002,
	0.000000005,
	0.00000001,
	0.00000002,
	0.00000005,
	0.0000001,
	0.0000002,
	0.0000005,
	0.000001,
	0.000002,
	0.000005,
	0.00001,
	0.00002,
	0.00005,
	0.0001,
	0.0002,
	0.0005,
	0.001,
	0.002,
	0.005,
	0.01,
	0.02,
	0.05,
	0.1,
	0.2,
	0.5,
	1.0,
	2.0,
	5.0,
	10.0,
	15.0,
	20.0,
	30.0,
}

Types

type FiberPrometheus

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

FiberPrometheus ...

func New

func New(serviceName string) *FiberPrometheus

New creates a new instance of FiberPrometheus middleware serviceName is available as a const label

func NewWith

func NewWith(serviceName, namespace, subsystem string) *FiberPrometheus

NewWith creates a new instance of FiberPrometheus middleware but with an ability to pass namespace and a custom subsystem Here serviceName is created as a constant-label for the metrics Namespace, subsystem get prefixed to the metrics.

For e.g. namespace = "my_app", subsystem = "http" then metrics would be `my_app_http_requests_total{...,service= "serviceName"}`

func NewWithLabels

func NewWithLabels(labels map[string]string, namespace, subsystem string) *FiberPrometheus

NewWithLabels creates a new instance of FiberPrometheus middleware but with an ability to pass namespace and a custom subsystem Here labels are created as a constant-labels for the metrics Namespace, subsystem get prefixed to the metrics.

For e.g. namespace = "my_app", subsystem = "http" and labels = map[string]string{"key1": "value1", "key2":"value2"} then then metrics would become `my_app_http_requests_total{...,key1= "value1", key2= "value2" }`

func NewWithRegistry

func NewWithRegistry(registry prometheus.Registerer, serviceName, namespace, subsystem string, labels map[string]string, buckets []float64) *FiberPrometheus

NewWithRegistry creates a new instance of FiberPrometheus middleware but with an ability to pass a custom registry, serviceName, namespace, subsystem and labels Here labels are created as a constant-labels for the metrics Namespace, subsystem get prefixed to the metrics.

For e.g. namespace = "my_app", subsystem = "http" and labels = map[string]string{"key1": "value1", "key2":"value2"} then then metrics would become `my_app_http_requests_total{...,key1= "value1", key2= "value2" }`

func (*FiberPrometheus) Middleware

func (ps *FiberPrometheus) Middleware(ctx *fiber.Ctx) error

Middleware is the actual default middleware implementation

func (*FiberPrometheus) RegisterAt

func (ps *FiberPrometheus) RegisterAt(app fiber.Router, url string, handlers ...fiber.Handler)

RegisterAt will register the prometheus handler at a given URL

func (*FiberPrometheus) SetSkipPaths

func (ps *FiberPrometheus) SetSkipPaths(paths []string)

SetSkipPaths allows to set the paths that should be skipped from the metrics