fiberprometheus

README

fiberprometheus

Prometheus middleware for gofiber.

Note: Requires Go 1.21 and above

Following metrics are available by default:

http_requests_total
http_request_duration_seconds
http_requests_in_progress_total
http_cache_results

Install v2

go get -u github.com/gofiber/fiber/v2
go get -u github.com/ansrivas/fiberprometheus/v2

Example using v2

package main

import (
	"github.com/ansrivas/fiberprometheus/v2"
	"github.com/gofiber/fiber/v2"
)

func main() {
  app := fiber.New()

  // This here will appear as a label, one can also use
  // fiberprometheus.NewWith(servicename, namespace, subsystem )
  // or
  // labels := map[string]string{"custom_label1":"custom_value1", "custom_label2":"custom_value2"}
  // fiberprometheus.NewWithLabels(labels, namespace, subsystem )
  prometheus := fiberprometheus.New("my-service-name")
  prometheus.RegisterAt(app, "/metrics")
  prometheus.SetSkipPaths([]string{"/ping"}) // Optional: Remove some paths from metrics
  app.Use(prometheus.Middleware)

  app.Get("/", func(c *fiber.Ctx) error {
    return c.SendString("Hello World")
  })

  app.Get("/ping", func(c *fiber.Ctx) error {
    return c.SendString("pong")
  })

  app.Post("/some", func(c *fiber.Ctx) error {
    return c.SendString("Welcome!")
  })

  app.Listen(":3000")
}

Result

• Hit the default url at http://localhost:3000
• Navigate to http://localhost:3000/metrics

Grafana Board

• https://grafana.com/grafana/dashboards/14331

Documentation

Index

• 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) CustomCacheKey(cacheHeaderKey string)
  • 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)

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) *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) CustomCacheKey

func (ps *FiberPrometheus) CustomCacheKey(cacheHeaderKey string)

CustomCacheKey allows to set a custom header key for caching By default it is set to "X-Cache", the fiber default

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