From 1b222f958a43ab4e44ebca3bc93a07aabda5a225 Mon Sep 17 00:00:00 2001 From: Juli Tera Date: Wed, 28 Aug 2024 14:43:18 -0700 Subject: [PATCH] Update based on feedback --- .../lib/aws-sdk-core/plugins/telemetry.rb | 14 ++++++++------ .../lib/aws-sdk-core/telemetry/base.rb | 4 ++-- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/gems/aws-sdk-core/lib/aws-sdk-core/plugins/telemetry.rb b/gems/aws-sdk-core/lib/aws-sdk-core/plugins/telemetry.rb index 68300a86c6b..57bfb216713 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-core/plugins/telemetry.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-core/plugins/telemetry.rb @@ -9,12 +9,14 @@ class Telemetry < Seahorse::Client::Plugin default: Aws::Telemetry::NoOpTelemetryProvider, doc_type: Aws::Telemetry::TelemetryProviderBase, rbs_type: Aws::Telemetry::TelemetryProviderBase, - docstring: <<~DOCS) do |_cfg| -Allows you to provide a telemetry provider, which is used -to emit telemetry data. By default, uses `NoOpTelemetryProvider` -which will not record or emit any telemetry data. The SDK currently supports -OpenTelemetry (OTel) as a telemetry provider. To use the OTel provider, -require the`opentelemetry-sdk` gem and then, pass in an instance of a + docstring: <<-DOCS) do |_cfg| +Allows you to provide a telemetry provider, which is used to +emit telemetry data. By default, uses `NoOpTelemetryProvider` which +will not record or emit any telemetry data. The SDK supports the +following telemetry providers: + +* OpenTelemetry (OTel) - To use the OTel provider, install and require the +`opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider. DOCS Aws::Telemetry::NoOpTelemetryProvider.new diff --git a/gems/aws-sdk-core/lib/aws-sdk-core/telemetry/base.rb b/gems/aws-sdk-core/lib/aws-sdk-core/telemetry/base.rb index 0ae0b950ec5..fbe011a4363 100644 --- a/gems/aws-sdk-core/lib/aws-sdk-core/telemetry/base.rb +++ b/gems/aws-sdk-core/lib/aws-sdk-core/telemetry/base.rb @@ -5,10 +5,10 @@ module Telemetry # Base for `TelemetryProvider` classes. # They are used to emit telemetry data. It needs the # following class implementations to function: - # - {TracerProviderBase} - A provider that returns a tracer + # * {TracerProviderBase} - A provider that returns a tracer # instance. Then, a tracer will create spans and those # spans will contain information in that given moment. - # - {ContextManagerBase} - Manages context and used to + # * {ContextManagerBase} - Manages context and used to # return the current context within a trace. class TelemetryProviderBase # @param [Aws::Telemetry::TracerBase] tracer_provider A provider