ddtrace 0.50.0 → 1.0.0

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/LICENSE-3rdparty.csv

@@ -1,2 +1,3 @@
 Component,Origin,License,Copyright
-ddtrace/vendor/multipart-post,https://github.com/socketry/multipart-post,MIT,"Copyright (c) 2007-2013 Nick Sieger."
+datadog/core/vendor/multipart-post,https://github.com/socketry/multipart-post,MIT,"Copyright (c) 2007-2013 Nick Sieger."
+ddtrace/contrib/active_record/vendor,https://github.com/rails/rails/,MIT,"Copyright (c) 2005-2018 David Heinemeier Hansson"

data/README.md

@@ -1,7 +1,11 @@
+***Version 1.0.0 is in beta! Check out our [upgrade guide](https://github.com/DataDog/dd-trace-rb/blob/master/docs/UpgradeGuide.md#from-0x-to-10) for more details.***
+
 # Datadog Trace Client
 
+![Gem](https://img.shields.io/gem/v/ddtrace)
 [![CircleCI](https://circleci.com/gh/DataDog/dd-trace-rb/tree/master.svg?style=svg&circle-token=b0bd5ef866ec7f7b018f48731bb495f2d1372cc1)](https://circleci.com/gh/DataDog/dd-trace-rb/tree/master)
 [![codecov](https://codecov.io/gh/DataDog/dd-trace-rb/branch/master/graph/badge.svg)](https://app.codecov.io/gh/DataDog/dd-trace-rb/branch/master)
+[![YARD documentation](https://img.shields.io/badge/YARD-documentation-blue)](https://www.rubydoc.info/gems/ddtrace/)
 
 ``ddtrace`` is Datadog’s tracing client for Ruby. It is used to trace requests as they flow across web servers,
 databases and microservices so that developers have great visiblity into bottlenecks and troublesome requests.

data/bin/ddtracerb

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

data/ddtrace.gemspec

@@ -6,8 +6,8 @@ require 'ddtrace/version'
 
 Gem::Specification.new do |spec|
   spec.name                  = 'ddtrace'
-  spec.version               = Datadog::VERSION::STRING
-  spec.required_ruby_version = [">= #{Datadog::VERSION::MINIMUM_RUBY_VERSION}", "< #{Datadog::VERSION::MAXIMUM_RUBY_VERSION}"]
+  spec.version               = DDTrace::VERSION::STRING
+  spec.required_ruby_version = [">= #{DDTrace::VERSION::MINIMUM_RUBY_VERSION}", "< #{DDTrace::VERSION::MAXIMUM_RUBY_VERSION}"]
   spec.required_rubygems_version = '>= 2.0.0'
   spec.authors               = ['Datadog, Inc.']
   spec.email                 = ['dev@datadoghq.com']
@@ -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|yard)/}) }
+    .reject do |f|
+      ['.dockerignore', '.env', '.gitattributes', '.gitlab-ci.yml', '.rspec', '.rubocop.yml',
+       '.rubocop_todo.yml', '.simplecov', 'Appraisals', 'Gemfile', 'Rakefile', 'docker-compose.yml', '.pryrc', '.yardopts'].include?(f)
+    end
   spec.executables   = ['ddtracerb']
   spec.require_paths = ['lib']
 
@@ -39,6 +46,14 @@ Gem::Specification.new do |spec|
     spec.add_dependency 'msgpack', '< 1.4'
   end
 
-  # Used by the profiler
-  spec.add_dependency 'ffi', '~> 1.0'
+  # Used by the profiler native extension to support older Rubies (see NativeExtensionDesign.md for notes)
+  #
+  # Because we only use this for older Rubies, and we consider it "feature-complete" for those older Rubies,
+  # we're pinning it at the latest available version and will manually bump the dependency as needed.
+  spec.add_dependency 'debase-ruby_core_source', '<= 0.10.15'
+
+  # Used by appsec
+  spec.add_dependency 'libddwaf', '~> 1.3.0.0.0.a'
+
+  spec.extensions = ['ext/ddtrace_profiling_native_extension/extconf.rb']
 end

data/docs/AutoInstrumentation.md

@@ -0,0 +1,36 @@
+# Auto Instrumentation
+
+`ddtrace` can automatically instrument all available libraries, without requiring the manual setup of each one.
+
+## Rails
+
+Add the following to your `Gemfile`/`gems.rb` file:
+
+```ruby
+source 'https://rubygems.org'
+gem 'ddtrace', require: 'ddtrace/auto_instrument'
+```
+
+## Ruby
+
+Require `'ddtrace/auto_instrument'` after all gems that you'd like to instrument have been loaded:
+
+```ruby
+# Example libraries with supported integrations
+require 'sinatra'
+require 'faraday'
+require 'redis'
+
+require 'ddtrace/auto_instrument'
+```
+
+## Additional configuration
+
+You can reconfigure, override, or disable any specific integration settings by adding
+a [`Datadog.configure`](GettingStarted.md#integration-instrumentation) call after `ddtrace/auto_instrument` is activated.
+
+## Custom integrations
+
+Custom integrations that want to support auto instrumentation need to be registered
+(e.g. invoke their {Datadog::Tracing::Contrib::Registerable::ClassMethods#register_as} method) before
+the tracer requires `'ddtrace/auto_instrument'`.

data/docs/Deprecation.md

@@ -0,0 +1,8 @@
+# Deprecation
+
+Deprecated API objects are scheduled to be **removed in the next major version release**.
+
+Deprecated objects can still be safely used until the next major version.
+
+Objects will receive the deprecation tag in a minor version release,
+allowing for deprecation warnings to be surfaced to users before the next major release.

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
@@ -237,7 +247,7 @@ Then pass an adapter instance to the tracer configuration:
 
 ```ruby
 Datadog.configure do |c|
-  c.tracer.transport_options = proc { |t|
+  c.tracing.transport_options = proc { |t|
     # By name
     t.adapter :custom