missed docstring for smithyotelmetrics

metrics/smithy-otel-metrics/async.go

@@ -26,7 +26,7 @@ type int64Observer struct {
 
 var _ metrics.Int64Observer = (*int64Observer)(nil)
 
-func (o *int64Observer) Observe(ctx context.Context, v int64, opts ...metrics.RecordMetricOption) {
+func (o *int64Observer) Observe(_ context.Context, v int64, opts ...metrics.RecordMetricOption) {
 	o.observer.ObserveInt64(o.instrument, v, withMetricProps(opts...))
 }
 
@@ -48,7 +48,7 @@ type float64Observer struct {
 
 var _ metrics.Float64Observer = (*float64Observer)(nil)
 
-func (o *float64Observer) Observe(ctx context.Context, v float64, opts ...metrics.RecordMetricOption) {
+func (o *float64Observer) Observe(_ context.Context, v float64, opts ...metrics.RecordMetricOption) {
 	o.observer.ObserveFloat64(o.instrument, v, withMetricProps(opts...))
 }
 

metrics/smithy-otel-metrics/doc.go

@@ -0,0 +1,40 @@
+// Package smithyotelmetrics implements a Smithy client metrics adapter for the
+// OTEL Go SDK.
+//
+// # Usage
+//
+// Callers use the [Adapt] API in this package to wrap a concrete OTEL SDK
+// MeterProvider.
+//
+// The following example uses the AWS SDK for S3:
+//
+//	import (
+//		"github.com/aws/aws-sdk-go-v2/config"
+//		"github.com/aws/aws-sdk-go-v2/service/s3"
+//		smithyotelmetrics "github.com/aws/smithy-go/metrics/smithy-otel-metrics"
+//		"go.opentelemetry.io/otel/sdk/metric"
+//		"go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp"
+//	)
+//
+//	func main() {
+//		cfg, err := config.LoadDefaultConfig(context.Background())
+//		if err != nil {
+//			panic(err)
+//		}
+//
+//		// export via OTLP - perhaps to the otel collector, etc.
+//		exporter, err := otlpmetrichttp.New(ctx, otlpmetrichttp.WithEndpointURL("http://localhost:4318"))
+//		if err != nil {
+//			panic(err)
+//		}
+//
+//		// aggressive reader interval for demonstration purposes
+//		reader := metric.NewPeriodicReader(exporter, metric.WithInterval(time.Second))
+//		provider := metric.NewMeterProvider(metric.WithReader(reader)
+//
+//		svc := s3.NewFromConfig(cfg, func(o *s3.Options) {
+//			o.MeterProvider = smithyotelmetrics.Adapt(provider)
+//		})
+//		// ...
+//	}
+package smithyotelmetrics