ddtrace 0.12.0.rc1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f73d39bda4233aa96ad4c0a5537ca45c7a682721
-  data.tar.gz: b494960dadd540e1c5bc0b1b2ca810cc0878477e
+  metadata.gz: ed9e1360ddbe75df4f11570139cc00f400c18071
+  data.tar.gz: 913743d057209630997ba59f724e1daab5a596dd
 SHA512:
-  metadata.gz: c78b30912aa1776417fc5a073791e3b527adb042831110b5d5fe4e1e7d42bb5a031fbbb899bfe0b35ffeec28bc14fe475747aefe4bce6effe26ec48c765393e0
-  data.tar.gz: 849cc865358ed3b9c171ad74f50609a8a4b57b532df97e2b7da408dfbfc40bf9646a0a8e4bd83e68953d88533e03a7798846fb9543dabbebca35f1663aae5645
+  metadata.gz: 19746053111cb07270b7a8e09f59064f85f50d47be4d083a2e31dad8c7ce0b973e1706b74ae4fb71795f0d21edfe8a740f5cab5fbff097967d94be92844ed9bd
+  data.tar.gz: 2588e88b3bdf175079518fc14cdc58501b54f9d49a313ab5c19291ec02d86a84e3c10fa7870cc1050c640c89f89afa14c7c8692ae8debb4d57f03f3f83a7da19

data/CHANGELOG.md

@@ -4,6 +4,38 @@
 
 ## [Unreleased (beta)]
 
+## [0.12.0] - 2018-05-08
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.12.0
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.11.4...v0.12.0
+
+### Added
+- GraphQL integration (supporting graphql 1.7.9+) (#295)
+- ActiveRecord object instantiation tracing (#311, #334)
+- Subscriber module for ActiveSupport::Notifications tracing (#324, #380, #390, #395) (@dasch)
+- HTTP quantization module (#384)
+- Partial flushing option to tracer (#247, #397)
+
+### Changed
+- Rack applies URL quantization by default (#371)
+- Elasticsearch applies body quantization by default (#362)
+- Context for a single trace now has hard limit of 100,000 spans (#247)
+- Tags with `rails.db.x` to `active_record.db.x` instead (#396)
+
+### Fixed
+- Loading the ddtrace library after Rails has fully initialized can result in load errors. (#357)
+- Some scenarios where `middleware_names` could result in bad resource names (#354)
+- ActionController instrumentation conflicting with some gems that monkey patch Rails (#391)
+
+### Deprecated
+- Use of `:datadog_rack_request_span` variable in favor of `'datadog.rack_request_span'` in Rack. (#365, #392)
+
+### Refactored
+- Racecar to use ActiveSupport::Notifications Subscriber module (#381)
+- Rails to use ActiveRecord integration instead of its own implementation (#396)
+- ActiveRecord to use ActiveSupport::Notifications Subscriber module (#396)
+
 ## [0.12.0.rc1] - 2018-04-11
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.12.0.rc1
@@ -253,8 +285,9 @@ 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 (stable)]: https://github.com/DataDog/dd-trace-rb/compare/v0.11.4...master
-[Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.12.0.rc1...0.12-dev
+[Unreleased (stable)]: https://github.com/DataDog/dd-trace-rb/compare/v0.12.0...master
+[Unreleased (beta)]: https://github.com/DataDog/dd-trace-rb/compare/v0.12.0...0.13-dev
+[0.12.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.11.4...v0.12.0
 [0.12.0.rc1]: https://github.com/DataDog/dd-trace-rb/compare/v0.11.4...v0.12.0.rc1
 [0.12.0.beta2]: https://github.com/DataDog/dd-trace-rb/compare/v0.12.0.beta1...v0.12.0.beta2
 [0.12.0.beta1]: https://github.com/DataDog/dd-trace-rb/compare/v0.11.2...v0.12.0.beta1

data/docs/GettingStarted.md

@@ -885,68 +885,144 @@ span.context.sampling_priority = Datadog::Ext::Priority::USER_KEEP
 
 ### Distributed Tracing
 
-To trace requests across hosts, the spans on the secondary hosts must be linked together by setting ``trace_id`` and ``parent_id``:
+Distributed tracing allows traces to be propagated across multiple instrumented applications, so that a request can be presented as a single trace, rather than a separate trace per service.
 
-```ruby
-def request_on_secondary_host(parent_trace_id, parent_span_id)
-    tracer.trace('web.request') do |span|
-       span.parent_id = parent_span_id
-       span.trace_id = parent_trace_id
+To trace requests across application boundaries, the following must be propagated between each application:
 
-       # perform user code
-    end
-end
+| Property              | Type    | Description                                                                                                                 |
+| --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------- |
+| **Trace ID**          | Integer | ID of the trace. This value should be the same across all requests that belong to the same trace.                           |
+| **Parent Span ID**    | Integer | ID of the span in the service originating the request. This value will always be different for each request within a trace. |
+| **Sampling Priority** | Integer | Sampling priority level for the trace. This value should be the same across all requests that belong to the same trace.     |
+
+Such propagation can be visualized as:
+
+```
+Service A:
+  Trace ID:  100000000000000001
+  Parent ID: 0
+  Span ID:   100000000000000123
+  Priority:  1
+
+  |
+  | Service B Request:
+  |   Metadata:
+  |     Trace ID:  100000000000000001
+  |     Parent ID: 100000000000000123
+  |     Priority:  1
+  |
+  V
+
+Service B:
+  Trace ID:  100000000000000001
+  Parent ID: 100000000000000123
+  Span ID:   100000000000000456
+  Priority:  1
+
+  |
+  | Service C Request:
+  |   Metadata:
+  |     Trace ID:  100000000000000001
+  |     Parent ID: 100000000000000456
+  |     Priority:  1
+  |
+  V
+
+Service C:
+  Trace ID:  100000000000000001
+  Parent ID: 100000000000000456
+  Span ID:   100000000000000789
+  Priority:  1
 ```
 
-Users can pass along the ``parent_trace_id`` and ``parent_span_id`` via whatever method best matches the RPC framework.
+**Via HTTP**
 
-Below is an example using Net/HTTP and Sinatra, where we bypass the integrations to demo how distributed tracing works.
+For HTTP requests between instrumented applications, this trace metadata is propagated by use of HTTP Request headers:
 
-On the client:
+| Property              | Type    | HTTP Header name              |
+| --------------------- | ------- | ----------------------------- |
+| **Trace ID**          | Integer | `x-datadog-trace-id`          |
+| **Parent Span ID**    | Integer | `x-datadog-parent-id`         |
+| **Sampling Priority** | Integer | `x-datadog-sampling-priority` |
 
-```ruby
-require 'net/http'
-require 'ddtrace'
+Such that:
 
-uri = URI('http://localhost:4567/')
+```
+Service A:
+  Trace ID:  100000000000000001
+  Parent ID: 0
+  Span ID:   100000000000000123
+  Priority:  1
+
+  |
+  | Service B HTTP Request:
+  |   Headers:
+  |     x-datadog-trace-id:          100000000000000001
+  |     x-datadog-parent-id:         100000000000000123
+  |     x-datadog-sampling-priority: 1
+  |
+  V
+
+Service B:
+  Trace ID:  100000000000000001
+  Parent ID: 100000000000000123
+  Span ID:   100000000000000456
+  Priority:  1
+
+  |
+  | Service B HTTP Request:
+  |   Headers:
+  |     x-datadog-trace-id:          100000000000000001
+  |     x-datadog-parent-id:         100000000000000456
+  |     x-datadog-sampling-priority: 1
+  |
+  V
+
+Service C:
+  Trace ID:  100000000000000001
+  Parent ID: 100000000000000456
+  Span ID:   100000000000000789
+  Priority:  1
+```
 
-Datadog.tracer.trace('web.call') do |span|
-  req = Net::HTTP::Get.new(uri)
-  req['x-datadog-trace-id'] = span.trace_id.to_s
-  req['x-datadog-parent-id'] = span.span_id.to_s
+**Activating distributed tracing for integrations**
 
-  response = Net::HTTP.start(uri.hostname, uri.port) do |http|
-    http.request(req)
-  end
+Many integrations included in `ddtrace` support distributed tracing. Distributed tracing is disabled by default, but can be activated via configuration settings.
 
-  puts response.body
-end
-```
+- If your application receives requests from services with distributed tracing activated, you must activate distributed tracing on the integrations that handle these requests (e.g. Rails)
+- If your application send requests to services with distributed tracing activated, you must activate distributed tracing on the integrations that send these requests (e.g. Faraday)
+- If your application both sends and receives requests implementing distributed tracing, it must activate all integrations which handle these requests.
 
-On the server:
+For more details on how to activate distributed tracing for integrations, see their documentation:
 
-```ruby
-require 'sinatra'
-require 'ddtrace'
+- [Faraday](#faraday)
+- [Net/HTTP](#nethttp)
+- [Rack](#rack)
+- [Rails](#rails)
+- [Sinatra](#sinatra)
 
-get '/' do
-  parent_trace_id = request.env['HTTP_X_DATADOG_TRACE_ID']
-  parent_span_id = request.env['HTTP_X_DATADOG_PARENT_ID']
+**Using the HTTP propagator**
 
-  Datadog.tracer.trace('web.work') do |span|
-     if parent_trace_id && parent_span_id
-       span.trace_id = parent_trace_id.to_i
-       span.parent_id = parent_span_id.to_i
-     end
+To make the process of propagating this metadata easier, you can use the `Datadog::HTTPPropagator` module.
 
-    'Hello world!'
-  end
+On the client:
+
+```ruby
+Datadog.tracer.trace('web.call') do |span|
+  # Inject span context into headers (`env` must be a Hash)
+  Datadog::HTTPPropagator.inject!(span.context, env)
 end
 ```
 
-[Rack](#rack) and [Net/HTTP](#nethttp) have experimental support for this, they can send and receive these headers automatically and tie spans together automatically, provided you pass a ``:distributed_tracing`` option set to ``true``.
+On the server:
 
-Distributed tracing is disabled by default.
+```ruby
+Datadog.tracer.trace('web.work') do |span|
+  # Build a context from headers (`env` must be a Hash)
+  context = HTTPPropagator.extract(request.env)
+  Datadog.tracer.provider.context = context if context.trace_id
+end
+```
 
 ### Processing Pipeline
 

data/lib/ddtrace/version.rb

@@ -3,7 +3,7 @@ module Datadog
     MAJOR = 0
     MINOR = 12
     PATCH = 0
-    PRE = 'rc1'.freeze
+    PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddtrace
 version: !ruby/object:Gem::Version
-  version: 0.12.0.rc1
+  version: 0.12.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -352,9 +352,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14