ddtrace 1.0.0.beta1 → 1.1.0

data/lib/datadog/profiling/load_native_extension.rb

@@ -0,0 +1,22 @@
+# typed: ignore
+
+# This file is used to load the profiling native extension. It works in two steps:
+#
+# 1. Load the ddtrace_profiling_loader extension. This extension will be used to load the actual extension, but in
+#    a special way that avoids exposing native-level code symbols. See `ddtrace_profiling_loader.c` for more details.
+#
+# 2. Use the Datadog::Profiling::Loader exposed by the ddtrace_profiling_loader extension to load the actual
+#    profiling native extension.
+#
+# All code on this file is on-purpose at the top-level; this makes it so this file is executed only once,
+# the first time it gets required, to avoid any issues with the native extension being initialized more than once.
+
+require "ddtrace_profiling_loader.#{RUBY_VERSION}_#{RUBY_PLATFORM}"
+
+extension_name = "ddtrace_profiling_native_extension.#{RUBY_VERSION}_#{RUBY_PLATFORM}"
+full_file_path = "#{__dir__}/../../#{extension_name}.#{RbConfig::CONFIG['DLEXT']}"
+init_function_name = "Init_#{extension_name.split('.').first}"
+
+status, result = Datadog::Profiling::Loader._native_load(full_file_path, init_function_name)
+
+raise "Failure to load #{extension_name} due to #{result}" if status == :error

data/lib/datadog/profiling/native_extension.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Profiling
     # This module contains classes and methods which are implemented using native code in the

data/lib/datadog/profiling/pprof/builder.rb

@@ -1,6 +1,7 @@
-# typed: true
 # frozen_string_literal: true
 
+# typed: true
+
 require 'datadog/profiling/flush'
 require 'datadog/profiling/pprof/message_set'
 require 'datadog/profiling/pprof/string_table'

data/lib/datadog/profiling/pprof/converter.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/profiling/ext'
 
 module Datadog

data/lib/datadog/profiling/pprof/message_set.rb

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

data/lib/datadog/profiling/pprof/payload.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Profiling
     module Pprof

data/lib/datadog/profiling/pprof/pprof_pb.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: lib/datadog/profiling/pprof/pprof.proto
 

data/lib/datadog/profiling/pprof/stack_sample.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/profiling/ext'
 require 'datadog/profiling/events/stack'
 require 'datadog/profiling/pprof/builder'

data/lib/datadog/profiling/pprof/string_table.rb

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

data/lib/datadog/profiling/pprof/template.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/profiling/pprof/payload'
 require 'datadog/profiling/pprof/message_set'
 require 'datadog/profiling/pprof/builder'

data/lib/datadog/profiling/preload.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 require 'ddtrace'
 
 Datadog::Profiling.start_if_enabled

data/lib/datadog/profiling/profiler.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Profiling
     # Profiling entry point, which coordinates collectors and a scheduler

data/lib/datadog/profiling/recorder.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/profiling/buffer'
 require 'datadog/profiling/flush'
 
@@ -74,7 +75,7 @@ module Datadog
 
         code_provenance = @code_provenance_collector.refresh.generate_json if @code_provenance_collector
 
-        Flush.new(
+        OldFlush.new(
           start: start,
           finish: finish,
           event_groups: event_groups,

data/lib/datadog/profiling/scheduler.rb

@@ -1,4 +1,5 @@
-# typed: false
+# typed: true
+
 require 'datadog/core/utils/time'
 
 require 'datadog/core/worker'
@@ -113,7 +114,7 @@ module Datadog
         # Sleep for a bit to cause misalignment between profilers in multi-process applications
         #
         # When not being run in a loop, it means the scheduler has not been started or was stopped, and thus
-        # a) it's being shutting down (and is trying to report the last profile)
+        # a) it's being shut down (and is trying to report the last profile)
         # b) it's being run as a one-shot, usually in a test
         # ...so in those cases we don't sleep
         #

data/lib/datadog/profiling/stack_recorder.rb

@@ -0,0 +1,33 @@
+# typed: false
+
+module Datadog
+  module Profiling
+    # Used to wrap a ddprof_ffi_Profile in a Ruby object and expose Ruby-level serialization APIs
+    # Methods prefixed with _native_ are implemented in `stack_recorder.c`
+    class StackRecorder
+      def serialize
+        status, result = self.class._native_serialize(self)
+
+        if status == :ok
+          start, finish, encoded_pprof = result
+
+          Datadog.logger.debug { "Encoded profile covering #{start.iso8601} to #{finish.iso8601}" }
+
+          [start, finish, encoded_pprof]
+        else
+          error_message = result
+
+          Datadog.logger.error("Failed to serialize profiling data: #{error_message}")
+
+          nil
+        end
+      end
+
+      # Used only for Ruby 2.2 and below which don't have the native `rb_time_timespec_new` API
+      # Called from native code
+      def self.ruby_time_from(timespec_seconds, timespec_nanoseconds)
+        Time.at(0).utc + timespec_seconds + (timespec_nanoseconds.to_r / 1_000_000_000)
+      end
+    end
+  end
+end

data/lib/datadog/profiling/tag_builder.rb

@@ -0,0 +1,48 @@
+# typed: true
+
+module Datadog
+  module Profiling
+    # Builds a hash of default plus user tags to be included in a profile
+    module TagBuilder
+      include Datadog::Profiling::Ext::Transport::HTTP # Tag name constants
+
+      def self.call(
+        settings:,
+        # Unified service tagging
+        env: settings.env,
+        service: settings.service,
+        version: settings.version,
+        # Other metadata
+        host: Core::Environment::Socket.hostname,
+        language: Core::Environment::Identity.lang,
+        pid: Process.pid.to_s,
+        profiler_version: Core::Environment::Identity.tracer_version,
+        runtime_engine: Core::Environment::Identity.lang_engine,
+        runtime_id: Core::Environment::Identity.id,
+        runtime_platform: Core::Environment::Identity.lang_platform,
+        runtime_version: Core::Environment::Identity.lang_version,
+        # User-provided tags
+        user_tags: settings.tags
+      )
+        tags = {
+          # When changing or adding these, make sure they are kept in sync with
+          # https://docs.google.com/spreadsheets/d/1LOGMf4c4Avbtn36uZ2SWvhIGKRPLM1BoWkUP4JYj7hA/ (Datadog internal link)
+          FORM_FIELD_TAG_HOST => host,
+          FORM_FIELD_TAG_LANGUAGE => language,
+          FORM_FIELD_TAG_PID => pid,
+          FORM_FIELD_TAG_PROFILER_VERSION => profiler_version,
+          FORM_FIELD_TAG_RUNTIME => language, # This is known to be repeated from language, above
+          FORM_FIELD_TAG_RUNTIME_ENGINE => runtime_engine,
+          FORM_FIELD_TAG_RUNTIME_ID => runtime_id,
+          FORM_FIELD_TAG_RUNTIME_PLATFORM => runtime_platform,
+          FORM_FIELD_TAG_RUNTIME_VERSION => runtime_version,
+        }
+        tags[FORM_FIELD_TAG_ENV] = env if env
+        tags[FORM_FIELD_TAG_SERVICE] = service if service
+        tags[FORM_FIELD_TAG_VERSION] = version if version
+
+        user_tags.merge(tags)
+      end
+    end
+  end
+end

data/lib/datadog/profiling/tasks/exec.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Profiling
     module Tasks
@@ -37,10 +38,10 @@ module Datadog
         def exec_with_error_handling(args)
           Kernel.exec(*args)
         rescue Errno::ENOENT => e
-          Kernel.warn "ddtracerb exec failed: #{e.message} (command was '#{args.join(' ')}')"
+          Kernel.warn "ddtracerb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(' ')}')"
           Kernel.exit 127
         rescue Errno::EACCES, Errno::ENOEXEC => e
-          Kernel.warn "ddtracerb exec failed: #{e.message} (command was '#{args.join(' ')}')"
+          Kernel.warn "ddtracerb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(' ')}')"
           Kernel.exit 126
         end
       end

data/lib/datadog/profiling/tasks/help.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Profiling
     module Tasks

data/lib/datadog/profiling/tasks/setup.rb

@@ -1,6 +1,6 @@
 # typed: false
+
 require 'datadog/core/utils/only_once'
-require 'datadog/profiling'
 require 'datadog/profiling/ext/forking'
 
 module Datadog
@@ -18,7 +18,8 @@ module Datadog
               setup_at_fork_hooks
             rescue StandardError, ScriptError => e
               Datadog.logger.warn do
-                "Profiler extensions unavailable. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+                "Profiler extensions unavailable. Cause: #{e.class.name} #{e.message} " \
+                "Location: #{Array(e.backtrace).first}"
               end
             end
           end
@@ -34,7 +35,8 @@ module Datadog
           end
         rescue StandardError, ScriptError => e
           Datadog.logger.warn do
-            "Profiler forking extensions unavailable. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+            "Profiler forking extensions unavailable. Cause: #{e.class.name} #{e.message} " \
+            "Location: #{Array(e.backtrace).first}"
           end
         end
 
@@ -64,7 +66,8 @@ module Datadog
                 Profiling.start_if_enabled
               rescue StandardError => e
                 Datadog.logger.warn do
-                  "Error during post-fork hooks. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
+                  "Error during post-fork hooks. Cause: #{e.class.name} #{e.message} " \
+                  "Location: #{Array(e.backtrace).first}"
                 end
               end
             end

data/lib/datadog/profiling/trace_identifiers/ddtrace.rb

@@ -1,6 +1,7 @@
-# typed: true
 # frozen_string_literal: true
 
+# typed: true
+
 require 'datadog/tracing'
 require 'datadog/tracing/metadata/ext'
 

data/lib/datadog/profiling/trace_identifiers/helper.rb

@@ -1,6 +1,7 @@
-# typed: true
 # frozen_string_literal: true
 
+# typed: true
+
 require 'datadog/profiling/trace_identifiers/ddtrace'
 
 module Datadog

data/lib/datadog/profiling/transport/client.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Profiling
     module Transport

data/lib/datadog/profiling/transport/http/api/endpoint.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/utils/compression'
 require 'datadog/core/vendor/multipart-post/multipart/post/composite_read_io'
 require 'datadog/profiling/ext'

data/lib/datadog/profiling/transport/http/api/instance.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/transport/http/api/instance'
 require 'datadog/profiling/transport/http/api/spec'
 

data/lib/datadog/profiling/transport/http/api/spec.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/transport/http/api/spec'
 
 module Datadog

data/lib/datadog/profiling/transport/http/api.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/transport/http/api/map'
 require 'datadog/profiling/encoding/profile'
 require 'datadog/profiling/transport/http/api/spec'

data/lib/datadog/profiling/transport/http/builder.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/transport/http/builder'
 
 require 'datadog/profiling/transport/http/api'

data/lib/datadog/profiling/transport/http/client.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/transport/http/client'
 require 'datadog/profiling/transport/client'
 

data/lib/datadog/profiling/transport/http/response.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/transport/http/response'
 require 'datadog/profiling/transport/response'
 

data/lib/datadog/profiling/transport/http.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/environment/ext'
 require 'ddtrace/transport/ext'
 

data/lib/datadog/profiling/transport/io/client.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/transport/io/client'
 require 'datadog/profiling/transport/client'
 require 'datadog/profiling/transport/request'

data/lib/datadog/profiling/transport/io/response.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 require 'ddtrace/transport/io/response'
 require 'datadog/profiling/transport/response'
 

data/lib/datadog/profiling/transport/io.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/profiling/transport/io/client'
 require 'datadog/profiling/encoding/profile'
 

data/lib/datadog/profiling/transport/parcel.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/transport/parcel'
 
 module Datadog

data/lib/datadog/profiling/transport/request.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'ddtrace/transport/request'
 require 'datadog/profiling/transport/parcel'
 

data/lib/datadog/profiling/transport/response.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Datadog
   module Profiling
     module Transport

data/lib/datadog/profiling.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core'
 require 'datadog/core/environment/variable_helpers'
 require 'datadog/core/utils/only_once'
@@ -9,9 +10,6 @@ module Datadog
     GOOGLE_PROTOBUF_MINIMUM_VERSION = Gem::Version.new('3.0')
     private_constant :GOOGLE_PROTOBUF_MINIMUM_VERSION
 
-    SKIPPED_NATIVE_EXTENSION_ONLY_ONCE = Core::Utils::OnlyOnce.new
-    private_constant :SKIPPED_NATIVE_EXTENSION_ONLY_ONCE
-
     def self.supported?
       unsupported_reason.nil?
     end
@@ -20,7 +18,7 @@ module Datadog
       # NOTE: Only the first matching reason is returned, so try to keep a nice order on reasons -- e.g. tell users
       # first that they can't use this on JRuby before telling them that they are missing protobuf
 
-      ruby_engine_unsupported? ||
+      native_library_compilation_skipped? ||
         native_library_failed_to_load? ||
         protobuf_gem_unavailable? ||
         protobuf_version_unsupported? ||
@@ -43,8 +41,24 @@ module Datadog
       !!profiler
     end
 
-    private_class_method def self.ruby_engine_unsupported?
-      'JRuby is not supported' if RUBY_ENGINE == 'jruby'
+    private_class_method def self.native_library_compilation_skipped?
+      skipped_reason = try_reading_skipped_reason_file
+
+      "Your ddtrace installation is missing support for the Continuous Profiler because #{skipped_reason}" if skipped_reason
+    end
+
+    private_class_method def self.try_reading_skipped_reason_file(file_api = File)
+      # This file, if it exists, is recorded by extconf.rb during compilation of the native extension
+      skipped_reason_file = "#{__dir__}/../../ext/ddtrace_profiling_native_extension/skipped_reason.txt"
+
+      begin
+        return unless file_api.exist?(skipped_reason_file)
+
+        contents = file_api.read(skipped_reason_file).strip
+        contents unless contents.empty?
+      rescue StandardError
+        # Do nothing
+      end
     end
 
     private_class_method def self.protobuf_gem_unavailable?
@@ -92,12 +106,11 @@ module Datadog
         # In the future it'd be nice to shuffle the logger startup to happen first to avoid this special case.
         Kernel.warn(
           '[DDTRACE] Error while loading google-protobuf gem. ' \
-          "Cause: '#{e.message}' Location: '#{Array(e.backtrace).first}'. " \
+          "Cause: '#{e.class.name} #{e.message}' Location: '#{Array(e.backtrace).first}'. " \
           'This can happen when google-protobuf is missing its native components. ' \
           'To fix this, try removing and reinstalling the gem, forcing it to recompile the components: ' \
           '`gem uninstall google-protobuf -a; BUNDLE_FORCE_RUBY_PLATFORM=true bundle install`. ' \
-          'If the error persists, please contact support via <https://docs.datadoghq.com/help/> or ' \
-          'file a bug at <https://github.com/DataDog/dd-trace-rb/blob/master/CONTRIBUTING.md#found-a-bug>.'
+          'If the error persists, please contact Datadog support at <https://docs.datadoghq.com/help/>.'
         )
         @protobuf_loaded = false
       end
@@ -109,31 +122,18 @@ module Datadog
       unless success
         if exception
           'There was an error loading the profiling native extension due to ' \
-          "'#{exception.message}' at '#{exception.backtrace.first}'"
+          "'#{exception.class.name} #{exception.message}' at '#{exception.backtrace.first}'"
         else
           'The profiling native extension did not load correctly. ' \
-          'If the error persists, please contact support via <https://docs.datadoghq.com/help/> or ' \
-          'file a bug at <https://github.com/DataDog/dd-trace-rb/blob/master/CONTRIBUTING.md#found-a-bug>.'
+          'For help solving this issue, please contact Datadog support at <https://docs.datadoghq.com/help/>.' \
         end
       end
     end
 
     private_class_method def self.try_loading_native_library
-      if Core::Environment::VariableHelpers.env_to_bool('DD_PROFILING_NO_EXTENSION', false)
-        SKIPPED_NATIVE_EXTENSION_ONLY_ONCE.run do
-          Kernel.warn(
-            '[DDTRACE] Skipped loading of profiling native extension due to DD_PROFILING_NO_EXTENSION environment ' \
-            'variable being set. ' \
-            'This option is experimental and will lead to the profiler not working in future releases. ' \
-            'If you needed to use this, please tell us why on <https://github.com/DataDog/dd-trace-rb/issues/new>.'
-          )
-        end
-
-        return [true, nil]
-      end
-
       begin
-        require "ddtrace_profiling_native_extension.#{RUBY_VERSION}_#{RUBY_PLATFORM}"
+        require 'datadog/profiling/load_native_extension'
+
         success =
           defined?(Profiling::NativeExtension) && Profiling::NativeExtension.send(:native_working?)
         [success, nil]
@@ -147,7 +147,9 @@ module Datadog
 
       require 'datadog/profiling/ext/forking'
       require 'datadog/profiling/collectors/code_provenance'
+      require 'datadog/profiling/collectors/old_stack'
       require 'datadog/profiling/collectors/stack'
+      require 'datadog/profiling/stack_recorder'
       require 'datadog/profiling/exporter'
       require 'datadog/profiling/recorder'
       require 'datadog/profiling/scheduler'
@@ -158,10 +160,11 @@ module Datadog
       require 'datadog/profiling/native_extension'
       require 'datadog/profiling/trace_identifiers/helper'
       require 'datadog/profiling/pprof/pprof_pb'
+      require 'datadog/profiling/tag_builder'
 
       true
     end
 
-    load_profiling if supported?
+    load_profiling
   end
 end

data/lib/datadog/tracing/analytics.rb

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

data/lib/datadog/tracing/buffer.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core'
 require 'datadog/core/environment/ext'
 require 'datadog/core/buffer/thread_safe'
@@ -57,7 +58,9 @@ module Datadog
 
         @buffer_spans += trace.length
       rescue StandardError => e
-        Datadog.logger.debug("Failed to measure queue accept. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
+        Datadog.logger.debug(
+          "Failed to measure queue accept. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+        )
       end
 
       def measure_drop(trace)
@@ -65,7 +68,9 @@ module Datadog
 
         @buffer_spans -= trace.length
       rescue StandardError => e
-        Datadog.logger.debug("Failed to measure queue drop. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
+        Datadog.logger.debug(
+          "Failed to measure queue drop. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+        )
       end
 
       def measure_pop(traces)
@@ -88,7 +93,9 @@ module Datadog
         @buffer_dropped = 0
         @buffer_spans = 0
       rescue StandardError => e
-        Datadog.logger.debug("Failed to measure queue. Cause: #{e.message} Source: #{Array(e.backtrace).first}")
+        Datadog.logger.debug(
+          "Failed to measure queue. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
+        )
       end
     end
 

data/lib/datadog/tracing/configuration/ext.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module Tracing
     module Configuration

data/lib/datadog/tracing/context.rb

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