|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +module Aws |
| 4 | + module Plugins |
| 5 | + # @api private |
| 6 | + class Telemetry < Seahorse::Client::Plugin |
| 7 | + option( |
| 8 | + :telemetry_provider, |
| 9 | + default: Aws::Telemetry::NoOpTelemetryProvider, |
| 10 | + doc_type: Aws::Telemetry::TelemetryProviderBase, |
| 11 | + rbs_type: Aws::Telemetry::TelemetryProviderBase, |
| 12 | + docstring: <<-DOCS) do |_cfg| |
| 13 | +Allows you to provide a telemetry provider, which is used to |
| 14 | +emit telemetry data. By default, uses `NoOpTelemetryProvider` which |
| 15 | +will not record or emit any telemetry data. The SDK supports the |
| 16 | +following telemetry providers: |
| 17 | +
|
| 18 | +* OpenTelemetry (OTel) - To use the OTel provider, install and require the |
| 19 | +`opentelemetry-sdk` gem and then, pass in an instance of a |
| 20 | +`Aws::Telemetry::OTelProvider` for telemetry provider. |
| 21 | + DOCS |
| 22 | + Aws::Telemetry::NoOpTelemetryProvider.new |
| 23 | + end |
| 24 | + |
| 25 | + def after_initialize(client) |
| 26 | + validate_telemetry_provider(client.config) |
| 27 | + end |
| 28 | + |
| 29 | + def validate_telemetry_provider(config) |
| 30 | + unless config.telemetry_provider.is_a?(Aws::Telemetry::TelemetryProviderBase) |
| 31 | + raise ArgumentError, |
| 32 | + 'Must provide a telemetry provider for the '\ |
| 33 | + '`telemetry_provider` configuration option.' |
| 34 | + end |
| 35 | + end |
| 36 | + |
| 37 | + class Handler < Seahorse::Client::Handler |
| 38 | + def call(context) |
| 39 | + span_wrapper(context) { @handler.call(context) } |
| 40 | + end |
| 41 | + |
| 42 | + private |
| 43 | + |
| 44 | + def span_wrapper(context, &block) |
| 45 | + service_id = service_id(context) |
| 46 | + attributes = { |
| 47 | + 'rpc.system' => 'aws-api', |
| 48 | + 'rpc.service' => service_id, |
| 49 | + 'rpc.method' => context.operation.name, |
| 50 | + 'code.function' => context.operation_name.to_s, |
| 51 | + 'code.namespace' => 'Aws::Plugins::Telemetry' |
| 52 | + } |
| 53 | + context.tracer.in_span( |
| 54 | + parent_span_name(context, service_id), |
| 55 | + attributes: attributes, |
| 56 | + kind: Aws::Telemetry::SpanKind::CLIENT, |
| 57 | + &block |
| 58 | + ) |
| 59 | + end |
| 60 | + |
| 61 | + def service_id(context) |
| 62 | + context.config.api.metadata['serviceId'] || |
| 63 | + context.config.api.metadata['serviceAbbreviation'] || |
| 64 | + context.config.api.metadata['serviceFullName'] |
| 65 | + end |
| 66 | + |
| 67 | + def parent_span_name(context, service_id) |
| 68 | + "#{service_id}.#{context.operation.name}".delete(' ') |
| 69 | + end |
| 70 | + end |
| 71 | + |
| 72 | + handler(Handler, step: :initialize, priority: 99) |
| 73 | + end |
| 74 | + end |
| 75 | +end |
0 commit comments