Giter Club home page Giter Club logo

ginprom's Introduction

๐Ÿ“ก 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.

GrafanaDashboard

๐Ÿ“ƒ LICENSE

MIT license

ginprom's People

Contributors

chenjiandongx avatar itanken avatar dependabot[bot] avatar bwangelme avatar shanjingheng avatar

Stargazers

 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.