opentelemetry-exporters-datadog 0.1.0

data/lib/opentelemetry/exporters/datadog/propagator.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+# Copyright 2020 OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+require 'opentelemetry/sdk'
+require 'opentelemetry/context/propagation'
+require 'ddtrace/distributed_tracing/headers/headers'
+require 'ddtrace/distributed_tracing/headers/helpers'
+
+module OpenTelemetry
+  module Exporters
+    module Datadog
+      # Injects context into carriers using the W3C Trace Context format
+      class Propagator
+        include OpenTelemetry::Context::Propagation::DefaultSetter
+        include OpenTelemetry::Context::Propagation::DefaultGetter
+
+        TRACE_ID_KEY = 'x-datadog-trace-id'
+        PARENT_ID_KEY = 'x-datadog-parent-id'
+        SAMPLING_PRIORITY_KEY = 'x-datadog-sampling-priority'
+        ORIGIN_KEY = 'x-datadog-origin'
+        DD_ORIGIN = '_dd_origin'
+        ORIGIN_REGEX = /#{DD_ORIGIN}\=(.*?)($|,)/.freeze
+        DEFAULT_INJECTORS = [
+          OpenTelemetry::Trace::Propagation::TraceContext.text_injector,
+          OpenTelemetry::CorrelationContext::Propagation.text_injector
+        ].freeze
+
+        DEFAULT_EXTRACTORS = [
+          OpenTelemetry::Trace::Propagation::TraceContext.rack_extractor,
+          OpenTelemetry::CorrelationContext::Propagation.rack_extractor
+        ].freeze
+
+        # Returns a new Propagator
+        def initialize
+          # pass
+          @truncation_helper = ::Datadog::DistributedTracing::Headers::Headers.new({})
+        end
+
+        # Set the span context on the supplied carrier.
+        #
+        # @param [Context] context The active {Context}.
+        # @param [optional Callable] setter An optional callable that takes a carrier and a key and
+        #   a value and assigns the key-value pair in the carrier. If omitted the default setter
+        #   will be used which expects the carrier to respond to [] and []=.
+        # @return [Object] the carrier with context injected
+        def inject(carrier, context, &setter)
+          return carrier unless (span_context = span_context_from(context))
+
+          sampled = span_context.trace_flags&.sampled? ? 1 : 0
+
+          origin = get_origin_string(span_context.tracestate)
+          setter ||= DEFAULT_SETTER
+          setter.call(carrier, PARENT_ID_KEY, @truncation_helper.value_to_id(span_context.span_id.unpack1('H*'), 16).to_s)
+          setter.call(carrier, TRACE_ID_KEY, @truncation_helper.value_to_id(span_context.trace_id.unpack1('H*'), 16).to_s)
+          setter.call(carrier, SAMPLING_PRIORITY_KEY, sampled.to_s)
+          setter.call(carrier, ORIGIN_KEY, origin) if origin
+
+          carrier
+        end
+
+        # Extract a remote {Trace::SpanContext} from the supplied carrier.
+        # Invalid headers will result in a new, valid, non-remote {Trace::SpanContext}.
+        #
+        # @param [Carrier] carrier The carrier to get the header from.
+        # @param [Context] context The context to be updated with extracted context
+        # @param [optional Callable] getter An optional callable that takes a carrier and a key and
+        #   returns the value associated with the key. If omitted the default getter will be used
+        #   which expects the carrier to respond to [] and []=.
+        # @yield [Carrier, String] if an optional getter is provided, extract will yield the carrier
+        #   and the header key to the getter.
+        # @return [Context] Updated context with span context from the header, or the original
+        #   context if parsing fails.
+        def extract(carrier, context, &getter)
+          getter ||= default_getter
+          trace_id = getter.call(carrier, TRACE_ID_KEY) || getter.call(carrier, rack_helper(TRACE_ID_KEY))
+          span_id = getter.call(carrier, PARENT_ID_KEY) || getter.call(carrier, rack_helper(PARENT_ID_KEY))
+          sampled = getter.call(carrier, SAMPLING_PRIORITY_KEY) || getter.call(carrier, rack_helper(SAMPLING_PRIORITY_KEY))
+          origin = getter.call(carrier, ORIGIN_KEY) || getter.call(carrier, rack_helper(ORIGIN_KEY))
+
+          is_sampled = sampled.to_i.positive? ? 1 : 0
+
+          tracestate = origin ? "#{DD_ORIGIN}=#{origin}" : nil
+
+          return context if trace_id.nil? || span_id.nil?
+
+          span_context = Trace::SpanContext.new(trace_id: Array(trace_id.to_i.to_s(16)).pack('H*'),
+                                                span_id: Array(span_id.to_i.to_s(16)).pack('H*'),
+                                                trace_flags: OpenTelemetry::Trace::TraceFlags.from_byte(is_sampled),
+                                                tracestate: tracestate,
+                                                remote: true)
+
+          context.set_value(Trace::Propagation::ContextKeys.extracted_span_context_key, span_context)
+        rescue StandardError => e
+          OpenTelemetry.logger.debug("error extracting datadog propagation, #{e.message}")
+          context
+        end
+
+        def self.auto_configure
+          default_propagator = new
+          updated_injectors = DEFAULT_INJECTORS + [default_propagator]
+          updated_extractors = DEFAULT_EXTRACTORS + [default_propagator]
+          OpenTelemetry.propagation.http = OpenTelemetry::Context::Propagation::CompositePropagator.new(
+            updated_injectors,
+            updated_extractors
+          )
+        end
+
+        private
+
+        # account for rack re-formatting of headers
+        def rack_helper(header)
+          "HTTP_#{header.to_s.upcase.gsub(/[-\s]/, '_')}"
+        end
+
+        def span_context_from(context)
+          context[Trace::Propagation::ContextKeys.current_span_key]&.context ||
+            context[Trace::Propagation::ContextKeys.extracted_span_context_key]
+        end
+
+        def get_origin_string(tracestate)
+          return if tracestate.nil? || tracestate.index(DD_ORIGIN).nil?
+
+          # Depending on the edge cases in tracestate values this might be
+          # less efficient than mapping string => array => hash.
+          origin_value = tracestate.match(ORIGIN_REGEX)
+          return if origin_value.nil?
+
+          origin_value[1]
+        rescue StandardError => e
+          OpenTelemetry.logger.debug("error getting origin from trace state, #{e.message}")
+        end
+      end
+    end
+  end
+end

data/lib/opentelemetry/exporters/datadog/version.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache 2.0 license (see LICENSE).
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2020 Datadog, Inc.
+
+module OpenTelemetry
+  module Exporters
+    module Datadog
+      ## Current OpenTelemetry Datadog exporter version
+      VERSION = '0.1.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: opentelemetry-exporters-datadog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Datadog, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ddtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+description: |
+  opentelemetry-exporters-datadog is Datadog’s trace exporter for the OpenTelemetry
+  Ruby tracing library, which  is used to trace requests across web servers, databases
+  and microservices. The exporter formats and sends these traces to a Datadog Agent so
+  that they can be ingested, stored, and analyzed with Datadog.
+email:
+- dev@datadoghq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- lib/opentelemetry-exporters-datadog.rb
+- lib/opentelemetry/exporters/datadog.rb
+- lib/opentelemetry/exporters/datadog/datadog_probability_sampler.rb
+- lib/opentelemetry/exporters/datadog/datadog_span_processor.rb
+- lib/opentelemetry/exporters/datadog/exporter.rb
+- lib/opentelemetry/exporters/datadog/exporter/span_encoder.rb
+- lib/opentelemetry/exporters/datadog/propagator.rb
+- lib/opentelemetry/exporters/datadog/version.rb
+homepage: https://github.com/Datadog/dd-opentelemetry-exporter-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Datadog trace exporter for the OpenTelemetry framework
+test_files: []