datadog-lambda 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 195d3560e0bbcfc3874834d6f40e82d447b80c734445285a2f21730dfd4a7dd2
+  data.tar.gz: bea1f09ab1fb862507617be1c1045ace0dad31546dc3a4b8e073675e66a9cb41
+SHA512:
+  metadata.gz: d104d3a04a0cbaa9833e479d62dadc71ddac0064c49587ba3703554bb8731776f7c25cae0fa28bfafb6bb9146e6288b1e2ce573290cda2c4b3e30915bac540a0
+  data.tar.gz: 7fafb2dbc147e7a7d6b2dbafb03084f459a5a179a6959fc28fcc30e510c60a3e1b663c1ead3f09c93eae03c1bd05b5f39fa30ed03ac3f30a86d142a6d2de7937

data/lib/datadog/lambda.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+#
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache License Version 2.0.
+#
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019 Datadog, Inc.
+#
+
+require 'datadog/lambda/trace/listener'
+require 'datadog/lambda/utils/logger'
+require 'datadog/lambda/trace/patch_http'
+require 'json'
+require 'time'
+
+module Datadog
+  # Instruments AWS Lambda functions with Datadog distributed tracing and
+  # custom metrics
+  module Lambda
+    # Wrap the body of a lambda invocation
+    # @param event [Object] event sent to lambda
+    # @param context [Object] lambda context
+    # @param block [Proc] implementation of the handler function.
+    def self.wrap(event, _context, &block)
+      Datadog::Utils.update_log_level
+
+      @listener ||= Trace::Listener.new
+      @listener.on_start(event: event)
+      begin
+        res = block.call
+      ensure
+        @listener.on_end
+      end
+      res
+    end
+
+    # Gets the current tracing context
+    def self.trace_context
+      Datadog::Trace.trace_context
+    end
+
+    # Send a custom distribution metric
+    # @param name [String] name of the metric
+    # @param value [Numeric] value of the metric
+    # @param time [Time] the time of the metric, should be in the past
+    # @param tags [Hash] hash of tags, must be in "my.tag.name":"value" format
+    def self.metric(name, value, time: nil, **tags)
+      raise 'name must be a string' unless name.is_a?(String)
+      raise 'value must be a number' unless value.is_a?(Numeric)
+
+      time ||= Time.now
+      tag_list = ['dd_lambda_layer:datadog-ruby25']
+      tags.each do |tag|
+        tag_list.push("#{tag[0]}:#{tag[1]}")
+      end
+      time_ms = (time.to_f * 100).to_i
+      metric = { e: time_ms, m: name, t: tag_list, v: value }.to_json
+      puts metric
+    end
+  end
+end

data/lib/datadog/lambda/trace/constants.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+#
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache License Version 2.0.
+#
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019 Datadog, Inc.
+#
+
+module Datadog
+  module Trace
+    SAMPLE_MODE_USER_REJECT = -1
+    SAMPLE_MODE_AUTO_REJECT = 0
+    SAMPLE_MODE_AUTO_KEEP = 1
+    SAMPLE_MODE_USER_KEEP = 2
+    DD_TRACE_ID_HEADER = 'x-datadog-trace-id'
+    DD_PARENT_ID_HEADER = 'x-datadog-parent-id'
+    DD_SAMPLING_PRIORITY_HEADER = 'x-datadog-sampling-priority'
+    DD_XRAY_SUBSEGMENT_NAME = 'datadog-metadata'
+    DD_XRAY_SUBSEGMENT_KEY = 'trace'
+    DD_XRAY_SUBSEGMENT_NAMESPACE = 'datadog'
+  end
+end

data/lib/datadog/lambda/trace/context.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+#
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache License Version 2.0.
+#
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019 Datadog, Inc.
+#
+
+require 'aws-xray-sdk'
+require 'datadog/lambda/trace/constants'
+require 'datadog/lambda/utils/logger'
+
+module Datadog
+  # Trace contains utilities related to reading/writing trace context from
+  # lambda events/X-Ray
+  module Trace
+    class << self
+      def extract_trace_context(event)
+        context = read_trace_context_from_event(event)
+        unless context.nil?
+          begin
+            add_trace_context_to_xray(context)
+          rescue StandardError => e
+            Datadog::Utils.logger.error("couldn't add metadata to xray #{e}")
+          end
+          return context
+        end
+        read_trace_context_from_xray
+      end
+
+      def add_trace_context_to_xray(context)
+        seg = XRay.recorder.begin_subsegment(
+          DD_XRAY_SUBSEGMENT_NAME,
+          namespace: DD_XRAY_SUBSEGMENT_NAMESPACE
+        )
+        data = {
+          "parent-id": context[:parent_id],
+          "sampling-priority": context[:sample_mode].to_s,
+          "trace-id": context[:trace_id]
+        }
+        seg.metadata(namespace: DD_XRAY_SUBSEGMENT_NAMESPACE)
+           .update("#{DD_XRAY_SUBSEGMENT_KEY}": data)
+        XRay.recorder.end_subsegment
+      end
+
+      def current_trace_context(trace_context)
+        entity = XRay.recorder.current_entity
+        parent_id = entity.instance_variable_get('@parent_id')
+        {
+          trace_id: trace_context[:trace_id],
+          parent_id: convert_to_apm_parent_id(parent_id),
+          sample_mode: trace_context[:sample_mode]
+        }
+      end
+
+      def read_trace_context_from_xray
+        segment = XRay.recorder.current_entity
+        parent_id = segment.instance_variable_get('@parent_id')
+        mode = segment.sampled ? SAMPLE_MODE_USER_KEEP : SAMPLE_MODE_USER_REJECT
+        {
+          trace_id: convert_to_apm_trace_id(segment.trace_id),
+          parent_id: convert_to_apm_parent_id(parent_id),
+          sample_mode: mode
+        }
+      rescue StandardError => e
+        Datadog::Utils.logger.error("couldn't read xray trace header #{e}")
+        nil
+      end
+
+      def read_trace_context_from_event(event)
+        return nil unless headers?(event)
+
+        headers = event['headers'].transform_keys(&:downcase)
+
+        return nil unless trace_headers_present?(headers)
+
+        {
+          trace_id: headers[DD_TRACE_ID_HEADER],
+          parent_id: headers[DD_PARENT_ID_HEADER],
+          sample_mode: headers[DD_SAMPLING_PRIORITY_HEADER].to_i
+        }
+      end
+
+      def headers?(event)
+        event.is_a?(Hash) && event.key?('headers') &&
+          event['headers'].is_a?(Hash)
+      end
+
+      def trace_headers_present?(headers)
+        expected = [
+          DD_TRACE_ID_HEADER,
+          DD_PARENT_ID_HEADER,
+          DD_SAMPLING_PRIORITY_HEADER
+        ]
+        expected.each do |key|
+          return false unless headers.key?(key) && headers[key].is_a?(String)
+        end
+        true
+      end
+
+      def convert_to_apm_trace_id(xray_trace_id)
+        parts = xray_trace_id.split('-')
+        return nil if parts.length < 3
+
+        last_part = parts[2]
+        return nil if last_part.length != 24
+        # Make sure every character is hex
+        return nil if last_part.upcase[/\H/]
+
+        hex = last_part.to_i(16)
+        last_63_bits = hex & 0x7fffffffffffffff
+        last_63_bits.to_s(10)
+      end
+
+      def convert_to_apm_parent_id(xray_parent_id)
+        return nil if xray_parent_id.length != 16
+        return nil if xray_parent_id.upcase[/\H/]
+
+        hex = xray_parent_id.to_i(16)
+        hex.to_s(10)
+      end
+
+      def convert_to_sample_mode(xray_sampled)
+        xray_sampled == '1' ? SAMPLE_MODE_USER_KEEP : SAMPLE_MODE_USER_REJECT
+      end
+    end
+  end
+end

data/lib/datadog/lambda/trace/listener.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+#
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache License Version 2.0.
+#
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019 Datadog, Inc.
+#
+
+require 'datadog/lambda/trace/context'
+require 'datadog/lambda/trace/xray_lambda'
+require 'datadog/lambda/trace/patch_http'
+
+require 'aws-xray-sdk'
+
+module Datadog
+  module Trace
+    # TraceListener tracks tracing context information
+    class Listener
+      def initialize
+        XRay.recorder.configure(
+          patch: %I[aws_sdk],
+          context: Datadog::Trace::LambdaContext.new,
+          streamer: Datadog::Trace::LambdaStreamer.new,
+          emitter: Datadog::Trace::LambdaEmitter.new
+        )
+        Datadog::Trace.patch_http
+      end
+
+      def on_start(event:)
+        trace_context = Datadog::Trace.extract_trace_context(event)
+        Datadog::Trace.trace_context = trace_context
+        Datadog::Utils.logger.debug "extracted trace context #{trace_context}"
+      rescue StandardError => e
+        Datadog::Utils.logger.error "couldn't read tracing context #{e}"
+      end
+
+      def on_end; end
+    end
+  end
+end

data/lib/datadog/lambda/trace/patch_http.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+#
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache License Version 2.0.
+#
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019 Datadog, Inc.
+#
+
+require 'net/http'
+
+module Datadog
+  # Trace contains methods to help with patching Net/HTTP
+  module Trace
+    def self.trace_context
+      @trace_context
+    end
+
+    def self.trace_context=(val)
+      @trace_context = val
+    end
+
+    @patched = false
+    def self.patch_http
+      Net::HTTP.prepend NetExtensions unless @patched
+      @patched = true
+    end
+
+    # NetExtensions contains patches which add tracing context to http calls
+    module NetExtensions
+      def request(req, body = nil, &block)
+        logger = Datadog::Utils.logger
+        begin
+          context = Datadog::Trace.current_trace_context(
+            Datadog::Trace.trace_context
+          )
+
+          req[Datadog::Trace::DD_SAMPLING_PRIORITY_HEADER.to_sym] =
+            context[:sample_mode]
+          req[Datadog::Trace::DD_PARENT_ID_HEADER.to_sym] = context[:parent_id]
+          req[Datadog::Trace::DD_TRACE_ID_HEADER.to_sym] = context[:trace_id]
+          logger.debug("added context #{context} to request")
+        rescue StandardError => e
+          logger.error(
+            "couldn't add tracing context #{context} to request #{e}"
+          )
+        end
+        super(req, body, &block)
+      end
+    end
+  end
+end

data/lib/datadog/lambda/trace/xray_lambda.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+#
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache License Version 2.0.
+#
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019 Datadog, Inc.
+#
+
+require 'aws-xray-sdk'
+
+module Datadog
+  module Trace
+    # Workaround to XRay not being supported in Lambda
+    # https://github.com/aws/aws-xray-sdk-ruby/issues/20
+    class LambdaStreamer < XRay::DefaultStreamer
+      def initialize
+        @stream_threshold = 1 # Stream every subsegment as it is available
+      end
+    end
+
+    # LambdaEmitter filters out spans generated from the lambda daemon
+    class LambdaEmitter < XRay::DefaultEmitter
+      def should_send?(entity:)
+        entity.name != '127.0.0.1' # Do not send localhost entities.
+      end
+
+      def send_entity(entity:)
+        return nil unless should_send?(entity: entity)
+
+        super
+      end
+    end
+
+    # LambdaContext updated the trace id based on the curren trace header,
+    # using a FacadeSegment
+    class LambdaContext < XRay::DefaultContext
+      def handle_context_missing
+        nil
+      end
+
+      def check_context
+        # Create a new FacadeSegment if the _X_AMZN_TRACE_ID changes.
+        return if ENV['_X_AMZN_TRACE_ID'] == @current_trace_id
+
+        # puts "XRAY: Starting new segment for #{ENV['_X_AMZN_TRACE_ID']}"
+        @current_trace_id = ENV['_X_AMZN_TRACE_ID']
+        trace_header = XRay::TraceHeader.from_header_string(
+          header_str: @current_trace_id
+        )
+        segment = FacadeSegment.new(trace_id: trace_header.root,
+                                    parent_id: trace_header.parent_id,
+                                    id: trace_header.parent_id,
+                                    name: 'lambda_context',
+                                    sampled: trace_header.sampled)
+        store_entity(entity: segment)
+      end
+
+      def current_entity
+        # ensure the FacadeSegment is current whenever the current_entity is
+        # retrieved
+        check_context
+        super
+      end
+    end
+
+    # FacadeSegment is used to create a mock root span, that segments/
+    # subsegments can be attached to. This span will never be submitted to the
+    # X-Ray daemon
+    class FacadeSegment < XRay::Segment
+      def initialize(trace_id: nil, name: nil, parent_id: nil, id: nil,
+                     sampled: true)
+        super(trace_id: trace_id, name: name, parent_id: parent_id)
+        @id = id
+        @sampled = sampled
+      end
+
+      def ready_to_send?
+        false # never send this facade.
+      end
+    end
+  end
+end

data/lib/datadog/lambda/utils/logger.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache License Version 2.0.
+#
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019 Datadog, Inc.
+#
+
+require 'logger'
+
+module Datadog
+  # Utils contains utility functions shared between modules
+  module Utils
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def self.update_log_level
+      log_level = (ENV['DD_LOG_LEVEL'] || 'error').downcase
+      logger.level = case log_level
+                     when 'debug'
+                       Logger::DEBUG
+                     when 'info'
+                       Logger::INFO
+                     when 'warn'
+                       Logger::WARN
+                     else
+                       Logger::ERROR
+                     end
+    end
+  end
+end

data/lib/datadog/lambda/version.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+#
+# Unless explicitly stated otherwise all files in this repository are licensed
+# under the Apache License Version 2.0.
+#
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019 Datadog, Inc.
+#
+
+module Datadog
+  module Lambda
+    module VERSION
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      PRE = nil
+
+      STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: datadog-lambda
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Datadog, Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-xray-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+description: |
+  datadog-lambda is Datadog’s AWS Lambda integration for ruby. It is used to perform
+  distributed tracing between serverful and serverless environments, and send
+  custom metrics to Datadog.
+email:
+- dev@datadoghq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/datadog/lambda.rb
+- lib/datadog/lambda/trace/constants.rb
+- lib/datadog/lambda/trace/context.rb
+- lib/datadog/lambda/trace/listener.rb
+- lib/datadog/lambda/trace/patch_http.rb
+- lib/datadog/lambda/trace/xray_lambda.rb
+- lib/datadog/lambda/utils/logger.rb
+- lib/datadog/lambda/version.rb
+homepage: https://github.com/DataDog/dd-lambda-rb
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Instruments your Ruby AWS Lambda functions with Datadog
+test_files: []