chore(common): add documentation about template usage

[cwrau]

Summary by CodeRabbit

• Documentation
  • Enhanced the description of telemetry configuration settings to clarify parameter usage such as connection details and optional protocols without altering functionality.

[coderabbitai]

Walkthrough

The changes introduce a new comment block in the _telemetry.tpl template. This comment provides documentation for the configuration dictionary used for OpenTelemetry traces, detailing keys such as enabled, host, port, endpoint, serviceProtocol, and insecure. It specifies that serviceProtocol is optional and notes the need to cast the port to an integer, as it defaults to a float. The existing logic within the template remains unchanged, with no alterations to public entities.

Changes

File(s)	Change Summary
charts/.../_telemetry.tpl	Added a comment block that documents the configuration dictionary structure for telemetry traces.

Poem

Hop, hop, through lines of code I glide,
Whiskers twitched at comments, clear and wide,
A tale of keys and ports in plain sight,
In telemetry dreams on a coding night,
Celebrating changes with a bunny's delight! 🐰

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3450109 and df6443a.

📒 Files selected for processing (1)

• charts/common/templates/_telemetry.tpl (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• charts/common/templates/_telemetry.tpl

---

🪧 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.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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)

charts/common/templates/_telemetry.tpl (1)

35-40: Enhance Template Documentation

The newly added comment block clearly documents the purpose and structure of the configuration dictionary returned for OpenTelemetry traces. It details the available keys (enabled, host, port, endpoint, serviceProtocol, insecure) and offers important guidance—especially on the optional nature of serviceProtocol and the need to cast port to an integer. This addition improves the maintainability and clarity for developers using this template.

A small nitpick: you might consider adding a brief note on when or why one might need to override these defaults (if applicable), just to further assist developers in understanding the intended usage scenarios.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between fb8643c and 3450109.

📒 Files selected for processing (1)

• charts/common/templates/_telemetry.tpl (1 hunks)