OpenTelemetry: Fix code snippets in "synopsis" section

[amotl]

About

What the title says.

Preview

• https://cratedb-guide--457.org.readthedocs.build/integrate/opentelemetry/

References

• Resolves Documentation feedback on /docs/integrate/opentelemetry/index.md #432.

[coderabbitai]

Walkthrough

Documentation restructuring that replaces file inclusion references with explicit OpenTelemetry collector configuration and Telegraf/CrateDB integration blocks in YAML and INI formats, respectively.

Changes

Cohort / File(s)	Change Summary
OpenTelemetry Integration Documentation docs/integrate/opentelemetry/index.md	Replaced two literalinclude blocks with explicit OpenTelemetry exporter and service pipeline YAML configuration, including PrometheusRemoteWrite endpoint and debug exporter. Added inline Telegraf/CrateDB configuration block in INI format with inputs.opentelemetry and outputs.cratedb settings.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Review for accuracy of configuration examples (endpoint URLs, field names)
• Verify YAML and INI syntax correctness
• Check alignment with current OpenTelemetry and Telegraf versions

Possibly related PRs

• OpenTelemetry: Index page. Usage guides about OTel Collector and Telegraf. #334: Introduced the original literalinclude blocks in the same documentation file that this PR replaces with explicit configuration examples.

Suggested labels

new content

Suggested reviewers

• surister
• kneth

Poem

🐰 Config blocks emerge from hidden files,
In YAML and INI, no more denied miles,
Telegraf dances with CrateDB's embrace,
OpenTelemetry finds its rightful place! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.
Description Check	❓ Inconclusive	The PR description consists of minimal content that primarily references the PR title ("What the title says") and an issue reference (Resolves GH-432). While the content is related to the changeset—the PR title and objectives indicate it fixes code snippets in the OpenTelemetry documentation section, which aligns with the actual changes to docs/integrate/opentelemetry/index.md—the description itself is extremely vague and non-descriptive. Using placeholder language like "What the title says" instead of substantively describing the changes means the description does not convey meaningful information about what specifically was modified or why.	The description should be expanded to provide more specific details about the changes made. Instead of relying on the PR title, the author should explicitly describe what code snippets were fixed, what the changes accomplish (e.g., replacing literalinclude blocks with explicit YAML and INI configurations), and why these changes improve the documentation.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The pull request title "OpenTelemetry: Fix code snippets in 'synopsis' section" is directly related to the changeset. The raw summary shows that the changes involve replacing literalinclude blocks with explicit YAML and INI configuration blocks in the OpenTelemetry documentation, which aligns with the notion of "fixing code snippets." The title is specific, clear, and concise enough that a teammate reviewing the git history would understand the primary change involves correcting or updating code snippets in a particular section of the OpenTelemetry documentation.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix-opentelemetry

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}