Skip to content

APMLP-350 fix crash in crashtracker when agent url is an ipv6 address#4237

Merged
p-datadog merged 6 commits into
masterfrom
crashtracking-crash
Dec 19, 2024
Merged

APMLP-350 fix crash in crashtracker when agent url is an ipv6 address#4237
p-datadog merged 6 commits into
masterfrom
crashtracking-crash

Conversation

@p-datadog

Copy link
Copy Markdown
Member

What does this PR do?

  • Repairs the crash in crashtracker due to insufficient error handling - adds a check for the endpoint construction failing (returning NULL) and raises an exception in this case
  • Repairs incorrect agent URL construction from IPv6 addresses - the IPv6 addresses must be bracketed when put into the hostname of a URL

Motivation:

Crash reported by system tests

Change log entry

Yes: fix a crash in crashtracker when agent hostname is an IPv6 address

Additional Notes:

The code that this PR touches may have more missing error handling (of other situations), I didn't check it exhaustively.

How to test the change?

Unit tests are added.
I also wrote DataDog/libdatadog#809 for libdatadog to verify it works OK with our provided input (which it does).

@p-datadog
p-datadog requested review from a team as code owners December 19, 2024 13:51
@github-actions github-actions Bot added the core Involves Datadog core libraries label Dec 19, 2024
@datadog-datadog-prod-us1

datadog-datadog-prod-us1 Bot commented Dec 19, 2024

Copy link
Copy Markdown
Contributor

Datadog Report

Branch report: crashtracking-crash
Commit report: 20aac55
Test service: dd-trace-rb

✅ 0 Failed, 22121 Passed, 1477 Skipped, 6m 5.16s Total Time

@codecov-commenter

codecov-commenter commented Dec 19, 2024

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.75%. Comparing base (11b9ae1) to head (20aac55).
⚠️ Report is 3913 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4237   +/-   ##
=======================================
  Coverage   97.74%   97.75%           
=======================================
  Files        1355     1355           
  Lines       82333    82365   +32     
  Branches     4226     4230    +4     
=======================================
+ Hits        80477    80516   +39     
+ Misses       1856     1849    -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@pr-commenter

pr-commenter Bot commented Dec 19, 2024

Copy link
Copy Markdown

Benchmarks

Benchmark execution time: 2024-12-19 15:00:58

Comparing candidate commit 20aac55 in PR branch crashtracking-crash with baseline commit 7fd1feb in branch master.

Found 1 performance improvements and 0 performance regressions! Performance is the same for 30 metrics, 2 unstable metrics.

scenario:tracing - Propagation - Trace Context

  • 🟩 throughput [+4487.343op/s; +4606.193op/s] or [+13.147%; +13.495%]

Comment thread lib/datadog/core/crashtracking/agent_base_url.rb

@Strech Strech left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread lib/datadog/core/crashtracking/agent_base_url.rb
@p-datadog
p-datadog merged commit c116d75 into master Dec 19, 2024
@p-datadog
p-datadog deleted the crashtracking-crash branch December 19, 2024 23:03
@github-actions github-actions Bot added this to the 2.9.0 milestone Dec 19, 2024
ivoanjo added a commit that referenced this pull request Jan 2, 2025
**What does this PR do?**

This PR builds atop #4237 and fixes a similar-ish issue in the profiler
caused by the same mishandling of ipv6 addresses.

In particular, when provided with an ipv6 address in the agent url,
the profiler would fail with an exception:

```
$ env DD_AGENT_HOST=2001:db8:1::2 DD_PROFILING_ENABLED=true \
bundle exec ddprofrb exec ruby -e "sleep 2"

dd-trace-rb/lib/datadog/profiling/http_transport.rb:27:in `initialize':
Failed to initialize transport: invalid authority (ArgumentError)
```

**Motivation:**

Luckily we didn't have any customers using this, as it fails immediately
and loudly, but it's still a bug on a configuration that should be
supported.

**Additional Notes:**

Since we had similar buggy logic copy-pasted in crashtracking and
profiling (crashtracking had been fixed in #4237) I chose to extract
out the relevant logic into the `AgentSettings` class, so that
both can reuse it.

**How to test the change?**

I've added unit test coverage for this issue to profiling, and
the snippet above can be used to end-to-end test it's working fine.

Here's how it looks on my machine now:

```
E, [2025-01-02T17:32:32.398756 #359317] ERROR -- datadog: [datadog]
(dd-trace-rb/lib/datadog/profiling/http_transport.rb:68:in `export')
Failed to report profiling data (agent: http://[2001:db8:1::2]:8126/):
failed ddog_prof_Exporter_send: error trying to connect: tcp connect
error: Network is unreachable (os error 101): tcp connect error:
Network is unreachable (os error 101): Network is unreachable (os error 101)
```

E.g. we correctly try to connect to the dummy address, and fail :)

(Note: The error message is a bit ugly AND repeats itself a bit.
That's being tracked separately
in DataDog/libdatadog#283 )
quinna-h pushed a commit that referenced this pull request Jan 8, 2025
**What does this PR do?**

This PR builds atop #4237 and fixes a similar-ish issue in the profiler
caused by the same mishandling of ipv6 addresses.

In particular, when provided with an ipv6 address in the agent url,
the profiler would fail with an exception:

```
$ env DD_AGENT_HOST=2001:db8:1::2 DD_PROFILING_ENABLED=true \
bundle exec ddprofrb exec ruby -e "sleep 2"

dd-trace-rb/lib/datadog/profiling/http_transport.rb:27:in `initialize':
Failed to initialize transport: invalid authority (ArgumentError)
```

**Motivation:**

Luckily we didn't have any customers using this, as it fails immediately
and loudly, but it's still a bug on a configuration that should be
supported.

**Additional Notes:**

Since we had similar buggy logic copy-pasted in crashtracking and
profiling (crashtracking had been fixed in #4237) I chose to extract
out the relevant logic into the `AgentSettings` class, so that
both can reuse it.

**How to test the change?**

I've added unit test coverage for this issue to profiling, and
the snippet above can be used to end-to-end test it's working fine.

Here's how it looks on my machine now:

```
E, [2025-01-02T17:32:32.398756 #359317] ERROR -- datadog: [datadog]
(dd-trace-rb/lib/datadog/profiling/http_transport.rb:68:in `export')
Failed to report profiling data (agent: http://[2001:db8:1::2]:8126/):
failed ddog_prof_Exporter_send: error trying to connect: tcp connect
error: Network is unreachable (os error 101): tcp connect error:
Network is unreachable (os error 101): Network is unreachable (os error 101)
```

E.g. we correctly try to connect to the dummy address, and fail :)

(Note: The error message is a bit ugly AND repeats itself a bit.
That's being tracked separately
in DataDog/libdatadog#283 )
marcotc pushed a commit that referenced this pull request Jan 8, 2025
* add supported version script and table

* update script

* rubocop lint

* modify script locations, add description to md table

* improve table output

* wip

* refactor code

* wip

* add supported versions

* add branch for testing

* remove json to avoid merge conflict issues

* update PR body

* Update .github/scripts/generate_table_versions.rb

Co-authored-by: Steven Bouwkamp <[email protected]>

* switch to use gem declarations instead of hardcoded mappings

* linting checks

* cleanup comments

* refactor code

* cleanup code

* Combine duplicate option table rows

The documentation for instrumenting rake had two rows for the same option key. This consolidates those entries into a single row.

* Enable type checking for AgentSettingsResolver/AgentSettings

Steep doesn't seem to be a big fan of Structs so I just went ahead
and turned the `AgentSettings` into a regular class that's equivalent
to the struct we had before.

(In particular, I decided to still keep every field as optional).

Ideally this would be a `Data` class, but we're far from dropping
support for Rubies that don't have it.

* Move url building behavior from `AgentBaseUrl` to `AgentSettings`

This is preparation to also share this behavior with profiling.

* Refactor crashtracking to use `AgentSettings#url`

The behavior from the old `AgentBaseUrl` is now contained in
`AgentSettings` so we can clean up the extra logic.

* [PROF-11078] Fix profiling exception when agent url is an ipv6 address

**What does this PR do?**

This PR builds atop #4237 and fixes a similar-ish issue in the profiler
caused by the same mishandling of ipv6 addresses.

In particular, when provided with an ipv6 address in the agent url,
the profiler would fail with an exception:

```
$ env DD_AGENT_HOST=2001:db8:1::2 DD_PROFILING_ENABLED=true \
bundle exec ddprofrb exec ruby -e "sleep 2"

dd-trace-rb/lib/datadog/profiling/http_transport.rb:27:in `initialize':
Failed to initialize transport: invalid authority (ArgumentError)
```

**Motivation:**

Luckily we didn't have any customers using this, as it fails immediately
and loudly, but it's still a bug on a configuration that should be
supported.

**Additional Notes:**

Since we had similar buggy logic copy-pasted in crashtracking and
profiling (crashtracking had been fixed in #4237) I chose to extract
out the relevant logic into the `AgentSettings` class, so that
both can reuse it.

**How to test the change?**

I've added unit test coverage for this issue to profiling, and
the snippet above can be used to end-to-end test it's working fine.

Here's how it looks on my machine now:

```
E, [2025-01-02T17:32:32.398756 #359317] ERROR -- datadog: [datadog]
(dd-trace-rb/lib/datadog/profiling/http_transport.rb:68:in `export')
Failed to report profiling data (agent: http://[2001:db8:1::2]:8126/):
failed ddog_prof_Exporter_send: error trying to connect: tcp connect
error: Network is unreachable (os error 101): tcp connect error:
Network is unreachable (os error 101): Network is unreachable (os error 101)
```

E.g. we correctly try to connect to the dummy address, and fail :)

(Note: The error message is a bit ugly AND repeats itself a bit.
That's being tracked separately
in DataDog/libdatadog#283 )

* Implement `==` for new `AgentSettings` class

Forgot this one, some of our tests relied on it!

* use Ruby 3.4.1 for test-memcheck GHA

* Update exceptions file with another variant of thread creation memory leak

Since our exceptions match on the stack, they are affected by internal
naming changes, and it looks like a new `ruby_xcalloc_body` function
is now showing up in the stack.

* Introduce Ruby 3.5 gemfile variant for testing with dev builds

This is waaay incomplete in terms of adding support for Ruby 3.5 but
should get us going for ASAN testing for now.

* Update list of files used to compute cache checksum

In practice this shouldn't make a difference, since the final lockfiles
are supposed to be a superset of the root-level gemfile BUT the
`Appraisals` file no longer exists anyway and "just in case" let's
have it anyway as it seems more correct.

* Bump Ruby 3.4 integration image to stable version

* Remove workaround for strscan issue

This is not expected to be an issue in 3.5 (and is probably fixed for
3.4 as well, but I'll leave that for a separate PR to not affect the
appraisals).

* Add unsafe api calls checker to track down issues such as #4195

This checker is used to detect accidental thread scheduling switching
points happening during profiling sampling.

See the bigger comment in unsafe_api_calls_check.h .

I was able to check that this checker correctly triggers for the bug
in #4195, and also the bug I'm going to fix next, which is the
use of `rb_hash_lookup` in the otel context reading code.

* Fix going into Ruby code when looking up otel context

`rb_hash_lookup` calls `#hash` on the key being looked up so it's safe
to use unless during sampling.

This can cause the same issue as we saw in #4195 leading to

```
[BUG] unexpected situation - recordd:1 current:0

-- C level backtrace information -------------------------------------------
ruby(rb_print_backtrace+0x11) [0x55ba03ccf90f] vm_dump.c:820
ruby(rb_vm_bugreport) vm_dump.c:1151
ruby(bug_report_end+0x0) [0x55ba03e91607] error.c:1042
ruby(rb_bug_without_die) error.c:1042
ruby(die+0x0) [0x55ba03ac0998] error.c:1050
ruby(rb_bug) error.c:1052
ruby(disallow_reentry+0x0) [0x55ba03ab6dcc] vm_sync.c:226
ruby(rb_ec_vm_lock_rec_check+0x1a) [0x55ba03cb17aa] eval_intern.h:144
ruby(rb_ec_tag_state) eval_intern.h:155
ruby(rb_vm_exec) vm.c:2484
ruby(vm_invoke_proc+0x201) [0x55ba03cb62b1] vm.c:1509
ruby(rb_vm_invoke_proc+0x33) [0x55ba03cb65d3] vm.c:1728
ruby(thread_do_start_proc+0x176) [0x55ba03c63516] thread.c:598
ruby(thread_do_start+0x12) [0x55ba03c648a2] thread.c:615
ruby(thread_start_func_2) thread.c:672
ruby(nt_start+0x107) [0x55ba03c65137] thread_pthread.c:2187
/lib/x86_64-linux-gnu/libpthread.so.0(start_thread+0xd9) [0x7ff360b66609]
/lib/x86_64-linux-gnu/libc.so.6(clone+0x43) [0x7ff360a70353]
```

* Avoid trying to sample allocations when VM is raising exception

During my experiments to reproduce issues around allocation profiling,
I've noted that the VM is in an especially delicate state during
exception raising, so let's just decline to sample in this situation.

* Update tests with new signatures for test methods

* Check if symbol is static before calling SYM2ID on it

It occurs to me that if a symbol is dynamic, we were causing it to
become a static symbol (e.g. making it never be able to be garbage
collected).

This can be very bad! And also, we know the symbol we're looking for
must be a static symbol because if nothing else, our initialization
caused it to become a static symbol.

Thus, if we see a dynamic symbol, we can stop there, since by
definition it won't be the symbol we're looking after.

This is... really awkward to add a specific unit test for, so
I've just relied on our existing test coverage to show that this
has not affected the correctness of our otel code.

* Document that unsafe api calls checker is only for test code

* Add 3.4 support

* Update DevelopmentGuide

* Remove `racc` gem from 3.3 and 3.4 appraisal files

* [🤖] Lock Dependency: https://github.com/DataDog/dd-trace-rb/actions/runs/12595964519

* Remove strscan specification in 3.4 gemfile

* [🤖] Lock Dependency: https://github.com/DataDog/dd-trace-rb/actions/runs/12595969993

* add hardcoded

update workflow file

---------

Co-authored-by: Steven Bouwkamp <[email protected]>
Co-authored-by: Bradley Schaefer <[email protected]>
Co-authored-by: Ivo Anjo <[email protected]>
Co-authored-by: Andrey Marchenko <[email protected]>
Co-authored-by: Sarah Chen <[email protected]>
Co-authored-by: ivoanjo <[email protected]>
@p-datadog p-datadog mentioned this pull request Jan 15, 2025
ivoanjo added a commit that referenced this pull request Apr 9, 2026
As part of upgrading Ruby from libdatadog v29 to v30 we started having
a flaky test failure related to crashtracking.

It turns out the following happened:

1. We support reconfiguration of things such as the agent url. Thus we
   need to know if we need to call `ddog_crasht_init` (first call) or
   `ddog_crasht_reconfigure` (afterwards).
2. We keep a `static bool first_init = false` to know which one to call
3. We have a test that passes the agent url as an invalid ipv6 address
   -- `http://1234:1234::1/`. This test exists because in the past we
   actually had a crash due to not handling this error case correctly
   -- see #4237 &&
   https://datadoghq.atlassian.net/browse/APMLP-350 .
4. In the past, we had `ddog_endpoint_from_url`. That API validated the
   url and told us when it wasn't valid. If we had an invalid endpoint,
   we never called `ddog_crasht_init` and never set `first_init = true`
5. With the v30 new API, the endpoint check happens inside
   `ddog_crasht_init`. This means `ddog_crasht_init` **fails** on the
   wrong url. Then we were setting `first_init = true` inconditionally.
6. The flakiness in our test suite came from -- the test in 3. running
   before or after the other tests. If it ran before, it left the
   crashtracker in a broken state, and it could never recover.
ivoanjo added a commit that referenced this pull request Apr 9, 2026
As part of upgrading Ruby from libdatadog v29 to v30 we started having
a flaky test failure related to crashtracking.

It turns out the following happened:

1. We support reconfiguration of things such as the agent url. Thus we
   need to know if we need to call `ddog_crasht_init` (first call) or
   `ddog_crasht_reconfigure` (afterwards).
2. We keep a `static bool first_init = false` to know which one to call
3. We have a test that passes the agent url as an invalid ipv6 address
   -- `http://1234:1234::1/`. This test exists because in the past we
   actually had a crash due to not handling this error case correctly
   -- see #4237 &&
   https://datadoghq.atlassian.net/browse/APMLP-350 .
4. In the past, we had `ddog_endpoint_from_url`. That API validated the
   url and told us when it wasn't valid. If we had an invalid endpoint,
   we never called `ddog_crasht_init` and never set `first_init = true`
5. With the v30 new API, the endpoint check happens inside
   `ddog_crasht_init`. This means `ddog_crasht_init` **fails** on the
   wrong url. Then we were setting `first_init = true` inconditionally.
6. The flakiness in our test suite came from -- the test in 3. running
   before or after the other tests. If it ran before, it left the
   crashtracker in a broken state, and it could never recover.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Involves Datadog core libraries

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants