README
¶
fiberprometheus
Prometheus middleware for gofiber.
Forked from ansrivas
Please feel free to open any issue with possible enhancements or bugs
Note: Requires Go 1.22 and above
Following metrics are available by default:
http_requests_total
http_request_duration_seconds
http_requests_in_progress_total
http_cache_results
Install v3
go get -u github.com/gofiber/fiber/v3
go get -u github.com/FKouhai/fiberprometheus/v3
Example using v3
package main
import (
"github.com/FKouhai/fiberprometheus/v3"
"github.com/gofiber/fiber/v3"
)
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 )
prom := prometheus.New("my-service-name")
prom.RegisterAt(&app, "/metrics")
app.Use(prom.Middleware)
app.Get("/", func(c *fiber.Ctx) error {
return c.SendString("Hello World")
})
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
Documentation
¶
Index ¶
- Constants
- func CopyString(s string) string
- func UnsafeBytes(s string) []byte
- 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
Constants ¶
const MaxStringLen = 0x7fff0000
Variables ¶
This section is empty.
Functions ¶
func CopyString ¶
func UnsafeBytes ¶
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
Source Files