ginprom

README

📡 ginprom

Prometheus metrics exporter for Gin. Inspired by Depado/ginprom.

🔰 Installation

[!Note] Required go 1.20

go get github.com/godoes/ginprom

📝 Usage

It's easy to get started with ginprom, only a few lines of code needed.

package main

import (
    "github.com/gin-gonic/gin"
    "github.com/godoes/ginprom"
    "github.com/prometheus/client_golang/prometheus/promhttp"
)

func main() {
    r := gin.Default()
    // use prometheus metrics exporter middleware.
    //
    // ginprom.PromMiddleware() expects a ginprom.PromOpts{} pointer.
    // It is used for filtering labels by regex. `nil` will pass every requests.
    //
    // ginprom prometheus-labels: 
    //   `status`, `endpoint`, `method`
    //
    // for example:
    // 1). I don't want to record the 404 status request. That's easy for it.
    // ginprom.PromMiddleware(&ginprom.PromOpts{ExcludeRegexStatus: "404"})
    //
    // 2). And I wish to ignore endpoints started with `/prefix`.
    // ginprom.PromMiddleware(&ginprom.PromOpts{ExcludeRegexEndpoint: "^/prefix"})
    r.Use(ginprom.PromMiddleware(nil))

    // register the `/metrics` route.
    r.GET("/metrics", ginprom.PromHandler(promhttp.Handler()))

    // your working routes
    r.GET("/", func(c *gin.Context) {
        c.JSON(http.StatusOK, gin.H{"message": "home"})
     })
}

Static check

go run github.com/golangci/golangci-lint/cmd/golangci-lint@latest run

go run honnef.co/go/tools/cmd/staticcheck@latest -f stylish ./...

🎉 Metrics

Details about exposed Prometheus metrics.

Name	Type	Exposed Information
service_uptime	Counter	HTTP service uptime.
service_http_request_count_total	Counter	Total number of HTTP requests made.
service_http_request_duration_seconds	Histogram	HTTP request latencies in seconds.
service_http_request_size_bytes	Summary	HTTP request sizes in bytes.
service_http_response_size_bytes	Summary	HTTP response sizes in bytes.

📊 Grafana

Although Prometheus offers a simple dashboard, Grafana is clearly a better choice. Grafana's configuration.

📃 LICENSE

MIT license

• Copyright (c) 2022-present iTanken
• Copyright (c) 2019-2021 chenjiandongx

Documentation

Index

• Variables
• func PromHandler(handler http.Handler) gin.HandlerFunc
• func PromMiddleware(promOpts *PromOpts) gin.HandlerFunc
• type PromOpts
  • func NewDefaultOpts() *PromOpts
• type RequestLabelMappingFn

Variables

var UseChineseHelpInfo = func() (yes bool) {
	if val, ok := os.LookupEnv("GINPROM_USE_CHINESE_HELP_INFO"); ok {
		yes, _ = strconv.ParseBool(val)
	}
	return
}()

UseChineseHelpInfo control whether to use chinese help information.

Functions

func PromHandler

func PromHandler(handler http.Handler) gin.HandlerFunc

PromHandler wrappers the standard http.Handler to gin.HandlerFunc

func PromMiddleware

func PromMiddleware(promOpts *PromOpts) gin.HandlerFunc

PromMiddleware returns a gin.HandlerFunc for exporting some Web metrics

Types

type PromOpts

type PromOpts struct {
	ExcludeRegexStatus     string
	ExcludeRegexEndpoint   string
	ExcludeRegexMethod     string
	EndpointLabelMappingFn RequestLabelMappingFn
}

PromOpts represents the Prometheus middleware Options. It is used for filtering labels by regex.

func NewDefaultOpts

func NewDefaultOpts() *PromOpts

NewDefaultOpts return the default ProOpts

type RequestLabelMappingFn

type RequestLabelMappingFn func(c *gin.Context) string

RequestLabelMappingFn request label mapping function returns c.Request.URL.Path by default.