ginprometheus

README

🛰 gin-prometheus

Prometheus metrics exporter for Gin base on OpenTelemetry.

🔰 Installation

$ go get -u github.com/hanshuaikang/gin-prometheus

📝 Usage

It's easy to get started with in-prometheus, You just need to install a middleware for your Gin project

package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
	ginprometheus "github.com/hanshuaikang/gin-prometheus"
	semconv "go.opentelemetry.io/otel/semconv/v1.25.0"
	"net/http"
)

const serviceName = "gin-prometheus-demo"

func main() {
	fmt.Println("initializing")
	r := gin.New()
	r.Use(ginprometheus.Middleware())
	r.GET("/ping", func(ctx *gin.Context) {
		ctx.JSON(http.StatusOK, gin.H{
			"message": "pong",
		})
	})
	r.Run()
}

The Prometheus service will start, you can visit http://localhost:2233/metrics at your browser

gin-prometheus supports a lot of custom configuration. the detail please look example/example.go file

🎉 Metrics

Details about exposed Prometheus metrics.

Name	Type	Exposed Information
http_server_active_requests	Counter	Number of requests inflight.
http_server_duration	Histogram	Time Taken by request
http_server_request_total	Counter	Number of Requests.
http_server_request_content_length	Histogram	HTTP request sizes in bytes.
http_server_response_content_length	Histogram	HTTP response sizes in bytes.
system_cpu_usage	Counter	CPU Usage
system_memory_usage	Counter	Memory Usage

Documentation

Index

• Variables
• func Middleware(options ...Option) gin.HandlerFunc
• type Option
  • func WithAttributes(attributes func(route string, request *http.Request) []attribute.KeyValue) Option
  • func WithGlobalAttributes(attributes []attribute.KeyValue) Option
  • func WithGroupedStatusDisabled() Option
  • func WithMetricPrefix(prefix string) Option
  • func WithPrometheusPort(port int) Option
  • func WithRecordDurationDisabled() Option
  • func WithRecordInFlightDisabled() Option
  • func WithRecordSizeDisabled() Option
  • func WithRecorder(recorder Recorder) Option
  • func WithService(serviceName string, version string) Option
  • func WithShouldRecordFunc(shouldRecord func(route string, request *http.Request) bool) Option
  • func WithSystemMetricDisabled() Option
• type Recorder
  • func NewHttpMetricsRecorder(serviceName, version, metricsPrefix string) Recorder

Variables

var DefaultAttributes = func(route string, request *http.Request) []attribute.KeyValue {
	attrs := []attribute.KeyValue{
		semconv.HTTPMethodKey.String(request.Method),
	}
	if route != "" {
		attrs = append(attrs, semconv.HTTPRouteKey.String(route))
	}
	return attrs
}

Functions

func Middleware

func Middleware(options ...Option) gin.HandlerFunc

Middleware 请求中间件

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option applies a configuration to the given config

func WithAttributes

func WithAttributes(attributes func(route string, request *http.Request) []attribute.KeyValue) Option

func WithGlobalAttributes

func WithGlobalAttributes(attributes []attribute.KeyValue) Option

func WithGroupedStatusDisabled

func WithGroupedStatusDisabled() Option

func WithMetricPrefix

func WithMetricPrefix(prefix string) Option

func WithPrometheusPort

func WithPrometheusPort(port int) Option

func WithRecordDurationDisabled

func WithRecordDurationDisabled() Option

func WithRecordInFlightDisabled

func WithRecordInFlightDisabled() Option

func WithRecordSizeDisabled

func WithRecordSizeDisabled() Option

func WithRecorder

func WithRecorder(recorder Recorder) Option

func WithService

func WithService(serviceName string, version string) Option

func WithShouldRecordFunc

func WithShouldRecordFunc(shouldRecord func(route string, request *http.Request) bool) Option

func WithSystemMetricDisabled

func WithSystemMetricDisabled() Option

type Recorder

type Recorder interface {
	// AddRequests increments the number of requests being processed.
	AddRequests(ctx context.Context, quantity int64, attributes []attribute.KeyValue)

	// ObserveHTTPRequestDuration measures the duration of an HTTP request.
	ObserveHTTPRequestDuration(ctx context.Context, duration time.Duration, attributes []attribute.KeyValue)

	// ObserveHTTPRequestSize measures the size of an HTTP request in bytes.
	ObserveHTTPRequestSize(ctx context.Context, sizeBytes int64, attributes []attribute.KeyValue)

	// ObserveHTTPResponseSize measures the size of an HTTP response in bytes.
	ObserveHTTPResponseSize(ctx context.Context, sizeBytes int64, attributes []attribute.KeyValue)

	// AddInflightRequests increments and decrements the number of inflight request being processed.
	AddInflightRequests(ctx context.Context, quantity int64, attributes []attribute.KeyValue)

	// ObserveSystemMetric measures the cpu and memory usage
	ObserveSystemMetric(ctx context.Context, attributes []attribute.KeyValue)
}

func NewHttpMetricsRecorder

func NewHttpMetricsRecorder(serviceName, version, metricsPrefix string) Recorder