Prometheus

Enable Prometheus middleware

Install

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

Options

options	description	type	default
grpc.middleware.prom.enabled	Enable Prometheus middleware	boolean	false
grpc.middleware.prom.ignore	Ignore by path	[]string	[]

Concept

Prometheus middleware will record bellow information

Fields	Type	Description
elapsedNano	Summary	RPC elapsed time in nano
resCode	Counter	Counter of response code

Labels as bellow:

Label	Description
entryName	Entry name
entryType	Entry type
domain	ENV value of DOMAIN, eg: prod
instance	Hostname
restMethod	eg: GET
restPath	eg: /rk/v1/alive
resCode	Response code, eg: 200

Example

rk_prom_elapsedNano{domain="*",entryName="greeter",entryType="GinEntry",instance="lark.local",resCode="200",restMethod="GET",restPath="/v1/greeter",quantile="0.5"} 88645
...
rk_prom_resCode{domain="*",entryName="greeter",entryType="GinEntry",instance="lark.local",resCode="200",restMethod="GET",restPath="/v1/greeter"} 1

Quick start

1.Create and compile protocol buffer

Compile protobuf

2.Create boot.yaml

---
grpc:
  - name: greeter
    port: 8080
    enabled: true
    enableRkGwOption: true
    prom:
      enabled : true
    middleware:
      prom:
        enabled: true
#        ignore: [""]

3.Create main.go

package main

import (
  "context"
  "github.com/rookie-ninja/rk-boot/v2"
  "github.com/rookie-ninja/rk-demo/api/gen/v1"
  "github.com/rookie-ninja/rk-grpc/v2/boot"
  "google.golang.org/grpc"
)

func main() {
  boot := rkboot.NewBoot()

  // register grpc
  entry := rkgrpc.GetGrpcEntry("greeter")
  entry.AddRegFuncGrpc(registerGreeter)
  entry.AddRegFuncGw(greeter.RegisterGreeterHandlerFromEndpoint)

  // Bootstrap
  boot.Bootstrap(context.TODO())

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

func registerGreeter(server *grpc.Server) {
  greeter.RegisterGreeterServer(server, &GreeterServer{})
}

type GreeterServer struct{}

func (server *GreeterServer) Hello(ctx context.Context, _ *greeter.HelloRequest) (*greeter.HelloResponse, error) {
  return &greeter.HelloResponse{
    Message: "hello!",
  }, nil
}

4.Validate

Send request

$ curl localhost:8080/v1/hello
{"message":"hello!"}

Prometheus client:

http://localhost:8080/metrics

Cheers