Skip to content

Conversation

@brett0000FF
Copy link
Contributor

@brett0000FF brett0000FF commented Jan 26, 2026

What does this PR do? What is the motivation?

Takes new content from #33631 and puts it into new cdocs format.

Restructures OpenTelemetry API support documentation to follow a consistent multi-language directory structure:

Rust: Creates rust/ directory with metrics.md (private, v0.4.0) and traces.md, removes old rust.md
Go: Creates go/ directory with metrics.md and traces.md, following the same directory-based organization
PHP: Creates php/ directory with metrics.md and traces.md, following the same directory-based organization
Structure:

Rust, Go, and PHP now follow the same directory-based organization as Python, .NET, Node.js, and Ruby
Motivation:

Standardize documentation structure across all supported languages and prepare for upcoming metrics support in Rust (v0.3.0), Go (v2.6.0), and PHP (v1.16.0).

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

@brett0000FF brett0000FF requested review from a team as code owners January 26, 2026 17:19
@brett0000FF brett0000FF marked this pull request as draft January 26, 2026 17:21
@github-actions github-actions bot added the cdocs label Jan 26, 2026
@brett0000FF brett0000FF reopened this Jan 26, 2026
@github-actions
Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@brett0000FF brett0000FF marked this pull request as ready for review January 26, 2026 18:05
@buraizu buraizu self-assigned this Jan 26, 2026
Copy link
Contributor

@buraizu buraizu 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 overall, approving with some (mostly) optional minor feedback

{% if equals($prog_lang, "ruby") %}
- Verify required gems are installed. Ensure `opentelemetry-metrics-sdk` and `opentelemetry-exporter-otlp-metrics` are installed in your Ruby environment.
- Ensure `Datadog.configure` is called before `OpenTelemetry::SDK.configure`. The Datadog SDK must be configured first to properly set up the meter provider.
- Verify required gems are installed. Verify `opentelemetry-metrics-sdk` and `opentelemetry-exporter-otlp-metrics` are installed in your Ruby environment.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Verify required gems are installed. Verify `opentelemetry-metrics-sdk` and `opentelemetry-exporter-otlp-metrics` are installed in your Ruby environment.
- Verify required gems (`opentelemetry-metrics-sdk` and `opentelemetry-exporter-otlp-metrics`) are installed in your Ruby environment.

Copy link
Contributor

Choose a reason for hiding this comment

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

Optional suggestion as these sentences seem to have some overlap, feel free to modify the suggestion

{% if equals($prog_lang, "python") %}
- Verify `opentelemetry-sdk` is installed. The Python SDK requires `opentelemetry-sdk` and `opentelemetry-exporter-otlp` to be installed in your Python environment.
- Ensure `ddtrace-run` is active. Verify that you are running your application with `ddtrace-run` (or have imported and initialized `ddtrace` manually).
- Verify `ddtrace-run` is active. Verify that you are running your application with `ddtrace-run` (or have imported and initialized `ddtrace` manually).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Verify `ddtrace-run` is active. Verify that you are running your application with `ddtrace-run` (or have imported and initialized `ddtrace` manually).
- Verify that you are running your application with `ddtrace-run` (or have imported and initialized `ddtrace` manually).

Copy link
Contributor

Choose a reason for hiding this comment

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

Optional suggestion as these two sentences seem redundant

- Enable debug logging with `DD_TRACE_DEBUG=true` to see detailed logs.
{% /if %}
{% if equals($prog_lang, "rust") %}
- Verify transport features are enabled. Verify `metrics-grpc` or `metrics-http` feature is enabled in your Cargo.toml depending on your protocol choice.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Verify transport features are enabled. Verify `metrics-grpc` or `metrics-http` feature is enabled in your Cargo.toml depending on your protocol choice.
- Verify that a transport feature (`metrics-grpc` or `metrics-http`) is enabled in your Cargo.toml file, depending on your protocol choice.

Copy link
Contributor

Choose a reason for hiding this comment

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

Optional, except for adding file after Cargo.toml.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants