snapshot of https://github.com/grpc/grpc-go.git (master, 2026-09-15; blobs > 131072B omitted)

examples/features/opentelemetry/README.md

@@ -0,0 +1,39 @@
+# 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.
+This example shows 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.

examples/features/opentelemetry/client/main.go

@@ -0,0 +1,100 @@
+/*
+ *
+ * Copyright 2024 gRPC authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// Binary client is a client for the OpenTelemetry example.
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"log"
+	"net/http"
+	"time"
+
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+	"go.opentelemetry.io/otel/exporters/prometheus"
+	otelstdouttrace "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
+	otelpropagation "go.opentelemetry.io/otel/propagation"
+	otelmetric "go.opentelemetry.io/otel/sdk/metric"
+	otelresource "go.opentelemetry.io/otel/sdk/resource"
+	sdktrace "go.opentelemetry.io/otel/sdk/trace"
+	semconv "go.opentelemetry.io/otel/semconv/v1.24.0"
+	"google.golang.org/grpc"
+	"google.golang.org/grpc/credentials/insecure"
+	"google.golang.org/grpc/examples/features/proto/echo"
+	oteltracing "google.golang.org/grpc/experimental/opentelemetry"
+	"google.golang.org/grpc/stats/opentelemetry"
+)
+
+var (
+	addr               = flag.String("addr", "localhost:50051", "the server address to connect to")
+	prometheusEndpoint = flag.String("prometheus_endpoint", ":9465", "the Prometheus exporter endpoint for metrics")
+)
+
+func main() {
+	exporter, err := prometheus.New()
+	if err != nil {
+		log.Fatalf("Failed to start prometheus exporter: %v", err)
+	}
+	// Configure meter provider for metrics
+	meterProvider := otelmetric.NewMeterProvider(otelmetric.WithReader(exporter))
+	// Configure exporter for traces
+	traceExporter, err := otelstdouttrace.New(otelstdouttrace.WithPrettyPrint())
+	if err != nil {
+		log.Fatalf("Failed to create stdouttrace exporter: %v", err)
+	}
+	traceProvider := sdktrace.NewTracerProvider(sdktrace.WithBatcher(traceExporter), sdktrace.WithResource(otelresource.NewWithAttributes(semconv.SchemaURL, semconv.ServiceName("grpc-client"))))
+	// Configure W3C Trace Context Propagator for traces
+	textMapPropagator := otelpropagation.TraceContext{}
+	do := opentelemetry.DialOption(opentelemetry.Options{
+		MetricsOptions: opentelemetry.MetricsOptions{
+			MeterProvider: meterProvider,
+			// These are example experimental gRPC metrics, which are disabled
+			// by default and must be explicitly enabled. For the full,
+			// up-to-date list of metrics, see:
+			// https://grpc.io/docs/guides/opentelemetry-metrics/#instruments
+			Metrics: opentelemetry.DefaultMetrics().Add(
+				"grpc.subchannel.connection_attempts_succeeded",
+				"grpc.subchannel.connection_attempts_failed",
+			),
+		},
+		TraceOptions: oteltracing.TraceOptions{TracerProvider: traceProvider, TextMapPropagator: textMapPropagator},
+	})
+
+	go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
+
+	cc, err := grpc.NewClient(*addr, grpc.WithTransportCredentials(insecure.NewCredentials()), do)
+	if err != nil {
+		log.Fatalf("grpc.NewClient() failed: %v", err)
+	}
+	defer cc.Close()
+	c := echo.NewEchoClient(cc)
+	ctx := context.Background()
+
+	// Make an RPC every second. This should trigger telemetry to be emitted from
+	// the client and the server.
+	for {
+		r, err := c.UnaryEcho(ctx, &echo.EchoRequest{Message: "this is examples/opentelemetry"})
+		if err != nil {
+			log.Fatalf("UnaryEcho failed: %v", err)
+		}
+		fmt.Println(r)
+		time.Sleep(time.Second)
+	}
+}

examples/features/opentelemetry/server/main.go

@@ -0,0 +1,93 @@
+/*
+ *
+ * Copyright 2024 gRPC authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// Binary server is a server for the OpenTelemetry example.
+package main
+
+import (
+	"context"
+	"flag"
+	"fmt"
+	"log"
+	"net"
+	"net/http"
+
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+	"go.opentelemetry.io/otel/exporters/prometheus"
+	otelstdouttrace "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
+	otelpropagation "go.opentelemetry.io/otel/propagation"
+	otelmetric "go.opentelemetry.io/otel/sdk/metric"
+	otelresource "go.opentelemetry.io/otel/sdk/resource"
+	sdktrace "go.opentelemetry.io/otel/sdk/trace"
+	semconv "go.opentelemetry.io/otel/semconv/v1.24.0"
+	"google.golang.org/grpc"
+	pb "google.golang.org/grpc/examples/features/proto/echo"
+	oteltracing "google.golang.org/grpc/experimental/opentelemetry"
+	"google.golang.org/grpc/stats/opentelemetry"
+)
+
+var (
+	addr               = flag.String("addr", "localhost:50051", "the server address to connect to")
+	prometheusEndpoint = flag.String("prometheus_endpoint", ":9464", "the Prometheus exporter endpoint for metrics")
+)
+
+type echoServer struct {
+	pb.UnimplementedEchoServer
+	addr string
+}
+
+func (s *echoServer) UnaryEcho(_ context.Context, req *pb.EchoRequest) (*pb.EchoResponse, error) {
+	return &pb.EchoResponse{Message: fmt.Sprintf("%s (from %s)", req.Message, s.addr)}, nil
+}
+
+func main() {
+	exporter, err := prometheus.New()
+	if err != nil {
+		log.Fatalf("Failed to start prometheus exporter: %v", err)
+	}
+	// Configure meter provider for metrics
+	meterProvider := otelmetric.NewMeterProvider(otelmetric.WithReader(exporter))
+	// Configure exporter for traces
+	traceExporter, err := otelstdouttrace.New(otelstdouttrace.WithPrettyPrint())
+	if err != nil {
+		log.Fatalf("Failed to create stdouttrace exporter: %v", err)
+	}
+	traceProvider := sdktrace.NewTracerProvider(sdktrace.WithBatcher(traceExporter), sdktrace.WithResource(otelresource.NewWithAttributes(semconv.SchemaURL, semconv.ServiceName("grpc-server"))))
+	// Configure W3C Trace Context Propagator for traces
+	textMapPropagator := otelpropagation.TraceContext{}
+	so := opentelemetry.ServerOption(opentelemetry.Options{
+		MetricsOptions: opentelemetry.MetricsOptions{
+			MeterProvider: meterProvider,
+		},
+		TraceOptions: oteltracing.TraceOptions{TracerProvider: traceProvider, TextMapPropagator: textMapPropagator}})
+
+	go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
+
+	lis, err := net.Listen("tcp", *addr)
+	if err != nil {
+		log.Fatalf("Failed to listen: %v", err)
+	}
+	s := grpc.NewServer(so)
+	pb.RegisterEchoServer(s, &echoServer{addr: *addr})
+
+	log.Printf("Serving on %s\n", *addr)
+
+	if err := s.Serve(lis); err != nil {
+		log.Fatalf("Failed to serve: %v", err)
+	}
+}