From e1c829179410753306c4b4ac100668c211be0fec Mon Sep 17 00:00:00 2001 From: Sam Xie Date: Thu, 2 May 2024 15:06:24 -0700 Subject: [PATCH] Add metrics --- example/otel-collector/README.md | 2 +- example/otel-collector/go.mod | 8 ++- example/otel-collector/main.go | 94 +++++++++++++++++++++++++------- 3 files changed, 83 insertions(+), 21 deletions(-) diff --git a/example/otel-collector/README.md b/example/otel-collector/README.md index f7013acb5cf..dcb003bd679 100644 --- a/example/otel-collector/README.md +++ b/example/otel-collector/README.md @@ -52,7 +52,7 @@ web-browser to view the generated traces. The Prometheus UI is available at [http://localhost:9090](http://localhost:9090). Navigate there in your favorite -web-browser to view the generated metrics. +web-browser to view the generated metrics, for instance, `testapp_run_total`. # Shutting down diff --git a/example/otel-collector/go.mod b/example/otel-collector/go.mod index 9b096a7f13c..55cb8aaec93 100644 --- a/example/otel-collector/go.mod +++ b/example/otel-collector/go.mod @@ -9,8 +9,11 @@ replace ( require ( go.opentelemetry.io/otel v1.26.0 + go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v1.26.0 go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.26.0 + go.opentelemetry.io/otel/metric v1.26.0 go.opentelemetry.io/otel/sdk v1.26.0 + go.opentelemetry.io/otel/sdk/metric v1.26.0 go.opentelemetry.io/otel/trace v1.26.0 google.golang.org/grpc v1.63.2 ) @@ -21,7 +24,6 @@ require ( github.com/go-logr/stdr v1.2.2 // indirect github.com/grpc-ecosystem/grpc-gateway/v2 v2.19.1 // indirect go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.26.0 // indirect - go.opentelemetry.io/otel/metric v1.26.0 // indirect go.opentelemetry.io/proto/otlp v1.2.0 // indirect golang.org/x/net v0.23.0 // indirect golang.org/x/sys v0.19.0 // indirect @@ -38,3 +40,7 @@ replace go.opentelemetry.io/otel/exporters/otlp/otlptrace => ../../exporters/otl replace go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc => ../../exporters/otlp/otlptrace/otlptracegrpc replace go.opentelemetry.io/otel/metric => ../../metric + +replace go.opentelemetry.io/otel/sdk/metric => ../../sdk/metric + +replace go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc => ../../exporters/otlp/otlpmetric/otlpmetricgrpc diff --git a/example/otel-collector/main.go b/example/otel-collector/main.go index fa81633dc74..43c43ba74b9 100644 --- a/example/otel-collector/main.go +++ b/example/otel-collector/main.go @@ -19,29 +19,22 @@ import ( "go.opentelemetry.io/otel" "go.opentelemetry.io/otel/attribute" + "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc" "go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc" + "go.opentelemetry.io/otel/metric" "go.opentelemetry.io/otel/propagation" + sdkmetric "go.opentelemetry.io/otel/sdk/metric" "go.opentelemetry.io/otel/sdk/resource" sdktrace "go.opentelemetry.io/otel/sdk/trace" semconv "go.opentelemetry.io/otel/semconv/v1.24.0" "go.opentelemetry.io/otel/trace" ) -// Initializes an OTLP exporter, and configures the corresponding trace and -// metric providers. -func initProvider() (func(context.Context) error, error) { - ctx := context.Background() - - res, err := resource.New(ctx, - resource.WithAttributes( - // the service name used to display traces in backends - semconv.ServiceName("test-service"), - ), - ) - if err != nil { - return nil, fmt.Errorf("failed to create resource: %w", err) - } +var serviceName = semconv.ServiceNameKey.String("test-service") +// Initialize a gRPC connection to be used by both the tracer and meter +// providers. +func initConn() (*grpc.ClientConn, error) { // It connects the OpenTelemetry Collector through local gRPC connection. // You may replace `localhost:4317` with your endpoint. conn, err := grpc.NewClient("localhost:4317", @@ -52,6 +45,21 @@ func initProvider() (func(context.Context) error, error) { return nil, fmt.Errorf("failed to create gRPC connection to collector: %w", err) } + return conn, err +} + +// Initializes an OTLP exporter, and configures the corresponding trace provider. +func initTracerProvider(ctx context.Context, conn *grpc.ClientConn) (func(context.Context) error, error) { + res, err := resource.New(ctx, + resource.WithAttributes( + // The service name used to display traces in backends + serviceName, + ), + ) + if err != nil { + return nil, fmt.Errorf("failed to create resource: %w", err) + } + // Set up a trace exporter traceExporter, err := otlptracegrpc.New(context.Background(), otlptracegrpc.WithGRPCConn(conn)) if err != nil { @@ -68,30 +76,72 @@ func initProvider() (func(context.Context) error, error) { ) otel.SetTracerProvider(tracerProvider) - // set global propagator to tracecontext (the default is no-op). + // Set global propagator to tracecontext (the default is no-op). otel.SetTextMapPropagator(propagation.TraceContext{}) // Shutdown will flush any remaining spans and shut down the exporter. return tracerProvider.Shutdown, nil } +// Initializes an OTLP exporter, and configures the corresponding meter provider. +func initMeterProvider(ctx context.Context, conn *grpc.ClientConn) (func(context.Context) error, error) { + res, err := resource.New(ctx, + resource.WithAttributes( + // The service name used to display traces in backends + serviceName, + ), + ) + if err != nil { + return nil, fmt.Errorf("failed to create resource: %w", err) + } + + metricExporter, err := otlpmetricgrpc.New(ctx, otlpmetricgrpc.WithGRPCConn(conn)) + if err != nil { + return nil, fmt.Errorf("failed to create metrics exporter: %w", err) + } + + meterProvider := sdkmetric.NewMeterProvider( + sdkmetric.WithReader(sdkmetric.NewPeriodicReader(metricExporter)), + sdkmetric.WithResource(res), + ) + otel.SetMeterProvider(meterProvider) + + return meterProvider.Shutdown, nil +} + func main() { log.Printf("Waiting for connection...") ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt) defer cancel() - shutdown, err := initProvider() + conn, err := initConn() + if err != nil { + log.Fatal(err) + } + + shutdownTracerProvider, err := initTracerProvider(ctx, conn) + if err != nil { + log.Fatal(err) + } + defer func() { + if err := shutdownTracerProvider(ctx); err != nil { + log.Fatalf("failed to shutdown TracerProvider: %s", err) + } + }() + + shutdownMeterProvider, err := initMeterProvider(ctx, conn) if err != nil { log.Fatal(err) } defer func() { - if err := shutdown(ctx); err != nil { - log.Fatal("failed to shutdown TracerProvider: %w", err) + if err := shutdownMeterProvider(ctx); err != nil { + log.Fatalf("failed to shutdown MeterProvider: %s", err) } }() tracer := otel.Tracer("test-tracer") + meter := otel.Meter("test-meter") // Attributes represent additional key-value descriptors that can be bound // to a metric observer or recorder. @@ -101,7 +151,12 @@ func main() { attribute.String("attrC", "vanilla"), } - // work begins + runCount, err := meter.Int64Counter("run", metric.WithDescription("The number of times the iteration ran")) + if err != nil { + log.Fatal(err) + } + + // Work begins ctx, span := tracer.Start( ctx, "CollectorExporter-Example", @@ -109,6 +164,7 @@ func main() { defer span.End() for i := 0; i < 10; i++ { _, iSpan := tracer.Start(ctx, fmt.Sprintf("Sample-%d", i)) + runCount.Add(ctx, 1, metric.WithAttributes(commonAttrs...)) log.Printf("Doing really hard work (%d / 10)\n", i+1) <-time.After(time.Second)