ddtrace 1.0.0.beta1 → 1.1.0

data/lib/datadog/core/metrics/client.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/core/utils/time'
 require 'datadog/core/utils/only_once'
 
@@ -95,7 +96,9 @@ module Datadog
 
           statsd.count(stat, value, metric_options(options))
         rescue StandardError => e
-          Datadog.logger.error("Failed to send count stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
+          Datadog.logger.error(
+            "Failed to send count stat. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+          )
         end
 
         def distribution(stat, value = nil, options = nil, &block)
@@ -106,7 +109,9 @@ module Datadog
 
           statsd.distribution(stat, value, metric_options(options))
         rescue StandardError => e
-          Datadog.logger.error("Failed to send distribution stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
+          Datadog.logger.error(
+            "Failed to send distribution stat. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+          )
         end
 
         def increment(stat, options = nil)
@@ -116,7 +121,9 @@ module Datadog
 
           statsd.increment(stat, metric_options(options))
         rescue StandardError => e
-          Datadog.logger.error("Failed to send increment stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
+          Datadog.logger.error(
+            "Failed to send increment stat. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+          )
         end
 
         def gauge(stat, value = nil, options = nil, &block)
@@ -127,7 +134,9 @@ module Datadog
 
           statsd.gauge(stat, value, metric_options(options))
         rescue StandardError => e
-          Datadog.logger.error("Failed to send gauge stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
+          Datadog.logger.error(
+            "Failed to send gauge stat. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+          )
         end
 
         def time(stat, options = nil)
@@ -143,7 +152,9 @@ module Datadog
               distribution(stat, ((finished - start) * 1000), options)
             end
           rescue StandardError => e
-            Datadog.logger.error("Failed to send time stat. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
+            Datadog.logger.error(
+              "Failed to send time stat. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+            )
           end
         end
 

data/lib/datadog/core/metrics/ext.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Core
     module Metrics

data/lib/datadog/core/metrics/helpers.rb

@@ -1,3 +1,5 @@
+# typed: false
+
 module Datadog
   module Core
     module Metrics

data/lib/datadog/core/metrics/logging.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'logger'
 require 'json'
 

data/lib/datadog/core/metrics/metric.rb

@@ -1,3 +1,5 @@
+# typed: false
+
 module Datadog
   module Core
     module Metrics

data/lib/datadog/core/metrics/options.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'datadog/core/metrics/ext'
 require 'datadog/core/environment/ext'
 require 'datadog/core/environment/identity'

data/lib/datadog/core/pin.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 
 module Datadog
   module Core

data/lib/datadog/core/runtime/metrics.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/runtime/ext'
 
 require 'datadog/core/metrics/client'
@@ -78,7 +79,7 @@ module Datadog
         def try_flush
           yield
         rescue StandardError => e
-          Datadog.logger.error("Error while sending runtime metric. Cause: #{e.message}")
+          Datadog.logger.error("Error while sending runtime metric. Cause: #{e.class.name} #{e.message}")
         end
 
         def default_metric_options

data/lib/datadog/core/utils/compression.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'stringio'
 require 'zlib'
 

data/lib/datadog/core/utils/forking.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module Core
     module Utils

data/lib/datadog/core/utils/object_set.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/utils/sequence'
 
 module Datadog

data/lib/datadog/core/utils/only_once.rb

@@ -1,6 +1,7 @@
-# typed: true
 # frozen_string_literal: true
 
+# typed: true
+
 module Datadog
   module Core
     module Utils

data/lib/datadog/core/utils/safe_dup.rb

@@ -0,0 +1,27 @@
+# typed: false
+
+module Datadog
+  module Core
+    module Utils
+      # Helper methods for safer dup
+      module SafeDup
+        if RUBY_VERSION < '2.2' # nil.dup only fails in Ruby 2.1
+          # Ensures #initialize can call nil.dup safely
+          module RefineNil
+            refine NilClass do
+              def dup
+                self
+              end
+            end
+          end
+
+          using RefineNil
+        end
+
+        def self.frozen_or_dup(v)
+          v.frozen? ? v : v.dup
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/utils/sequence.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Core
     module Utils

data/lib/datadog/core/utils/string_table.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/utils/sequence'
 
 module Datadog

data/lib/datadog/core/utils/time.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Core
     module Utils

data/lib/datadog/core/utils.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/utils/forking'
 require 'datadog/tracing/span'
 

data/lib/datadog/core/vendor/multipart-post/multipart/post/composite_read_io.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 #--
 # Copyright (c) 2007-2012 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/multipart/post/multipartable.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/multipart/post/parts.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/multipart/post/version.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Datadog
   module Core
     module Vendor

data/lib/datadog/core/vendor/multipart-post/multipart/post.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Datadog
   module Core
     module Vendor

data/lib/datadog/core/vendor/multipart-post/multipart.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 #--
 # Copyright (c) 2007-2013 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/vendor/multipart-post/net/http/post/multipart.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 #--
 # Copyright (c) 2007-2012 Nick Sieger.
 # See the file README.txt included with the distribution for

data/lib/datadog/core/worker.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Core
     # Base class for work tasks

data/lib/datadog/core/workers/async.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/core/logger'
 
 module Datadog
@@ -137,7 +138,9 @@ module Datadog
               # rubocop:disable Lint/RescueException
               rescue Exception => e
                 @error = e
-                Datadog.logger.debug("Worker thread error. Cause #{e.message} Location: #{Array(e.backtrace).first}")
+                Datadog.logger.debug(
+                  "Worker thread error. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+                )
                 raise
               end
               # rubocop:enable Lint/RescueException

data/lib/datadog/core/workers/interval_loop.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module Core
     module Workers

data/lib/datadog/core/workers/polling.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/core/workers/async'
 require 'datadog/core/workers/interval_loop'
 

data/lib/datadog/core/workers/queue.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module Core
     module Workers

data/lib/datadog/core/workers/runtime_metrics.rb

@@ -1,5 +1,4 @@
 # typed: false
-require 'forwardable'
 
 require 'datadog/core/runtime/metrics'
 
@@ -12,7 +11,6 @@ module Datadog
     module Workers
       # Emits runtime metrics asynchronously on a timed loop
       class RuntimeMetrics < Worker
-        extend Forwardable
         include Workers::Polling
 
         # In seconds

data/lib/datadog/core.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 # TODO: Move these requires to smaller modules.
 #       Would be better to lazy load these; not
 #       all of these components will be used in
@@ -58,6 +59,12 @@ require 'datadog/core/extensions'
 # We must load core extensions to make certain global APIs
 # accessible: both for Datadog features and the core itself.
 module Datadog
+  # Common, lower level, internal code used (or usable) by two or more
+  # products. It is a dependency of each product. Contrast with Datadog::Kit
+  # for higher-level features.
+  module Core
+  end
+
   extend Core::Extensions
 
   # Add shutdown hook:

data/lib/datadog/kit/enable_core_dumps.rb

@@ -0,0 +1,50 @@
+# typed: ignore
+
+module Datadog
+  module Kit
+    # This helper is used to enable core dumps for the current Ruby app. This is useful when debugging native-level
+    # crashes.
+    #
+    # It can be enabled simply by adding `require 'datadog/kit/enable_core_dumps'` to start of the app.
+    module EnableCoreDumps
+      def self.call
+        current_size, maximum_size = Process.getrlimit(:CORE)
+        core_pattern =
+          begin
+            File.read('/proc/sys/kernel/core_pattern').strip
+          rescue
+            '(Could not open /proc/sys/kernel/core_pattern)'
+          end
+
+        if maximum_size <= 0
+          Kernel.warn("[DDTRACE] Could not enable core dumps on crash, maximum size is #{maximum_size} (disabled).")
+          return
+        elsif maximum_size == current_size
+          Kernel.warn('[DDTRACE] Core dumps already enabled, nothing to do!')
+          return
+        end
+
+        begin
+          Process.setrlimit(:CORE, maximum_size)
+        rescue => e
+          Kernel.warn(
+            "[DDTRACE] Failed to enable core dumps. Cause: #{e.class.name} #{e.message} " \
+            "Location: #{Array(e.backtrace).first}"
+          )
+          return
+        end
+
+        if current_size == 0
+          Kernel.warn("[DDTRACE] Enabled core dumps. Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'")
+        else
+          Kernel.warn(
+            "[DDTRACE] Raised core dump limit. Old size: #{current_size} " \
+            "Maximum size: #{maximum_size} Output pattern: '#{core_pattern}'"
+          )
+        end
+      end
+    end
+  end
+end
+
+Datadog::Kit::EnableCoreDumps.call

data/lib/datadog/kit/identity.rb

@@ -0,0 +1,63 @@
+# typed: false
+
+module Datadog
+  module Kit
+    # Tracking identity via traces
+    module Identity
+      # Attach user information to the trace
+      #
+      # @param trace [TraceOperation] Trace to attach data to.
+      # @param id [String] Mandatory. Username or client id extracted
+      #   from the access token or Authorization header in the inbound request
+      #   from outside the system.
+      # @param email [String] Email of the authenticated user associated
+      #   to the trace.
+      # @param name [String] User-friendly name. To be displayed in the
+      #   UI if set.
+      # @param session_id [String] Session ID of the authenticated user.
+      # @param role [String] Actual/assumed role the client is making
+      #   the request under extracted from token or application security
+      #   context.
+      # @param scope [String] Scopes or granted authorities the client
+      #   currently possesses extracted from token or application security
+      #   context. The value would come from the scope associated with an OAuth
+      #   2.0 Access Token or an attribute value in a SAML 2.0 Assertion.
+      # @param others [Hash<String || Symbol, String>] Additional free-form
+      #   user information to attach to the trace.
+      #
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      def self.set_user(trace, id:, email: nil, name: nil, session_id: nil, role: nil, scope: nil, **others)
+        raise ArgumentError, 'missing required key: :id' if id.nil?
+
+        # enforce types
+
+        raise TypeError, 'id must be a String'         unless id.is_a?(String)
+        raise TypeError, 'email must be a String'      unless email.nil? || email.is_a?(String)
+        raise TypeError, 'name must be a String'       unless name.nil? || name.is_a?(String)
+        raise TypeError, 'session_id must be a String' unless session_id.nil? || session_id.is_a?(String)
+        raise TypeError, 'role must be a String'       unless role.nil? || role.is_a?(String)
+        raise TypeError, 'scope must be a String'      unless scope.nil? || scope.is_a?(String)
+
+        others.each do |k, v|
+          raise TypeError, "#{k.inspect} must be a String" unless v.nil? || v.is_a?(String)
+        end
+
+        # set tags once data is known consistent
+
+        trace.set_tag('usr.id', id)
+        trace.set_tag('usr.email', email)           unless email.nil?
+        trace.set_tag('usr.name', name)             unless name.nil?
+        trace.set_tag('usr.session_id', session_id) unless session_id.nil?
+        trace.set_tag('usr.role', role)             unless role.nil?
+        trace.set_tag('usr.scope', scope)           unless scope.nil?
+
+        others.each do |k, v|
+          trace.set_tag("usr.#{k}", v) unless v.nil?
+        end
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
+    end
+  end
+end

data/lib/datadog/kit.rb

@@ -0,0 +1,11 @@
+# typed: false
+
+module Datadog
+  # Datadog::Kit holds public-facing APIs for higher level user-facing
+  # features, these features not belonging to a specific product. Contrary to
+  # Datadog::Core, Kit depends on products.
+  module Kit
+  end
+end
+
+require 'datadog/kit/identity'

data/lib/datadog/opentracer/binary_propagator.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module OpenTracer
     # OpenTracing propagator for Datadog::OpenTracer::Tracer

data/lib/datadog/opentracer/carrier.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Datadog
   module OpenTracer
     # @public_api

data/lib/datadog/opentracer/distributed_headers.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/tracing/span'
 require 'datadog/tracing/distributed/headers/ext'
 

data/lib/datadog/opentracer/global_tracer.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module OpenTracer
     # Patch for OpenTracing module

data/lib/datadog/opentracer/propagator.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Datadog
   module OpenTracer
     # OpenTracing propagator for Datadog::OpenTracer::Tracer

data/lib/datadog/opentracer/rack_propagator.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/tracing/context'
 require 'datadog/tracing/distributed/headers/ext'
 require 'datadog/tracing/propagation/http'

data/lib/datadog/opentracer/scope.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module OpenTracer
     # OpenTracing adapter for scope

data/lib/datadog/opentracer/scope_manager.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Datadog
   module OpenTracer
     # @public_api

data/lib/datadog/opentracer/span.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'time'
 
 require 'datadog/tracing/metadata/ext'

data/lib/datadog/opentracer/span_context.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module OpenTracer
     # OpenTracing adapter for SpanContext

data/lib/datadog/opentracer/span_context_factory.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module OpenTracer
     # Creates new Datadog::OpenTracer::SpanContext

data/lib/datadog/opentracer/text_map_propagator.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/tracing/context'
 require 'datadog/tracing/distributed/headers/ext'
 require 'datadog/tracing/trace_operation'

data/lib/datadog/opentracer/thread_local_scope.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module OpenTracer
     # OpenTracing adapter for thread local scopes

data/lib/datadog/opentracer/thread_local_scope_manager.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module OpenTracer
     # OpenTracing adapter for thread local scope management

data/lib/datadog/opentracer/tracer.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'time'
 
 require 'datadog/tracing/context'
@@ -9,8 +10,6 @@ module Datadog
     # OpenTracing adapter for Datadog::Tracer
     # @public_api
     class Tracer < ::OpenTracing::Tracer
-      extend Forwardable
-
       # (see Datadog::Tracer)
       # @return [Datadog::Tracer]
       attr_reader \

data/lib/datadog/opentracer.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 require 'opentracing'
 require 'opentracing/carrier'
 require 'datadog/tracing'

data/lib/datadog/profiling/backtrace_location.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Profiling
     # Entity class used to represent an entry in a stack trace.

data/lib/datadog/profiling/buffer.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/buffer/thread_safe'
 require 'datadog/core/utils/object_set'
 require 'datadog/core/utils/string_table'

data/lib/datadog/profiling/collectors/code_provenance.rb

@@ -1,6 +1,7 @@
-# typed: false
 # frozen_string_literal: true
 
+# typed: false
+
 require 'set'
 require 'json'