RubyGems - ddtrace - Versions diffs - 0.49.0 → 0.50.0 - Mend

ddtrace 0.49.0 → 0.50.0

Files changed (377) hide show

data/benchmarks/data/profiler-submission-marshal.gz ADDED Viewed

Binary file

data/benchmarks/profiler_submission.rb ADDED Viewed

@@ -0,0 +1,93 @@
+require 'benchmark/ips'
+require 'ddtrace'
+require 'pry'
+# This benchmark measures the performance of encoding pprofs and trying to submit them
+#
+# The FLUSH_DUMP_FILE (by default benchmarks/data/profiler-submission-marshal.gz, gathered from benchmarking using
+# the discourse forum rails app) can be generated by changing the scheduler.rb#flush_events to dump the contents of
+# "flush" to a file during a benchmark execution:
+#
+# dump_file = "marshal-#{Time.now.utc.to_i}.dump"
+# File.open(dump_file, "w") { |f| Marshal.dump(flush, f) }
+# Datadog.logger.info("Dumped to #{dump_file}")
+#
+# And then gzipping the result. (This can probably be automated a bit by adding an extra exporter, but the above worked
+# for me).
+class ProfilerSubmission
+  def create_profiler
+    @adapter_buffer = []
+    Datadog.configure do |c|
+      # c.diagnostics.debug = true
+      c.profiling.enabled = true
+      c.tracer.transport_options = proc { |t| t.adapter :test, @adapter_buffer }
+    end
+    # Stop background threads
+    Datadog.profiler.shutdown!
+    # Call exporter directly
+    @exporter = Datadog.profiler.scheduler.exporters.first
+    @flush = Marshal.load(
+      Zlib::GzipReader.new(File.open(ENV['FLUSH_DUMP_FILE'] || 'benchmarks/data/profiler-submission-marshal.gz'))
+    )
+  end
+  def check_valid_pprof
+    output_pprof = @adapter_buffer.last[:form]["data[0]"].io
+    expected_hashes = [
+      "75c65dec2d5d750faca3e905486c39ba44219636ac1bea15d5d624b741d4b62a",
+      "6780c47b3e271f2abe0346fd40ac358f6a34270b3a8f5743aacd1970bbbbc6f5"
+    ]
+    current_hash = Digest::SHA256.hexdigest(Zlib::GzipReader.new(output_pprof).read)
+    if expected_hashes.include?(current_hash)
+      puts "Output hash #{current_hash} matches known signature"
+    else
+      puts "WARNING: Unexpected pprof output -- unknown hash. Hashes seem to differ due to some of our dependencies changing, " \
+        "but it can also indicate that encoding output has become corrupted."
+    end
+  end
+  def run_benchmark
+    Benchmark.ips do |x|
+      x.config(time: 10, warmup: 2)
+      x.report("exporter #{ENV['CONFIG']}") do
+        run_once
+      end
+      x.save! 'profiler-submission-results.json'
+      x.compare!
+    end
+  end
+  def run_forever
+    while true
+      run_once
+      print '.'
+    end
+  end
+  def run_once
+    @adapter_buffer.clear
+    @exporter.export(@flush)
+  end
+end
+puts "Current pid is #{Process.pid}"
+ProfilerSubmission.new.instance_exec do
+  create_profiler
+  run_once
+  check_valid_pprof
+  if ARGV.include?('--forever')
+    run_forever
+  else
+    run_benchmark
+  end
+end

data/ddtrace.gemspec CHANGED Viewed

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   if RUBY_VERSION >= '2.2.0'
     spec.add_dependency 'msgpack'
   else
-    # msgpack 1.4 fails for Ruby 2.0 and 2.1: https://github.com/msgpack/msgpack-ruby/issues/205
+    # msgpack 1.4 fails for Ruby 2.1: https://github.com/msgpack/msgpack-ruby/issues/205
     spec.add_dependency 'msgpack', '< 1.4'
   end

data/docker-compose.yml CHANGED Viewed

@@ -1,35 +1,6 @@
 version: '3.2'
 services:
   # MRI
-  tracer-2.0:
-    image: palazzem/docker-library:ddtrace_rb_2_0_0
-    command: /bin/bash
-    depends_on:
-      - ddagent
-      - elasticsearch
-      - memcached
-      - mongodb
-      - mysql
-      - postgres
-      - presto
-      - redis
-    env_file: ./.env
-    environment:
-      - BUNDLE_GEMFILE=/app/Gemfile
-      - DD_AGENT_HOST=ddagent
-      - TEST_DATADOG_INTEGRATION=1
-      - TEST_ELASTICSEARCH_HOST=elasticsearch
-      - TEST_MEMCACHED_HOST=memcached
-      - TEST_MONGODB_HOST=mongodb
-      - TEST_MYSQL_HOST=mysql
-      - TEST_POSTGRES_HOST=postgres
-      - TEST_PRESTO_HOST=presto
-      - TEST_REDIS_HOST=redis
-    stdin_open: true
-    tty: true
-    volumes:
-      - .:/app
-      - bundle-2.0:/usr/local/bundle
   tracer-2.1:
     image: palazzem/docker-library:ddtrace_rb_2_1_10
     command: /bin/bash
@@ -329,8 +300,8 @@ services:
       - .:/app
       - bundle-jruby-9.2-latest:/usr/local/bundle
   # TruffleRuby
-  tracer-truffleruby-21.0.0:
-    image: ivoanjo/docker-library:ddtrace_rb_truffleruby_21_0_0
+  tracer-truffleruby-21.1.0:
+    image: ivoanjo/docker-library:ddtrace_rb_truffleruby_21_1_0
     command: /bin/bash
     depends_on:
       - ddagent
@@ -358,7 +329,7 @@ services:
     tty: true
     volumes:
       - .:/app
-      - bundle-truffleruby-21.0.0:/usr/local/bundle
+      - bundle-truffleruby-21.1.0:/usr/local/bundle
   ddagent:
     image: datadog/agent
     environment:
@@ -430,7 +401,6 @@ services:
     ports:
       - "${TEST_REDIS_PORT}:6379"
 volumes:
-  bundle-2.0:
   bundle-2.1:
   bundle-2.2:
   bundle-2.3:
@@ -441,4 +411,4 @@ volumes:
   bundle-3.0:
   bundle-jruby-9.2.0.0:
   bundle-jruby-9.2-latest:
-  bundle-truffleruby-21.0.0:
+  bundle-truffleruby-21.1.0:

data/docs/GettingStarted.md CHANGED Viewed

@@ -85,6 +85,7 @@ To contribute, check out the [contribution guidelines][contribution docs] and [d
      - [Metrics](#metrics)
          - [For application runtime](#for-application-runtime)
      - [OpenTracing](#opentracing)
+     - [Profiling](#profiling)
 ## Compatibility
@@ -100,7 +101,7 @@ To contribute, check out the [contribution guidelines][contribution docs] and [d
 |       |                            | 2.3     | Full                                 | Latest              |
 |       |                            | 2.2     | Full                                 | Latest              |
 |       |                            | 2.1     | Full                                 | Latest              |
-|       |                            | 2.0     | Deprecated                           | < 0.50.0            |
+|       |                            | 2.0     | EOL since June 7th, 2021             | < 0.50.0            |
 |       |                            | 1.9.3   | EOL since August 6th, 2020           | < 0.27.0            |
 |       |                            | 1.9.1   | EOL since August 6th, 2020           | < 0.27.0            |
 | JRuby | https://www.jruby.org      | 9.2     | Full                                 | Latest              |
@@ -546,7 +547,7 @@ Datadog.configure do |c|
   # Symbol matching your database connection in config/database.yml
   # Only available if you are using Rails with ActiveRecord.
   c.use :active_record, describes: :secondary_database, service_name: 'secondary-db'
   # Block configuration pattern.
   c.use :active_record, describes: :secondary_database do |second_db|
     second_db.service_name = 'secondary-db'
@@ -584,7 +585,7 @@ Datadog.configure do |c|
   # Matches any `mysql2` connection.
   c.use :active_record, describes: { adapter: 'mysql2'}, service_name: 'mysql-db'
   # Matches any `mysql2` connection to the `reports` database.
   #
   # In case of multiple matching `describe` configurations, the latest one applies.
@@ -1565,7 +1566,7 @@ Datadog.configure do |c|
   # For network connections, only these fields are considered during matching:
   # scheme, host, port, db
   # Other fields are ignored.
   # Network connection string
   c.use :redis, describes: 'redis://127.0.0.1:6379/0', service_name: 'redis-connection-string'
   c.use :redis, describes: { url: 'redis://127.0.0.1:6379/1' }, service_name: 'redis-connection-url'
@@ -1678,8 +1679,6 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | --- | ----------- | ------- |
 | `service_name` | Service name for `sequel` instrumentation | Name of database adapter (e.g. `'mysql2'`) |
-Only Ruby 2.0+ is supported.
 **Configuring databases to use different settings**
 If you use multiple databases with Sequel, you can give each of them different settings by configuring their respective `Sequel::Database` objects:
@@ -1867,7 +1866,7 @@ Datadog.configure do |c|
   # Breaks down very large traces into smaller batches
   c.tracer.partial_flush.enabled = false
   # You can specify your own tracer
   c.tracer.instance = Datadog::Tracer.new
@@ -1954,7 +1953,7 @@ We recommend setting the environment variable `DD_TRACE_SAMPLE_RATE=1.0` in all
 App Analytics, previously configured with the `analytics_enabled` setting, is deprecated in favor of Tracing without Limits™. Documentation for this [deprecated configuration is still available](https://docs.datadoghq.com/tracing/legacy_app_analytics/).
 #### Application-side sampling
 While the trace agent can sample traces to reduce bandwidth usage, application-side sampling reduces the performance overhead.
 This will **reduce visibility and is not recommended**. See [DD_TRACE_SAMPLE_RATE](#environment-variables) for the recommended sampling approach.
@@ -2410,7 +2409,7 @@ The tracer and its integrations can produce some additional metrics that can pro
 To configure your application for metrics collection:
 1. [Configure your Datadog agent for StatsD](https://docs.datadoghq.com/developers/dogstatsd/#setup)
-2. Add `gem 'dogstatsd-ruby'` to your Gemfile
+2. Add `gem 'dogstatsd-ruby', '~> 4.0'` to your Gemfile (note that it is advised to pin v4.x [until this issue is solved](https://github.com/DataDog/dogstatsd-ruby/issues/182))
 #### For application runtime
@@ -2480,3 +2479,19 @@ However, additional instrumentation provided by Datadog can be activated alongsi
 | `OpenTracing::FORMAT_TEXT_MAP` | Yes        |                        |
 | `OpenTracing::FORMAT_RACK`     | Yes        | Because of the loss of resolution in the Rack format, please note that baggage items with names containing either upper case characters or `-` will be converted to lower case and `_` in a round-trip respectively. We recommend avoiding these characters or accommodating accordingly on the receiving end. |
 | `OpenTracing::FORMAT_BINARY`   | No         |                        |
+### Profiling
+*Currently available as BETA feature.*
+`ddtrace` can produce profiles that measure method-level application resource usage within production environments. These profiles can give insight into resources spent in Ruby code outside of existing trace instrumentation.
+**Setup**
+To get started with profiling, follow the [Profiler Getting Started Guide](https://docs.datadoghq.com/tracing/profiler/getting_started/?code-lang=ruby).
+#### Profiling Resque jobs
+When profiling [Resque](https://github.com/resque/resque) jobs, you should set the `RUN_AT_EXIT_HOOKS=1` option described in the [Resque](https://github.com/resque/resque/blob/v2.0.0/docs/HOOKS.md#worker-hooks) documentation.
+Without this flag, profiles for short-lived Resque jobs will not be available as Resque kills worker processes before they have a chance to submit this information.