ddtrace 0.53.0 → 0.54.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d503fa2075462a3264c15a5e05ed1bc19afae88994c6df987dd32c6ee4f500c
-  data.tar.gz: 93a4cfaa1b395f1f968b1e87525df21b44c3a2fd63458013a1d506c9ae3b28e2
+  metadata.gz: bef2da14245890c8187ebffd9cce972da89a177a806c6991f2e3050e1de62bc3
+  data.tar.gz: d37dcaf645e16177c6f7a3dd77628f2e5a4920c45fca8e3f78665c34a4d76db2
 SHA512:
-  metadata.gz: 63918fc0a3b1d50a76842f6b500ae80300c6df9afd873628230a70a17b83b8971904fe2e1b1ff71cb44143eb6ef62b294f4958188c4db24cb12ee61a2069ab34
-  data.tar.gz: 5de75c82e3030e4c617a0b06b590574f5389d428eba9294e8b1a5221bd7f4e3b0bfbc40295cb86d1fb91af1a199585015ea6d6d4e3080dc475e15e8bba1288f0
+  metadata.gz: c59d7c5b2f363eb96f78ad602489ccbd0ed94ae9d6e856c70272ddb21ba467255179814db1831518789b7c32e9ab5d0f13421dd67ea585d0b39fe78849bcfe81
+  data.tar.gz: 97dcba8ee6eda7c3cafdb39946863d337ef67843ac7f071890ce6253786b9d9a26ca8a9f181a8c0dad44c01a3ffab53c146ea4848b6497552d26558f9f1278ce

data/CHANGELOG.md

@@ -2,6 +2,53 @@
 
 ## [Unreleased]
 
+## [0.54.1] - 2021-11-30
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.54.1
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.54.0...v0.54.1
+
+### Fixed
+
+- Skip building profiling native extension when Ruby has been compiled without JIT ([#1774][], [#1776][])
+
+## [0.54.0] - 2021-11-17
+
+Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.54.0
+
+Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.53.0...v0.54.0
+
+### Added
+
+- MongoDB service name resolver when using multi cluster ([#1423][]) ([@skcc321][])
+- Service name override for ActiveJob in Rails configuration ([#1703][], [#1770][]) ([@hatstand][])
+- Profiler: Expose profile duration and start to the UI ([#1709][])
+- Profiler: Gather CPU time without monkey patching Thread ([#1735][], [#1740][])
+- Profiler: Link profiler samples to individual web requests ([#1688][])
+- Profiler: Capture threads with empty backtrace ([#1719][])
+- CI-App: Memoize environment tags to improve performance ([#1762][])
+- CI-App: `test.framework_version` tag for rspec and cucumber ([#1713][])
+
+### Changed
+
+- Set minimum version of dogstatsd-ruby 5 series to 5.3 ([#1717][])
+- Use USER_KEEP/USER_REJECT for RuleSampler decisions ([#1769][])
+
+### Fixed
+
+- "private method `ruby2_keywords' called" errors ([#1712][], [#1714][])
+- Configuration warning when Agent port is a String ([#1720][])
+- Ensure internal trace buffer respects its maximum size ([#1715][])
+- Remove erroneous maximum resque version support ([#1761][])
+- CI-App: Environment variables parsing precedence ([#1745][], [#1763][])
+- CI-App: GitHub Metadata Extraction ([#1771][])
+- Profiler: Missing thread id for natively created threads ([#1718][])
+- Docs: Active Job integration example code ([#1721][]) ([@y-yagi][])
+
+### Refactored
+
+- Redis client patch to use prepend ([#1743][]) ([@justinhoward][])
+
 ## [0.53.0] - 2021-10-06
 
 Release notes: https://github.com/DataDog/dd-trace-rb/releases/tag/v0.53.0
@@ -17,6 +64,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.52.0...v0.53.0
 - Runtime Metrics: Global VM cache statistics ([#1680][])
 - Automatically send traces to agent Unix socket if present ([#1700][])
 - CI-App: User Provided Git Metadata ([#1662][])
+- ActionMailer integration ([#1280][])
 
 ### Changed
 
@@ -475,26 +523,26 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.39.0...v0.40.0
 ### Fixed
 
 - Sinatra nested modular applications possibly leaking spans ([#1035][], [#1145][])
-  
+
   * **BREAKING** for nested modular Sinatra applications only:
     ```ruby
     class Nested < Sinatra::Base
     end
-    
+
     class TopLevel < Sinatra::Base
       use Nested # Nesting happens here
     end
     ```
   * Non-breaking for classic applications nor modular non-nested applications.
-  
+
   Fixes issues introduced by [#1015][] (in 0.35.0), when we first introduced Sinatra support for modular applications.
-  
+
   The main issue we had to solve for modular support is how to handle nested applications, as only one application is actually responsible for handling the route. A naive implementation would cause the creation of nested `sinatra.request` spans, even for applications that did not handle the request. This is technically correct, as Sinatra is traversing that middleware, accruing overhead, but that does not aligned with our existing behavior of having a single `sinatra.request` span.
-  
+
   While trying to achieve backwards-compatibility, we had to resort to a solution that turned out brittle: `sinatra.request` spans had to start in one middleware level and finished it in another. This allowed us to only capture the `sinatra.request` for the matching route, and skip the non-matching one. This caused unexpected issues on some user setups, specially around Sinatra middleware that created spans in between the initialization and closure of `sinatra.request` spans.
-  
+
   This change now address these implementation issues by creating multiple `sinatra.request`, one for each traversed Sinatra application, even non-matching ones. This instrumentation is more correct, but at the cost of being a breaking change for nested modular applications.
-  
+
   Please see [#1145][] for more information, and example screenshots on how traces for affected applications will look like.
 
 - Rack/Rails span error propagation with `rescue_from` ([#1155][], [#1162][])
@@ -1350,7 +1398,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.14.1...v0.14.2
 
 ### Fixed
 
-- Sampling priority from request headers not being used ([#521][])  
+- Sampling priority from request headers not being used ([#521][])
 
 ## [0.14.1] - 2018-08-21
 
@@ -1496,9 +1544,9 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.12.1...v0.13.0
 - Hash quantization into core library ([#410][])
 - MongoDB integration to use Hash quantization library ([#463][])
 
-### Changed 
+### Changed
 
-- Hash quantization truncates arrays with nested objects ([#463][]) 
+- Hash quantization truncates arrays with nested objects ([#463][])
 
 ## [0.13.0.beta1] - 2018-05-09
 
@@ -1847,7 +1895,8 @@ 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.53.0...master
+[Unreleased]: https://github.com/DataDog/dd-trace-rb/compare/v0.54.0...master
+[0.54.0]: https://github.com/DataDog/dd-trace-rb/compare/v0.53.0...v0.54.0
 [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
@@ -2439,6 +2488,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#1277]: https://github.com/DataDog/dd-trace-rb/issues/1277
 [#1278]: https://github.com/DataDog/dd-trace-rb/issues/1278
 [#1279]: https://github.com/DataDog/dd-trace-rb/issues/1279
+[#1280]: https://github.com/DataDog/dd-trace-rb/issues/1280
 [#1281]: https://github.com/DataDog/dd-trace-rb/issues/1281
 [#1283]: https://github.com/DataDog/dd-trace-rb/issues/1283
 [#1284]: https://github.com/DataDog/dd-trace-rb/issues/1284
@@ -2516,6 +2566,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#1420]: https://github.com/DataDog/dd-trace-rb/issues/1420
 [#1421]: https://github.com/DataDog/dd-trace-rb/issues/1421
 [#1422]: https://github.com/DataDog/dd-trace-rb/issues/1422
+[#1423]: https://github.com/DataDog/dd-trace-rb/issues/1423
 [#1426]: https://github.com/DataDog/dd-trace-rb/issues/1426
 [#1427]: https://github.com/DataDog/dd-trace-rb/issues/1427
 [#1428]: https://github.com/DataDog/dd-trace-rb/issues/1428
@@ -2601,12 +2652,36 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [#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
+[#1688]: https://github.com/DataDog/dd-trace-rb/issues/1688
 [#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
+[#1703]: https://github.com/DataDog/dd-trace-rb/issues/1703
 [#1706]: https://github.com/DataDog/dd-trace-rb/issues/1706
+[#1709]: https://github.com/DataDog/dd-trace-rb/issues/1709
+[#1712]: https://github.com/DataDog/dd-trace-rb/issues/1712
+[#1713]: https://github.com/DataDog/dd-trace-rb/issues/1713
+[#1714]: https://github.com/DataDog/dd-trace-rb/issues/1714
+[#1715]: https://github.com/DataDog/dd-trace-rb/issues/1715
+[#1717]: https://github.com/DataDog/dd-trace-rb/issues/1717
+[#1718]: https://github.com/DataDog/dd-trace-rb/issues/1718
+[#1719]: https://github.com/DataDog/dd-trace-rb/issues/1719
+[#1720]: https://github.com/DataDog/dd-trace-rb/issues/1720
+[#1721]: https://github.com/DataDog/dd-trace-rb/issues/1721
+[#1735]: https://github.com/DataDog/dd-trace-rb/issues/1735
+[#1740]: https://github.com/DataDog/dd-trace-rb/issues/1740
+[#1743]: https://github.com/DataDog/dd-trace-rb/issues/1743
+[#1745]: https://github.com/DataDog/dd-trace-rb/issues/1745
+[#1761]: https://github.com/DataDog/dd-trace-rb/issues/1761
+[#1762]: https://github.com/DataDog/dd-trace-rb/issues/1762
+[#1763]: https://github.com/DataDog/dd-trace-rb/issues/1763
+[#1769]: https://github.com/DataDog/dd-trace-rb/issues/1769
+[#1770]: https://github.com/DataDog/dd-trace-rb/issues/1770
+[#1771]: https://github.com/DataDog/dd-trace-rb/issues/1771
+[#1774]: https://github.com/DataDog/dd-trace-rb/issues/1774
+[#1776]: https://github.com/DataDog/dd-trace-rb/issues/1776
 [@AdrianLC]: https://github.com/AdrianLC
 [@Azure7111]: https://github.com/Azure7111
 [@BabyGroot]: https://github.com/BabyGroot
@@ -2669,6 +2744,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@gkampjes]: https://github.com/gkampjes
 [@gottfrois]: https://github.com/gottfrois
 [@guizmaii]: https://github.com/guizmaii
+[@hatstand]: https://github.com/hatstand
 [@hawknewton]: https://github.com/hawknewton
 [@hs-bguven]: https://github.com/hs-bguven
 [@illdelph]: https://github.com/illdelph
@@ -2678,6 +2754,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@jfrancoist]: https://github.com/jfrancoist
 [@joeyAghion]: https://github.com/joeyAghion
 [@jpaulgs]: https://github.com/jpaulgs
+[@justinhoward]: https://github.com/justinhoward
 [@jvalanen]: https://github.com/jvalanen
 [@kelvin-acosta]: https://github.com/kelvin-acosta
 [@kexoth]: https://github.com/kexoth
@@ -2715,6 +2792,7 @@ Git diff: https://github.com/DataDog/dd-trace-rb/compare/v0.3.0...v0.3.1
 [@senny]: https://github.com/senny
 [@shayonj]: https://github.com/shayonj
 [@sinsoku]: https://github.com/sinsoku
+[@skcc321]: https://github.com/skcc321
 [@soulcutter]: https://github.com/soulcutter
 [@stefanahman]: https://github.com/stefanahman
 [@steveh]: https://github.com/steveh

data/ddtrace.gemspec

@@ -46,8 +46,11 @@ 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.12'
 
   spec.extensions = ['ext/ddtrace_profiling_native_extension/extconf.rb']
 end

data/docs/GettingStarted.md

@@ -135,13 +135,18 @@ To contribute, check out the [contribution guidelines][contribution docs] and [d
 
 *EOL* indicates support is no longer provided.
 
+### Microsoft Windows support
+
+Using `ddtrace ` on Microsoft Windows is currently unsupported. We'll still accept community contributions and issues,
+but will consider them as having low priority.
+
 ## Installation
 
 The following steps will help you quickly start tracing your Ruby application.
 
 ### Configure the Datadog Agent for APM
 
-Before downloading tracing on your application, install the Datadog Agent. The Ruby APM tracer sends trace data through the Datadog Agent.
+Before downloading tracing on your application, [install the Datadog Agent on the host](https://docs.datadoghq.com/agent/). The Ruby APM tracer sends trace data through the Datadog Agent.
 
 Install and configure the Datadog Agent to receive traces from your now instrumented application. By default the Datadog Agent is enabled in your `datadog.yaml` file under `apm_enabled: true` and listens for trace traffic at `localhost:8126`. For containerized environments, follow the steps below to enable trace collection within the Datadog Agent.
 
@@ -540,7 +545,7 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 Most of the time, Active Job is set up as part of Rails, but it can be activated separately:
 
 ```ruby
-require 'activejob'
+require 'active_job'
 require 'ddtrace'
 
 Datadog.configure do |c|
@@ -1217,6 +1222,37 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | `quantize` | Hash containing options for quantization. May include `:show` with an Array of keys to not quantize (or `:all` to skip quantization), or `:exclude` with Array of keys to exclude entirely. | `{ show: [:collection, :database, :operation] }` |
 | `service_name` | Service name used for `mongo` instrumentation | `'mongodb'` |
 
+**Configuring trace settings per connection**
+
+You can configure trace settings per connection by using the `describes` option:
+
+```ruby
+# Provide a `:describes` option with a connection key.
+# Any of the following keys are acceptable and equivalent to one another.
+# If a block is provided, it yields a Settings object that
+# accepts any of the configuration options listed above.
+
+Datadog.configure do |c|
+  # Network connection string
+  c.use :mongo, describes: '127.0.0.1:27017', service_name: 'mongo-primary'
+
+  # Network connection regular expression
+  c.use :mongo, describes: /localhost.*/, service_name: 'mongo-secondary'
+end
+
+client = Mongo::Client.new([ '127.0.0.1:27017' ], :database => 'artists')
+collection = client[:people]
+collection.insert_one({ name: 'Steve' })
+# Traced call will belong to `mongo-primary` service
+
+client = Mongo::Client.new([ 'localhost:27017' ], :database => 'artists')
+collection = client[:people]
+collection.insert_one({ name: 'Steve' })
+# Traced call will belong to `mongo-secondary` service
+```
+
+When multiple `describes` configurations match a connection, the latest configured rule that matches will be applied.
+
 ### MySQL2
 
 The MySQL2 integration traces any SQL command sent through `mysql2` gem.
@@ -1471,6 +1507,7 @@ Where `options` is an optional `Hash` that accepts the following parameters:
 | `database_service` | Database service name used when tracing database activity | `'<app_name>-<adapter_name>'` |
 | `distributed_tracing` | Enables [distributed tracing](#distributed-tracing) so that this service trace is connected with a trace of another service if tracing headers are received | `true` |
 | `exception_controller` | Class or Module which identifies a custom exception controller class. Tracer provides improved error behavior when it can identify custom exception controllers. By default, without this option, it 'guesses' what a custom exception controller looks like. Providing this option aids this identification. | `nil` |
+| `job_service` | Service name used when tracing ActiveJob activity. | `<app_name>-active_job` |
 | `middleware` | Add the trace middleware to the Rails application. Set to `false` if you don't want the middleware to load. | `true` |
 | `middleware_names` | Enables any short-circuited middleware requests to display the middleware name as a resource for the trace. | `false` |
 | `service_name` | Service name used when tracing application requests (on the `rack` level) | `'<app_name>'` (inferred from your Rails application namespace) |
@@ -2461,7 +2498,7 @@ The tracer and its integrations can produce some additional metrics that can pro
 To configure your application for metrics collection:
 
 1. [Configure your Datadog agent for StatsD](https://docs.datadoghq.com/developers/dogstatsd/#setup)
-2. Add `gem 'dogstatsd-ruby', '~> 5.2'` to your Gemfile
+2. Add `gem 'dogstatsd-ruby', '~> 5.3'` to your Gemfile
 
 #### For application runtime
 

data/docs/ProfilingDevelopment.md

@@ -97,9 +97,9 @@ The profiler backend links a trace covering a given time interval to the profile
 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.
+profiler is tagged with the `local root span 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
+This is done using the `Datadog::Profiling::TraceIdentifiers::Helper` that retrieves a `root_span_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

data/ext/ddtrace_profiling_native_extension/NativeExtensionDesign.md

@@ -0,0 +1,86 @@
+# Profiling Native Extension Design
+
+The profiling native extension is used to implement features which are expensive (in terms of resources) or otherwise
+impossible to implement using Ruby code.
+
+This extension is quite coupled with MRI Ruby ("C Ruby") internals, and is not intended to support other rubies such as
+JRuby or TruffleRuby. When below we say "Ruby", read it as "MRI Ruby".
+
+## Disabling
+
+The profiling native extension can be disabled by setting `DD_PROFILING_NO_EXTENSION=true` when installing or running
+the gem. Setting `DD_PROFILING_NO_EXTENSION` at installation time skips compilation of the extension entirely.
+
+(If you're a customer and needed to use this, please tell us why on <https://github.com/DataDog/dd-trace-rb/issues/new>.)
+
+Currently the profiler can still "limp along" when the native extension is disabled, but the plan is to require it
+in future releases -- e.g. disabling the extension will disable profiling entirely.
+
+## Safety
+
+The profiling native extension is (and must always be) designed to **not cause failures** during gem installation, even
+if some features, Ruby versions, or operating systems are not supported.
+
+E.g. the extension must cleanly build on Ruby 2.1 (or the oldest Ruby version we support at the time) on Windows,
+even if at run time it will effectively do nothing for such a setup.
+
+We have a CI setup to help validate this, but this is really important to keep in mind when adding to or changing the
+existing codebase.
+
+## Usage of private VM headers
+
+To implement some of the features below, we sometimes require access to private Ruby header files (that describe VM
+internal types, structures and functions).
+
+Because these private header files are not included in regular Ruby installations, we have two different workarounds:
+
+1. for Ruby versions >= 2.6 we make use use the Ruby private MJIT header
+2. for Ruby versions < 2.6 (legacy Rubies) we make use of the `debase-ruby_core_source` gem
+
+Functions which make use of these headers are defined in the <private_vm_api_acccess.c> file.
+
+**Important Note**: Our medium/long-term plan is to stop relying on all private Ruby headers, and instead request and
+contribute upstream changes so that they become official public VM APIs.
+
+### Approach 1: Using the Ruby private MJIT header
+
+Ruby versions >= 2.6 introduced a JIT compiler called MJIT. This compiler does not directly generate machine code;
+instead it generates C code and uses the system C compiler to turn it into machine code.
+
+The generated C code `#include`s a private header -- which we reference as "the MJIT header" everywhere.
+The MJIT header gets shipped with all MJIT-enabled Rubies and includes the layout of many internal VM structures;
+and of course the intention is that it is only used by the Ruby MJIT compiler.
+
+This header is placed inside the `include/` directory in a Ruby installation, and is named for that specific Ruby
+version. e.g. `rb_mjit_min_header-2.7.4.h`.
+
+### Approach 2: Using the `debase-ruby_core_source` gem
+
+The [`debase-ruby_core_source`](https://github.com/ruby-debug/debase-ruby_core_source) contains almost no code;
+instead, it just contains per-Ruby-version folders with the private VM headers (`.h`) files for that version.
+
+Thus, even though a regular Ruby installation does not include these files, we can access the copy inside this gem.
+
+## Feature: Getting thread CPU-time clock_ids
+
+* **OS support**: Linux
+* **Ruby support**: 2.6+
+
+To enable CPU-time profiling, we use the `pthread_getcpuclockid(pthread_t thread, clockid_t *clockid)` C function to
+obtain a `clockid_t` that can then be used with the `Process.clock_gettime` method (or directly with the
+`clock_gettime()` C function).
+
+The challenge with using `pthread_getcpuclockid()` is that we need to get the `pthread_t` for a given Ruby `Thread`
+object. We previously did this with a weird combination of monkey patching and `pthread_self()` (effectively patching
+every `Thread` to run `pthread_self()` at initialization time and stash that value somewhere), but this had a number
+of downsides.
+
+The approach we use in the profiling native extension is to reach inside the internal structure of the `Thread` object,
+and extract the `pthread_t` that Ruby itself keeps, but does not expose. This is implemented in the `pthread_id_for()`
+function in `private_vm_api_acccess.c`. Thus, using this trick we can at any point in execution go from a `Thread`
+object into the `clockid_t` that we need.
+
+Note that `pthread_getcpuclockid()` is not available on macOS (nor, obviously, on Windows), and hence this feature
+is currently Linux-specific. Thus, in the <clock_id_from_pthread.c> file we implement the feature for supported Ruby
+setups but if something is missing we instead compile in <clock_id_noop.c> that includes a no-op implementation of the
+feature.

data/ext/ddtrace_profiling_native_extension/clock_id.h

@@ -0,0 +1,4 @@
+#pragma once
+
+void self_test_clock_id();
+VALUE clock_id_for(VALUE self, VALUE thread);

data/ext/ddtrace_profiling_native_extension/clock_id_from_pthread.c

@@ -0,0 +1,52 @@
+#include "extconf.h"
+
+// This file is only compiled on systems where pthread_getcpuclockid() is available;
+// Otherwise we compile clock_id_noop.c
+#ifdef HAVE_PTHREAD_GETCPUCLOCKID
+
+#include <pthread.h>
+#include <time.h>
+#include <errno.h>
+
+#include <ruby.h>
+
+#ifdef RUBY_2_1_WORKAROUND
+#include <thread_native.h>
+#else
+#include <ruby/thread_native.h>
+#endif
+
+#include "private_vm_api_access.h"
+
+#include "clock_id.h"
+
+// Validate that our home-cooked pthread_id_for() matches pthread_self() for the current thread
+void self_test_clock_id() {
+  rb_nativethread_id_t expected_pthread_id = pthread_self();
+  rb_nativethread_id_t actual_pthread_id = pthread_id_for(rb_thread_current());
+
+  if (expected_pthread_id != actual_pthread_id) rb_raise(rb_eRuntimeError, "pthread_id_for() self-test failed");
+}
+
+VALUE clock_id_for(VALUE self, VALUE thread) {
+  rb_nativethread_id_t thread_id = pthread_id_for(thread);
+
+  clockid_t clock_id;
+  int error = pthread_getcpuclockid(thread_id, &clock_id);
+
+  if (error == 0) {
+    return CLOCKID2NUM(clock_id);
+  } else {
+    switch(error) {
+      // The more specific error messages are based on the pthread_getcpuclockid(3) man page
+      case ENOENT:
+        rb_exc_raise(rb_syserr_new(error, "Failed to get clock_id for given thread: Per-thread CPU time clocks are not supported by the system."));
+      case ESRCH:
+        rb_exc_raise(rb_syserr_new(error, "Failed to get clock_id for given thread: No thread could be found."));
+      default:
+        rb_exc_raise(rb_syserr_new(error, "Failed to get clock_id for given thread"));
+    }
+  }
+}
+
+#endif

data/ext/ddtrace_profiling_native_extension/clock_id_noop.c

@@ -0,0 +1,14 @@
+#include "extconf.h"
+
+// This file is the dual of clock_id_from_pthread.c for systems where that info
+// is not available.
+#ifndef HAVE_PTHREAD_GETCPUCLOCKID
+
+#include <ruby.h>
+
+#include "clock_id.h"
+
+void self_test_clock_id() { } // Nothing to check
+VALUE clock_id_for(VALUE self, VALUE thread) { return Qnil; } // Nothing to return
+
+#endif

data/ext/ddtrace_profiling_native_extension/extconf.rb

@@ -1,28 +1,166 @@
-# typed: false
-def skip_building_extension?
+# typed: ignore
+
+# Older Rubies don't have the MJIT header, used by the JIT compiler, so we need to use a different approach
+CAN_USE_MJIT_HEADER = RUBY_VERSION >= '2.6'
+
+def on_jruby?
   # 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'
+  RUBY_ENGINE == 'jruby'
+end
+
+def on_truffleruby?
+  # We don't officially support TruffleRuby for dd-trace-rb at all BUT let's not break adventurous customers that
+  # want to give it a try.
+  RUBY_ENGINE == 'truffleruby'
+end
+
+def on_windows?
+  # Microsoft Windows is unsupported, so let's not build the extension there.
+  Gem.win_platform?
+end
+
+def expected_to_use_mjit_but_mjit_is_disabled?
+  # On some Rubies, we require the mjit header to be present. If Ruby was installed without MJIT support, we also skip
+  # building the extension.
+  mjit_disabled = CAN_USE_MJIT_HEADER && RbConfig::CONFIG['MJIT_SUPPORT'] != 'yes'
 
+  if mjit_disabled
+    # rubocop:disable Style/StderrPuts
+    $stderr.puts(%(
++------------------------------------------------------------------------------+
+| Your Ruby has been compiled without JIT support (--disable-jit-support).     |
+| The profiling native extension requires a Ruby compiled with JIT support,    |
+| even if the JIT is not in use by the application itself.                     |
+|                                                                              |
+| WARNING: Without the profiling native extension, some profiling features     |
+| will not be available.                                                       |
++------------------------------------------------------------------------------+
+
+))
+  end
+
+  mjit_disabled
+end
+
+def disabled_via_env?
   # 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'
+  ENV['DD_PROFILING_NO_EXTENSION'].to_s.downcase == 'true'
+end
 
-  on_jruby || disabled_via_env
+def skip_building_extension?
+  disabled_via_env? || on_jruby? || on_truffleruby? || on_windows? || expected_to_use_mjit_but_mjit_is_disabled?
+end
+
+# IMPORTANT: When adding flags, remember that our customers compile with a wide range of gcc/clang versions, so
+# doublecheck that what you're adding can be reasonably expected to exist on their systems.
+def add_compiler_flag(flag)
+  $CFLAGS << ' ' << flag
 end
 
 if skip_building_extension?
+  $stderr.puts(%(
++------------------------------------------------------------------------------+
+| Skipping build of profiling native extension and replacing it with a no-op   |
+| Makefile                                                                     |
++------------------------------------------------------------------------------+
+
+))
+
   File.write('Makefile', 'all install clean: # dummy makefile that does nothing')
   return
 end
 
+$stderr.puts(%(
++------------------------------------------------------------------------------+
+| **Preparing to build the ddtrace native extension...**                       |
+|                                                                              |
+| If you run into any failures during this step, you can set the               |
+| `DD_PROFILING_NO_EXTENSION` environment variable to `true` e.g.              |
+| `$ DD_PROFILING_NO_EXTENSION=true bundle install` to skip this step.         |
+|                                                                              |
+| Disabling the extension will lead to the ddtrace profiling features 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> so we can fix it :\)      |
+|                                                                              |
+| Thanks for using ddtrace! You rock!                                          |
++------------------------------------------------------------------------------+
+
+))
+# rubocop:enable Style/StderrPuts
+
 # 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'
 
+# Gets really noisy when we include the MJIT header, let's omit it
+add_compiler_flag '-Wno-unused-function'
+
+# Allow defining variables at any point in a function
+add_compiler_flag '-Wno-declaration-after-statement'
+
+# If we forget to include a Ruby header, the function call may still appear to work, but then
+# cause a segfault later. Let's ensure that never happens.
+add_compiler_flag '-Werror-implicit-function-declaration'
+
+if RUBY_PLATFORM.include?('linux')
+  # Supposedly, the correct way to do this is
+  # ```
+  # have_library 'pthread'
+  # have_func 'pthread_getcpuclockid'
+  # ```
+  # but it broke the build on Windows and on older Ruby versions (2.1 and 2.2)
+  # so instead we just assume that we have the function we need on Linux, and nowhere else
+  $defs << '-DHAVE_PTHREAD_GETCPUCLOCKID'
+end
+
 # 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}"
+EXTENSION_NAME = "ddtrace_profiling_native_extension.#{RUBY_VERSION}_#{RUBY_PLATFORM}".freeze
+
+if CAN_USE_MJIT_HEADER
+  $defs << '-DUSE_MJIT_HEADER'
+
+  # NOTE: This needs to come after all changes to $defs
+  create_header
+
+  # The MJIT header is always (afaik?) suffixed with the exact Ruby VM version,
+  # including patch (e.g. 2.7.2). Thus, we add to the header file a definition
+  # containing the exact file, so that it can be used in a #include in the C code.
+  header_contents =
+    File.read($extconf_h)
+        .sub('#endif',
+             <<-EXTCONF_H.strip
+#define RUBY_MJIT_HEADER "rb_mjit_min_header-#{RUBY_VERSION}.h"
+
+#endif
+             EXTCONF_H
+            )
+  File.open($extconf_h, 'w') { |file| file.puts(header_contents) }
+
+  create_makefile EXTENSION_NAME
+else
+  # On older Rubies, we use the debase-ruby_core_source gem to get access to private VM headers.
+  # This gem ships source code copies of these VM headers for the different Ruby VM versions;
+  # see https://github.com/ruby-debug/debase-ruby_core_source for details
+
+  thread_native_for_ruby_2_1 = proc { true }
+  if RUBY_VERSION < '2.2'
+    # This header became public in Ruby 2.2, but we need to pull it from the private headers folder for 2.1
+    thread_native_for_ruby_2_1 = proc { have_header('thread_native.h') }
+    $defs << '-DRUBY_2_1_WORKAROUND'
+  end
+
+  create_header
+
+  require 'debase/ruby_core_source'
+  dir_config('ruby') # allow user to pass in non-standard core include directory
+
+  Debase::RubyCoreSource
+    .create_makefile_with_core(proc { have_header('vm_core.h') && thread_native_for_ruby_2_1.call }, EXTENSION_NAME)
+end