Clarified the telemetry logging instructions to ensure users utilise the correct option.

[KtorZ]

Summary by CodeRabbit

• Documentation

  • Clarified the telemetry logging instructions to ensure users utilise the correct option.
  • Updated the example command to reflect the recommended configuration.

• Style

  • Enhanced the formatting consistency of warning and tip sections for improved readability.

[coderabbitai]

Walkthrough

The pull request updates the README.md file to refine the instructions for logging telemetry. The previously used --with-otlp option has been removed, leaving only the --with-open-telemetry option for clarity. The example command has been adjusted to reflect this change. Additionally, formatting improvements have been made to the warning and tip sections for consistency, although these do not affect the functionality of the guidance.

Changes

File	Change Summary
README.md	Removed --with-otlp, emphasised --with-open-telemetry in the logging configuration instructions, and enhanced formatting for warnings and tips.

Possibly related PRs

• doc: document options for connecting amaru to monitoring stack #95: Updates the README to clarify telemetry logging, closely aligning with these modifications.

Suggested reviewers

• abailly
• jeluard

Poem

In the realm of docs where details gleam,
A tweak was made to perfect the telemetry theme.
Out with the old, in with a brighter view,
Commands now dance clearer for me and you.
Cheers to the change—a delightful code dream!
☕🐧

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

81-88: Telemetry Logging Update and Abbreviation Tweak

The revised section correctly removes the obsolete --with-otlp option and now clearly emphasises --with-open-telemetry in both the instruction and the example command. This should make it much easier for our users to get their telemetry logs set up properly.

Just a friendly nudge: the abbreviation "eg." is used here; many style guides prefer "e.g.," (with both full stops and an ensuing comma) to clearly denote "for example." A small tweak here could further polish the instructions.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~81-~81: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tion before the daemon sub-command, eg. > > ```console > cargo run --release --...

(E_G)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d923148 and 249011e.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[uncategorized] ~81-~81: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tion before the daemon sub-command, eg. > > ```console > cargo run --release --...

(E_G)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Build on windows-latest with target x86_64-pc-windows-msvc

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

81-81: Formatting Suggestion for Abbreviation "e.g."

LanguageTool flagged a tiny nitpick regarding the abbreviation “e.g.”. Please ensure it contains the standard two periods (e.g., "e.g.,"), for extra clarity and consistency in our documentation. A minor tweak, but it’s the little things that keep our docs spick and span.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~81-~81: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tion before the daemon sub-command, eg. > > ```console > cargo run --release --...

(E_G)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 249011e and 4633c9e.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[uncategorized] ~81-~81: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tion before the daemon sub-command, eg. > > ```console > cargo run --release --...

(E_G)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Build on windows-latest with target x86_64-pc-windows-msvc

🔇 Additional comments (1)

README.md (1)

81-87: Clarified Telemetry Logging Instructions

The updated section clearly directs users to pass --with-open-telemetry before the daemon sub-command, which neatly removes the previous confusion between telemetry options. This simplicity is sure to save everyone from a spot of needless head-scratching.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~81-~81: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tion before the daemon sub-command, eg. > > ```console > cargo run --release --...

(E_G)