Grp: how to add Prometheus monitoring in GRP service?

Introduce

This article will show you how to gRPC In microservice , Join in Prometheus monitor .

gRPC Automatic monitoring of functions , It will be introduced in the following articles , Here we only introduce how to gRPC In the code , Realization prometheus monitor .

• We will use rk-boot To start up gRPC service .
• We will use rk-prom To start up prometheus client .

Please visit the following address for a complete tutorial ：https://rkdev.info/cnhttps://rkdocs.netlify.app/cn ( spare )

install

go get github.com/rookie-ninja/rk-boot
go get github.com/rookie-ninja/rk-grpc

Quick start

For detailed documents, please refer to ：

• Official documents
• perhaps ,Github

1. establish boot.yaml

---
grpc:
  - name: greeter                   # Name of grpc entry
    port: 8080                      # Port of grpc entry
    enabled: true                   # Enable grpc entry
    prom:
      enabled: true                 # Enable prometheus client
#      path: "metrics"              # Default value is "metrics", set path as needed.

2. establish main.go

package main

import (
	"context"
	"github.com/rookie-ninja/rk-boot"
	_ "github.com/rookie-ninja/rk-grpc/boot"
)

// Application entrance.
func main() {
	// Create a new boot instance.
	boot := rkboot.NewBoot()

	// Bootstrap
	boot.Bootstrap(context.Background())

	// Wait for shutdown sig
	boot.WaitForShutdownSig(context.Background())
}

3. start-up main.go

$ go run main.go

4. verification

visit ：http://localhost:8080/metrics

Prometheus Add monitoring to the client

We need to know Prometheus The following concepts in .

name	details
MetricsSet	RK Custom structure , adopt MetricsSet register Prometheus Of Counter,Gauge,Histogram and Summary
Prometheus Registerer	Prometheus Will pass Registrerer To manage Counter,Gauge,Histogram and Summary
Prometheus Counter	Counter It's a cumulative measure , Represents a single monotonically increasing counter , Its value can only be increased or reset to zero
Prometheus Gauge	Gauge Values can be added or subtracted at will
Prometheus Histogram	Histogram sampling （ It's usually something like request duration or response size ） And calculate them in configurable buckets , It also provides the sum of all observations
Prometheus Summary	And Histogram similar , Abstract sample observation （ It's usually something like request duration and response size ）
Prometheus Namespace	Prometheus Monitor name format ： namespace_subSystem_metricsName
Prometheus SubSystem	Prometheus Monitor name format ： namespace_subSystem_metricsName

1. stay main.go Add monitoring items to

package main

import (
	"context"
	"github.com/rookie-ninja/rk-boot"
	"github.com/rookie-ninja/rk-grpc/boot"
	"github.com/rookie-ninja/rk-prom"
)

// Application entrance.
func main() {
	// Create a new boot instance.
	boot := rkboot.NewBoot()

	// Bootstrap
	boot.Bootstrap(context.Background())

	// Create a metrics set into prometheus.Registerer
	set := rkprom.NewMetricsSet("rk", "demo", boot.GetEntry("greeter").(*rkgrpc.GrpcEntry).GwEntry.PromEntry.Registerer)

	// Register counter, gauge, histogram, summary
	set.RegisterCounter("my_counter", "label")
	set.RegisterGauge("my_gauge", "label")
	set.RegisterHistogram("my_histogram", []float64{}, "label")
	set.RegisterSummary("my_summary", rkprom.SummaryObjectives, "label")

	// Increase counter, gauge, histogram, summary with label value
	set.GetCounterWithValues("my_counter", "value").Inc()
	set.GetGaugeWithValues("my_gauge", "value").Add(1.0)
	set.GetHistogramWithValues("my_histogram", "value").Observe(0.1)
	set.GetSummaryWithValues("my_summary", "value").Observe(0.1)

	// Wait for shutdown sig
	boot.WaitForShutdownSig(context.Background())
}

2. start-up main.go

$ go run main.go

3. verification

visit ：http://localhost:8080/metrics

Pushed to the prometheus pushgateway

Next , Let's see , How to make gRPC service , Automatically push monitoring data to remote Pushgateway in .

1.boot.yaml Start in pusher

---
grpc:
  - name: greeter                             # Name of grpc entry
    port: 8080                                # Port of grpc entry
    enabled: true                             # Enable grpc entry
    prom:
      enabled: true                           # Enable prometheus client
      pusher:
        enabled : true                        # Enable backend job push metrics to remote pushgateway
        jobName: "demo"                       # Name of current push job
        remoteAddress: "localhost:9091"       # Remote address of pushgateway
        intervalMs: 2000                      # Push interval in milliseconds
#        basicAuth: "user:pass"               # Basic auth of pushgateway
#        cert:
#          ref: "ref"                         # Cert reference defined in CertEntry. Please see advanced user guide for details.

2. Start locally pushgateway

We use docker start-up pushgateway

$ docker run prom/pushgateway -p 9091:9091

3. start-up main.go

$ go run main.go

4. verification

visit ：http://localhost:9091/metrics