ddtrace 0.50.0 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9add4aab5afd288528cb19861c90d1c51f0760cc683716cb5aefdbd03cd6ee0
-  data.tar.gz: 9eba21868f503c91e4af96fa2dd5e625fc60ac19b43ff6b1f538c269e3159599
+  metadata.gz: 5d503fa2075462a3264c15a5e05ed1bc19afae88994c6df987dd32c6ee4f500c
+  data.tar.gz: 93a4cfaa1b395f1f968b1e87525df21b44c3a2fd63458013a1d506c9ae3b28e2
 SHA512:
-  metadata.gz: 36623270e170b810ba47ec10fab7aeb73d366653149266661468727153c71a6b322eb1f87dbda1f2be1587aa49fc8a2c9ffdbf06e753a03d558885123ac0b71b
-  data.tar.gz: 9140282f96d2f3fd5450b51f5f7f1a9370c9772d40eac8f67ed5dbd1a0d421bc1a2689019a9592f47593853dcbaf44a5691870c4224f5c924e7155858167c33e
+  metadata.gz: 63918fc0a3b1d50a76842f6b500ae80300c6df9afd873628230a70a17b83b8971904fe2e1b1ff71cb44143eb6ef62b294f4958188c4db24cb12ee61a2069ab34
+  data.tar.gz: 5de75c82e3030e4c617a0b06b590574f5389d428eba9294e8b1a5221bd7f4e3b0bfbc40295cb86d1fb91af1a199585015ea6d6d4e3080dc475e15e8bba1288f0

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,141 @@
 
 ## [Unreleased]
 
+## [0.53.0] - 2021-10-06
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.53.0
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.52.0...v0.53.0
+
+### Added
+
+- ActiveJob integration ([#1639][]) ([@bensheldon][])
+- Instrument Action Cable subscribe/unsubscribe hooks ([#1674][]) ([@agrobbin][])
+- Instrument Sidekiq server internal events (heartbeat, job fetch, and scheduled push) ([#1685][]) ([@agrobbin][])
+- Correlate Active Job logs to the active DataDog trace ([#1694][]) ([@agrobbin][])
+- Runtime Metrics: Global VM cache statistics ([#1680][])
+- Automatically send traces to agent Unix socket if present ([#1700][])
+- CI-App: User Provided Git Metadata ([#1662][])
+
+### Changed
+
+- Profiler: Set Sinatra resource setting at beginning of request and delay setting fallback resource ([#1628][])
+- Profiler: Use most recent event for trace resource name ([#1695][])
+- Profiler: Limit number of threads per sample ([#1699][])
+- Profiler: Rename `extract_trace_resource` to `endpoint.collection.enabled` ([#1702][])
+
+### Fixed
+
+- Capture Rails exception before default error page is rendered ([#1684][])
+- `NoMethodError` in sinatra integration when Tracer middleware is missing ([#1643][], [#1644][]) ([@mscrivo][])
+- CI-App: Require `rspec-core` for RSpec integration ([#1654][]) ([@elliterate][])
+- CI-App: Use the merge request branch on merge requests ([#1687][]) ([@carlallen][])
+- Remove circular dependencies. ([#1668][]) ([@saturnflyer][])
+- Links in the Table of Contents ([#1661][]) ([@chychkan][])
+- CI-App: Fix CI Visibility Spec Tests ([#1706][])
+
+### Refactored
+
+- Profiler: pprof encoding benchmark and improvements ([#1511][])
+
+## [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
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.51.0...v0.51.1
+
+### Fixed
+
+- AWS-SDK instrumentation without `aws-sdk-s3` ([#1592][])
+
+## [0.51.0] - 2021-07-12
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.51.0
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.50.0...v0.51.0
+
+### Added
+
+- Semantic Logger trace correlation injection ([#1566][])
+- New and improved Lograge trace correlation injection ([#1555][])
+- Profiler: Start profiler on `ddtrace/auto_instrument`
+- CI-App: Add runtime and OS information ([#1587][])
+- CI-App: Read metadata from local git repository ([#1561][])
+
+### Changed
+
+- Rename `Datadog::Runtime` to `Datadog::Core::Environment` ([#1570][])
+
+  As we prepare the `Datadog` Ruby namespace to better accommodate new products, we are moving a few internal modules to a different location to avoid conflicts.
+
+  None of the affected files are exposed publicly in our documentation, and they are only expected to be used internally and may change at any time, even between patch releases.
+
+  * The following modules have been moved:
+  ```ruby
+  Datadog::Runtime::Cgroup -> Datadog::Core::Environment::Cgroup
+  Datadog::Runtime::ClassCount -> Datadog::Core::Environment::ClassCount
+  Datadog::Runtime::Container -> Datadog::Core::Environment::Container
+  Datadog::Runtime::GC -> Datadog::Core::Environment::GC
+  Datadog::Runtime::Identity -> Datadog::Core::Environment::Identity
+  Datadog::Runtime::ObjectSpace -> Datadog::Core::Environment::ObjectSpace
+  Datadog::Runtime::Socket -> Datadog::Core::Environment::Socket
+  Datadog::Runtime::ThreadCount -> Datadog::Core::Environment::ThreadCount
+  ```
+  * Most constants from `Datadog::Ext::Runtime` have been moved to a new module: `Datadog::Core::Environment::Ext`.
+- Skip CPU time instrumentation if logging gem is detected ([#1557][])
+
+### Fixed
+
+- Initialize `dogstatsd-ruby` in single threaded mode ([#1576][])
+
+  This should alleviate any existing issues with `dogstatsd-ruby` resource leaks.
+
+- Do not use configured `dogstatsd-ruby` instance when it's an incompatible version ([#1560][])
+- Ensure tags with special Datadog processing are consistently serialized ([#1556][])
+- Profiler: NameError during initialization ([#1552][])
+
+### Refactored
+- Improvements to test suite & CI ([#1586][])
+- Improvements to documentation ([#1397][])
+
 ## [0.50.0] - 2021-06-07
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.50.0
@@ -1712,7 +1847,11 @@ Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.3.1
 
 Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 
-[Unreleased]: https://github.com/DataDog/dd-trace-rb/compare/v0.48.0...master
+[Unreleased]: https://github.com/DataDog/dd-trace-rb/compare/v0.53.0...master
+[0.53.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.52.0...v0.53.0
+[0.52.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.51.1...v0.52.0
+[0.51.1]: https://github.com/DataDog/dd-trace-rb/compare/v0.51.0...v0.51.1
+[0.51.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.50.0...v0.51.0
 [0.48.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.47.0...v0.48.0
 [0.47.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.46.0...v0.47.0
 [0.46.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.45.0...v0.46.0
@@ -2359,6 +2498,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#1393]: https://github.com/DataDog/dd-trace-rb/issues/1393
 [#1394]: https://github.com/DataDog/dd-trace-rb/issues/1394
 [#1396]: https://github.com/DataDog/dd-trace-rb/issues/1396
+[#1397]: https://github.com/DataDog/dd-trace-rb/issues/1397
 [#1398]: https://github.com/DataDog/dd-trace-rb/issues/1398
 [#1399]: https://github.com/DataDog/dd-trace-rb/issues/1399
 [#1400]: https://github.com/DataDog/dd-trace-rb/issues/1400
@@ -2410,6 +2550,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#1507]: https://github.com/DataDog/dd-trace-rb/issues/1507
 [#1509]: https://github.com/DataDog/dd-trace-rb/issues/1509
 [#1510]: https://github.com/DataDog/dd-trace-rb/issues/1510
+[#1511]: https://github.com/DataDog/dd-trace-rb/issues/1511
 [#1523]: https://github.com/DataDog/dd-trace-rb/issues/1523
 [#1524]: https://github.com/DataDog/dd-trace-rb/issues/1524
 [#1529]: https://github.com/DataDog/dd-trace-rb/issues/1529
@@ -2419,6 +2560,53 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#1537]: https://github.com/DataDog/dd-trace-rb/issues/1537
 [#1543]: https://github.com/DataDog/dd-trace-rb/issues/1543
 [#1544]: https://github.com/DataDog/dd-trace-rb/issues/1544
+[#1552]: https://github.com/DataDog/dd-trace-rb/issues/1552
+[#1555]: https://github.com/DataDog/dd-trace-rb/issues/1555
+[#1556]: https://github.com/DataDog/dd-trace-rb/issues/1556
+[#1557]: https://github.com/DataDog/dd-trace-rb/issues/1557
+[#1560]: https://github.com/DataDog/dd-trace-rb/issues/1560
+[#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
+[#1639]: https://github.com/DataDog/dd-trace-rb/issues/1639
+[#1643]: https://github.com/DataDog/dd-trace-rb/issues/1643
+[#1644]: https://github.com/DataDog/dd-trace-rb/issues/1644
+[#1654]: https://github.com/DataDog/dd-trace-rb/issues/1654
+[#1661]: https://github.com/DataDog/dd-trace-rb/issues/1661
+[#1662]: https://github.com/DataDog/dd-trace-rb/issues/1662
+[#1668]: https://github.com/DataDog/dd-trace-rb/issues/1668
+[#1674]: https://github.com/DataDog/dd-trace-rb/issues/1674
+[#1680]: https://github.com/DataDog/dd-trace-rb/issues/1680
+[#1684]: https://github.com/DataDog/dd-trace-rb/issues/1684
+[#1685]: https://github.com/DataDog/dd-trace-rb/issues/1685
+[#1687]: https://github.com/DataDog/dd-trace-rb/issues/1687
+[#1694]: https://github.com/DataDog/dd-trace-rb/issues/1694
+[#1695]: https://github.com/DataDog/dd-trace-rb/issues/1695
+[#1699]: https://github.com/DataDog/dd-trace-rb/issues/1699
+[#1700]: https://github.com/DataDog/dd-trace-rb/issues/1700
+[#1702]: https://github.com/DataDog/dd-trace-rb/issues/1702
+[#1706]: https://github.com/DataDog/dd-trace-rb/issues/1706
 [@AdrianLC]: https://github.com/AdrianLC
 [@Azure7111]: https://github.com/Azure7111
 [@BabyGroot]: https://github.com/BabyGroot
@@ -2447,11 +2635,14 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@awendt]: https://github.com/awendt
 [@bartekbsh]: https://github.com/bartekbsh
 [@benhutton]: https://github.com/benhutton
+[@bensheldon]: https://github.com/bensheldon
 [@bheemreddy181]: https://github.com/bheemreddy181
 [@blaines]: https://github.com/blaines
 [@brafales]: https://github.com/brafales
 [@bzf]: https://github.com/bzf
 [@callumj]: https://github.com/callumj
+[@carlallen]: https://github.com/carlallen
+[@chychkan]: https://github.com/chychkan
 [@cjford]: https://github.com/cjford
 [@ck3g]: https://github.com/ck3g
 [@components]: https://github.com/components
@@ -2463,6 +2654,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@dorner]: https://github.com/dorner
 [@drcapulet]: https://github.com/drcapulet
 [@e1senh0rn]: https://github.com/e1senh0rn
+[@elliterate]: https://github.com/elliterate
 [@elyalvarado]: https://github.com/elyalvarado
 [@ericmustin]: https://github.com/ericmustin
 [@erict-square]: https://github.com/erict-square
@@ -2470,6 +2662,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
@@ -2501,6 +2694,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@mdross95]: https://github.com/mdross95
 [@michaelkl]: https://github.com/michaelkl
 [@mriddle]: https://github.com/mriddle
+[@mscrivo]: https://github.com/mscrivo
 [@mstruve]: https://github.com/mstruve
 [@mustela]: https://github.com/mustela
 [@nic-lan]: https://github.com/nic-lan
@@ -2516,6 +2710,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@renchap]: https://github.com/renchap
 [@ricbartm]: https://github.com/ricbartm
 [@roccoblues]: https://github.com/roccoblues
+[@saturnflyer]: https://github.com/saturnflyer
 [@sco11morgan]: https://github.com/sco11morgan
 [@senny]: https://github.com/senny
 [@shayonj]: https://github.com/shayonj

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', '.pryrc'].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)
@@ -40,9 +42,7 @@ Then within this container you can [run tests](#running-tests), or [run code qua
 
 ## Testing
 
-The test suite uses both [Minitest](https://github.com/seattlerb/minitest) and [RSpec](https://rspec.info/) tests to verify the correctness of both the core trace library and its integrations.
-
-Minitest is deprecated in favor of RSpec; all new tests should be written in RSpec, and only existing minitests should be updated.
+The test suite uses [RSpec](https://rspec.info/) tests to verify the correctness of both the core trace library and its integrations.
 
 ### Writing tests
 
@@ -66,9 +66,6 @@ Simplest way to run tests is to run `bundle exec rake ci`, which will run the en
 Run the tests for the core library with:
 
 ```
-# Run Minitest
-$ bundle exec rake test:main
-# Run RSpec
 $ bundle exec rake spec:main
 ```
 
@@ -162,6 +159,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