Skip to content

Commit

Permalink
Update based on feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
jterapin committed Aug 28, 2024
1 parent 5d171f6 commit 1b222f9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
14 changes: 8 additions & 6 deletions gems/aws-sdk-core/lib/aws-sdk-core/plugins/telemetry.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions gems/aws-sdk-core/lib/aws-sdk-core/telemetry/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1b222f9

Please sign in to comment.