Telemetry-safe error reporting for native extensions#5076
Merged
Conversation
This gets us closer to allowing these errors to be sent to telemetry.
Add ruby_helpers.h include to 8 C files that use datadog_profiling_error_class and datadog_profiling_internal_error_class but were missing the header declaration. This fixes the compilation error: error: 'datadog_profiling_error_class' undeclared Files fixed: - clock_id_from_pthread.c - collectors_gc_profiling_helper.c - collectors_stack.c - collectors_thread_context.c - encoded_profile.c - libdatadog_helpers.c - private_vm_api_access.c - unsafe_api_calls_check.c
Move ruby_helpers.h include after private VM headers to avoid conflicts. This file requires private VM headers to be included first before any public Ruby headers, but ruby_helpers.h includes datadog_ruby_common.h which includes ruby.h, causing header ordering conflicts. Fixes compilation error: 'expected ')' before '==' token in RHASH_EMPTY_P'
Cannot include ruby_helpers.h in this file as it pulls in public Ruby headers (via datadog_ruby_common.h) that conflict with private VM headers. Instead, declare the exception class globals as extern, following the pattern already established in this file for other declarations. This fully resolves the header ordering compilation error.
Method was renamed from safe_exception_message to constant_exception_message but the RBS signature file was not updated, causing Steep type errors.
The error method must be public but was accidentally made private when constant_exception_message was added. Moving it before the private keyword restores its public visibility. Fixes test failure: NoMethodError: private method 'error' called
Serialization errors contain dynamic libdatadog content, so they should raise ProfilingInternalError (not ProfilingError or RuntimeError). Updated both the Ruby wrapper code and the test expectation to use ProfilingInternalError consistently. Fixes test failure expecting ProfilingError but getting RuntimeError.
github-actions
Bot
added
core
BenchmarksBenchmark execution time: 2026-01-20 10:09:45 Comparing candidate commit 5aae53b in PR branch Found 0 performance improvements and 0 performance regressions! Performance is the same for 44 metrics, 2 unstable metrics. |
Member
|
The failure in the benchmarks... is because the "use the test code from this branch with master" doesn't work if master isn't API-compatible with this branch. TBH what I've done in the past is just disable the benchmark and re-enable it later, but it's kinda meh workaround. Suggestions welcome 😅 |
ivoanjo
reviewed
Dec 11, 2025
Member
ivoanjo
left a comment
ivoanjo
left a comment
There was a problem hiding this comment.
This is looking great! The one reason I didn't press the approve button is due to the raise_error in datadog_ruby_common.c -- that one doesn't quite look correct.
Signed-off-by: Marco Costa <marco.costa@datadoghq.com>
…remediation-custom-profiler-code' into marcotc/error-logs-remediation-custom-profiler-code
Member
Btw this one is still on my radar, catching up on a pile of things this week! 😅 |
…elpers.c` The use of `telemetry_message_id` was moved to `datadog_ruby_common.h/.c` directly, this was no longer needed.
ivoanjo
deleted the
marcotc/error-logs-remediation-custom-profiler-code
branch
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
(I'll squash the commits on reviews finish)
What does this PR do?
This PR ensure errors raised from native
ext/code have enough context to be valuable in telemetry.Motivation:
Because error information sent to telemetry cannot have arbitrary, dynamic data, we must ensure that we are only sending values that are known at gem build time.
Because our fallback is to only report the exception class, this PR adds a
telemetry_messageto native exceptions, so that their error information is not completely lost.Change log entry
Yes. Telemetry: Added static error reporting for native extensions.Additional Notes:
There's a follow up PR to reduce code duplication for the
datadog_ruby_common.c/hfiles: #5088How to test the change?
Easiest and fastest test it:
bundle exec rake clean compile && bundle exec rake spec:profilingThere are more products supported by
libdatadog, but at that point, just run CI :)