Update the Config Sync custom monitoring documentation #1821
Conversation
- Add prominent warning about custom configurations not being maintained by Config Sync - Clarify compatibility risks with version upgrades - Replace complex configuration examples with minimal working example - Remove outdated version-specific instructions (v1.11.x and earlier) - Simplify metric list examples using ellipsis notation - Remove unnecessary health check extensions from minimal example - Improve clarity around temporary workaround recommendations
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @tiffanny29631, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request significantly updates the Config Sync custom monitoring documentation. The primary goal is to consolidate existing content, improve clarity, and provide more accurate and simplified guidance for users customizing metric collection.
Highlights
- Warning Addition: A prominent warning has been added to inform users that custom configurations are not maintained by Config Sync and may have compatibility issues with version upgrades.
- Metric List Expansion: A detailed list of available Config Sync metrics (Core, Kustomize, Additional) has been added for better clarity.
- Simplified Configuration Examples: Complex configuration examples have been replaced with a minimal working example, making it easier for users to understand and implement custom monitoring.
- Outdated Information Removal: Version-specific instructions (e.g., for v1.11.x and earlier) have been removed to streamline the documentation and ensure relevance.
- Improved Guidance: The document now includes clearer step-by-step instructions for modifying, applying, and verifying custom OpenTelemetry Collector configurations, along with troubleshooting tips.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
Warning Gemini encountered an error creating the review. You can try again by commenting |
| ### Common Issues | ||
|
|
||
| 1. **ConfigMap not applied**: Ensure the ConfigMap name is exactly `otel-collector-custom` | ||
| 2. **Collector not restarting**: Manually delete the deployment to force a restart |
There was a problem hiding this comment.
Do you delete a Deployment or restart a Pod? Also suggest providing the exact Deployment/Pod name for clarity
| If `otel-collector` deployment not automatically restarted, restart the OpenTelemetry Collector Pod to pick up the new configuration: | ||
|
|
||
| ```bash | ||
| kubectl delete deployment/otel-collector -n config-management-monitoring |
There was a problem hiding this comment.
Is it right that the Deployment gets deleted? I assume the Pod just needs to be restarted
Update custom monitoring doc to consolidate the contents in http://cloud/kubernetes-engine/enterprise/config-sync/docs/how-to/monitor-config-sync-custom.