grpc-go/examples/features/opentelemetry

OpenTelemetry

This example shows how to configure OpenTelemetry on a client and server, and shows what type of telemetry data it can produce for certain RPCs, and demonstrates how to enable experimental gRPC metrics, which are disabled by default and must be explicitly configured on the client and/or server.

Try it

go run server/main.go

go run client/main.go

curl localhost:9464/metrics
curl localhost:9465/metrics

Explanation

The client continuously makes RPCs to a server. The client and server both expose a prometheus exporter to listen and provide metrics. This defaults to :9464 for the server and :9465 for the client. The client and server are also configured to output traces directly to their standard output streams using stdouttrace.

OpenTelemetry is configured on both the client and the server, and exports to the Prometheus exporter. The exporter exposes metrics on the Prometheus ports described above. OpenTelemetry exports traces using the stdouttrace exporter, which prints structured trace data to the console output of both the client and server. Each RPC call produces trace information that captures the execution flow and timing of operations.

Curling to the exposed Prometheus ports outputs the metrics recorded on the client and server.