Giter Club home page Giter Club logo

gin-prometheus's Introduction

๐Ÿ›ฐ 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

gin-prometheus's People

Contributors

hanshuaikang avatar

Stargazers

lucissfer avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.