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 additional resource attributes for cluster metrics #547

Merged
merged 1 commit into from
Nov 4, 2024

Conversation

srikanthccv
Copy link
Member

@srikanthccv srikanthccv commented Nov 4, 2024

Summary by CodeRabbit

  • New Features
    • Added resource_attributes field for enhanced cluster metrics configuration.
    • Introduced auth_type field for specifying authentication methods for Kubernetes events.
    • Enabled new resource attributes for improved telemetry data collection, including k8s.pod.qos_class, k8s.kubelet.version, container.runtime, container.runtime.version, and k8s.container.status.last_terminated_reason.

These changes enhance monitoring capabilities and flexibility in configuration.

Copy link

coderabbitai bot commented Nov 4, 2024

Walkthrough

The changes introduced in this pull request enhance the configuration templates for the OpenTelemetry Collector by adding new fields to support additional resource attributes and authentication methods for Kubernetes events. Specifically, the resource_attributes field is added to the clusterMetricsConfig, and the auth_type field is included in the k8sEventsConfig. Additionally, several new resource attributes are enabled in the values.yaml file, improving the granularity of telemetry data collected from the Kubernetes cluster.

Changes

File Change Summary
charts/k8s-infra/templates/_config.tpl - Added resource_attributes in opentelemetry-collector.clusterMetricsConfig.
- Added auth_type in opentelemetry-collector.k8sEventsConfig.
charts/k8s-infra/values.yaml - Enabled new resource attributes: k8s.pod.qos_class, k8s.kubelet.version, container.runtime, container.runtime.version, k8s.container.status.last_terminated_reason.

Possibly related PRs

Suggested reviewers

  • prashant-shahi
  • grandwizard28

🐇 In the meadow where data flows,
New fields sprout like springtime grows.
Metrics dance in vibrant hues,
Collecting tales of pods and views.
With auth types and attributes bright,
Our Kubernetes shines with insight! 🌼


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 changed the title Enable additional resource attributed for cluster metrics Enable additional resource attributes for cluster metrics Nov 4, 2024
@srikanthccv srikanthccv marked this pull request as ready for review November 4, 2024 08:41
@srikanthccv srikanthccv requested a review from a team as a code owner November 4, 2024 08:41
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
charts/k8s-infra/templates/_config.tpl (1)

170-171: LGTM! The resource_attributes field enhances cluster metrics configuration.

The addition of the resource_attributes field to the clusterMetricsConfig template is well-integrated and follows Helm templating best practices:

  • Uses proper YAML indentation (6 spaces) consistent with the rest of the file
  • Correctly uses toYaml for converting the values to YAML format
  • Maintains the hierarchical structure of the configuration

Consider documenting the supported resource attributes in the chart's README.md or values.yaml to help users understand what attributes can be configured.

charts/k8s-infra/values.yaml (1)

261-271: Consider adding documentation for the new resource attributes.

It would be helpful to add comments describing each resource attribute's purpose and the data it provides, similar to other configuration sections in this file.

Example:

 resourceAttributes:
+      # -- Tracks the Quality of Service (QoS) class assigned to pods
       k8s.pod.qos_class:
         enabled: true
+      # -- Reports the version of kubelet running on nodes
       k8s.kubelet.version:
         enabled: true
+      # -- Identifies the container runtime in use (e.g., containerd, docker)
       container.runtime:
         enabled: true
+      # -- Reports the version of the container runtime
       container.runtime.version:
         enabled: true
+      # -- Captures the reason for the last container termination
       k8s.container.status.last_terminated_reason:
         enabled: true
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0a250ce and 21b6c40.

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

261-271: LGTM! The new resource attributes enhance cluster monitoring capabilities.

The added resource attributes provide valuable telemetry data for:

  • Pod QoS class monitoring for better scheduling insights
  • Kubelet version tracking for compatibility management
  • Container runtime monitoring for environment visibility
  • Container termination reasons for improved debugging

@srikanthccv srikanthccv merged commit 4c3c5c1 into main Nov 4, 2024
3 checks passed
@srikanthccv srikanthccv deleted the addl-resource-attributes-for-cluster-metrics branch November 4, 2024 16:26
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