Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable few optional metrics for cluster metrics #522

Merged
merged 3 commits into from
Oct 12, 2024

Conversation

srikanthccv
Copy link
Member

@srikanthccv srikanthccv commented Oct 11, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced metrics configuration for improved flexibility and additional metrics collection.
    • Expanded cluster metrics reporting with new node conditions.
  • Updates

    • Upgraded OpenTelemetry Collector image tags to the latest version.
    • Improved resource detection and deployment environment configurations.
  • Bug Fixes

    • Refined handling of service pipelines to ensure only relevant configurations are retained.
  • Documentation

    • Clarified configurations for namespace and cluster name to avoid confusion.

@srikanthccv srikanthccv marked this pull request as ready for review October 11, 2024 13:23
@srikanthccv srikanthccv requested a review from a team as a code owner October 11, 2024 13:23
@prashant-shahi
Copy link
Member

Can you bump up chart version as well?

@srikanthccv
Copy link
Member Author

I will bump when all individual PRs are merged.

#523
#521
#516

Copy link

coderabbitai bot commented Oct 12, 2024

Walkthrough

The pull request introduces significant updates to the configuration templates and values for the OpenTelemetry Collector in Kubernetes. Key modifications include the addition of new metrics configurations, enhancements to conditional logic for applying configurations, and refined handling of service pipelines. The values.yaml file has also been updated to reflect new metrics, an image tag upgrade, and improved resource detection. These changes collectively enhance the flexibility and robustness of the OpenTelemetry setup.

Changes

File Path Change Summary
charts/k8s-infra/templates/_config.tpl - Added metrics field to clusterMetricsConfig, kubeletMetricsConfig, and logsCollectionConfig.
- Enhanced conditional logic for applying configurations based on presets.
- Refined service pipeline handling to unset empty receivers/exporters.
- Standardized exporters configuration across services.
- Improved resource detection and deployment environment configurations.
- General refactoring for clarity.
charts/k8s-infra/values.yaml - Expanded clusterMetrics with new node conditions and metrics.
- Updated image tags for otelAgent and otelDeployment to 0.109.0.
- Defined clusterName in both global and K8s infra settings.
- Maintained service configurations and RBAC rules.
- Specified resource requests and limits for deployments.

Possibly related PRs

Suggested reviewers

  • grandwizard28

Poem

In the fields of code, we hop and play,
New metrics bloom, brightening the day.
With tags that soar, our versions align,
OpenTelemetry shines, oh how divine!
Configs refined, like a rabbit's dance,
In Kubernetes gardens, we take our chance! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0de5aa3 and 513c9ed.

📒 Files selected for processing (2)
  • charts/k8s-infra/templates/_config.tpl (1 hunks)
  • charts/k8s-infra/values.yaml (2 hunks)
🧰 Additional context used
🔇 Additional comments (4)
charts/k8s-infra/values.yaml (3)

201-203: Excellent addition of new node conditions and metrics!

The inclusion of DiskPressure, PIDPressure, and NetworkUnavailable node conditions, along with the k8s.node.condition and k8s.pod.status_reason metrics, significantly enhances the cluster's observability. These additions will provide more comprehensive insights into the cluster's health and potential issues.

Also applies to: 209-213


Line range hint 1-924: Summary of changes and their impact

This update brings two main improvements to the Kubernetes infrastructure setup:

  1. Enhanced cluster metrics: New node conditions and metrics have been added, which will provide more detailed insights into the cluster's health and performance.

  2. OpenTelemetry Collector version update: Both OtelAgent and OtelDeployment have been updated to version 0.109.0, which likely includes new features, bug fixes, and performance improvements.

These changes should significantly improve the observability of your Kubernetes cluster. However, ensure that you've thoroughly tested the new version and reviewed any potential breaking changes before deploying to production.


Line range hint 277-277: Approved: OpenTelemetry Collector version update

The update of the OpenTelemetry Collector image from version 0.88.0 to 0.109.0 for both OtelAgent and OtelDeployment is a significant upgrade. This likely brings important improvements and new features.

Please ensure that:

  1. This version is compatible with your current setup.
  2. You've reviewed the changelog for any breaking changes or new features that may require configuration updates.
  3. You've tested this version in a non-production environment before deploying to production.

To assist with the verification, you can run the following script to check for any potential issues:

Also applies to: 574-574

✅ Verification successful

The OpenTelemetry Collector image has been successfully updated from version 0.88.0 to 0.109.0 in charts/k8s-infra/values.yaml. No remaining hardcoded references to the old version were found in the codebase.

Please proceed with testing to ensure full compatibility and verify that all functionalities operate as expected.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for potential compatibility issues with the new OpenTelemetry Collector version

# Test: Search for custom configurations that might be affected by the version update
echo "Searching for custom OpenTelemetry Collector configurations:"
rg --type yaml 'otelcol|opentelemetry' -g '!charts/k8s-infra/values.yaml'

# Test: Check if there are any hardcoded version references that need updating
echo "Checking for hardcoded OpenTelemetry Collector version references:"
rg --type yaml '0\.88\.0' -g '!charts/k8s-infra/values.yaml'

echo "Please review these results and ensure all necessary updates have been made."

Length of output: 2259

charts/k8s-infra/templates/_config.tpl (1)

165-166: Ensure the 'metrics' field under 'k8s_cluster' receiver is correctly configured

The metrics field has been added under the k8s_cluster receiver. Please verify that the metrics specified in .Values.presets.clusterMetrics.metrics align with the expected configuration schema of the k8s_cluster receiver in the OpenTelemetry Collector. This ensures that only valid and supported metrics are collected without causing configuration errors.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 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.

@srikanthccv srikanthccv merged commit 60d6bcd into main Oct 12, 2024
3 checks passed
@srikanthccv srikanthccv deleted the cluster-addon-metrics branch October 12, 2024 04:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants