aspecto-opentelemetry 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2bcc099a425ea9d9d4ea5279fcdde5fd1c72ee7a747cac0db749ec4946e6400
-  data.tar.gz: 4045a1f967fc690eb67d057311f8543924abb14a223fd6484135e3831bc1fa11
+  metadata.gz: dd25c9da7c25d1c4c7e7a389189e7f0369dc7b97120425eda7cf49d9fb344b42
+  data.tar.gz: '075783f49804d1e01c16b6b80d1c37ed3b0d1de4c05b6ed4f2cd19007c28ccfc'
 SHA512:
-  metadata.gz: 5abe512f0a006febca0d20dab3dc2600539ef5af63429e3f05e715278e2760f611cc85908176a08e84a5570a045d02fd6baba260a8b769b691e9ad13f8d29abd
-  data.tar.gz: f37300481a7a2994eb99600ed22fd122abaae7afe2569f36beb342f79204320b8726125fdb226adf1114169b178f6b7f43ff93c482c3d8b682681c9503d4579a
+  metadata.gz: eb1b4410ae3dfa99e61592663cc1f4dff627908632f784fc39938b72a698a9f220e2ce88feb636402ae7a1c791b3395ad7dd5a376daa240ee0398f62961a25a2
+  data.tar.gz: 67606263a5e1dc5ecbf8375bd511fd97e9728dd8fd6fa259d746641abb8a488b8e88d81a0b72416a3aee8184c94f30f61e2600bda267cfba6d8a16d814b1d82a

data/README.md

@@ -65,17 +65,12 @@ end
 
 | 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 |
+| `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 |
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/aspecto/opentelemetry/remote_config.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+
+module Aspecto
+  # Aspecto's OpenTelemetry distribution
+  module OpenTelemetry
+    def self.fetch_config(aspecto_auth)
+      aspecto_config_url = ENV["ASPECTO_CONFIG_HOST"] || "https://config.aspecto.io"
+
+      conn = Faraday.new "#{aspecto_config_url}/config/#{aspecto_auth}" do |f|
+        f.response :json # decode response bodies as JSON
+      end
+
+      ::OpenTelemetry::Common::Utilities.untraced do
+        response = conn.get
+        response.body
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "./utils"
+
+module Aspecto
+  # Aspecto OpenTelemetry Distro
+  module OpenTelemetry
+    module Sampler
+      # Aspecto's sampling rule condition
+      class Condition
+        def initialize(condition_config)
+          @comparison = condition_config["comparison"]&.to_sym
+          @value = condition_config["value"]
+          @from = condition_config["from"]&.to_sym
+          @key = condition_config["key"]
+        end
+
+        def satisfied?(attributes, span_name)
+          case @from
+          when :attribute
+            Sampler.meets_operator?(@comparison, @value, attributes[@key]&.to_s)
+          when :operation
+            Sampler.meets_operator?(@comparison, @value, span_name)
+          else
+            # Other "from" are not implemented for now
+            false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "./sampling_rule"
+require_relative "./utils"
+
+module Aspecto
+  # Aspecto OpenTelemetry Distro
+  module OpenTelemetry
+    module Sampler
+      # OpenTelemetry sampler which implements the remote rules logic with fallback to service sampler
+      class RulesSampler
+        def initialize(config, fallback_sampler, service_name, env)
+          @rules = config
+                   .select { |rule| Sampler.meets_operator?(rule["packageName"]["comparison"].to_sym, rule["packageName"]["value"], service_name) }
+                   .select { |rule| Sampler.meets_operator?(rule["env"]["comparison"].to_sym, rule["env"]["value"], env) }
+                   .map { |rule_config| SamplingRule.new rule_config }
+          @fallback_sampler = fallback_sampler
+        end
+
+        def should_sample?(trace_id:, parent_context:, links:, name:, kind:, attributes:)
+          matching_rule = @rules.find { |rule| rule.satisfied?(attributes, name) }
+          delegate_sampler = matching_rule ? matching_rule.sampler : @fallback_sampler
+          delegate_sampler.should_sample?(trace_id: trace_id, parent_context: parent_context, links: links, name: name, kind: kind, attributes: attributes)
+        end
+
+        def description
+          "RulesSampler {#{rules.length} rules}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "opentelemetry/sdk"
+require_relative "./condition"
+
+module Aspecto
+  # Aspecto OpenTelemetry Distro
+  module OpenTelemetry
+    module Sampler
+      # Single rule for sampling
+      class SamplingRule
+        def initialize(rule_config)
+          @id = rule_config["_id"]
+          @sampler = ::OpenTelemetry::SDK::Trace::Samplers.trace_id_ratio_based(rule_config["samplingRate"])
+          @conditions = rule_config["conditions"].map { |condition_config| Condition.new condition_config }
+        end
+
+        attr_reader :sampler
+
+        def satisfied?(attributes, span_name)
+          @conditions.all? { |condition| condition.satisfied?(attributes, span_name) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Aspecto
+  # Aspecto OpenTelemetry Distro
+  module OpenTelemetry
+    # Sampling logic for aspecto otel distribution
+    module Sampler
+      extend self
+
+      def meets_operator?(operator, expected, actual) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity
+        expected_lower = expected&.downcase
+        actual_lower = actual&.downcase
+        case operator
+        when :eq
+          expected_lower == actual_lower
+        when :ne
+          expected_lower != actual_lower
+        when :starts_with
+          actual_lower.start_with?(expected_lower)
+        when :ends_with
+          actual_lower.end_with?(expected_lower)
+        when :contains
+          actual_lower.include?(expected_lower)
+        when :not_contains
+          !actual_lower.include?(expected_lower)
+        when :matches
+          Regexp.new(expected_lower).match(actual_lower)
+        when :defined
+          !actual.nil?
+        when :undefined
+          actual.nil?
+        when :any
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/aspecto/opentelemetry/version.rb

@@ -2,6 +2,6 @@
 
 module Aspecto
   module OpenTelemetry
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/aspecto/opentelemetry.rb

@@ -4,6 +4,9 @@ require_relative "opentelemetry/version"
 require_relative "opentelemetry/configurator"
 require_relative "opentelemetry/resource/detectors/aspecto"
 require_relative "opentelemetry/resource/detectors/deployment"
+require_relative "opentelemetry/remote_config"
+require_relative "opentelemetry/sampler/rules_sampler"
+
 require "opentelemetry/sdk"
 require "opentelemetry/exporter/otlp"
 require "opentelemetry/instrumentation/all"
@@ -37,9 +40,19 @@ module Aspecto
                                                           })
           )
         )
+
+        at_exit do
+          ::OpenTelemetry.tracer_provider.shutdown
+        end
       end
 
-      ::OpenTelemetry.tracer_provider.sampler = ::OpenTelemetry::SDK::Trace::Samplers.parent_based(root: ::OpenTelemetry::SDK::Trace::Samplers.trace_id_ratio_based(configurator.sampling_ratio))
+      fallback_sampler = ::OpenTelemetry::SDK::Trace::Samplers.trace_id_ratio_based(configurator.sampling_ratio)
+      remote_config = fetch_config configurator.aspecto_auth
+      # 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 }
+      _, env = ::OpenTelemetry.tracer_provider.resource.attribute_enumerator.detect { |elem| elem[0] == ::OpenTelemetry::SemanticConventions::Resource::DEPLOYMENT_ENVIRONMENT }
+      rules_sampler = Sampler::RulesSampler.new remote_config["samplingRules"], fallback_sampler, service_name, env
+      ::OpenTelemetry.tracer_provider.sampler = ::OpenTelemetry::SDK::Trace::Samplers.parent_based(root: rules_sampler)
     rescue StandardError => e
       warn "Failed to initialize Aspecto tracing."
       warn e

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspecto-opentelemetry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Aspecto
@@ -10,20 +10,48 @@ bindir: exe
 cert_chain: []
 date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
+- !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: aspecto-opentelemetry-instrumentation-aws_sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement
@@ -124,8 +152,13 @@ files:
 - lib/aspecto/auto_instrument.rb
 - lib/aspecto/opentelemetry.rb
 - lib/aspecto/opentelemetry/configurator.rb
+- lib/aspecto/opentelemetry/remote_config.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/rules_sampler.rb
+- lib/aspecto/opentelemetry/sampler/sampling_rule.rb
+- lib/aspecto/opentelemetry/sampler/utils.rb
 - lib/aspecto/opentelemetry/version.rb
 homepage: https://docs.aspecto.io/
 licenses: