ddtrace 0.24.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 634a3b4b1798b771abe9af49ee6ac02c2b64a4bc
-  data.tar.gz: 8854e2a87b04f4aeaf426eb8320ce9f728565dd0
+  metadata.gz: cc7abea1fd11b0e43875d0b3e657110d9784e735
+  data.tar.gz: dcfbeb9c0ad9d4a1d32e8bca7ab24290e65a40aa
 SHA512:
-  metadata.gz: a816feb5c86306091e2bf300dc2219f9a6c60cb08e41643bfba4f8a4a5832623c2677eedf48778d40a4557b31fe53dc456f8793f02035cca7dc2115fae909e5c
-  data.tar.gz: 203406fe03985bfda50aeb2e886251b74672f066cb43765bbd06450ab6c86d5a98493691876f3cfb8fc1ca69a426276ae770851e39b96a122c2060c2c5ad938e
+  metadata.gz: a3d4c48ba5015646eecc48254b76a71dad02713c4ceaf01a5b97dc2538784df65ee55b10e5794ed9987390145e83a00a8cb8214b9e445cfd80dbc750c3fad83d
+  data.tar.gz: e22ee413bba3877f5296ffcaa6ca62684c65c907dbe03e1f62d63c6c98cb187ae19ec9217d5e9b1c6a35dcd9f5a03e37c6964728d9489e8ec6ed860330572b33

data/.circleci/config.yml

@@ -5,27 +5,27 @@ job_defaults: &job_defaults
 
 ruby_containers: &ruby_containers
   - &container-1_9
-    image: datadog/docker-library:ddtrace_rb_1_9_3
+    image: palazzem/docker-library:ddtrace_rb_1_9_3
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
   - &container-2_0
-    image: datadog/docker-library:ddtrace_rb_2_0_0
+    image: palazzem/docker-library:ddtrace_rb_2_0_0
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
   - &container-2_1
-    image: datadog/docker-library:ddtrace_rb_2_1_10
+    image: palazzem/docker-library:ddtrace_rb_2_1_10
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
   - &container-2_2
-    image: datadog/docker-library:ddtrace_rb_2_2_10
+    image: palazzem/docker-library:ddtrace_rb_2_2_10
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
   - &container-2_3
-    image: datadog/docker-library:ddtrace_rb_2_3_7
+    image: palazzem/docker-library:ddtrace_rb_2_3_8
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
   - &container-2_4
-    image: datadog/docker-library:ddtrace_rb_2_4_4
+    image: palazzem/docker-library:ddtrace_rb_2_4_6
     environment:
       - BUNDLE_GEMFILE=/app/Gemfile
 

data/.circleci/images/primary/Dockerfile-1.9.3

@@ -1,6 +1,10 @@
 # Last version: https://github.com/docker-library/ruby/blob/90c4e3be58d565007c518d311d4bd05086a1638c/1.9/Dockerfile
 FROM ruby:1.9.3
 
+# Add Jessie repos
+# Fixes https://superuser.com/questions/1423486/issue-with-fetching-http-deb-debian-org-debian-dists-jessie-updates-inrelease
+RUN printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list
+
 # Make apt non-interactive
 RUN echo 'APT::Get::Assume-Yes "true";' > /etc/apt/apt.conf.d/90circleci \
   && echo 'DPkg::Options "--force-confnew";' >> /etc/apt/apt.conf.d/90circleci
@@ -59,8 +63,8 @@ RUN DOCKERIZE_URL="https://circle-downloads.s3.amazonaws.com/circleci-images/cac
   && dockerize --version
 
 # Install RubyGems
-RUN gem update --system
-RUN gem install bundler
+RUN gem update --system 2.7.9
+RUN gem install bundler -v '1.17.3'
 ENV BUNDLE_SILENCE_ROOT_WARNING 1
 
 RUN mkdir /app

data/.circleci/images/primary/Dockerfile-2.0.0

@@ -1,6 +1,10 @@
 # Last version: https://github.com/docker-library/ruby/blob/c387c6c3a2505060514e31c247cb37d22c944e55/2.0/Dockerfile
 FROM ruby:2.0.0
 
+# Add Jessie repos
+# Fixes https://superuser.com/questions/1423486/issue-with-fetching-http-deb-debian-org-debian-dists-jessie-updates-inrelease
+RUN printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list
+
 # Make apt non-interactive
 RUN echo 'APT::Get::Assume-Yes "true";' > /etc/apt/apt.conf.d/90circleci \
   && echo 'DPkg::Options "--force-confnew";' >> /etc/apt/apt.conf.d/90circleci
@@ -59,8 +63,8 @@ RUN DOCKERIZE_URL="https://circle-downloads.s3.amazonaws.com/circleci-images/cac
   && dockerize --version
 
 # Install RubyGems
-RUN gem update --system
-RUN gem install bundler
+RUN gem update --system 2.7.9
+RUN gem install bundler -v '1.17.3'
 ENV BUNDLE_SILENCE_ROOT_WARNING 1
 
 RUN mkdir /app

data/.circleci/images/primary/Dockerfile-2.1.10

@@ -1,6 +1,10 @@
 # Last version: https://github.com/docker-library/ruby/blob/99def14400fcd612782367830836dfcbc10c8c50/2.1/Dockerfile
 FROM ruby:2.1.10
 
+# Add Jessie repos
+# Fixes https://superuser.com/questions/1423486/issue-with-fetching-http-deb-debian-org-debian-dists-jessie-updates-inrelease
+RUN printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list
+
 # Make apt non-interactive
 RUN echo 'APT::Get::Assume-Yes "true";' > /etc/apt/apt.conf.d/90circleci \
   && echo 'DPkg::Options "--force-confnew";' >> /etc/apt/apt.conf.d/90circleci
@@ -59,8 +63,8 @@ RUN DOCKERIZE_URL="https://circle-downloads.s3.amazonaws.com/circleci-images/cac
   && dockerize --version
 
 # Install RubyGems
-RUN gem update --system
-RUN gem install bundler
+RUN gem update --system 2.7.9
+RUN gem install bundler -v '1.17.3'
 ENV BUNDLE_SILENCE_ROOT_WARNING 1
 
 RUN mkdir /app

data/.circleci/images/primary/Dockerfile-2.2.10

@@ -1,6 +1,10 @@
 # Last version: https://github.com/docker-library/ruby/blob/395cce4eba52917eb9a40c72d50703a1ce9e1acd/2.2/jessie/Dockerfile
 FROM ruby:2.2.10
 
+# Add Jessie repos
+# Fixes https://superuser.com/questions/1423486/issue-with-fetching-http-deb-debian-org-debian-dists-jessie-updates-inrelease
+RUN printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list
+
 # Make apt non-interactive
 RUN echo 'APT::Get::Assume-Yes "true";' > /etc/apt/apt.conf.d/90circleci \
   && echo 'DPkg::Options "--force-confnew";' >> /etc/apt/apt.conf.d/90circleci
@@ -59,8 +63,8 @@ RUN DOCKERIZE_URL="https://circle-downloads.s3.amazonaws.com/circleci-images/cac
   && dockerize --version
 
 # Install RubyGems
-RUN gem update --system
-RUN gem install bundler
+RUN gem update --system 2.7.9
+RUN gem install bundler -v '1.17.3'
 ENV BUNDLE_SILENCE_ROOT_WARNING 1
 
 RUN mkdir /app

data/.circleci/images/primary/{Dockerfile-2.4.4 → Dockerfile-2.3.8}

@@ -1,5 +1,5 @@
-# Current version: https://github.com/docker-library/ruby/blob/699a04311386ecc98ca242fc9bdee17fb4008863/2.4/stretch/Dockerfile
-FROM ruby:2.4.4
+# Current version: https://github.com/docker-library/ruby/blob/31f66490fdb837ddcc5896e3275f2188f2b7b6dd/2.3/stretch/Dockerfile
+FROM ruby:2.3.8
 
 # Make apt non-interactive
 RUN echo 'APT::Get::Assume-Yes "true";' > /etc/apt/apt.conf.d/90circleci \
@@ -64,7 +64,9 @@ RUN mkdir -p "$GEM_HOME" && chmod -R 777 "$GEM_HOME"
 
 # Install RubyGems
 RUN gem update --system
-RUN gem install bundler
+# Ruby 2.3 can support Bundler 2+
+# But hold back to < 2 for now, because some dependencies require it.
+RUN gem install bundler -v '1.17.3'
 ENV BUNDLE_SILENCE_ROOT_WARNING 1
 
 RUN mkdir /app

data/.circleci/images/primary/{Dockerfile-2.3.7 → Dockerfile-2.4.6}

@@ -1,5 +1,5 @@
-# Current version: https://github.com/docker-library/ruby/blob/699a04311386ecc98ca242fc9bdee17fb4008863/2.3/stretch/Dockerfile
-FROM ruby:2.3.7
+# Current version: https://github.com/docker-library/ruby/blob/802421922ef50cfa05c89a3c619992acf4329986/2.4/jessie/Dockerfile
+FROM ruby:2.4.6
 
 # Make apt non-interactive
 RUN echo 'APT::Get::Assume-Yes "true";' > /etc/apt/apt.conf.d/90circleci \

data/CHANGELOG.md

@@ -4,6 +4,42 @@
 
 ## [Unreleased (beta)]
 
+## [0.25.0] - 2019-06-27
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.25.0
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.24.0...v0.25.0
+
+Support for Ruby < 2.0 is *deprecated*. Plan for timeline is as follows:
+
+ - 0.25.0: Support for Ruby < 2.0 is deprecated; retains full feature support.
+ - 0.26.0: Last version to support Ruby < 2.0; any new features will not support 1.9.
+ - 0.27.0: Support for Ruby < 2.0 is removed.
+
+Version 0.26.x will receive only critical bugfixes for 1 year following the release of 0.26.0.
+
+### Added
+
+ - Unix socket support for transport layer (#770)
+
+### Changed
+
+ - Renamed 'ForcedTracing' to 'ManualTracing' (#765)
+
+### Fixed
+
+ - HTTP headers for distributed tracing sometimes appearing in duplicate (#768)
+
+### Refactored
+
+ - Transport layer (#628)
+
+### Deprecated
+
+ - Ruby < 2.0 support (#771)
+ - Use of `Datadog::HTTPTransport` (#628)
+ - Use of `Datadog::Ext::ForcedTracing` (#765)
+
 ## [0.24.0] - 2019-05-21
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.24.0

data/docker-compose.yml

@@ -1,7 +1,7 @@
 version: '3.2'
 services:
   tracer-1.9:
-    image: datadog/docker-library:ddtrace_rb_1_9_3
+    image: palazzem/docker-library:ddtrace_rb_1_9_3
     command: /bin/bash
     depends_on:
       - ddagent
@@ -29,7 +29,7 @@ services:
       - bundle-1.9:/usr/local/bundle
       - gemfiles-1.9:/app/gemfiles
   tracer-2.0:
-    image: datadog/docker-library:ddtrace_rb_2_0_0
+    image: palazzem/docker-library:ddtrace_rb_2_0_0
     command: /bin/bash
     depends_on:
       - ddagent
@@ -57,7 +57,7 @@ services:
       - bundle-2.0:/usr/local/bundle
       - gemfiles-2.0:/app/gemfiles
   tracer-2.1:
-    image: datadog/docker-library:ddtrace_rb_2_1_10
+    image: palazzem/docker-library:ddtrace_rb_2_1_10
     command: /bin/bash
     depends_on:
       - ddagent
@@ -85,7 +85,7 @@ services:
       - bundle-2.1:/usr/local/bundle
       - gemfiles-2.1:/app/gemfiles
   tracer-2.2:
-    image: datadog/docker-library:ddtrace_rb_2_2_10
+    image: palazzem/docker-library:ddtrace_rb_2_2_10
     command: /bin/bash
     depends_on:
       - ddagent
@@ -113,7 +113,7 @@ services:
       - bundle-2.2:/usr/local/bundle
       - gemfiles-2.2:/app/gemfiles
   tracer-2.3:
-    image: datadog/docker-library:ddtrace_rb_2_3_7
+    image: palazzem/docker-library:ddtrace_rb_2_3_8
     command: /bin/bash
     depends_on:
       - ddagent
@@ -141,7 +141,7 @@ services:
       - bundle-2.3:/usr/local/bundle
       - gemfiles-2.3:/app/gemfiles
   tracer-2.4:
-    image: datadog/docker-library:ddtrace_rb_2_4_4
+    image: palazzem/docker-library:ddtrace_rb_2_4_6
     command: /bin/bash
     depends_on:
       - ddagent

data/docs/DevelopmentGuide.md

@@ -11,6 +11,7 @@ This guide covers some of the common how-tos and technical reference material fo
      - [Checking code quality](#checking-code-quality)
  - [Appendix](#appendix)
      - [Writing new integrations](#writing-new-integrations)
+     - [Custom transport adapters](#custom-transport-adapters)
 
 ## Setting up
 
@@ -130,3 +131,65 @@ Then [open a pull request](https://github.com/DataDog/dd-trace-rb/CONTRIBUTING.m
  - Links to the repository/website of the library being integrated
  - Screenshots showing a sample trace
  - Any additional code snippets, sample apps, benchmarks, or other resources that demonstrate its implementation are a huge plus!
+
+### Custom transport adapters
+
+The tracer can be configured with transports that customize how data is sent and where it is sent to. This is done through the use of adapters: classes that receive generic requests, process them, and return appropriate responses.
+
+#### Developing HTTP transport adapters
+
+To create a custom HTTP adapter, define a class that responds to `call(env)` which returns a kind of `Datadog::Transport::Response`:
+
+```ruby
+require 'ddtrace/transport/response'
+
+class CustomAdapter
+  # Sends HTTP request
+  # env: Datadog::Transport::HTTP::Env
+  def call(env)
+    # Add custom code here to send data.
+    # Then return a Response object.
+    Response.new
+  end
+
+  class Response
+    include Datadog::Transport::Response
+
+    # Implement the following methods as appropriate
+    # for your adapter.
+
+    # Return a String
+    def payload; end
+
+    # Return true/false
+    # Return nil if it does not apply
+    def ok?; end
+    def unsupported?; end
+    def not_found?; end
+    def client_error?; end
+    def server_error?; end
+    def internal_error?; end
+  end
+end
+```
+
+Optionally, you can register the adapter as a well-known type:
+
+```ruby
+Datadog::Transport::HTTP::Builder::REGISTRY.set(CustomAdapter, :custom)
+```
+
+Then pass an adapter instance to the tracer configuration:
+
+```ruby
+Datadog.configure do |c|
+  c.tracer transport_options: proc { |t|
+    # By name
+    t.adapter :custom
+
+    # By instance
+    custom_adapter = CustomAdapter.new
+    t.adapter custom_adapter
+  }
+end
+```

data/docs/GettingStarted.md

@@ -67,6 +67,7 @@ For contributing, checkout the [contribution guidelines][contribution docs] and
          - [Filtering](#filtering)
          - [Processing](#processing)
      - [Trace correlation](#trace-correlation)
+     - [Configuring the transport layer](#configuring-the-transport-layer)
      - [Metrics](#metrics)
          - [For application runtime](#for-application-runtime)
      - [OpenTracing](#opentracing)
@@ -77,8 +78,8 @@ For contributing, checkout the [contribution guidelines][contribution docs] and
 
 | Type  | Documentation              | Version | Support type |
 | ----- | -------------------------- | -----   | ------------ |
-| MRI   | https://www.ruby-lang.org/ | 1.9.1   | Experimental |
-|       |                            | 1.9.3   | Full         |
+| MRI   | https://www.ruby-lang.org/ | 1.9.1   | Deprecated   |
+|       |                            | 1.9.3   | Deprecated   |
 |       |                            | 2.0     | Full         |
 |       |                            | 2.1     | Full         |
 |       |                            | 2.2     | Full         |
@@ -104,6 +105,8 @@ For contributing, checkout the [contribution guidelines][contribution docs] and
 
 *Experimental* indicates most features should be available, but unverified.
 
+*Deprecated* indicates support will be removed in a future release.
+
 ## Installation
 
 The following steps will help you quickly start tracing your Ruby application.
@@ -1402,6 +1405,9 @@ When not using [distributed tracing](#distributed-tracing), you may change the p
 If you change the priority, we recommend you do it as soon as possible, when the root span has just been created.
 
 ```ruby
+# First, grab the active span
+span = Datadog.tracer.active_span
+
 # Indicate to reject the trace
 span.context.sampling_priority = Datadog::Ext::Priority::USER_REJECT
 
@@ -1731,6 +1737,71 @@ Datadog.tracer.trace('my.operation') { logger.warn('This is a traced operation.'
 # [2019-01-16 18:38:41 +0000][my_app][WARN][dd.trace_id=8545847825299552251 dd.span_id=3711755234730770098] This is a traced operation.
 ```
 
+### Configuring the transport layer
+
+By default, the tracer submits trace data using `Net::HTTP` to `127.0.0.1:8126`, the default location for the Datadog trace agent process. However, the tracer can be configured to send its trace data to alternative destinations, or by alternative protocols.
+
+Some basic settings, such as hostname and port, can be configured using [tracer settings](#tracer-settings).
+
+#### Using the Net::HTTP adapter
+
+The `Net` adapter submits traces using `Net::HTTP` over TCP. It is the default transport adapter.
+
+```ruby
+Datadog.configure do |c|
+  c.tracer transport_options: proc do |t|
+    # Hostname, port, and additional options. :timeout is in seconds.
+    t.adapter :net_http, '127.0.0.1', 8126, { timeout: 1 }
+  }
+end
+```
+
+#### Using the Unix socket adapter
+
+The `UnixSocket` adapter submits traces using `Net::HTTP` over Unix socket.
+
+To use, first configure your trace agent to listen by Unix socket, then configure the tracer with:
+
+```ruby
+Datadog.configure do |c|
+  c.tracer transport_options: proc { |t|
+    # Provide filepath to trace agent Unix socket
+    t.adapter :unix, '/tmp/ddagent/trace.sock'
+  }
+end
+```
+
+#### Using the transport test adapter
+
+The `Test` adapter is a no-op transport that can optionally buffer requests. For use in test suites or other non-production environments.
+
+```ruby
+Datadog.configure do |c|
+  c.tracer transport_options: proc { |t|
+    # Set transport to no-op mode. Does not retain traces.
+    t.adapter :test
+
+    # Alternatively, you can provide a buffer to examine trace output.
+    # The buffer must respond to '<<'.
+    t.adapter :test, []
+  }
+end
+```
+
+#### Using a custom transport adapter
+
+Custom adapters can be configured with:
+
+```ruby
+Datadog.configure do |c|
+  c.tracer transport_options: proc { |t|
+    # Initialize and pass an instance of the adapter
+    custom_adapter = CustomAdapter.new
+    t.adapter custom_adapter
+  }
+end
+```
+
 ### Metrics
 
 The tracer and its integrations can produce some additional metrics that can provide useful insight into the performance of your application. These metrics are collected with `dogstatsd-ruby`, and can be sent to the same Datadog agent to which you send your traces.
@@ -1778,7 +1849,6 @@ In addition, all metrics will include the following tags:
 | Name         | Description                                             |
 | ------------ | ------------------------------------------------------- |
 | `language`   | Programming language traced. (e.g. `ruby`)              |
-| `runtime-id` | Unique identifier of runtime environment (i.e. process) |
 | `service`    | List of services this metric is associated with.        |
 
 ### OpenTracing