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

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

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

@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 Required

This pull request requires approval from the @DataDog/documentation team before it can be merged.

Please ensure your changes follow our documentation guidelines and wait for a team member to review and approve your changes.

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)

anna-git and others added 2 commits June 6, 2025 15:28
Co-authored-by: Duncan Hewett <[email protected]>
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>
**Description**: Provides a `runtime_id` tag along with every metric. The `runtime_id` represents the application's process identifier and allows you to directly correlate runtime metrics with individual running applications.
Copy link
Contributor

Choose a reason for hiding this comment

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

[optional] did we want to go with "enhanced runtime metrics" here to be more enticing for our users to use it?

Suggested change
**Description**: Provides a `runtime_id` tag along with every metric. The `runtime_id` represents the application's process identifier and allows you to directly correlate runtime metrics with individual running applications.
**Description**: Enables enhanced runtime metrics, providing a `runtime_id` tag along with every metric. The `runtime_id` represents the application's process identifier and allows you to directly correlate runtime metrics with individual running applications.

@@ -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>

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.

3 participants