aspecto-opentelemetry 0.1.6 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d67f2909e02b637a0342f01aaab45d1cbb0b5fae5cc27271b76113fe7af183
-  data.tar.gz: 1615052d3f62bb92ac80f91e3bc5a4f5f035ed9f361cefd4e7f459b6b3849d77
+  metadata.gz: 005e783e20aa54623dca0a11daae40ef3e3d8a6d9b83a13b6fd44f11a0a7f00b
+  data.tar.gz: 9edaffde8afa0cbfb8f3547aec3fd4ab3fc236395e70e6ecb1e60b83f5d563b1
 SHA512:
-  metadata.gz: 7133ce0b64d98585b535fac5791f77b84850ed98c561ec820ea5ba9ebd282b04249810eae0af36cb34f7d52dcd0eb54c020432d03a0d0d967884362d49401f94
-  data.tar.gz: 8686004ce06bb37f4b4e92623b708d7905e1b9dfdf26220853f0887bfb19293123e58b3a633b251f92f6c91bce788ee5b4bb5879b37ce36176a163488b2c3c36
+  metadata.gz: a220142b3826b3cf0d95e73c559e0ac5ce0e29828f98883fd6e7f8e7a9c4a486bfe6620a49f73cbc938d23c3b0c48f8782147a69779256719520532112ef1b6d
+  data.tar.gz: fd9e2c8b3513d25599411f2718ff1f3aa79b75425fd9d81f75f32e1ceb7b69c4228dfc46abc1f0dc64a7f020c2916ed47f1bc29d11539cabf87e91945ce38851

data/README.md

@@ -1,5 +1,7 @@
 # Aspecto::OpenTelemetry
 
+[![Gem Version](https://badge.fury.io/rb/aspecto-opentelemetry.svg)](https://badge.fury.io/rb/aspecto-opentelemetry)
+
 Aspecto's SDK for ruby.  
 This gem is a distribution of OpenTelemetry pre-configured to use all available instrumentations and export trace data to Aspecto.
 
@@ -97,16 +99,18 @@ The only required config options are [`aspecto_auth`](https://app.aspecto.io/app
 
 ### Configuration Options
 
-| Option Name                          | Environment Variable                 | Type        | Default                                 | Description                                                                                                                                          |
-| ------------------------------------ | ------------------------------------ | ----------- | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `aspecto_auth`                       | `ASPECTO_AUTH`                       | UUID string | -                                       | Aspecto's [API key for authentication](https://app.aspecto.io/app/integration/api-key)                                                               |
-| `service_name`                       | `OTEL_SERVICE_NAME`                  | string      | -                                       | name of the service which is sending telemetry                                                                                                       |
-| `env`                                | `ASPECTO_ENV`                        | string      | extracted from rails or sinatra if used | deployment environment: `production` / `staging` / `development`, etc.                                                                               |
-| `log_level`                          | `OTEL_LOG_LEVEL`                     | string      | `ERROR`                                 | `ERROR` / `WARN` / `INFO`, etc.                                                                                                                      |
-| `sampling_ratio`                     | `ASPECTO_SAMPLING_RATIO`             | float       | 1.0                                     | How many of the traces starting in this service should be sampled. set to number in range [0.0, 1.0] where 0.0 is no sampling, and 1.0 is sample all |
-| `otel_exporter_otlp_traces_endpoint` | `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | URL         | "https://otelcol.aspecto.io/v1/trace"   | Url                                                                                                                                                  |
-| `require_config_for_traces` | `ASPECTO_REQUIRE_CONFIG_FOR_TRACES` | boolean         | False   | When `True`, the SDK will not trace anything until remote sampling configuration arrives (few hundreds ms). Can be used to enforce sampling configuration is always applied, with the cost of losing traces generated during service startup.
-                                                                                                                                                  |
+| Option Name | Environment Variable | Type | Default | Description |
+| --- | --- | --- | --- | --- |
+| `aspecto_auth` | `ASPECTO_AUTH` | UUID string | - | Aspecto's [API key](https://app.aspecto.io/app/integration/api-key) for authentication |
+| `service_name` | `OTEL_SERVICE_NAME` | string | - | Name of the service which is sending telemetry|
+| `env` | `ASPECTO_ENV` | string | Extracted from Rails or Sinatra if used | Deployment environment: `production` / `staging` / `development`, etc. |
+| `log_level` | `OTEL_LOG_LEVEL` | string | `ERROR` | `ERROR` / `WARN` / `INFO`, etc. |
+| `sampling_ratio` | `ASPECTO_SAMPLING_RATIO` | float | 1.0| How many of the traces starting in this service should be sampled. set to number in range [0.0, 1.0] where 0.0 is no sampling, and 1.0 is sample all |
+| `otel_exporter_otlp_traces_endpoint` | `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` | URL | `https://otelcol.aspecto.io/v1/trace` | Url |
+| `require_config_for_traces` | `ASPECTO_REQUIRE_CONFIG_FOR_TRACES` | boolean | `false` | When `true`, the SDK will not trace anything until remote sampling configuration arrives (few hundreds ms). Can be used to enforce sampling configuration is always applied, with the cost of losing traces generated during service startup. |
+| `extract_b3_context` | `ASPECTO_EXTRACT_B3_CONTEXT` | boolean | `false` | Set to `true` when the service receives requests from another instrumented component that propagate context via B3 protocol multi or single header. For example: Envoy Proxy, Ambassador and Istio |
+| `inject_b3_context_single_header` | `ASPECTO_INJECT_B3_CONTEXT_SINGLE_HEADER` | boolean | `false` | Set to `true` when the service send traffic to another instrumented component that propagate context via B3 **single header** protocol |
+| `inject_b3_context_multi_header` | `ASPECTO_INJECT_B3_CONTEXT_MULTI_HEADER` | boolean | `false` | Set to `true` when the service send traffic to another instrumented component that propagate context via B3 **multi header** protocol. For example: Envoy Proxy, Istio |
 
 ## Contributing
 

data/lib/aspecto/opentelemetry/config/remote_config.rb

@@ -16,6 +16,8 @@ module Aspecto
         def initialize(aspecto_auth, service_name, env, fallback_sampler)
           @service_name = service_name
           @env = env
+          @error_reported = false
+          @got_remote_config = false
           @fallback_sampler = fallback_sampler
           aspecto_config_host = ENV.fetch("ASPECTO_CONFIG_HOST", "https://config.aspecto.io")
           @aspecto_config_url = URI("#{aspecto_config_host}/config/#{aspecto_auth}")
@@ -27,7 +29,10 @@ module Aspecto
             update_config
           end
 
-          ::OpenTelemetry.logger.info "[Aspecto] SDK client initialized"
+          ::OpenTelemetry.logger.info "[Aspecto] initialized remote config polling"
+        rescue StandardError => e
+          ::OpenTelemetry.logger.error "[Aspecto] failed to initialize remote config polling"
+          ::OpenTelemetry.logger.error e
         end
 
         def shutdown
@@ -50,7 +55,7 @@ module Aspecto
           @http_client.verify_mode = OpenSSL::SSL::VERIFY_PEER
         end
 
-        def update_config # rubocop:disable Metrics/AbcSize
+        def update_config
           ::OpenTelemetry::Common::Utilities.untraced do
             request = Net::HTTP::Get.new(@aspecto_config_url.path)
             request["If-None-Match"] = @latest_config_etag unless @latest_config_etag.nil?
@@ -60,7 +65,7 @@ module Aspecto
             return if response_code == 304
 
             if response_code >= 400
-              ::OpenTelemetry.logger.error("[Aspecto] error when trying to get remote config. will try again in #{@remote_config_poll_frequency}")
+              log_config_error "failed to get remote config with http response #{response_code}."
               return
             end
 
@@ -68,13 +73,14 @@ module Aspecto
             handle_new_config JSON.parse(response.body) if response_code < 300
           end
         rescue StandardError => e
-          ::OpenTelemetry.logger.error "[Aspecto] updating remote config failed. using previous remote config"
-          ::OpenTelemetry.logger.debug e
+          log_config_error "updating remote config failed with exception.", e
         end
 
         def handle_new_config(config)
-          ::OpenTelemetry.logger.info("[Aspecto] successfully received remote configuration")
           update_sampler config["samplingRules"]
+          @error_reported = false
+          @got_remote_config = true
+          ::OpenTelemetry.logger.info("[Aspecto] successfully updated remote configuration")
         end
 
         def update_sampler(sampler_config)
@@ -84,6 +90,16 @@ module Aspecto
           # updating the sampler should be thread safe as it's an atomic setter on a global value
           ::OpenTelemetry.tracer_provider.sampler = message_process_sampler
         end
+
+        def log_config_error(msg, err = nil)
+          return if @error_reported # report every issue only once
+
+          retry_msg = "will try again until success every #{@remote_config_poll_frequency}."
+          previous_config_msg = @got_remote_config ? "using previous remote config" : "no previous config is avialable"
+          ::OpenTelemetry.logger.info("[Aspecto]: #{msg} #{retry_msg} #{previous_config_msg}")
+          ::OpenTelemetry.logger.info(err) if err
+          @error_reported = true
+        end
       end
     end
   end

data/lib/aspecto/opentelemetry/configurator.rb

@@ -6,7 +6,7 @@ module Aspecto
     class Configurator
       TRUTHY_VALUES = %w[1 T t true TRUE True].freeze
 
-      def initialize
+      def initialize # rubocop:disable Metrics/AbcSize
         # initialize config options from environment variables.
         # they can later be overwritten with configurator attribute setters
         # that have precedence over env
@@ -16,7 +16,12 @@ module Aspecto
         self.env = ENV["ASPECTO_ENV"] if ENV["ASPECTO_ENV"]
         self.sampling_ratio = Float(ENV.fetch("ASPECTO_SAMPLING_RATIO", 1.0))
         self.otel_exporter_otlp_traces_endpoint = ENV.fetch("OTEL_EXPORTER_OTLP_TRACES_ENDPOINT", "https://otelcol.aspecto.io/v1/trace")
-        self.require_config_for_traces = TRUTHY_VALUES.include?(ENV["ASPECTO_REQUIRE_CONFIG_FOR_TRACES"]&.strip)
+        self.require_config_for_traces = self.class.bool_env_variable "ASPECTO_REQUIRE_CONFIG_FOR_TRACES", false
+
+        # b3 propagattor
+        self.extract_b3_context = self.class.bool_env_variable "ASPECTO_EXTRACT_B3_CONTEXT", false
+        self.inject_b3_context_single_header = self.class.bool_env_variable "ASPECTO_INJECT_B3_CONTEXT_SINGLE_HEADER", false
+        self.inject_b3_context_multi_header = self.class.bool_env_variable "ASPECTO_INJECT_B3_CONTEXT_MULTI_HEADER", false
       end
 
       def service_name=(service_name)
@@ -27,7 +32,7 @@ module Aspecto
         @override_resource_attributes[::OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT] = env
       end
 
-      attr_accessor :sampling_ratio, :log_level, :otel_exporter_otlp_traces_endpoint, :require_config_for_traces
+      attr_accessor :sampling_ratio, :log_level, :otel_exporter_otlp_traces_endpoint, :require_config_for_traces, :extract_b3_context, :inject_b3_context_single_header, :inject_b3_context_multi_header
       attr_reader :aspecto_auth
 
       def aspecto_auth=(aspecto_auth)
@@ -38,6 +43,13 @@ module Aspecto
       def config_override_resource
         ::OpenTelemetry::SDK::Resources::Resource.create(@override_resource_attributes)
       end
+
+      def self.bool_env_variable(env_variable_name, default_value)
+        env_value = ENV[env_variable_name]
+        return default_value if env_value.nil?
+
+        TRUTHY_VALUES.include?(env_value.strip)
+      end
     end
   end
 end

data/lib/aspecto/opentelemetry/propagator/aspecto.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "opentelemetry"
+require "opentelemetry-propagator-b3"
+
+module Aspecto
+  module OpenTelemetry
+    module Propagator
+      # Aspecto OpenTelemetry Propagator Configuration
+      module Aspecto
+        extend self
+
+        W3C_PROPAGATOR = ::OpenTelemetry::Trace::Propagation::TraceContext.text_map_propagator
+        B3_SINGLE_PROPAGATOR = ::OpenTelemetry::Propagator::B3::Single.text_map_propagator
+        B3_MULTI_PROPAGATOR = ::OpenTelemetry::Propagator::B3::Multi.text_map_propagator
+
+        def from_configurator(configurator)
+          injectors = [W3C_PROPAGATOR]
+          injectors.push(B3_SINGLE_PROPAGATOR) if configurator.inject_b3_context_single_header
+          injectors.push(B3_MULTI_PROPAGATOR) if configurator.inject_b3_context_multi_header
+
+          extractors = [W3C_PROPAGATOR]
+          extractors.push(B3_SINGLE_PROPAGATOR, B3_MULTI_PROPAGATOR) if configurator.extract_b3_context
+
+          ::OpenTelemetry::Context::Propagation::CompositeTextMapPropagator.compose(injectors: injectors, extractors: extractors)
+        end
+      end
+    end
+  end
+end

data/lib/aspecto/opentelemetry/sampler/message_process_sampler.rb

@@ -29,7 +29,7 @@ module Aspecto
         private
 
         def should_sample_processing(parent_context, links, name, attributes)
-          return if links.length.zero?
+          return if !links || links.length.zero?
 
           decision = link_decision(links[0])
 

data/lib/aspecto/opentelemetry/version.rb

@@ -2,6 +2,6 @@
 
 module Aspecto
   module OpenTelemetry
-    VERSION = "0.1.6"
+    VERSION = "0.1.9"
   end
 end

data/lib/aspecto/opentelemetry.rb

@@ -2,14 +2,15 @@
 
 require_relative "opentelemetry/version"
 require_relative "opentelemetry/configurator"
+require_relative "opentelemetry/propagator/aspecto"
 require_relative "opentelemetry/resource/detectors/aspecto"
-require_relative "opentelemetry/resource/detectors/deployment"
 require_relative "opentelemetry/config/remote_config"
 
 require "opentelemetry/sdk"
 require "opentelemetry/exporter/otlp"
 require "opentelemetry/instrumentation/all"
 require "opentelemetry-instrumentation-aws_sdk"
+require "opentelemetry-resource-detector-deployment"
 
 module Aspecto
   # Aspecto OpenTelemetry Distro
@@ -27,7 +28,7 @@ module Aspecto
       ::OpenTelemetry::SDK.configure do |c|
         c.logger = Logger.new($stdout, level: configurator.log_level)
         c.resource = Aspecto::OpenTelemetry::Resource::Detectors::Aspecto.detect
-        c.resource = Aspecto::OpenTelemetry::Resource::Detectors::Deployment.detect
+        c.resource = ::OpenTelemetry::Resource::Detector::Deployment.detect
         c.resource = configurator.config_override_resource # must be last
         c.use_all "OpenTelemetry::Instrumentation::ActionPack" => { enable_recognize_route: true },
                   "OpenTelemetry::Instrumentation::AwsSdk" => {
@@ -50,6 +51,10 @@ module Aspecto
         end
       end
 
+      # Propagation
+      ::OpenTelemetry.propagation = ::Aspecto::OpenTelemetry::Propagator::Aspecto.from_configurator configurator
+
+      # Sampling
       if configurator.require_config_for_traces
         ::OpenTelemetry.logger.info "[Aspecto] Require config for traces. Applying ALWAYS_OFF sampler"
         ::OpenTelemetry.tracer_provider.sampler = ::OpenTelemetry::SDK::Trace::Samplers::ALWAYS_OFF

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspecto-opentelemetry
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.9
 platform: ruby
 authors:
 - Aspecto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aspecto-opentelemetry-instrumentation-aws_sdk
@@ -52,6 +52,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-propagator-b3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.2
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-resource-detector-deployment
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
@@ -167,8 +195,8 @@ files:
 - lib/aspecto/opentelemetry.rb
 - lib/aspecto/opentelemetry/config/remote_config.rb
 - lib/aspecto/opentelemetry/configurator.rb
+- lib/aspecto/opentelemetry/propagator/aspecto.rb
 - lib/aspecto/opentelemetry/resource/detectors/aspecto.rb
-- lib/aspecto/opentelemetry/resource/detectors/deployment.rb
 - lib/aspecto/opentelemetry/sampler/condition.rb
 - lib/aspecto/opentelemetry/sampler/message_process_sampler.rb
 - lib/aspecto/opentelemetry/sampler/operator.rb

data/lib/aspecto/opentelemetry/resource/detectors/deployment.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Aspecto
-  module OpenTelemetry
-    module Resource
-      module Detectors
-        # Deployment contains detect class method for determining deployment resource attributes
-        module Deployment
-          extend self
-
-          def detect
-            resource_attributes = {}
-            deployment_environment = rails_env || sinatra_env || rack_env
-            resource_attributes[::OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT] = deployment_environment if deployment_environment
-            ::OpenTelemetry::SDK::Resources::Resource.create(resource_attributes)
-          end
-
-          private
-
-          def rails_env
-            # rails extract env like this:
-            # https://github.com/rails/rails/blob/5647a9c1ced68d20338552d47a3b755e10a271c4/railties/lib/rails.rb#L74
-            # ActiveSupport::EnvironmentInquirer.new(ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence || "development")
-            ::Rails.env.to_s if defined?(::Rails.env)
-          end
-
-          def rack_env
-            ENV["RACK_ENV"]
-          end
-
-          def sinatra_env
-            # https://github.com/sinatra/sinatra/blob/e69b6b9dee7165d3a583fc8a6af10ceee1ea687d/lib/sinatra/base.rb#L1801
-            # cases:
-            #
-            # 1. if sinatra is "require"d before the detector, then we return the value from the library
-            # this case will return the default "development" fallback if not env variable is set which is good.
-            #
-            # 2. if sinatra is "require"d after the detector, then:
-            # 2.1 if user is setting environment via 'APP_ENV' or 'RACK_ENV' then those value will be picked up and reported
-            # 2.2 else, the sinatra environment will fallback to "development", but detector will return nil for it.
-            # this issue is not covered, as when detector initialize the immutable resource, it has no way
-            # of knowing if "sinatra" will be required later or not.
-            (::Sinatra::Base.environment.to_s if defined?(::Sinatra::Base.environment)) || ENV["APP_ENV"]
-          end
-        end
-      end
-    end
-  end
-end