mirror of
				https://github.com/openimsdk/open-im-server.git
				synced 2025-11-04 11:22:10 +08:00 
			
		
		
		
	api prommetrics
This commit is contained in:
		
							parent
							
								
									97636c4c7a
								
							
						
					
					
						commit
						1336b83142
					
				
							
								
								
									
										6
									
								
								go.mod
									
									
									
									
									
								
							
							
						
						
									
										6
									
								
								go.mod
									
									
									
									
									
								
							@ -14,7 +14,7 @@ require (
 | 
			
		||||
	github.com/lestrrat-go/file-rotatelogs v2.4.0+incompatible // indirect
 | 
			
		||||
	github.com/mitchellh/mapstructure v1.5.0
 | 
			
		||||
	github.com/openimsdk/protocol v0.0.69-alpha.24
 | 
			
		||||
	github.com/openimsdk/tools v0.0.49-alpha.39
 | 
			
		||||
	github.com/openimsdk/tools v0.0.49-alpha.41
 | 
			
		||||
	github.com/pkg/errors v0.9.1 // indirect
 | 
			
		||||
	github.com/prometheus/client_golang v1.18.0
 | 
			
		||||
	github.com/stretchr/testify v1.9.0
 | 
			
		||||
@ -176,3 +176,7 @@ require (
 | 
			
		||||
	golang.org/x/crypto v0.21.0 // indirect
 | 
			
		||||
	gopkg.in/ini.v1 v1.67.0 // indirect
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
//replace (
 | 
			
		||||
//	github.com/openimsdk/tools => /Users/chao/Desktop/withchao/tools
 | 
			
		||||
//)
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										4
									
								
								go.sum
									
									
									
									
									
								
							
							
						
						
									
										4
									
								
								go.sum
									
									
									
									
									
								
							@ -272,8 +272,8 @@ github.com/openimsdk/gomake v0.0.14-alpha.5 h1:VY9c5x515lTfmdhhPjMvR3BBRrRquAUCF
 | 
			
		||||
github.com/openimsdk/gomake v0.0.14-alpha.5/go.mod h1:PndCozNc2IsQIciyn9mvEblYWZwJmAI+06z94EY+csI=
 | 
			
		||||
github.com/openimsdk/protocol v0.0.69-alpha.24 h1:TYcNJeWOTuE40UQ54eNPdDdy0KTOh9rAOgax8lCyhDc=
 | 
			
		||||
github.com/openimsdk/protocol v0.0.69-alpha.24/go.mod h1:OZQA9FR55lseYoN2Ql1XAHYKHJGu7OMNkUbuekrKCM8=
 | 
			
		||||
github.com/openimsdk/tools v0.0.49-alpha.39 h1:bl5+q7xHsc/j1NnkN8/gYmn23RsNNbRizDY58d2EY1w=
 | 
			
		||||
github.com/openimsdk/tools v0.0.49-alpha.39/go.mod h1:zc0maZ2ohXlHd0ylY5JnCE8uqq/hslhcfcKa6iO5PCU=
 | 
			
		||||
github.com/openimsdk/tools v0.0.49-alpha.41 h1:rLnwW/yYqtuonDB61U8KB/HXj0BMP4chzF0GLgJL+Uo=
 | 
			
		||||
github.com/openimsdk/tools v0.0.49-alpha.41/go.mod h1:zc0maZ2ohXlHd0ylY5JnCE8uqq/hslhcfcKa6iO5PCU=
 | 
			
		||||
github.com/pelletier/go-toml/v2 v2.1.0 h1:FnwAJ4oYMvbT/34k9zzHuZNrhlz48GB3/s6at6/MHO4=
 | 
			
		||||
github.com/pelletier/go-toml/v2 v2.1.0/go.mod h1:tJU2Z3ZkXwnxa4DPO899bsyIoywizdUvyaeZurnPPDc=
 | 
			
		||||
github.com/pierrec/lz4/v4 v4.1.21 h1:yOVMLb6qSIDP67pl/5F7RepeKYu/VmTyEXvuMI5d9mQ=
 | 
			
		||||
 | 
			
		||||
@ -29,7 +29,6 @@ import (
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	kdisc "github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister"
 | 
			
		||||
	ginprom "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
 | 
			
		||||
	"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
 | 
			
		||||
	"github.com/openimsdk/tools/discovery"
 | 
			
		||||
	"github.com/openimsdk/tools/errs"
 | 
			
		||||
@ -72,9 +71,9 @@ func Start(ctx context.Context, index int, config *Config) error {
 | 
			
		||||
				netDone <- struct{}{}
 | 
			
		||||
				return
 | 
			
		||||
			}
 | 
			
		||||
			p := ginprom.NewPrometheus("app", prommetrics.GetGinCusMetrics("Api"))
 | 
			
		||||
			p.SetListenAddress(fmt.Sprintf(":%d", prometheusPort))
 | 
			
		||||
			if err = p.Use(router); err != nil && err != http.ErrServerClosed {
 | 
			
		||||
			srv := http.NewServeMux()
 | 
			
		||||
			srv.Handle(prommetrics.ApiPath, prommetrics.ApiHandler())
 | 
			
		||||
			if err := http.ListenAndServe(fmt.Sprintf(":%d", prometheusPort), srv); err != nil && err != http.ErrServerClosed {
 | 
			
		||||
				netErr = errs.WrapMsg(err, fmt.Sprintf("prometheus start err: %d", prometheusPort))
 | 
			
		||||
				netDone <- struct{}{}
 | 
			
		||||
			}
 | 
			
		||||
 | 
			
		||||
@ -2,8 +2,10 @@ package api
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"strings"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/gin-gonic/gin"
 | 
			
		||||
	"github.com/gin-gonic/gin/binding"
 | 
			
		||||
@ -19,6 +21,22 @@ import (
 | 
			
		||||
	"google.golang.org/grpc/credentials/insecure"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func prommetricsGin() gin.HandlerFunc {
 | 
			
		||||
	return func(c *gin.Context) {
 | 
			
		||||
		start := time.Now()
 | 
			
		||||
		c.Next()
 | 
			
		||||
		path := c.FullPath()
 | 
			
		||||
		prommetrics.HttpCall(path, c.Request.Method, c.Writer.Status(), time.Since(start))
 | 
			
		||||
		if c.Request.Method == http.MethodPost {
 | 
			
		||||
			if resp := apiresp.GetGinApiResponse(c); resp == nil {
 | 
			
		||||
				prommetrics.APICall(path, -1, "NO_GIN_RESPONSE_FOUND")
 | 
			
		||||
			} else {
 | 
			
		||||
				prommetrics.APICall(path, resp.ErrCode, resp.ErrMsg)
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func newGinRouter(disCov discovery.SvcDiscoveryRegistry, config *Config) *gin.Engine {
 | 
			
		||||
	disCov.AddOption(mw.GrpcClient(), grpc.WithTransportCredentials(insecure.NewCredentials()),
 | 
			
		||||
		grpc.WithDefaultServiceConfig(fmt.Sprintf(`{"LoadBalancingPolicy": "%s"}`, "round_robin")))
 | 
			
		||||
@ -37,7 +55,7 @@ func newGinRouter(disCov discovery.SvcDiscoveryRegistry, config *Config) *gin.En
 | 
			
		||||
	authRpc := rpcclient.NewAuth(disCov, config.Share.RpcRegisterName.Auth)
 | 
			
		||||
	thirdRpc := rpcclient.NewThird(disCov, config.Share.RpcRegisterName.Third, config.API.Prometheus.GrafanaURL)
 | 
			
		||||
 | 
			
		||||
	r.Use(gin.Recovery(), mw.CorsHandler(), mw.GinParseOperationID(), GinParseToken(authRpc))
 | 
			
		||||
	r.Use(prommetricsGin(), gin.Recovery(), mw.CorsHandler(), mw.GinParseOperationID(), GinParseToken(authRpc))
 | 
			
		||||
	u := NewUserApi(*userRpc)
 | 
			
		||||
	m := NewMessageApi(messageRpc, userRpc, config.Share.IMAdminUserID)
 | 
			
		||||
	userRouterGroup := r.Group("/user")
 | 
			
		||||
 | 
			
		||||
@ -14,430 +14,431 @@
 | 
			
		||||
 | 
			
		||||
package ginprometheus
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"bytes"
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"io"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"os"
 | 
			
		||||
	"strconv"
 | 
			
		||||
	"time"
 | 
			
		||||
 | 
			
		||||
	"github.com/gin-gonic/gin"
 | 
			
		||||
	"github.com/prometheus/client_golang/prometheus"
 | 
			
		||||
	"github.com/prometheus/client_golang/prometheus/promhttp"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var defaultMetricPath = "/metrics"
 | 
			
		||||
 | 
			
		||||
// counter, counter_vec, gauge, gauge_vec,
 | 
			
		||||
// histogram, histogram_vec, summary, summary_vec.
 | 
			
		||||
var (
 | 
			
		||||
	reqCounter = &Metric{
 | 
			
		||||
		ID:          "reqCnt",
 | 
			
		||||
		Name:        "requests_total",
 | 
			
		||||
		Description: "How many HTTP requests processed, partitioned by status code and HTTP method.",
 | 
			
		||||
		Type:        "counter_vec",
 | 
			
		||||
		Args:        []string{"code", "method", "handler", "host", "url"}}
 | 
			
		||||
 | 
			
		||||
	reqDuration = &Metric{
 | 
			
		||||
		ID:          "reqDur",
 | 
			
		||||
		Name:        "request_duration_seconds",
 | 
			
		||||
		Description: "The HTTP request latencies in seconds.",
 | 
			
		||||
		Type:        "histogram_vec",
 | 
			
		||||
		Args:        []string{"code", "method", "url"},
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	resSize = &Metric{
 | 
			
		||||
		ID:          "resSz",
 | 
			
		||||
		Name:        "response_size_bytes",
 | 
			
		||||
		Description: "The HTTP response sizes in bytes.",
 | 
			
		||||
		Type:        "summary"}
 | 
			
		||||
 | 
			
		||||
	reqSize = &Metric{
 | 
			
		||||
		ID:          "reqSz",
 | 
			
		||||
		Name:        "request_size_bytes",
 | 
			
		||||
		Description: "The HTTP request sizes in bytes.",
 | 
			
		||||
		Type:        "summary"}
 | 
			
		||||
 | 
			
		||||
	standardMetrics = []*Metric{
 | 
			
		||||
		reqCounter,
 | 
			
		||||
		reqDuration,
 | 
			
		||||
		resSize,
 | 
			
		||||
		reqSize,
 | 
			
		||||
	}
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
RequestCounterURLLabelMappingFn is a function which can be supplied to the middleware to control
 | 
			
		||||
the cardinality of the request counter's "url" label, which might be required in some contexts.
 | 
			
		||||
For instance, if for a "/customer/:name" route you don't want to generate a time series for every
 | 
			
		||||
possible customer name, you could use this function:
 | 
			
		||||
 | 
			
		||||
	func(c *gin.Context) string {
 | 
			
		||||
		url := c.Request.URL.Path
 | 
			
		||||
		for _, p := range c.Params {
 | 
			
		||||
			if p.Key == "name" {
 | 
			
		||||
				url = strings.Replace(url, p.Value, ":name", 1)
 | 
			
		||||
				break
 | 
			
		||||
			}
 | 
			
		||||
		}
 | 
			
		||||
		return url
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
which would map "/customer/alice" and "/customer/bob" to their template "/customer/:name".
 | 
			
		||||
*/
 | 
			
		||||
type RequestCounterURLLabelMappingFn func(c *gin.Context) string
 | 
			
		||||
 | 
			
		||||
// Metric is a definition for the name, description, type, ID, and
 | 
			
		||||
// prometheus.Collector type (i.e. CounterVec, Summary, etc) of each metric.
 | 
			
		||||
type Metric struct {
 | 
			
		||||
	MetricCollector prometheus.Collector
 | 
			
		||||
	ID              string
 | 
			
		||||
	Name            string
 | 
			
		||||
	Description     string
 | 
			
		||||
	Type            string
 | 
			
		||||
	Args            []string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Prometheus contains the metrics gathered by the instance and its path.
 | 
			
		||||
type Prometheus struct {
 | 
			
		||||
	reqCnt        *prometheus.CounterVec
 | 
			
		||||
	reqDur        *prometheus.HistogramVec
 | 
			
		||||
	reqSz, resSz  prometheus.Summary
 | 
			
		||||
	router        *gin.Engine
 | 
			
		||||
	listenAddress string
 | 
			
		||||
	Ppg           PrometheusPushGateway
 | 
			
		||||
 | 
			
		||||
	MetricsList []*Metric
 | 
			
		||||
	MetricsPath string
 | 
			
		||||
 | 
			
		||||
	ReqCntURLLabelMappingFn RequestCounterURLLabelMappingFn
 | 
			
		||||
 | 
			
		||||
	// gin.Context string to use as a prometheus URL label
 | 
			
		||||
	URLLabelFromContext string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// PrometheusPushGateway contains the configuration for pushing to a Prometheus pushgateway (optional).
 | 
			
		||||
type PrometheusPushGateway struct {
 | 
			
		||||
 | 
			
		||||
	// Push interval in seconds
 | 
			
		||||
	PushIntervalSeconds time.Duration
 | 
			
		||||
 | 
			
		||||
	// Push Gateway URL in format http://domain:port
 | 
			
		||||
	// where JOBNAME can be any string of your choice
 | 
			
		||||
	PushGatewayURL string
 | 
			
		||||
 | 
			
		||||
	// Local metrics URL where metrics are fetched from, this could be omitted in the future
 | 
			
		||||
	// if implemented using prometheus common/expfmt instead
 | 
			
		||||
	MetricsURL string
 | 
			
		||||
 | 
			
		||||
	// pushgateway job name, defaults to "gin"
 | 
			
		||||
	Job string
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewPrometheus generates a new set of metrics with a certain subsystem name.
 | 
			
		||||
func NewPrometheus(subsystem string, customMetricsList ...[]*Metric) *Prometheus {
 | 
			
		||||
	if subsystem == "" {
 | 
			
		||||
		subsystem = "app"
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	var metricsList []*Metric
 | 
			
		||||
 | 
			
		||||
	if len(customMetricsList) > 1 {
 | 
			
		||||
		panic("Too many args. NewPrometheus( string, <optional []*Metric> ).")
 | 
			
		||||
	} else if len(customMetricsList) == 1 {
 | 
			
		||||
		metricsList = customMetricsList[0]
 | 
			
		||||
	}
 | 
			
		||||
	metricsList = append(metricsList, standardMetrics...)
 | 
			
		||||
 | 
			
		||||
	p := &Prometheus{
 | 
			
		||||
		MetricsList: metricsList,
 | 
			
		||||
		MetricsPath: defaultMetricPath,
 | 
			
		||||
		ReqCntURLLabelMappingFn: func(c *gin.Context) string {
 | 
			
		||||
			return c.FullPath() // e.g. /user/:id , /user/:id/info
 | 
			
		||||
		},
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	p.registerMetrics(subsystem)
 | 
			
		||||
 | 
			
		||||
	return p
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetPushGateway sends metrics to a remote pushgateway exposed on pushGatewayURL
 | 
			
		||||
// every pushIntervalSeconds. Metrics are fetched from metricsURL.
 | 
			
		||||
func (p *Prometheus) SetPushGateway(pushGatewayURL, metricsURL string, pushIntervalSeconds time.Duration) {
 | 
			
		||||
	p.Ppg.PushGatewayURL = pushGatewayURL
 | 
			
		||||
	p.Ppg.MetricsURL = metricsURL
 | 
			
		||||
	p.Ppg.PushIntervalSeconds = pushIntervalSeconds
 | 
			
		||||
	p.startPushTicker()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetPushGatewayJob job name, defaults to "gin".
 | 
			
		||||
func (p *Prometheus) SetPushGatewayJob(j string) {
 | 
			
		||||
	p.Ppg.Job = j
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetListenAddress for exposing metrics on address. If not set, it will be exposed at the
 | 
			
		||||
// same address of the gin engine that is being used.
 | 
			
		||||
func (p *Prometheus) SetListenAddress(address string) {
 | 
			
		||||
	p.listenAddress = address
 | 
			
		||||
	if p.listenAddress != "" {
 | 
			
		||||
		p.router = gin.Default()
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetListenAddressWithRouter for using a separate router to expose metrics. (this keeps things like GET /metrics out of
 | 
			
		||||
// your content's access log).
 | 
			
		||||
func (p *Prometheus) SetListenAddressWithRouter(listenAddress string, r *gin.Engine) {
 | 
			
		||||
	p.listenAddress = listenAddress
 | 
			
		||||
	if len(p.listenAddress) > 0 {
 | 
			
		||||
		p.router = r
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetMetricsPath set metrics paths.
 | 
			
		||||
func (p *Prometheus) SetMetricsPath(e *gin.Engine) error {
 | 
			
		||||
 | 
			
		||||
	if p.listenAddress != "" {
 | 
			
		||||
		p.router.GET(p.MetricsPath, prometheusHandler())
 | 
			
		||||
		return p.runServer()
 | 
			
		||||
	} else {
 | 
			
		||||
		e.GET(p.MetricsPath, prometheusHandler())
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// SetMetricsPathWithAuth set metrics paths with authentication.
 | 
			
		||||
func (p *Prometheus) SetMetricsPathWithAuth(e *gin.Engine, accounts gin.Accounts) error {
 | 
			
		||||
 | 
			
		||||
	if p.listenAddress != "" {
 | 
			
		||||
		p.router.GET(p.MetricsPath, gin.BasicAuth(accounts), prometheusHandler())
 | 
			
		||||
		return p.runServer()
 | 
			
		||||
	} else {
 | 
			
		||||
		e.GET(p.MetricsPath, gin.BasicAuth(accounts), prometheusHandler())
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (p *Prometheus) runServer() error {
 | 
			
		||||
	return p.router.Run(p.listenAddress)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (p *Prometheus) getMetrics() []byte {
 | 
			
		||||
	response, err := http.Get(p.Ppg.MetricsURL)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return nil
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	defer response.Body.Close()
 | 
			
		||||
 | 
			
		||||
	body, _ := io.ReadAll(response.Body)
 | 
			
		||||
	return body
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
var hostname, _ = os.Hostname()
 | 
			
		||||
 | 
			
		||||
func (p *Prometheus) getPushGatewayURL() string {
 | 
			
		||||
	if p.Ppg.Job == "" {
 | 
			
		||||
		p.Ppg.Job = "gin"
 | 
			
		||||
	}
 | 
			
		||||
	return p.Ppg.PushGatewayURL + "/metrics/job/" + p.Ppg.Job + "/instance/" + hostname
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (p *Prometheus) sendMetricsToPushGateway(metrics []byte) {
 | 
			
		||||
	req, err := http.NewRequest("POST", p.getPushGatewayURL(), bytes.NewBuffer(metrics))
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		return
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	client := &http.Client{}
 | 
			
		||||
	resp, err := client.Do(req)
 | 
			
		||||
	if err != nil {
 | 
			
		||||
		fmt.Println("Error sending to push gateway error:", err.Error())
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	resp.Body.Close()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (p *Prometheus) startPushTicker() {
 | 
			
		||||
	ticker := time.NewTicker(time.Second * p.Ppg.PushIntervalSeconds)
 | 
			
		||||
	go func() {
 | 
			
		||||
		for range ticker.C {
 | 
			
		||||
			p.sendMetricsToPushGateway(p.getMetrics())
 | 
			
		||||
		}
 | 
			
		||||
	}()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// NewMetric associates prometheus.Collector based on Metric.Type.
 | 
			
		||||
func NewMetric(m *Metric, subsystem string) prometheus.Collector {
 | 
			
		||||
	var metric prometheus.Collector
 | 
			
		||||
	switch m.Type {
 | 
			
		||||
	case "counter_vec":
 | 
			
		||||
		metric = prometheus.NewCounterVec(
 | 
			
		||||
			prometheus.CounterOpts{
 | 
			
		||||
				Subsystem: subsystem,
 | 
			
		||||
				Name:      m.Name,
 | 
			
		||||
				Help:      m.Description,
 | 
			
		||||
			},
 | 
			
		||||
			m.Args,
 | 
			
		||||
		)
 | 
			
		||||
	case "counter":
 | 
			
		||||
		metric = prometheus.NewCounter(
 | 
			
		||||
			prometheus.CounterOpts{
 | 
			
		||||
				Subsystem: subsystem,
 | 
			
		||||
				Name:      m.Name,
 | 
			
		||||
				Help:      m.Description,
 | 
			
		||||
			},
 | 
			
		||||
		)
 | 
			
		||||
	case "gauge_vec":
 | 
			
		||||
		metric = prometheus.NewGaugeVec(
 | 
			
		||||
			prometheus.GaugeOpts{
 | 
			
		||||
				Subsystem: subsystem,
 | 
			
		||||
				Name:      m.Name,
 | 
			
		||||
				Help:      m.Description,
 | 
			
		||||
			},
 | 
			
		||||
			m.Args,
 | 
			
		||||
		)
 | 
			
		||||
	case "gauge":
 | 
			
		||||
		metric = prometheus.NewGauge(
 | 
			
		||||
			prometheus.GaugeOpts{
 | 
			
		||||
				Subsystem: subsystem,
 | 
			
		||||
				Name:      m.Name,
 | 
			
		||||
				Help:      m.Description,
 | 
			
		||||
			},
 | 
			
		||||
		)
 | 
			
		||||
	case "histogram_vec":
 | 
			
		||||
		metric = prometheus.NewHistogramVec(
 | 
			
		||||
			prometheus.HistogramOpts{
 | 
			
		||||
				Subsystem: subsystem,
 | 
			
		||||
				Name:      m.Name,
 | 
			
		||||
				Help:      m.Description,
 | 
			
		||||
			},
 | 
			
		||||
			m.Args,
 | 
			
		||||
		)
 | 
			
		||||
	case "histogram":
 | 
			
		||||
		metric = prometheus.NewHistogram(
 | 
			
		||||
			prometheus.HistogramOpts{
 | 
			
		||||
				Subsystem: subsystem,
 | 
			
		||||
				Name:      m.Name,
 | 
			
		||||
				Help:      m.Description,
 | 
			
		||||
			},
 | 
			
		||||
		)
 | 
			
		||||
	case "summary_vec":
 | 
			
		||||
		metric = prometheus.NewSummaryVec(
 | 
			
		||||
			prometheus.SummaryOpts{
 | 
			
		||||
				Subsystem: subsystem,
 | 
			
		||||
				Name:      m.Name,
 | 
			
		||||
				Help:      m.Description,
 | 
			
		||||
			},
 | 
			
		||||
			m.Args,
 | 
			
		||||
		)
 | 
			
		||||
	case "summary":
 | 
			
		||||
		metric = prometheus.NewSummary(
 | 
			
		||||
			prometheus.SummaryOpts{
 | 
			
		||||
				Subsystem: subsystem,
 | 
			
		||||
				Name:      m.Name,
 | 
			
		||||
				Help:      m.Description,
 | 
			
		||||
			},
 | 
			
		||||
		)
 | 
			
		||||
	}
 | 
			
		||||
	return metric
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func (p *Prometheus) registerMetrics(subsystem string) {
 | 
			
		||||
	for _, metricDef := range p.MetricsList {
 | 
			
		||||
		metric := NewMetric(metricDef, subsystem)
 | 
			
		||||
		if err := prometheus.Register(metric); err != nil {
 | 
			
		||||
			fmt.Println("could not be registered in Prometheus,metricDef.Name:", metricDef.Name, "   error:", err.Error())
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		switch metricDef {
 | 
			
		||||
		case reqCounter:
 | 
			
		||||
			p.reqCnt = metric.(*prometheus.CounterVec)
 | 
			
		||||
		case reqDuration:
 | 
			
		||||
			p.reqDur = metric.(*prometheus.HistogramVec)
 | 
			
		||||
		case resSize:
 | 
			
		||||
			p.resSz = metric.(prometheus.Summary)
 | 
			
		||||
		case reqSize:
 | 
			
		||||
			p.reqSz = metric.(prometheus.Summary)
 | 
			
		||||
		}
 | 
			
		||||
		metricDef.MetricCollector = metric
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Use adds the middleware to a gin engine.
 | 
			
		||||
func (p *Prometheus) Use(e *gin.Engine) error {
 | 
			
		||||
	e.Use(p.HandlerFunc())
 | 
			
		||||
	return p.SetMetricsPath(e)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// UseWithAuth adds the middleware to a gin engine with BasicAuth.
 | 
			
		||||
func (p *Prometheus) UseWithAuth(e *gin.Engine, accounts gin.Accounts) error {
 | 
			
		||||
	e.Use(p.HandlerFunc())
 | 
			
		||||
	return p.SetMetricsPathWithAuth(e, accounts)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// HandlerFunc defines handler function for middleware.
 | 
			
		||||
func (p *Prometheus) HandlerFunc() gin.HandlerFunc {
 | 
			
		||||
	return func(c *gin.Context) {
 | 
			
		||||
		if c.Request.URL.Path == p.MetricsPath {
 | 
			
		||||
			c.Next()
 | 
			
		||||
			return
 | 
			
		||||
		}
 | 
			
		||||
 | 
			
		||||
		start := time.Now()
 | 
			
		||||
		reqSz := computeApproximateRequestSize(c.Request)
 | 
			
		||||
 | 
			
		||||
		c.Next()
 | 
			
		||||
 | 
			
		||||
		status := strconv.Itoa(c.Writer.Status())
 | 
			
		||||
		elapsed := float64(time.Since(start)) / float64(time.Second)
 | 
			
		||||
		resSz := float64(c.Writer.Size())
 | 
			
		||||
 | 
			
		||||
		url := p.ReqCntURLLabelMappingFn(c)
 | 
			
		||||
		if len(p.URLLabelFromContext) > 0 {
 | 
			
		||||
			u, found := c.Get(p.URLLabelFromContext)
 | 
			
		||||
			if !found {
 | 
			
		||||
				u = "unknown"
 | 
			
		||||
			}
 | 
			
		||||
			url = u.(string)
 | 
			
		||||
		}
 | 
			
		||||
		p.reqDur.WithLabelValues(status, c.Request.Method, url).Observe(elapsed)
 | 
			
		||||
		p.reqCnt.WithLabelValues(status, c.Request.Method, c.HandlerName(), c.Request.Host, url).Inc()
 | 
			
		||||
		p.reqSz.Observe(float64(reqSz))
 | 
			
		||||
		p.resSz.Observe(resSz)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func prometheusHandler() gin.HandlerFunc {
 | 
			
		||||
	h := promhttp.Handler()
 | 
			
		||||
	return func(c *gin.Context) {
 | 
			
		||||
		h.ServeHTTP(c.Writer, c.Request)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func computeApproximateRequestSize(r *http.Request) int {
 | 
			
		||||
	var s int
 | 
			
		||||
	if r.URL != nil {
 | 
			
		||||
		s = len(r.URL.Path)
 | 
			
		||||
	}
 | 
			
		||||
 | 
			
		||||
	s += len(r.Method)
 | 
			
		||||
	s += len(r.Proto)
 | 
			
		||||
	for name, values := range r.Header {
 | 
			
		||||
		s += len(name)
 | 
			
		||||
		for _, value := range values {
 | 
			
		||||
			s += len(value)
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	s += len(r.Host)
 | 
			
		||||
 | 
			
		||||
	// r.FormData and r.MultipartForm are assumed to be included in r.URL.
 | 
			
		||||
 | 
			
		||||
	if r.ContentLength != -1 {
 | 
			
		||||
		s += int(r.ContentLength)
 | 
			
		||||
	}
 | 
			
		||||
	return s
 | 
			
		||||
}
 | 
			
		||||
//
 | 
			
		||||
//import (
 | 
			
		||||
//	"bytes"
 | 
			
		||||
//	"fmt"
 | 
			
		||||
//	"io"
 | 
			
		||||
//	"net/http"
 | 
			
		||||
//	"os"
 | 
			
		||||
//	"strconv"
 | 
			
		||||
//	"time"
 | 
			
		||||
//
 | 
			
		||||
//	"github.com/gin-gonic/gin"
 | 
			
		||||
//	"github.com/prometheus/client_golang/prometheus"
 | 
			
		||||
//	"github.com/prometheus/client_golang/prometheus/promhttp"
 | 
			
		||||
//)
 | 
			
		||||
//
 | 
			
		||||
//var defaultMetricPath = "/metrics"
 | 
			
		||||
//
 | 
			
		||||
//// counter, counter_vec, gauge, gauge_vec,
 | 
			
		||||
//// histogram, histogram_vec, summary, summary_vec.
 | 
			
		||||
//var (
 | 
			
		||||
//	reqCounter = &Metric{
 | 
			
		||||
//		ID:          "reqCnt",
 | 
			
		||||
//		Name:        "requests_total",
 | 
			
		||||
//		Description: "How many HTTP requests processed, partitioned by status code and HTTP method.",
 | 
			
		||||
//		Type:        "counter_vec",
 | 
			
		||||
//		Args:        []string{"code", "method", "handler", "host", "url"}}
 | 
			
		||||
//
 | 
			
		||||
//	reqDuration = &Metric{
 | 
			
		||||
//		ID:          "reqDur",
 | 
			
		||||
//		Name:        "request_duration_seconds",
 | 
			
		||||
//		Description: "The HTTP request latencies in seconds.",
 | 
			
		||||
//		Type:        "histogram_vec",
 | 
			
		||||
//		Args:        []string{"code", "method", "url"},
 | 
			
		||||
//	}
 | 
			
		||||
//
 | 
			
		||||
//	resSize = &Metric{
 | 
			
		||||
//		ID:          "resSz",
 | 
			
		||||
//		Name:        "response_size_bytes",
 | 
			
		||||
//		Description: "The HTTP response sizes in bytes.",
 | 
			
		||||
//		Type:        "summary"}
 | 
			
		||||
//
 | 
			
		||||
//	reqSize = &Metric{
 | 
			
		||||
//		ID:          "reqSz",
 | 
			
		||||
//		Name:        "request_size_bytes",
 | 
			
		||||
//		Description: "The HTTP request sizes in bytes.",
 | 
			
		||||
//		Type:        "summary"}
 | 
			
		||||
//
 | 
			
		||||
//	standardMetrics = []*Metric{
 | 
			
		||||
//		reqCounter,
 | 
			
		||||
//		reqDuration,
 | 
			
		||||
//		resSize,
 | 
			
		||||
//		reqSize,
 | 
			
		||||
//	}
 | 
			
		||||
//)
 | 
			
		||||
//
 | 
			
		||||
///*
 | 
			
		||||
//RequestCounterURLLabelMappingFn is a function which can be supplied to the middleware to control
 | 
			
		||||
//the cardinality of the request counter's "url" label, which might be required in some contexts.
 | 
			
		||||
//For instance, if for a "/customer/:name" route you don't want to generate a time series for every
 | 
			
		||||
//possible customer name, you could use this function:
 | 
			
		||||
//
 | 
			
		||||
//	func(c *gin.Context) string {
 | 
			
		||||
//		url := c.Request.URL.Path
 | 
			
		||||
//		for _, p := range c.Params {
 | 
			
		||||
//			if p.Key == "name" {
 | 
			
		||||
//				url = strings.Replace(url, p.Value, ":name", 1)
 | 
			
		||||
//				break
 | 
			
		||||
//			}
 | 
			
		||||
//		}
 | 
			
		||||
//		return url
 | 
			
		||||
//	}
 | 
			
		||||
//
 | 
			
		||||
//which would map "/customer/alice" and "/customer/bob" to their template "/customer/:name".
 | 
			
		||||
//*/
 | 
			
		||||
//type RequestCounterURLLabelMappingFn func(c *gin.Context) string
 | 
			
		||||
//
 | 
			
		||||
//// Metric is a definition for the name, description, type, ID, and
 | 
			
		||||
//// prometheus.Collector type (i.e. CounterVec, Summary, etc) of each metric.
 | 
			
		||||
//type Metric struct {
 | 
			
		||||
//	MetricCollector prometheus.Collector
 | 
			
		||||
//	ID              string
 | 
			
		||||
//	Name            string
 | 
			
		||||
//	Description     string
 | 
			
		||||
//	Type            string
 | 
			
		||||
//	Args            []string
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// Prometheus contains the metrics gathered by the instance and its path.
 | 
			
		||||
//type Prometheus struct {
 | 
			
		||||
//	reqCnt        *prometheus.CounterVec
 | 
			
		||||
//	reqDur        *prometheus.HistogramVec
 | 
			
		||||
//	reqSz, resSz  prometheus.Summary
 | 
			
		||||
//	router        *gin.Engine
 | 
			
		||||
//	listenAddress string
 | 
			
		||||
//	Ppg           PrometheusPushGateway
 | 
			
		||||
//
 | 
			
		||||
//	MetricsList []*Metric
 | 
			
		||||
//	MetricsPath string
 | 
			
		||||
//
 | 
			
		||||
//	ReqCntURLLabelMappingFn RequestCounterURLLabelMappingFn
 | 
			
		||||
//
 | 
			
		||||
//	// gin.Context string to use as a prometheus URL label
 | 
			
		||||
//	URLLabelFromContext string
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// PrometheusPushGateway contains the configuration for pushing to a Prometheus pushgateway (optional).
 | 
			
		||||
//type PrometheusPushGateway struct {
 | 
			
		||||
//
 | 
			
		||||
//	// Push interval in seconds
 | 
			
		||||
//	PushIntervalSeconds time.Duration
 | 
			
		||||
//
 | 
			
		||||
//	// Push Gateway URL in format http://domain:port
 | 
			
		||||
//	// where JOBNAME can be any string of your choice
 | 
			
		||||
//	PushGatewayURL string
 | 
			
		||||
//
 | 
			
		||||
//	// Local metrics URL where metrics are fetched from, this could be omitted in the future
 | 
			
		||||
//	// if implemented using prometheus common/expfmt instead
 | 
			
		||||
//	MetricsURL string
 | 
			
		||||
//
 | 
			
		||||
//	// pushgateway job name, defaults to "gin"
 | 
			
		||||
//	Job string
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// NewPrometheus generates a new set of metrics with a certain subsystem name.
 | 
			
		||||
//func NewPrometheus(subsystem string, customMetricsList ...[]*Metric) *Prometheus {
 | 
			
		||||
//	if subsystem == "" {
 | 
			
		||||
//		subsystem = "app"
 | 
			
		||||
//	}
 | 
			
		||||
//
 | 
			
		||||
//	var metricsList []*Metric
 | 
			
		||||
//
 | 
			
		||||
//	if len(customMetricsList) > 1 {
 | 
			
		||||
//		panic("Too many args. NewPrometheus( string, <optional []*Metric> ).")
 | 
			
		||||
//	} else if len(customMetricsList) == 1 {
 | 
			
		||||
//		metricsList = customMetricsList[0]
 | 
			
		||||
//	}
 | 
			
		||||
//	metricsList = append(metricsList, standardMetrics...)
 | 
			
		||||
//
 | 
			
		||||
//	p := &Prometheus{
 | 
			
		||||
//		MetricsList: metricsList,
 | 
			
		||||
//		MetricsPath: defaultMetricPath,
 | 
			
		||||
//		ReqCntURLLabelMappingFn: func(c *gin.Context) string {
 | 
			
		||||
//			return c.FullPath() // e.g. /user/:id , /user/:id/info
 | 
			
		||||
//		},
 | 
			
		||||
//	}
 | 
			
		||||
//
 | 
			
		||||
//	p.registerMetrics(subsystem)
 | 
			
		||||
//
 | 
			
		||||
//	return p
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// SetPushGateway sends metrics to a remote pushgateway exposed on pushGatewayURL
 | 
			
		||||
//// every pushIntervalSeconds. Metrics are fetched from metricsURL.
 | 
			
		||||
//func (p *Prometheus) SetPushGateway(pushGatewayURL, metricsURL string, pushIntervalSeconds time.Duration) {
 | 
			
		||||
//	p.Ppg.PushGatewayURL = pushGatewayURL
 | 
			
		||||
//	p.Ppg.MetricsURL = metricsURL
 | 
			
		||||
//	p.Ppg.PushIntervalSeconds = pushIntervalSeconds
 | 
			
		||||
//	p.startPushTicker()
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// SetPushGatewayJob job name, defaults to "gin".
 | 
			
		||||
//func (p *Prometheus) SetPushGatewayJob(j string) {
 | 
			
		||||
//	p.Ppg.Job = j
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// SetListenAddress for exposing metrics on address. If not set, it will be exposed at the
 | 
			
		||||
//// same address of the gin engine that is being used.
 | 
			
		||||
//func (p *Prometheus) SetListenAddress(address string) {
 | 
			
		||||
//	p.listenAddress = address
 | 
			
		||||
//	if p.listenAddress != "" {
 | 
			
		||||
//		p.router = gin.Default()
 | 
			
		||||
//	}
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// SetListenAddressWithRouter for using a separate router to expose metrics. (this keeps things like GET /metrics out of
 | 
			
		||||
//// your content's access log).
 | 
			
		||||
//func (p *Prometheus) SetListenAddressWithRouter(listenAddress string, r *gin.Engine) {
 | 
			
		||||
//	p.listenAddress = listenAddress
 | 
			
		||||
//	if len(p.listenAddress) > 0 {
 | 
			
		||||
//		p.router = r
 | 
			
		||||
//	}
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// SetMetricsPath set metrics paths.
 | 
			
		||||
//func (p *Prometheus) SetMetricsPath(e *gin.Engine) error {
 | 
			
		||||
//
 | 
			
		||||
//	if p.listenAddress != "" {
 | 
			
		||||
//		p.router.GET(p.MetricsPath, prometheusHandler())
 | 
			
		||||
//		return p.runServer()
 | 
			
		||||
//	} else {
 | 
			
		||||
//		e.GET(p.MetricsPath, prometheusHandler())
 | 
			
		||||
//		return nil
 | 
			
		||||
//	}
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// SetMetricsPathWithAuth set metrics paths with authentication.
 | 
			
		||||
//func (p *Prometheus) SetMetricsPathWithAuth(e *gin.Engine, accounts gin.Accounts) error {
 | 
			
		||||
//
 | 
			
		||||
//	if p.listenAddress != "" {
 | 
			
		||||
//		p.router.GET(p.MetricsPath, gin.BasicAuth(accounts), prometheusHandler())
 | 
			
		||||
//		return p.runServer()
 | 
			
		||||
//	} else {
 | 
			
		||||
//		e.GET(p.MetricsPath, gin.BasicAuth(accounts), prometheusHandler())
 | 
			
		||||
//		return nil
 | 
			
		||||
//	}
 | 
			
		||||
//
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//func (p *Prometheus) runServer() error {
 | 
			
		||||
//	return p.router.Run(p.listenAddress)
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//func (p *Prometheus) getMetrics() []byte {
 | 
			
		||||
//	response, err := http.Get(p.Ppg.MetricsURL)
 | 
			
		||||
//	if err != nil {
 | 
			
		||||
//		return nil
 | 
			
		||||
//	}
 | 
			
		||||
//
 | 
			
		||||
//	defer response.Body.Close()
 | 
			
		||||
//
 | 
			
		||||
//	body, _ := io.ReadAll(response.Body)
 | 
			
		||||
//	return body
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//var hostname, _ = os.Hostname()
 | 
			
		||||
//
 | 
			
		||||
//func (p *Prometheus) getPushGatewayURL() string {
 | 
			
		||||
//	if p.Ppg.Job == "" {
 | 
			
		||||
//		p.Ppg.Job = "gin"
 | 
			
		||||
//	}
 | 
			
		||||
//	return p.Ppg.PushGatewayURL + "/metrics/job/" + p.Ppg.Job + "/instance/" + hostname
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//func (p *Prometheus) sendMetricsToPushGateway(metrics []byte) {
 | 
			
		||||
//	req, err := http.NewRequest("POST", p.getPushGatewayURL(), bytes.NewBuffer(metrics))
 | 
			
		||||
//	if err != nil {
 | 
			
		||||
//		return
 | 
			
		||||
//	}
 | 
			
		||||
//
 | 
			
		||||
//	client := &http.Client{}
 | 
			
		||||
//	resp, err := client.Do(req)
 | 
			
		||||
//	if err != nil {
 | 
			
		||||
//		fmt.Println("Error sending to push gateway error:", err.Error())
 | 
			
		||||
//	}
 | 
			
		||||
//
 | 
			
		||||
//	resp.Body.Close()
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//func (p *Prometheus) startPushTicker() {
 | 
			
		||||
//	ticker := time.NewTicker(time.Second * p.Ppg.PushIntervalSeconds)
 | 
			
		||||
//	go func() {
 | 
			
		||||
//		for range ticker.C {
 | 
			
		||||
//			p.sendMetricsToPushGateway(p.getMetrics())
 | 
			
		||||
//		}
 | 
			
		||||
//	}()
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// NewMetric associates prometheus.Collector based on Metric.Type.
 | 
			
		||||
//func NewMetric(m *Metric, subsystem string) prometheus.Collector {
 | 
			
		||||
//	var metric prometheus.Collector
 | 
			
		||||
//	switch m.Type {
 | 
			
		||||
//	case "counter_vec":
 | 
			
		||||
//		metric = prometheus.NewCounterVec(
 | 
			
		||||
//			prometheus.CounterOpts{
 | 
			
		||||
//				Subsystem: subsystem,
 | 
			
		||||
//				Name:      m.Name,
 | 
			
		||||
//				Help:      m.Description,
 | 
			
		||||
//			},
 | 
			
		||||
//			m.Args,
 | 
			
		||||
//		)
 | 
			
		||||
//	case "counter":
 | 
			
		||||
//		metric = prometheus.NewCounter(
 | 
			
		||||
//			prometheus.CounterOpts{
 | 
			
		||||
//				Subsystem: subsystem,
 | 
			
		||||
//				Name:      m.Name,
 | 
			
		||||
//				Help:      m.Description,
 | 
			
		||||
//			},
 | 
			
		||||
//		)
 | 
			
		||||
//	case "gauge_vec":
 | 
			
		||||
//		metric = prometheus.NewGaugeVec(
 | 
			
		||||
//			prometheus.GaugeOpts{
 | 
			
		||||
//				Subsystem: subsystem,
 | 
			
		||||
//				Name:      m.Name,
 | 
			
		||||
//				Help:      m.Description,
 | 
			
		||||
//			},
 | 
			
		||||
//			m.Args,
 | 
			
		||||
//		)
 | 
			
		||||
//	case "gauge":
 | 
			
		||||
//		metric = prometheus.NewGauge(
 | 
			
		||||
//			prometheus.GaugeOpts{
 | 
			
		||||
//				Subsystem: subsystem,
 | 
			
		||||
//				Name:      m.Name,
 | 
			
		||||
//				Help:      m.Description,
 | 
			
		||||
//			},
 | 
			
		||||
//		)
 | 
			
		||||
//	case "histogram_vec":
 | 
			
		||||
//		metric = prometheus.NewHistogramVec(
 | 
			
		||||
//			prometheus.HistogramOpts{
 | 
			
		||||
//				Subsystem: subsystem,
 | 
			
		||||
//				Name:      m.Name,
 | 
			
		||||
//				Help:      m.Description,
 | 
			
		||||
//			},
 | 
			
		||||
//			m.Args,
 | 
			
		||||
//		)
 | 
			
		||||
//	case "histogram":
 | 
			
		||||
//		metric = prometheus.NewHistogram(
 | 
			
		||||
//			prometheus.HistogramOpts{
 | 
			
		||||
//				Subsystem: subsystem,
 | 
			
		||||
//				Name:      m.Name,
 | 
			
		||||
//				Help:      m.Description,
 | 
			
		||||
//			},
 | 
			
		||||
//		)
 | 
			
		||||
//	case "summary_vec":
 | 
			
		||||
//		metric = prometheus.NewSummaryVec(
 | 
			
		||||
//			prometheus.SummaryOpts{
 | 
			
		||||
//				Subsystem: subsystem,
 | 
			
		||||
//				Name:      m.Name,
 | 
			
		||||
//				Help:      m.Description,
 | 
			
		||||
//			},
 | 
			
		||||
//			m.Args,
 | 
			
		||||
//		)
 | 
			
		||||
//	case "summary":
 | 
			
		||||
//		metric = prometheus.NewSummary(
 | 
			
		||||
//			prometheus.SummaryOpts{
 | 
			
		||||
//				Subsystem: subsystem,
 | 
			
		||||
//				Name:      m.Name,
 | 
			
		||||
//				Help:      m.Description,
 | 
			
		||||
//			},
 | 
			
		||||
//		)
 | 
			
		||||
//	}
 | 
			
		||||
//	return metric
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//func (p *Prometheus) registerMetrics(subsystem string) {
 | 
			
		||||
//	for _, metricDef := range p.MetricsList {
 | 
			
		||||
//		metric := NewMetric(metricDef, subsystem)
 | 
			
		||||
//		if err := prometheus.Register(metric); err != nil {
 | 
			
		||||
//			fmt.Println("could not be registered in Prometheus,metricDef.Name:", metricDef.Name, "   error:", err.Error())
 | 
			
		||||
//		}
 | 
			
		||||
//
 | 
			
		||||
//		switch metricDef {
 | 
			
		||||
//		case reqCounter:
 | 
			
		||||
//			p.reqCnt = metric.(*prometheus.CounterVec)
 | 
			
		||||
//		case reqDuration:
 | 
			
		||||
//			p.reqDur = metric.(*prometheus.HistogramVec)
 | 
			
		||||
//		case resSize:
 | 
			
		||||
//			p.resSz = metric.(prometheus.Summary)
 | 
			
		||||
//		case reqSize:
 | 
			
		||||
//			p.reqSz = metric.(prometheus.Summary)
 | 
			
		||||
//		}
 | 
			
		||||
//		metricDef.MetricCollector = metric
 | 
			
		||||
//	}
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// Use adds the middleware to a gin engine.
 | 
			
		||||
//func (p *Prometheus) Use(e *gin.Engine) error {
 | 
			
		||||
//	e.Use(p.HandlerFunc())
 | 
			
		||||
//	return p.SetMetricsPath(e)
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// UseWithAuth adds the middleware to a gin engine with BasicAuth.
 | 
			
		||||
//func (p *Prometheus) UseWithAuth(e *gin.Engine, accounts gin.Accounts) error {
 | 
			
		||||
//	e.Use(p.HandlerFunc())
 | 
			
		||||
//	return p.SetMetricsPathWithAuth(e, accounts)
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//// HandlerFunc defines handler function for middleware.
 | 
			
		||||
//func (p *Prometheus) HandlerFunc() gin.HandlerFunc {
 | 
			
		||||
//	return func(c *gin.Context) {
 | 
			
		||||
//		if c.Request.URL.Path == p.MetricsPath {
 | 
			
		||||
//			c.Next()
 | 
			
		||||
//			return
 | 
			
		||||
//		}
 | 
			
		||||
//
 | 
			
		||||
//		start := time.Now()
 | 
			
		||||
//		reqSz := computeApproximateRequestSize(c.Request)
 | 
			
		||||
//
 | 
			
		||||
//		c.Next()
 | 
			
		||||
//
 | 
			
		||||
//		status := strconv.Itoa(c.Writer.Status())
 | 
			
		||||
//		elapsed := float64(time.Since(start)) / float64(time.Second)
 | 
			
		||||
//		resSz := float64(c.Writer.Size())
 | 
			
		||||
//
 | 
			
		||||
//		url := p.ReqCntURLLabelMappingFn(c)
 | 
			
		||||
//		if len(p.URLLabelFromContext) > 0 {
 | 
			
		||||
//			u, found := c.Get(p.URLLabelFromContext)
 | 
			
		||||
//			if !found {
 | 
			
		||||
//				u = "unknown"
 | 
			
		||||
//			}
 | 
			
		||||
//			url = u.(string)
 | 
			
		||||
//		}
 | 
			
		||||
//		p.reqDur.WithLabelValues(status, c.Request.Method, url).Observe(elapsed)
 | 
			
		||||
//		p.reqCnt.WithLabelValues(status, c.Request.Method, c.HandlerName(), c.Request.Host, url).Inc()
 | 
			
		||||
//		p.reqSz.Observe(float64(reqSz))
 | 
			
		||||
//		p.resSz.Observe(resSz)
 | 
			
		||||
//	}
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//func prometheusHandler() gin.HandlerFunc {
 | 
			
		||||
//	h := promhttp.Handler()
 | 
			
		||||
//	return func(c *gin.Context) {
 | 
			
		||||
//		h.ServeHTTP(c.Writer, c.Request)
 | 
			
		||||
//	}
 | 
			
		||||
//}
 | 
			
		||||
//
 | 
			
		||||
//func computeApproximateRequestSize(r *http.Request) int {
 | 
			
		||||
//	var s int
 | 
			
		||||
//	if r.URL != nil {
 | 
			
		||||
//		s = len(r.URL.Path)
 | 
			
		||||
//	}
 | 
			
		||||
//
 | 
			
		||||
//	s += len(r.Method)
 | 
			
		||||
//	s += len(r.Proto)
 | 
			
		||||
//	for name, values := range r.Header {
 | 
			
		||||
//		s += len(name)
 | 
			
		||||
//		for _, value := range values {
 | 
			
		||||
//			s += len(value)
 | 
			
		||||
//		}
 | 
			
		||||
//	}
 | 
			
		||||
//	s += len(r.Host)
 | 
			
		||||
//
 | 
			
		||||
//	// r.FormData and r.MultipartForm are assumed to be included in r.URL.
 | 
			
		||||
//
 | 
			
		||||
//	if r.ContentLength != -1 {
 | 
			
		||||
//		s += int(r.ContentLength)
 | 
			
		||||
//	}
 | 
			
		||||
//	return s
 | 
			
		||||
//}
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										106
									
								
								pkg/common/prommetrics/api.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										106
									
								
								pkg/common/prommetrics/api.go
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,106 @@
 | 
			
		||||
package prommetrics
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"github.com/prometheus/client_golang/prometheus"
 | 
			
		||||
	"github.com/prometheus/client_golang/prometheus/promhttp"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"strconv"
 | 
			
		||||
	"time"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
const ApiPath = "/metrics"
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	apiRegistry = prometheus.NewRegistry()
 | 
			
		||||
	apiCounter  = prometheus.NewCounterVec(
 | 
			
		||||
		prometheus.CounterOpts{
 | 
			
		||||
			Name: "api_count",
 | 
			
		||||
			Help: "Total number of API calls",
 | 
			
		||||
		},
 | 
			
		||||
		[]string{"path", "code", "type"},
 | 
			
		||||
	)
 | 
			
		||||
	httpCounter = prometheus.NewCounterVec(
 | 
			
		||||
		prometheus.CounterOpts{
 | 
			
		||||
			Name: "http_count",
 | 
			
		||||
			Help: "Total number of HTTP calls",
 | 
			
		||||
		},
 | 
			
		||||
		[]string{"path", "method", "status", "duration"},
 | 
			
		||||
	)
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func init() {
 | 
			
		||||
	apiRegistry.MustRegister(apiCounter, httpCounter)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func APICall(path string, apiCode int, apiType string) {
 | 
			
		||||
	apiCounter.With(prometheus.Labels{"path": path, "code": strconv.Itoa(apiCode), "type": apiType}).Inc()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func HttpCall(path string, method string, status int, duration time.Duration) {
 | 
			
		||||
	httpCounter.With(prometheus.Labels{"path": path, "method": method, "status": strconv.Itoa(status), "duration": durationRange(duration)}).Inc()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	durations = [...]time.Duration{
 | 
			
		||||
		time.Millisecond * 1,
 | 
			
		||||
		time.Millisecond * 2,
 | 
			
		||||
		time.Millisecond * 3,
 | 
			
		||||
		time.Millisecond * 4,
 | 
			
		||||
		time.Millisecond * 5,
 | 
			
		||||
		time.Millisecond * 6,
 | 
			
		||||
		time.Millisecond * 7,
 | 
			
		||||
		time.Millisecond * 8,
 | 
			
		||||
		time.Millisecond * 9,
 | 
			
		||||
		time.Millisecond * 10,
 | 
			
		||||
		time.Millisecond * 20,
 | 
			
		||||
		time.Millisecond * 30,
 | 
			
		||||
		time.Millisecond * 40,
 | 
			
		||||
		time.Millisecond * 50,
 | 
			
		||||
		time.Millisecond * 60,
 | 
			
		||||
		time.Millisecond * 70,
 | 
			
		||||
		time.Millisecond * 80,
 | 
			
		||||
		time.Millisecond * 90,
 | 
			
		||||
		time.Millisecond * 100,
 | 
			
		||||
		time.Millisecond * 200,
 | 
			
		||||
		time.Millisecond * 300,
 | 
			
		||||
		time.Millisecond * 400,
 | 
			
		||||
		time.Millisecond * 500,
 | 
			
		||||
		time.Millisecond * 600,
 | 
			
		||||
		time.Millisecond * 700,
 | 
			
		||||
		time.Millisecond * 800,
 | 
			
		||||
		time.Millisecond * 900,
 | 
			
		||||
		time.Second * 1,
 | 
			
		||||
		time.Second * 2,
 | 
			
		||||
		time.Second * 3,
 | 
			
		||||
		time.Second * 4,
 | 
			
		||||
		time.Second * 5,
 | 
			
		||||
		time.Second * 6,
 | 
			
		||||
		time.Second * 7,
 | 
			
		||||
		time.Second * 8,
 | 
			
		||||
		time.Second * 9,
 | 
			
		||||
		time.Second * 10,
 | 
			
		||||
		time.Second * 20,
 | 
			
		||||
		time.Second * 30,
 | 
			
		||||
		time.Second * 40,
 | 
			
		||||
		time.Second * 50,
 | 
			
		||||
		time.Second * 60,
 | 
			
		||||
		time.Second * 70,
 | 
			
		||||
		time.Second * 80,
 | 
			
		||||
		time.Second * 90,
 | 
			
		||||
		time.Second * 100,
 | 
			
		||||
	}
 | 
			
		||||
	maxDuration = durations[len(durations)-1]
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func durationRange(duration time.Duration) string {
 | 
			
		||||
	for _, d := range durations {
 | 
			
		||||
		if duration <= d {
 | 
			
		||||
			return d.String()
 | 
			
		||||
		}
 | 
			
		||||
	}
 | 
			
		||||
	return ">" + maxDuration.String()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func ApiHandler() http.Handler {
 | 
			
		||||
	return promhttp.HandlerFor(apiRegistry, promhttp.HandlerOpts{})
 | 
			
		||||
}
 | 
			
		||||
							
								
								
									
										56
									
								
								pkg/common/prommetrics/api_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										56
									
								
								pkg/common/prommetrics/api_test.go
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,56 @@
 | 
			
		||||
package prommetrics
 | 
			
		||||
 | 
			
		||||
import (
 | 
			
		||||
	"fmt"
 | 
			
		||||
	"github.com/prometheus/client_golang/prometheus"
 | 
			
		||||
	"github.com/prometheus/client_golang/prometheus/promhttp"
 | 
			
		||||
	"net/http"
 | 
			
		||||
	"testing"
 | 
			
		||||
	"time"
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
var (
 | 
			
		||||
	apiCallCounter1 = prometheus.NewCounterVec(
 | 
			
		||||
		prometheus.CounterOpts{
 | 
			
		||||
			Name: "api_calls_total",
 | 
			
		||||
			Help: "Total number of API calls",
 | 
			
		||||
		},
 | 
			
		||||
		[]string{"endpoint", "status", "code", "error"},
 | 
			
		||||
	)
 | 
			
		||||
	registerer *prometheus.Registry
 | 
			
		||||
)
 | 
			
		||||
 | 
			
		||||
func init() {
 | 
			
		||||
	registerer = prometheus.NewRegistry()
 | 
			
		||||
	registerer.MustRegister(apiCallCounter1)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func recordAPICall(endpoint string, status string) {
 | 
			
		||||
	apiCallCounter1.With(prometheus.Labels{"endpoint": endpoint, "status": status, "code": "200", "error": "ArgsError"}).Inc()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestName(t *testing.T) {
 | 
			
		||||
	go func() {
 | 
			
		||||
		for i := 0; ; i++ {
 | 
			
		||||
			recordAPICall("/api/test", "success")
 | 
			
		||||
			time.Sleep(time.Second)
 | 
			
		||||
		}
 | 
			
		||||
	}()
 | 
			
		||||
 | 
			
		||||
	go func() {
 | 
			
		||||
		for i := 0; ; i++ {
 | 
			
		||||
			recordAPICall("/api/test", "failed")
 | 
			
		||||
			time.Sleep(time.Second * 3)
 | 
			
		||||
		}
 | 
			
		||||
	}()
 | 
			
		||||
	http.Handle("/metrics", promhttp.HandlerFor(registerer, promhttp.HandlerOpts{}))
 | 
			
		||||
	if err := http.ListenAndServe(":2112", nil); err != nil {
 | 
			
		||||
		panic(err)
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func TestName2(t *testing.T) {
 | 
			
		||||
	var d time.Duration
 | 
			
		||||
	d = time.Second / 900
 | 
			
		||||
	fmt.Println(durationRange(d))
 | 
			
		||||
}
 | 
			
		||||
@ -14,17 +14,17 @@
 | 
			
		||||
 | 
			
		||||
package prommetrics
 | 
			
		||||
 | 
			
		||||
import ginprom "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
 | 
			
		||||
//import ginprom "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
labels := prometheus.Labels{"label_one": "any", "label_two": "value"}
 | 
			
		||||
ApiCustomCnt.MetricCollector.(*prometheus.CounterVec).With(labels).Inc().
 | 
			
		||||
*/
 | 
			
		||||
var (
 | 
			
		||||
	ApiCustomCnt = &ginprom.Metric{
 | 
			
		||||
		Name:        "custom_total",
 | 
			
		||||
		Description: "Custom counter events.",
 | 
			
		||||
		Type:        "counter_vec",
 | 
			
		||||
		Args:        []string{"label_one", "label_two"},
 | 
			
		||||
	}
 | 
			
		||||
)
 | 
			
		||||
//var (
 | 
			
		||||
//	ApiCustomCnt = &ginprom.Metric{
 | 
			
		||||
//		Name:        "custom_total",
 | 
			
		||||
//		Description: "Custom counter events.",
 | 
			
		||||
//		Type:        "counter_vec",
 | 
			
		||||
//		Args:        []string{"label_one", "label_two"},
 | 
			
		||||
//	}
 | 
			
		||||
//)
 | 
			
		||||
 | 
			
		||||
@ -17,7 +17,6 @@ package prommetrics
 | 
			
		||||
import (
 | 
			
		||||
	gp "github.com/grpc-ecosystem/go-grpc-prometheus"
 | 
			
		||||
	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
 | 
			
		||||
	"github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
 | 
			
		||||
	"github.com/prometheus/client_golang/prometheus"
 | 
			
		||||
	"github.com/prometheus/client_golang/prometheus/collectors"
 | 
			
		||||
)
 | 
			
		||||
@ -48,11 +47,11 @@ func GetGrpcCusMetrics(registerName string, share *config2.Share) []prometheus.C
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
func GetGinCusMetrics(name string) []*ginprometheus.Metric {
 | 
			
		||||
	switch name {
 | 
			
		||||
	case "Api":
 | 
			
		||||
		return []*ginprometheus.Metric{ApiCustomCnt}
 | 
			
		||||
	default:
 | 
			
		||||
		return []*ginprometheus.Metric{ApiCustomCnt}
 | 
			
		||||
	}
 | 
			
		||||
}
 | 
			
		||||
//func GetGinCusMetrics(name string) []*ginprometheus.Metric {
 | 
			
		||||
//	switch name {
 | 
			
		||||
//	case "Api":
 | 
			
		||||
//		return []*ginprometheus.Metric{ApiCustomCnt}
 | 
			
		||||
//	default:
 | 
			
		||||
//		return []*ginprometheus.Metric{ApiCustomCnt}
 | 
			
		||||
//	}
 | 
			
		||||
//}
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user