Merge branch 'master' into delner/20240305_update_2.0

Author: delner

.github/labeler.yml

@@ -14,7 +14,7 @@ dev/testing:
 
 # Changes to Profiling
 profiling:
-  - any: [ '{lib/datadog/profiling/**,ext/ddtrace_profiling_loader/**,ext/ddtrace_profiling_native_extension/**}' ]
+  - any: [ '{lib/datadog/profiling/**,ext/datadog_profiling_loader/**,ext/datadog_profiling_native_extension/**}' ]
 
 # Changes to CI-App
 ci-app:

.gitlab-ci.yml

@@ -177,6 +177,7 @@ onboarding_tests:
 
 deploy_to_reliability_env:
   stage: deploy
+  needs: [] # This allows the job to run without prerequisites
   rules:
     - if: $CI_PIPELINE_SOURCE == "schedule"
       when: on_success

.gitlab/benchmarks.yml

@@ -83,6 +83,14 @@ only-profiling-gc:
     DD_PROFILING_NO_SIGNALS_WORKAROUND_ENABLED: "false"
     DD_PROFILING_FORCE_ENABLE_GC: "true"
 
+only-profiling-alloc:
+  extends: .benchmarks
+  variables:
+    DD_BENCHMARKS_CONFIGURATION: only-profiling
+    DD_PROFILING_ENABLED: "true"
+    DD_PROFILING_NO_SIGNALS_WORKAROUND_ENABLED: "false"
+    DD_PROFILING_EXPERIMENTAL_ALLOCATION_ENABLED: "true"
+
 profiling-and-tracing:
   extends: .benchmarks
   variables:

LICENSE-3rdparty.csv

@@ -1,6 +1,6 @@
 "Component","Origin","License","Copyright"
 "debase-ruby_core_source","https://rubygems.org/gems/debase-ruby_core_source","MIT for gem and BSD-2-Clause for Ruby sources","Copyright (c) 2012 Gabriel Horner. Files from Ruby sources are Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved."
-"ext/ddtrace_profiling_native_extension/private_vm_api_access","https://github.com/ruby/ruby","BSD-2-Clause","Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved."
+"ext/datadog_profiling_native_extension/private_vm_api_access","https://github.com/ruby/ruby","BSD-2-Clause","Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved."
 "lib/datadog/core/vendor/multipart-post","https://github.com/socketry/multipart-post","MIT","Copyright (c) 2007-2013 Nick Sieger."
 "lib/datadog/tracing/contrib/active_record/vendor","https://github.com/rails/rails/","MIT","Copyright (c) 2005-2018 David Heinemeier Hansson"
 "lib/datadog/tracing/contrib/utils/quantization/http.rb","https://github.com/ruby/uri","BSD-2-Clause","Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved."

Rakefile

@@ -637,12 +637,12 @@ namespace :changelog do
 end
 
 NATIVE_EXTS = [
-  Rake::ExtensionTask.new("ddtrace_profiling_native_extension.#{RUBY_VERSION}_#{RUBY_PLATFORM}") do |ext|
-    ext.ext_dir = 'ext/ddtrace_profiling_native_extension'
+  Rake::ExtensionTask.new("datadog_profiling_native_extension.#{RUBY_VERSION}_#{RUBY_PLATFORM}") do |ext|
+    ext.ext_dir = 'ext/datadog_profiling_native_extension'
   end,
 
-  Rake::ExtensionTask.new("ddtrace_profiling_loader.#{RUBY_VERSION}_#{RUBY_PLATFORM}") do |ext|
-    ext.ext_dir = 'ext/ddtrace_profiling_loader'
+  Rake::ExtensionTask.new("datadog_profiling_loader.#{RUBY_VERSION}_#{RUBY_PLATFORM}") do |ext|
+    ext.ext_dir = 'ext/datadog_profiling_loader'
   end
 ].freeze
 

benchmarks/profiler_memory_sample_serialize.rb

@@ -0,0 +1,102 @@
+# Used to quickly run benchmark under RSpec as part of the usual test suite, to validate it didn't bitrot
+VALIDATE_BENCHMARK_MODE = ENV['VALIDATE_BENCHMARK'] == 'true'
+
+return unless __FILE__ == $PROGRAM_NAME || VALIDATE_BENCHMARK_MODE
+
+require 'benchmark/ips'
+require 'ddtrace'
+require 'pry'
+require_relative 'dogstatsd_reporter'
+
+require 'libdatadog'
+
+puts "Libdatadog from: #{Libdatadog.pkgconfig_folder}"
+
+# This benchmark measures the performance of sampling + serializing memory profiles. It enables us to evaluate changes to
+# the profiler and/or libdatadog that may impact both individual samples, as well as samples over time.
+#
+METRIC_VALUES = { 'cpu-time' => 0, 'cpu-samples' => 0, 'wall-time' => 0, 'alloc-samples' => 1, 'timeline' => 0 }.freeze
+OBJECT_CLASS = 'object'.freeze
+
+def sample_object(recorder, depth = 0)
+  if depth <= 0
+    Datadog::Profiling::StackRecorder::Testing._native_track_object(
+      recorder,
+      Object.new,
+      1,
+      OBJECT_CLASS,
+    )
+    Datadog::Profiling::Collectors::Stack::Testing._native_sample(
+      Thread.current,
+      recorder,
+      METRIC_VALUES,
+      [],
+      [],
+      400,
+      false
+    )
+  else
+    sample_object(recorder, depth - 1)
+  end
+end
+
+class ProfilerMemorySampleSerializeBenchmark
+  def create_profiler
+    @recorder = Datadog::Profiling::StackRecorder.new(
+      cpu_time_enabled: false,
+      alloc_samples_enabled: true,
+      heap_samples_enabled: false,
+      heap_size_enabled: false,
+      heap_sample_every: 1,
+      timeline_enabled: false,
+    )
+  end
+
+  def run_benchmark
+    Benchmark.ips do |x|
+      benchmark_time = VALIDATE_BENCHMARK_MODE ? { time: 0.01, warmup: 0 } : { time: 10, warmup: 2 }
+      x.config(
+        **benchmark_time,
+        suite: report_to_dogstatsd_if_enabled_via_environment_variable(benchmark_name: 'profiler_memory_sample_serialize')
+      )
+
+      x.report("sample+serialize #{ENV['CONFIG']}") do
+        samples_per_second = 100
+        simulate_seconds = 60
+
+        (samples_per_second * simulate_seconds).times do |i|
+          sample_object(@recorder, i % 400)
+        end
+
+        @recorder.serialize
+        nil
+      end
+
+      x.save! 'profiler_memory_sample_serialize-results.json' unless VALIDATE_BENCHMARK_MODE
+      x.compare!
+    end
+
+    @recorder.serialize
+  end
+
+  def run_forever
+    loop do
+      1000.times do |i|
+        sample_object(@recorder, i % 400)
+      end
+      @recorder.serialize
+      print '.'
+    end
+  end
+end
+
+puts "Current pid is #{Process.pid}"
+
+ProfilerMemorySampleSerializeBenchmark.new.instance_exec do
+  create_profiler
+  if ARGV.include?('--forever')
+    run_forever
+  else
+    run_benchmark
+  end
+end

bin/ddprofrb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+require 'datadog/profiling/tasks/exec'
+require 'datadog/profiling/tasks/help'
+
+command = ARGV.shift
+
+case command
+when 'exec'
+  Datadog::Profiling::Tasks::Exec.new(ARGV).run
+when 'help', '--help'
+  Datadog::Profiling::Tasks::Help.new.run
+else
+  puts "Command '#{command}' is not valid for ddprofrb."
+  Datadog::Profiling::Tasks::Help.new.run
+end

bin/ddtracerb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+Kernel.warn 'WARNING: Use of `ddtracerb` is deprecated, and will be removed in 2.0. Use `ddprofrb` instead.'
+
 require 'datadog/profiling/tasks/exec'
 require 'datadog/profiling/tasks/help'
 
@@ -10,6 +12,6 @@ when 'exec'
 when 'help', '--help'
   Datadog::Profiling::Tasks::Help.new.run
 else
-  puts "Command '#{command}' is not valid for ddtrace."
+  puts "Command '#{command}' is not valid for ddtracerb."
   Datadog::Profiling::Tasks::Help.new.run
 end

ddtrace.gemspec

@@ -44,7 +44,7 @@ Gem::Specification.new do |spec|
       .reject { |fn| fn.end_with?('.so', '.bundle') } # Exclude local profiler binary artifacts
       .reject { |fn| fn.end_with?('skipped_reason.txt') } # Generated by profiler; should never be distributed
 
-  spec.executables   = ['ddtracerb']
+  spec.executables   = ['ddtracerb', 'ddprofrb']
   spec.require_paths = ['lib']
 
   # Used to serialize traces to send them to the Datadog Agent.
@@ -69,7 +69,7 @@ Gem::Specification.new do |spec|
 
   # Used by profiling (and possibly others in the future)
   # When updating the version here, please also update the version in `native_extension_helpers.rb` (and yes we have a test for it)
-  spec.add_dependency 'libdatadog', '~> 6.0.0.1.0'
+  spec.add_dependency 'libdatadog', '~> 6.0.0.2.0'
 
-  spec.extensions = ['ext/ddtrace_profiling_native_extension/extconf.rb', 'ext/ddtrace_profiling_loader/extconf.rb']
+  spec.extensions = ['ext/datadog_profiling_native_extension/extconf.rb', 'ext/datadog_profiling_loader/extconf.rb']
 end

docs/ProfilingDevelopment.md

@@ -32,7 +32,7 @@ with ongoing tracing information, if any. Relies on the `Collectors::Stack` for
 
 ## Initialization
 
-When started via `ddtracerb exec` (together with `DD_PROFILING_ENABLED=true`), initialization goes through the following
+When started via `ddprofrb exec` (together with `DD_PROFILING_ENABLED=true`), initialization goes through the following
 flow:
 
 1. <../lib/datadog/profiling/preload.rb> triggers the creation of the profiler instance by calling the method `Datadog::Profiling.start_if_enabled`

ext/ddtrace_profiling_loader/.clang-format ext/datadog_profiling_loader/.clang-format

@@ -14,7 +14,7 @@
 // up other's symbols (`RTLD_DEEPBIND`).
 //
 // But Ruby's extension loading mechanism is not configurable -- there's no way to tell it to use different flags when
-// calling `dlopen`. To get around this, this file (ddtrace_profiling_loader.c) introduces another extension
+// calling `dlopen`. To get around this, this file (datadog_profiling_loader.c) introduces another extension
 // (profiling loader) which has only a single responsibility: mimic Ruby's extension loading mechanism, but when calling
 // `dlopen` use a different set of flags.
 // This idea was shamelessly stolen from @lloeki's work in https://github.com/rubyjs/mini_racer/pull/179, big thanks!
@@ -48,7 +48,7 @@ static void unload_failed_library(void *handle);
 
 #define DDTRACE_EXPORT __attribute__ ((visibility ("default")))
 
-void DDTRACE_EXPORT Init_ddtrace_profiling_loader(void) {
+void DDTRACE_EXPORT Init_datadog_profiling_loader(void) {
   VALUE datadog_module = rb_define_module("Datadog");
   VALUE profiling_module = rb_define_module_under(datadog_module, "Profiling");
   VALUE loader_module = rb_define_module_under(profiling_module, "Loader");

ext/ddtrace_profiling_loader/ddtrace_profiling_loader.c ext/datadog_profiling_loader/datadog_profiling_loader.c

@@ -3,7 +3,7 @@
 
 if RUBY_ENGINE != 'ruby' || Gem.win_platform?
   $stderr.puts(
-    'WARN: Skipping build of ddtrace profiling loader. See ddtrace profiling native extension note for details.'
+    'WARN: Skipping build of Datadog profiling loader. See Datadog profiling native extension note for details.'
   )
 
   File.write('Makefile', 'all install clean: # dummy makefile that does nothing')
@@ -46,7 +46,7 @@ def add_compiler_flag(flag)
 add_compiler_flag '-Wunused-parameter'
 
 # The native extension is not intended to expose any symbols/functions for other native libraries to use;
-# the sole exception being `Init_ddtrace_profiling_loader` which needs to be visible for Ruby to call it when
+# the sole exception being `Init_datadog_profiling_loader` which needs to be visible for Ruby to call it when
 # it `dlopen`s the library.
 #
 # By setting this compiler flag, we tell it to assume that everything is private unless explicitly stated.
@@ -64,7 +64,7 @@ def add_compiler_flag(flag)
 # This makes it easier for development (avoids "oops I forgot to rebuild when I switched my Ruby") and ensures that
 # the wrong library is never loaded.
 # When requiring, we need to use the exact same string, including the version and the platform.
-EXTENSION_NAME = "ddtrace_profiling_loader.#{RUBY_VERSION}_#{RUBY_PLATFORM}".freeze
+EXTENSION_NAME = "datadog_profiling_loader.#{RUBY_VERSION}_#{RUBY_PLATFORM}".freeze
 
 create_makefile(EXTENSION_NAME)