Skip to content

Commit eb4b687

Browse files
janardhanvissajanardhanvissa
authored
examples/features/opentelemetry: demonstrate tracing using OpenTelemetry plugin (#8056)
1 parent 8b2dbbb commit eb4b687

File tree

5 files changed

+67
-25
lines changed

5 files changed

+67
-25
lines changed

‎examples/features/opentelemetry/README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# OpenTelemetry
22

3-
This example shows how to configure OpenTelemetry on a client and server, and shows
4-
what type of telemetry data it can produce for certain RPC's.
3+
This example shows how to configure OpenTelemetry on a client and server, and
4+
shows what type of telemetry data it can produce for certain RPCs.
55

66
## Try it
77

@@ -20,13 +20,18 @@ curl localhost:9465/metrics
2020

2121
## Explanation
2222

23-
The client continuously makes RPC's to a server. The client and server both
23+
The client continuously makes RPCs to a server. The client and server both
2424
expose a prometheus exporter to listen and provide metrics. This defaults to
25-
:9464 for the server and :9465 for the client.
25+
:9464 for the server and :9465 for the client. The client and server are also
26+
configured to output traces directly to their standard output streams using
27+
`stdouttrace`.
2628

2729
OpenTelemetry is configured on both the client and the server, and exports to
2830
the Prometheus exporter. The exporter exposes metrics on the Prometheus ports
29-
described above.
31+
described above. OpenTelemetry exports traces using the `stdouttrace` exporter,
32+
which prints structured trace data to the console output of both the client and
33+
server. Each RPC call produces trace information that captures the execution
34+
flow and timing of operations.
3035

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

‎examples/features/opentelemetry/client/main.go

+27-10
Original file line numberDiff line numberDiff line change
@@ -27,38 +27,55 @@ import (
2727
"net/http"
2828
"time"
2929

30+
"github.com/prometheus/client_golang/prometheus/promhttp"
31+
"go.opentelemetry.io/otel/exporters/prometheus"
32+
otelstdouttrace "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
33+
otelpropagation "go.opentelemetry.io/otel/propagation"
34+
otelmetric "go.opentelemetry.io/otel/sdk/metric"
35+
otelresource "go.opentelemetry.io/otel/sdk/resource"
36+
sdktrace "go.opentelemetry.io/otel/sdk/trace"
37+
semconv "go.opentelemetry.io/otel/semconv/v1.24.0"
3038
"google.golang.org/grpc"
3139
"google.golang.org/grpc/credentials/insecure"
3240
"google.golang.org/grpc/examples/features/proto/echo"
41+
oteltracing "google.golang.org/grpc/experimental/opentelemetry"
3342
"google.golang.org/grpc/stats/opentelemetry"
34-
35-
"github.com/prometheus/client_golang/prometheus/promhttp"
36-
"go.opentelemetry.io/otel/exporters/prometheus"
37-
"go.opentelemetry.io/otel/sdk/metric"
3843
)
3944

4045
var (
4146
addr = flag.String("addr", ":50051", "the server address to connect to")
42-
prometheusEndpoint = flag.String("prometheus_endpoint", ":9465", "the Prometheus exporter endpoint")
47+
prometheusEndpoint = flag.String("prometheus_endpoint", ":9465", "the Prometheus exporter endpoint for metrics")
4348
)
4449

4550
func main() {
4651
exporter, err := prometheus.New()
4752
if err != nil {
4853
log.Fatalf("Failed to start prometheus exporter: %v", err)
4954
}
50-
provider := metric.NewMeterProvider(metric.WithReader(exporter))
51-
go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
55+
// Configure meter provider for metrics
56+
meterProvider := otelmetric.NewMeterProvider(otelmetric.WithReader(exporter))
57+
// Configure exporter for traces
58+
traceExporter, err := otelstdouttrace.New(otelstdouttrace.WithPrettyPrint())
59+
if err != nil {
60+
log.Fatalf("Failed to create stdouttrace exporter: %v", err)
61+
}
62+
traceProvider := sdktrace.NewTracerProvider(sdktrace.WithBatcher(traceExporter), sdktrace.WithResource(otelresource.NewWithAttributes(semconv.SchemaURL, semconv.ServiceName("grpc-client"))))
63+
// Configure W3C Trace Context Propagator for traces
64+
textMapPropagator := otelpropagation.TraceContext{}
65+
do := opentelemetry.DialOption(opentelemetry.Options{
66+
MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: meterProvider},
67+
TraceOptions: oteltracing.TraceOptions{TracerProvider: traceProvider, TextMapPropagator: textMapPropagator},
68+
})
5269

53-
ctx := context.Background()
54-
do := opentelemetry.DialOption(opentelemetry.Options{MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: provider}})
70+
go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
5571

5672
cc, err := grpc.NewClient(*addr, grpc.WithTransportCredentials(insecure.NewCredentials()), do)
5773
if err != nil {
58-
log.Fatalf("Failed to start NewClient: %v", err)
74+
log.Fatalf("grpc.NewClient() failed: %v", err)
5975
}
6076
defer cc.Close()
6177
c := echo.NewEchoClient(cc)
78+
ctx := context.Background()
6279

6380
// Make an RPC every second. This should trigger telemetry to be emitted from
6481
// the client and the server.

‎examples/features/opentelemetry/server/main.go

+24-8
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,23 @@ import (
2727
"net"
2828
"net/http"
2929

30+
"github.com/prometheus/client_golang/prometheus/promhttp"
31+
"go.opentelemetry.io/otel/exporters/prometheus"
32+
otelstdouttrace "go.opentelemetry.io/otel/exporters/stdout/stdouttrace"
33+
otelpropagation "go.opentelemetry.io/otel/propagation"
34+
otelmetric "go.opentelemetry.io/otel/sdk/metric"
35+
otelresource "go.opentelemetry.io/otel/sdk/resource"
36+
sdktrace "go.opentelemetry.io/otel/sdk/trace"
37+
semconv "go.opentelemetry.io/otel/semconv/v1.24.0"
3038
"google.golang.org/grpc"
3139
pb "google.golang.org/grpc/examples/features/proto/echo"
40+
oteltracing "google.golang.org/grpc/experimental/opentelemetry"
3241
"google.golang.org/grpc/stats/opentelemetry"
33-
34-
"github.com/prometheus/client_golang/prometheus/promhttp"
35-
"go.opentelemetry.io/otel/exporters/prometheus"
36-
"go.opentelemetry.io/otel/sdk/metric"
3742
)
3843

3944
var (
4045
addr = flag.String("addr", ":50051", "the server address to connect to")
41-
prometheusEndpoint = flag.String("prometheus_endpoint", ":9464", "the Prometheus exporter endpoint")
46+
prometheusEndpoint = flag.String("prometheus_endpoint", ":9464", "the Prometheus exporter endpoint for metrics")
4247
)
4348

4449
type echoServer struct {
@@ -55,10 +60,21 @@ func main() {
5560
if err != nil {
5661
log.Fatalf("Failed to start prometheus exporter: %v", err)
5762
}
58-
provider := metric.NewMeterProvider(metric.WithReader(exporter))
59-
go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
63+
// Configure meter provider for metrics
64+
meterProvider := otelmetric.NewMeterProvider(otelmetric.WithReader(exporter))
65+
// Configure exporter for traces
66+
traceExporter, err := otelstdouttrace.New(otelstdouttrace.WithPrettyPrint())
67+
if err != nil {
68+
log.Fatalf("Failed to create stdouttrace exporter: %v", err)
69+
}
70+
traceProvider := sdktrace.NewTracerProvider(sdktrace.WithBatcher(traceExporter), sdktrace.WithResource(otelresource.NewWithAttributes(semconv.SchemaURL, semconv.ServiceName("grpc-server"))))
71+
// Configure W3C Trace Context Propagator for traces
72+
textMapPropagator := otelpropagation.TraceContext{}
73+
so := opentelemetry.ServerOption(opentelemetry.Options{
74+
MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: meterProvider},
75+
TraceOptions: oteltracing.TraceOptions{TracerProvider: traceProvider, TextMapPropagator: textMapPropagator}})
6076

61-
so := opentelemetry.ServerOption(opentelemetry.Options{MetricsOptions: opentelemetry.MetricsOptions{MeterProvider: provider}})
77+
go http.ListenAndServe(*prometheusEndpoint, promhttp.Handler())
6278

6379
lis, err := net.Listen("tcp", *addr)
6480
if err != nil {

‎examples/go.mod

+3-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ go 1.23.0
55
require (
66
github.com/cncf/xds/go v0.0.0-20250326154945-ae57f3c0d45f
77
github.com/prometheus/client_golang v1.21.1
8+
go.opentelemetry.io/otel v1.35.0
89
go.opentelemetry.io/otel/exporters/prometheus v0.57.0
10+
go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.35.0
11+
go.opentelemetry.io/otel/sdk v1.35.0
912
go.opentelemetry.io/otel/sdk/metric v1.35.0
1013
golang.org/x/oauth2 v0.28.0
1114
google.golang.org/genproto/googleapis/rpc v0.0.0-20250324211829-b45e905df463
@@ -68,9 +71,7 @@ require (
6871
go.opentelemetry.io/contrib/detectors/gcp v1.35.0 // indirect
6972
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.60.0 // indirect
7073
go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.60.0 // indirect
71-
go.opentelemetry.io/otel v1.35.0 // indirect
7274
go.opentelemetry.io/otel/metric v1.35.0 // indirect
73-
go.opentelemetry.io/otel/sdk v1.35.0 // indirect
7475
go.opentelemetry.io/otel/trace v1.35.0 // indirect
7576
golang.org/x/crypto v0.36.0 // indirect
7677
golang.org/x/net v0.38.0 // indirect

‎examples/go.sum

+3
Original file line numberDiff line numberDiff line change
@@ -1151,6 +1151,8 @@ go.opentelemetry.io/otel v1.35.0 h1:xKWKPxrxB6OtMCbmMY021CqC45J+3Onta9MqjhnusiQ=
11511151
go.opentelemetry.io/otel v1.35.0/go.mod h1:UEqy8Zp11hpkUrL73gSlELM0DupHoiq72dR+Zqel/+Y=
11521152
go.opentelemetry.io/otel/exporters/prometheus v0.57.0 h1:AHh/lAP1BHrY5gBwk8ncc25FXWm/gmmY3BX258z5nuk=
11531153
go.opentelemetry.io/otel/exporters/prometheus v0.57.0/go.mod h1:QpFWz1QxqevfjwzYdbMb4Y1NnlJvqSGwyuU0B4iuc9c=
1154+
go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.35.0 h1:T0Ec2E+3YZf5bgTNQVet8iTDW7oIk03tXHq+wkwIDnE=
1155+
go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.35.0/go.mod h1:30v2gqH+vYGJsesLWFov8u47EpYTcIQcBjKpI6pJThg=
11541156
go.opentelemetry.io/otel/metric v1.32.0/go.mod h1:jH7CIbbK6SH2V2wE16W05BHCtIDzauciCRLoc/SyMv8=
11551157
go.opentelemetry.io/otel/metric v1.35.0 h1:0znxYu2SNyuMSQT4Y9WDWej0VpcsxkuklLa4/siN90M=
11561158
go.opentelemetry.io/otel/metric v1.35.0/go.mod h1:nKVFgxBZ2fReX6IlyW28MgZojkoAkJGaE8CpgeAU3oE=
@@ -1165,6 +1167,7 @@ go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqe
11651167
go.opentelemetry.io/proto/otlp v0.15.0/go.mod h1:H7XAot3MsfNsj7EXtrA2q5xSNQ10UqI405h3+duxN4U=
11661168
go.opentelemetry.io/proto/otlp v0.19.0/go.mod h1:H7XAot3MsfNsj7EXtrA2q5xSNQ10UqI405h3+duxN4U=
11671169
go.opentelemetry.io/proto/otlp v1.0.0/go.mod h1:Sy6pihPLfYHkr3NkUbEhGHFhINUSI/v80hjKIs5JXpM=
1170+
go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
11681171
go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
11691172
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
11701173
golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=

0 commit comments

Comments
 (0)