ddtrace 0.51.1 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86062d096de977021fa4a6d3d94e827f69ca4bdd5432cf52eb805b1cd5a39f9b
-  data.tar.gz: 7650141aa7e35974f25cd27f218a0ee0c091e006bedda51c337e31fefb471651
+  metadata.gz: 8f5ee0735d05ecdadc38bbc0978a2087141d136f31b1848845518d2086f877d2
+  data.tar.gz: dd677af05b413d5593440aedca7b36dc9aba0c9ba08e9213eb8eb9c5443cb2d9
 SHA512:
-  metadata.gz: 499aef18511017c04bd8f9ad78532ce544fd2a44102f40e7299768a0bdc4435c1028d703a778f148cc8dae82b8dc643767843ab02c8b6497487e34bcbff2a413
-  data.tar.gz: 542c6421d263c3b44dcb50e4c4bcd81cf32e3dde3404967cc6d263e6c1fc6c8d315419b6beb3b07d30aee35243c817c97950ba421d21fe5cf73bbcda92728e2e
+  metadata.gz: 9f964c58615348135d915933cea46dac145c1266fa7d573fd8609c7eaf13be8667a8917af8ad5d93340935c00d2dc4bcd89adc7e14db7667eadf005448594f91
+  data.tar.gz: 23ee7b6812d641a0f6bdc65e43baac6f7f17cc68ca2c07a42e87158400a9b97944aa0f6416c2002fdbbfd0e00f92b1e0a6907de7ee3df39e0840f408a6ec1aec

data/.editorconfig

@@ -0,0 +1,22 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.h]
+indent_style = space
+indent_size = 2
+
+[*.c]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -58,3 +58,10 @@ Gemfile.lock
 
 # bundle config
 gemfiles/.bundle
+
+# Native extension binaries
+lib/*.bundle
+lib/*.so
+
+# Extra file kept by sorbet for debugging usage, as documented in https://sorbet.org/docs/adopting#step-6-source-control
+sorbet/rbi/hidden-definitions/errors.txt

data/CHANGELOG.md

@@ -2,6 +2,44 @@
 
 ## [Unreleased]
 
+## [0.52.0] - 2021-08-09
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.52.0
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.51.1...v0.52.0
+
+### Added
+
+- Add Sorbet typechecker to dd-trace-rb ([#1607][])
+
+  Note that no inline type signatures were added, to avoid a hard dependency on sorbet.
+
+- Profiler: Add support for annotating profiler stacks with the resource of the active web trace, if any ([#1623][])
+
+  Note that this data is not yet visible on the profiling interface.
+
+- Add error_handler option to GRPC tracer configuration ([#1583][]) ([@fteem][])
+- User-friendly handling of slow submissions on shutdown ([#1601][])
+- Profiler: Add experimental toggle to disable the profiling native extension ([#1594][])
+- Profiler: Bootstrap profiling native extension ([#1584][])
+
+### Changed
+
+- Profiler: Profiling data is no longer reported when there's less than 1 second of data to report ([#1630][])
+- Move Grape span resource setting to beginning of request ([#1629][])
+- Set resource in Sinatra spans at the beginning of requests, and delay setting fallback resource to end of requests ([#1628][])
+- Move Rails span resource setting to beginning of request ([#1626][])
+- Make registry a global constant repository ([#1572][])
+- Profiler: Remove automatic agentless support ([#1590][])
+
+### Fixed
+
+- Profiler: Fix CPU-time accounting in Profiling when fibers are used ([#1636][])
+- Don't set peer.service tag on grpc.server spans ([#1632][])
+- CI-App: Fix GitHub actions environment variable extraction ([#1622][])
+- Additional Faraday 1.4+ cgroup parsing formats ([#1595][])
+- Avoid shipping development cruft files in gem releases ([#1585][])
+
 ## [0.51.1] - 2021-07-13
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.51.1
@@ -2490,10 +2528,27 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#1561]: https://github.com/DataDog/dd-trace-rb/issues/1561
 [#1566]: https://github.com/DataDog/dd-trace-rb/issues/1566
 [#1570]: https://github.com/DataDog/dd-trace-rb/issues/1570
+[#1572]: https://github.com/DataDog/dd-trace-rb/issues/1572
 [#1576]: https://github.com/DataDog/dd-trace-rb/issues/1576
+[#1583]: https://github.com/DataDog/dd-trace-rb/issues/1583
+[#1584]: https://github.com/DataDog/dd-trace-rb/issues/1584
+[#1585]: https://github.com/DataDog/dd-trace-rb/issues/1585
 [#1586]: https://github.com/DataDog/dd-trace-rb/issues/1586
 [#1587]: https://github.com/DataDog/dd-trace-rb/issues/1587
+[#1590]: https://github.com/DataDog/dd-trace-rb/issues/1590
 [#1592]: https://github.com/DataDog/dd-trace-rb/issues/1592
+[#1594]: https://github.com/DataDog/dd-trace-rb/issues/1594
+[#1595]: https://github.com/DataDog/dd-trace-rb/issues/1595
+[#1601]: https://github.com/DataDog/dd-trace-rb/issues/1601
+[#1607]: https://github.com/DataDog/dd-trace-rb/issues/1607
+[#1622]: https://github.com/DataDog/dd-trace-rb/issues/1622
+[#1623]: https://github.com/DataDog/dd-trace-rb/issues/1623
+[#1626]: https://github.com/DataDog/dd-trace-rb/issues/1626
+[#1628]: https://github.com/DataDog/dd-trace-rb/issues/1628
+[#1629]: https://github.com/DataDog/dd-trace-rb/issues/1629
+[#1630]: https://github.com/DataDog/dd-trace-rb/issues/1630
+[#1632]: https://github.com/DataDog/dd-trace-rb/issues/1632
+[#1636]: https://github.com/DataDog/dd-trace-rb/issues/1636
 [@AdrianLC]: https://github.com/AdrianLC
 [@Azure7111]: https://github.com/Azure7111
 [@BabyGroot]: https://github.com/BabyGroot
@@ -2545,6 +2600,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@evan-waters]: https://github.com/evan-waters
 [@fledman]: https://github.com/fledman
 [@frsantos]: https://github.com/frsantos
+[@fteem]: https://github.com/fteem
 [@gaborszakacs]: https://github.com/gaborszakacs
 [@giancarlocosta]: https://github.com/giancarlocosta
 [@gingerlime]: https://github.com/gingerlime

data/CONTRIBUTING.md

@@ -20,8 +20,6 @@ Additionally, if you can, include:
  - Links to similar features that would serve as a good comparison
  - (Any other details that would be useful for implementing this feature!)
 
-Feature requests will be reviewed, discussed, and then added to [our Community project](https://github.com/DataDog/dd-trace-rb/projects/2).
-
 ## Found a bug?
 
 For any urgent matters (such as outages) or issues concerning the Datadog service or UI, contact our support team via https://docs.datadoghq.com/help/ for direct, faster assistance.
@@ -46,7 +44,7 @@ If at all possible, also provide:
  - Code sample or test that reproduces the problem
  - An explanation of what causes the bug and/or how it can be fixed
 
-Reports that include rich detail are better, and ones with code that reproduce the bug are best. Bug requests are triaged, reviewed, and added to [our Community project](https://github.com/DataDog/dd-trace-rb/projects/2).
+Reports that include rich detail are better, and ones with code that reproduce the bug are best.
 
 ## Have a patch?
 
@@ -74,8 +72,6 @@ We also recommend that you share in your description:
  - Benchmarks if the feature is anticipated to have performance implications
  - Any limitations, constraints or risks that are important to consider
 
-Pull requests will be reviewed and added to [our Community project](https://github.com/DataDog/dd-trace-rb/projects/2).
-
 For more information on common topics such as debugging locally, or how to write new integrations, check out [our development guide](https://github.com/DataDog/dd-trace-rb/blob/master/docs/DevelopmentGuide.md). If at any point you have a question or need assistance with your pull request, feel free to mention a project member! We're always happy to help contributors with their pull requests.
 
 ## Final word

data/ddtrace.gemspec

@@ -28,7 +28,14 @@ Gem::Specification.new do |spec|
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files =
+    `git ls-files -z`
+    .split("\x0")
+    .reject { |f| f.match(%r{^(test|spec|features|[.]circleci|[.]github|[.]dd-ci|benchmarks|gemfiles|integration|tasks|sorbet)/}) }
+    .reject do |f|
+      ['.dockerignore', '.env', '.gitattributes', '.gitlab-ci.yml', '.rspec', '.rubocop.yml',
+       '.rubocop_todo.yml', '.simplecov', 'Appraisals', 'Gemfile', 'Rakefile', 'docker-compose.yml'].include?(f)
+    end
   spec.executables   = ['ddtracerb']
   spec.require_paths = ['lib']
 
@@ -41,4 +48,6 @@ Gem::Specification.new do |spec|
 
   # Used by the profiler
   spec.add_dependency 'ffi', '~> 1.0'
+
+  spec.extensions = ['ext/ddtrace_profiling_native_extension/extconf.rb']
 end

data/docs/DevelopmentGuide.md

@@ -9,6 +9,8 @@ This guide covers some of the common how-tos and technical reference material fo
      - [Writing tests](#writing-tests)
      - [Running tests](#running-tests)
      - [Checking code quality](#checking-code-quality)
+     - [Running benchmarks](#running-benchmarks)
+     - [Type checking](#type-checking)
  - [Appendix](#appendix)
      - [Writing new integrations](#writing-new-integrations)
      - [Custom transport adapters](#custom-transport-adapters)
@@ -162,6 +164,19 @@ $ bundle exec rake spec:benchmark
 
 Results are printed to STDOUT as well as written to the `./tmp/benchmark/` directory.
 
+## Type checking
+
+This library uses the [Sorbet](https://sorbet.org/) type checker. Sorbet can be run with `bundle exec srb tc` (or `bundle exec rake
+typecheck`). There's also Language Server Protocol support, if your editor supports it.
+
+Type checking can be controlled on a file-by-file manner, using a `# typed: ...` comment. The default (when none is provided) is assuming `# typed: false`.
+
+Things to note:
+
+* For compatibility with older Rubies, we use Sorbet but do not yet allow type annotations in the codebase. If Sorbet is blocking you, feel free to use `# typed: false` or `# typed: ignore` with a quick note on why this was needed. In many cases, Sorbet can typecheck a file correctly with no extra type annotations.
+
+* Most integration-specific code will reference optional external dependencies which Sorbet cannot see into. You'll probably need to use `# typed: false` or `# typed: ignore`  for those files as well.
+
 ## Appendix
 
 ### Writing new integrations

data/docs/GettingStarted.md

@@ -86,6 +86,8 @@ To contribute, check out the [contribution guidelines][contribution docs] and [d
          - [For application runtime](#for-application-runtime)
      - [OpenTracing](#opentracing)
      - [Profiling](#profiling)
+         - [Troubleshooting](#troubleshooting)
+         - [Profiling Resque jobs](#profiling-resque-jobs)
  - [Known issues and suggested configurations](#known-issues-and-suggested-configurations)
     - [Payload too large](#payload-too-large)
     - [Stack level too deep](#stack-level-too-deep)
@@ -1028,6 +1030,7 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | Key | Description | Default |
 | --- | ----------- | ------- |
 | `service_name` | Service name used for `grpc` instrumentation | `'grpc'` |
+| `error_handler` | Custom error handler invoked when a request is an error. A `Proc` that accepts `span` and `error` parameters. Sets error on the span by default. | `proc { |span, error| span.set_error(error) unless span.nil? }` |
 
 **Configuring clients to use different settings**
 
@@ -2491,6 +2494,10 @@ However, additional instrumentation provided by Datadog can be activated alongsi
 
 To get started with profiling, follow the [Profiler Getting Started Guide](https://docs.datadoghq.com/tracing/profiler/getting_started/?code-lang=ruby).
 
+#### Troubleshooting
+
+If you run into issues with profiling, please check the [Profiler Troubleshooting Guide](https://docs.datadoghq.com/tracing/profiler/profiler_troubleshooting/?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.

data/docs/ProfilingDevelopment.md

@@ -11,7 +11,7 @@ Components below live inside <../lib/ddtrace/profiling>:
 * `Collectors::Stack`: Collects stack trace samples from Ruby threads for both CPU-time (if available) and wall-clock.
   Runs on its own background thread.
 * `Encoding::Profile`: Encodes gathered data into the pprof format.
-* `Events::Stack`, `Events::StackSample`, `Events::StackExceptionSample`: Entity classes used to represent stacks.
+* `Events::Stack`, `Events::StackSample`: Entity classes used to represent stacks.
 * `Ext::CPU`: Monkey patches Ruby's `Thread` with our `Ext::CThread` to enable CPU-time profiling.
 * `Ext::CThread`: Extension used to enable CPU-time profiling via use of Pthread's `getcpuclockid`.
 * `Ext::Forking`: Monkey patches `Kernel#fork`, adding a `Kernel#at_fork` callback mechanism which is used to restore
@@ -20,6 +20,7 @@ Components below live inside <../lib/ddtrace/profiling>:
 * `Tasks::Setup`: Takes care of loading our extensions/monkey patches to handle fork() and CPU profiling.
 * `Transport::*` (in <../lib/ddtrace/profiling/transport>): Implements transmission of profiling payloads to the Datadog agent
   or backend.
+* `TraceIdentifiers::*`: Used to retrieve trace id and span id from tracers, to be used to connect traces to profiles.
 * `BacktraceLocation`: Entity class used to represent an entry in a stack trace.
 * `Buffer`: Bounded buffer used to store profiling events.
 * `Exporter`: Writes profiling data to a given transport.
@@ -41,22 +42,14 @@ flow:
 4. The `Setup` task activates our extensions
     * `Datadog::Profiling::Ext::Forking`
     * `Datadog::Profiling::Ext::CPU`
-5. Still inside `Datadog::Components`, the `build_profiler` method then creates and wires up the Profiler:
-    ```ruby
-          recorder = build_profiler_recorder(settings)
-          collectors = build_profiler_collectors(settings, recorder)
-          exporters = build_profiler_exporters(settings)
-          scheduler = build_profiler_scheduler(settings, recorder, exporters)
-
-          Datadog::Profiler.new(collectors, scheduler)
-    ```
+5. Still inside `Datadog::Components`, the `build_profiler` method then creates and wires up the Profiler as such:
     ```asciiflow
             +------------+
             |  Profiler  |
-            +-+--------+-+
-              |        |
-              v        v
-    +---------+--+  +--+--------+
+            +-+-------+--+
+              |       |
+              v       v
+    +---------+--+  +-+---------+
     | Collectors |  | Scheduler |
     +---------+--+  +-+-------+-+
               |       |       |
@@ -86,3 +79,29 @@ takes care of encoding the data and reporting it to the datadog agent (or to the
 ## How CPU-time profiling works
 
 **TODO**: Document our pthread-based approach to getting CPU-time for threads.
+
+## How linking of traces to profiles works
+
+The [code hotspots feature](https://docs.datadoghq.com/tracing/profiler/connect_traces_and_profiles) allows users to start
+from a trace and then to investigate the profile that corresponds to that trace.
+
+This works in two steps:
+1. Linking a trace to the profile that was gathered while it executed
+2. Enabling the filtering of a profile to contain only the samples relating to a given trace/span
+
+To link a trace to a profile, we must ensure that both have the same `runtime-id` tag.
+This tag is in `Datadog::Runtime::Identity.id` and is automatically added by both the tracer and the profiler to reported
+traces/profiles.
+
+The profiler backend links a trace covering a given time interval to the profiles covering the same time interval,
+whenever they share the same `runtime-id`.
+
+To further enable filtering of a profile to show only samples related to a given trace/span, each sample taken by the
+profiler is tagged with the trace_id and span_id for the given trace/span.
+
+This is done using the `Datadog::Profiling::TraceIdentifiers::Helper` that retrieves a trace_id and span_id, if
+available, from the supported tracers. This helper is called by the `Collectors::Stack` during sampling.
+
+Note that if a given trace executes too fast, it's possible that the profiler will not contain any samples for that
+specific trace. Nevertheless, the linking still works and is useful, as it allows users to explore what was going on their
+profile at that time, even if they can't filter down to the specific request.

data/ext/ddtrace_profiling_native_extension/extconf.rb

@@ -0,0 +1,28 @@
+# typed: false
+def skip_building_extension?
+  # We don't support JRuby for profiling, and JRuby doesn't support native extensions, so let's just skip this entire
+  # thing so that JRuby users of dd-trace-rb aren't impacted.
+  on_jruby = RUBY_ENGINE == 'jruby'
+
+  # Experimental toggle to disable building the extension.
+  # Disabling the extension 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>.
+  disabled_via_env = ENV['DD_PROFILING_NO_EXTENSION'].to_s.downcase == 'true'
+
+  on_jruby || disabled_via_env
+end
+
+if skip_building_extension?
+  File.write('Makefile', 'all install clean: # dummy makefile that does nothing')
+  return
+end
+
+# NOTE: we MUST NOT require 'mkmf' before we check the #skip_building_extension? because the require triggers checks
+# that may fail on an environment not properly setup for building Ruby extensions.
+require 'mkmf'
+
+# Tag the native extension library with the Ruby version and Ruby platform.
+# 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.
+create_makefile "ddtrace_profiling_native_extension.#{RUBY_VERSION}_#{RUBY_PLATFORM}"

data/ext/ddtrace_profiling_native_extension/profiling.c

@@ -0,0 +1,17 @@
+#include <ruby.h>
+#include <stdio.h>
+
+static VALUE native_working_p(VALUE self);
+
+void Init_ddtrace_profiling_native_extension(void) {
+  VALUE datadog_module = rb_define_module("Datadog");
+  VALUE profiling_module = rb_define_module_under(datadog_module, "Profiling");
+  VALUE native_extension_module = rb_define_module_under(profiling_module, "NativeExtension");
+
+  rb_define_singleton_method(native_extension_module, "native_working?", native_working_p, 0);
+  rb_funcall(native_extension_module, rb_intern("private_class_method"), 1, ID2SYM(rb_intern("native_working?")));
+}
+
+static VALUE native_working_p(VALUE self) {
+  return Qtrue;
+}

data/lib/datadog/ci.rb

@@ -1,3 +1,4 @@
+# typed: strict
 require 'ddtrace'
 
 module Datadog

data/lib/datadog/ci/configuration/components.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'datadog/ci/context_flush'
 
 module Datadog

data/lib/datadog/ci/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'datadog/ci/ext/settings'
 
 module Datadog

data/lib/datadog/ci/context_flush.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/context_flush'
 
 module Datadog

data/lib/datadog/ci/contrib/cucumber/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'datadog/ci/contrib/cucumber/ext'
 

data/lib/datadog/ci/contrib/cucumber/ext.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module CI
     module Contrib

data/lib/datadog/ci/contrib/cucumber/formatter.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'datadog/ci/test'
 require 'datadog/ci/ext/app_types'
 require 'datadog/ci/ext/environment'

data/lib/datadog/ci/contrib/cucumber/instrumentation.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'datadog/ci/contrib/cucumber/formatter'
 
 module Datadog

data/lib/datadog/ci/contrib/cucumber/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 
 require 'datadog/ci/contrib/cucumber/configuration/settings'

data/lib/datadog/ci/contrib/cucumber/patcher.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'datadog/ci/contrib/cucumber/instrumentation'
 

data/lib/datadog/ci/contrib/rspec/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'datadog/ci/contrib/rspec/ext'
 

data/lib/datadog/ci/contrib/rspec/example.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'datadog/ci/test'
 
 require 'datadog/ci/ext/app_types'

data/lib/datadog/ci/contrib/rspec/ext.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module CI
     module Contrib

data/lib/datadog/ci/contrib/rspec/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 
 require 'datadog/ci/contrib/rspec/configuration/settings'