Skip to content

Update _index.md on the runtime_id_enabled #29782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jun 26, 2025
Merged

Conversation

anna-git
Copy link
Contributor

@anna-git anna-git commented Jun 6, 2025

What does this PR do? What is the motivation?

It adds information about the runtime-id granularity possibility for nodejs/python/ruby

Merge instructions

Merge readiness:

  • Ready for merge

Sorry, something went wrong.

@anna-git anna-git requested a review from a team as a code owner June 6, 2025 11:36
@anna-git anna-git marked this pull request as draft June 6, 2025 11:36
Copy link
Contributor

github-actions bot commented Jun 6, 2025

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

Copy link
Contributor

github-actions bot commented Jun 6, 2025

Preview links (active after the build_preview check completes)

Modified Files

Copy link
Contributor

@duncanhewett duncanhewett left a comment

Choose a reason for hiding this comment

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

Looks good. I suggested a couple of minor formatting changes, plus:

  • In the Compatibility table above, I think we should remove "Generates runtime-id granularity" from each tab now, since it's addressed in the new configuration description?
  • Not strictly related but in that table we could also remove the "Support Level", just keeping it for Python since it's in Preview? (I think users should expect everything in docs to be GA unless otherwise stated)

Copy link
Contributor

@bm1549 bm1549 left a comment

Choose a reason for hiding this comment

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

Great docs! I had two optional suggestions, otherwise LGTM aside from Duncan's suggestion

@@ -163,6 +163,10 @@ Use the following environment variables to configure runtime metrics in your app
: **Default**: `true` for Java, `false` for all other languages <br>
**Description**: Enables the collection of runtime metrics. Metrics are sent to the Datadog agent, as configured for the instrumented application.

`DD_RUNTIME_ID_ENABLED`
: **Default**: `false` for Node.js, Ruby and Python languages <br>
Copy link
Contributor

Choose a reason for hiding this comment

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

[optional] consider inverting the definition here to make true appear more as the intended behavior

Suggested change
: **Default**: `false` for Node.js, Ruby and Python languages <br>
: **Default**: `true` for Java, .NET, and Go; `false` for all other languages <br>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

see below

@anna-git anna-git force-pushed the anna/runtime-id-documentation branch from 8db5169 to 75fabf4 Compare June 24, 2025 10:50
anna-git and others added 5 commits June 24, 2025 13:07
@anna-git anna-git force-pushed the anna/runtime-id-documentation branch from 75fabf4 to c74f05a Compare June 24, 2025 11:08
@@ -163,6 +157,10 @@ Use the following environment variables to configure runtime metrics in your app
: **Default**: `true` for Java, `false` for all other languages <br>
**Description**: Enables the collection of runtime metrics. Metrics are sent to the Datadog agent, as configured for the instrumented application.

`DD_RUNTIME_METRICS_RUNTIME_ID_ENABLED`
: **Default**: `true` for Java, `false` for Node.js, Ruby and Python. Does not exist for .NET and Go, runtime-id is always reported <br>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bm1549 changed to this as .net and go just don't have the env var and it's not configurable, so itwont work if someone tries to deactivate it for these languages. Let me know if you think it's too complicated and we should just say instead:

true for Java, .NET and Go, false for all other languages.

anna-git added 2 commits June 24, 2025 13:44
@anna-git anna-git marked this pull request as ready for review June 24, 2025 12:07
@anna-git
Copy link
Contributor Author

Looks good. I suggested a couple of minor formatting changes, plus:

  • In the Compatibility table above, I think we should remove "Generates runtime-id granularity" from each tab now, since it's addressed in the new configuration description?
  • Not strictly related but in that table we could also remove the "Support Level", just keeping it for Python since it's in Preview? (I think users should expect everything in docs to be GA unless otherwise stated)

Done both thanks, left Preview for Python as there is still the overshadowing issue that needs the DD_TRACE_EXPERIMENTAL_FEATURES_ENABLED=DD_RUNTIME_METRICS_ENABLED

Copy link
Contributor

@bm1549 bm1549 left a comment

Choose a reason for hiding this comment

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

LGTM

@bm1549 bm1549 requested a review from brett0000FF June 24, 2025 13:58
Co-authored-by: Brian Marks <[email protected]>
@brett0000FF brett0000FF self-assigned this Jun 24, 2025
Copy link
Contributor

@brett0000FF brett0000FF left a comment

Choose a reason for hiding this comment

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

Looks great! 🚀

Co-authored-by: Brett Blue <[email protected]>
@anna-git anna-git merged commit aea2543 into master Jun 26, 2025
15 checks passed
@anna-git anna-git deleted the anna/runtime-id-documentation branch June 26, 2025 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants