grpc-jsonnet-lib

DEPRECATED: I am no longer maintaining this component and have collapsed it under my monorepo here.

A jsonnet library for writing gRPC dashboards as code. For now, my focus is on the Grafana and Prometheus ecosystem. I tried to leave room for Datadog.

How to use

This library can be used two different ways. The easy way is to use one of our pre-built dashboards. You can quickly import the dashboard's JSON file into Grafana to start observing your gRPC services.

The second way to use this library is to add it as a dependency using jsonnet-bundler. This way, you can leverage our building blocks to assemble your own dashboard.

{
  "version": 1,
  "dependencies": [
    {
      "source": {
        "git": {
          "remote": "https://github.com/mjpitz/grpc-jsonnet-lib.git",
          "subdir": "."
        }
      },
      "version": "main"
    },
  ],
}

Once added as a dependency, you can import it to start building:

local grpc_grafana = import 'github.com/mjpitz/grpc-jsonnet-lib/grafana/grafana.libsonnet';

local client = grpc_grafana.client;   # for client side metrics
local server = grpc_grafana.server;   # for server side metrics
local slis = grpc_grafana.slis;       # for common service level indicators
local slos = grpc_grafana.slos;       # for common service level objectives

Pre-built Dashboards

gRPC metrics [ dashboard.json ]

Graphs:

Client call start rate
Client call completion rate
Client message send rate
Client message receive rate
Server call start rate
Server call completion rate
Server message send rate
Server message receive rate
Request Duration (p90)
Request Duration (p95)
Request Duration (p99)