aspecto-opentelemetry 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42bf7169cad40cd8e0fc53c8ef85c766f783330e06ed185c5bb14fcf48ce4d4d
-  data.tar.gz: aa44a60faa0b08052bbfb60458e53697fe6c11c22f0b64fe7285a4f4cec19635
+  metadata.gz: c8d67f2909e02b637a0342f01aaab45d1cbb0b5fae5cc27271b76113fe7af183
+  data.tar.gz: 1615052d3f62bb92ac80f91e3bc5a4f5f035ed9f361cefd4e7f459b6b3849d77
 SHA512:
-  metadata.gz: 81009b5b65381793e19eee34fb04c579a910952a4ad965b6b7879f69d15ac42477ec274380895a38a49b6fd31a991090a7ac7ab6ca9b1bbc27da524ceae23971
-  data.tar.gz: 2a1ac520558ef20b6fa09e7cad8c310b0507336ed7f1ab715bfe42ae8ab2df5dd8670e7132810b009e7289298d4572d16370cf45b8199d9d318b8ea47917448d
+  metadata.gz: 7133ce0b64d98585b535fac5791f77b84850ed98c561ec820ea5ba9ebd282b04249810eae0af36cb34f7d52dcd0eb54c020432d03a0d0d967884362d49401f94
+  data.tar.gz: 8686004ce06bb37f4b4e92623b708d7905e1b9dfdf26220853f0887bfb19293123e58b3a633b251f92f6c91bce788ee5b4bb5879b37ce36176a163488b2c3c36

data/README.md

@@ -105,6 +105,8 @@ The only required config options are [`aspecto_auth`](https://app.aspecto.io/app
 | `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.
+                                                                                                                                                  |
 
 ## Contributing
 

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require "faraday"
-require "faraday_middleware"
 require "rufus/scheduler"
+require "net/http"
+require "json"
 
 require_relative "../sampler/rules_sampler"
 require_relative "../sampler/message_process_sampler"
@@ -17,12 +17,9 @@ module Aspecto
           @service_name = service_name
           @env = env
           @fallback_sampler = fallback_sampler
-
-          aspecto_config_url = ENV.fetch("ASPECTO_CONFIG_HOST", "https://config.aspecto.io")
-          @http_client = Faraday.new "#{aspecto_config_url}/config/#{aspecto_auth}" do |f|
-            f.response :json # decode response bodies as JSON
-          end
-          @http_client.options.timeout = 10
+          aspecto_config_host = ENV.fetch("ASPECTO_CONFIG_HOST", "https://config.aspecto.io")
+          @aspecto_config_url = URI("#{aspecto_config_host}/config/#{aspecto_auth}")
+          init_http_client
 
           @scheduler = Rufus::Scheduler.new
           @remote_config_poll_frequency = ENV.fetch("ASPECTO_REMOTE_CONFIG_POLL_FREQUENCY", "30s")
@@ -39,19 +36,36 @@ module Aspecto
 
         private
 
+        def init_http_client
+          write_timeout_supported = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.6")
+
+          @http_client = Net::HTTP.new(@aspecto_config_url.host, @aspecto_config_url.port)
+          @http_client.read_timeout = 10
+          @http_client.open_timeout = 10
+          @http_client.write_timeout = 10 if write_timeout_supported
+          @http_client.max_retries = 0
+
+          # use uri.scheme == 'https' instead
+          @http_client.use_ssl = true
+          @http_client.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        end
+
         def update_config # rubocop:disable Metrics/AbcSize
           ::OpenTelemetry::Common::Utilities.untraced do
-            response = @http_client.get do |req|
-              req.headers["If-None-Match"] = @latest_config_etag unless @latest_config_etag.nil?
-            end
-            @latest_config_etag = response.headers["etag"]
-            return if response.status == 304
+            request = Net::HTTP::Get.new(@aspecto_config_url.path)
+            request["If-None-Match"] = @latest_config_etag unless @latest_config_etag.nil?
+            response = @http_client.request(request)
+            response_code = response.code.to_i
 
-            if response.status >= 400
+            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}")
               return
             end
-            handle_new_config response.body if response.status < 300
+
+            @latest_config_etag = response["etag"]
+            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"

data/lib/aspecto/opentelemetry/configurator.rb

@@ -4,6 +4,8 @@ module Aspecto
   module OpenTelemetry
     # Aspecto OpenTelemetry Distro Configurator
     class Configurator
+      TRUTHY_VALUES = %w[1 T t true TRUE True].freeze
+
       def initialize
         # initialize config options from environment variables.
         # they can later be overwritten with configurator attribute setters
@@ -14,6 +16,7 @@ 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)
       end
 
       def service_name=(service_name)
@@ -24,7 +27,7 @@ module Aspecto
         @override_resource_attributes[::OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT] = env
       end
 
-      attr_accessor :sampling_ratio, :log_level, :otel_exporter_otlp_traces_endpoint
+      attr_accessor :sampling_ratio, :log_level, :otel_exporter_otlp_traces_endpoint, :require_config_for_traces
       attr_reader :aspecto_auth
 
       def aspecto_auth=(aspecto_auth)

data/lib/aspecto/opentelemetry/version.rb

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

data/lib/aspecto/opentelemetry.rb

@@ -50,6 +50,11 @@ module Aspecto
         end
       end
 
+      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
+      end
+
       fallback_sampler = ::OpenTelemetry::SDK::Trace::Samplers.trace_id_ratio_based(configurator.sampling_ratio)
       # TODO: how to properly extract the data from resource?
       _, service_name = ::OpenTelemetry.tracer_provider.resource.attribute_enumerator.detect { |elem| elem[0] == ::OpenTelemetry::SemanticConventions::Resource::SERVICE_NAME }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspecto-opentelemetry
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Aspecto
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aspecto-opentelemetry-instrumentation-aws_sdk
@@ -24,34 +24,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.1.8
-- !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement