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

chore: add k8sattributes processor for cluster metrics and events #606

Merged
merged 6 commits into from
Jan 24, 2025

Conversation

srikanthccv
Copy link
Member

@srikanthccv srikanthccv commented Jan 21, 2025

The processor is missing from the cluster metrics and events pipeline and the node filter doesn't apply in this context. While we could add a conditional filter, our deployment has way too many roles to properly type it. We need collectors that work across different setups - daemonset, deployment, statefulset, and singleton with clearly defined responsibilities. Instead of forcing it into the current definition, I opted for a separate deployment definition to handle this at the cost of a few lines of duplication.

Summary by CodeRabbit

  • New Features

    • Enhanced OpenTelemetry Collector configuration with improved Kubernetes attributes support
    • Added more granular control for resource detection in deployment scenarios
  • Refactor

    • Streamlined configuration template for OpenTelemetry Collector
    • Improved handling of Kubernetes attributes configuration

Copy link

coderabbitai bot commented Jan 21, 2025

Walkthrough

The pull request modifies the OpenTelemetry Collector configuration templates in the Kubernetes infrastructure charts. The changes focus on enhancing the configuration of Kubernetes attributes and resource detection for deployments. A new function opentelemetry-collector.applyKubernetesAttributesConfigForDeployment is introduced to merge Kubernetes attributes configuration, and the existing resourceDetectionConfigForDeployment function is streamlined to provide more focused resource detection.

Changes

File Change Summary
charts/k8s-infra/templates/_config.tpl - Added new function opentelemetry-collector.applyKubernetesAttributesConfigForDeployment
- Modified resourceDetectionConfigForDeployment function
- Updated otelDeployment.config to include Kubernetes attributes configuration

Sequence Diagram

sequenceDiagram
    participant OtelCollector as OpenTelemetry Collector
    participant K8sAttributes as Kubernetes Attributes Processor
    participant ResourceDetection as Resource Detection Processor

    OtelCollector->>K8sAttributes: Enable Kubernetes Attributes
    K8sAttributes-->>OtelCollector: Configure Attributes Extraction
    OtelCollector->>ResourceDetection: Apply Resource Detection
    ResourceDetection-->>OtelCollector: Detect and Add Resources
Loading

Possibly related PRs

Suggested reviewers

  • grandwizard28

Poem

🐰 In the realm of Kubernetes' might,
OpenTelemetry configs take flight,
Attributes dance, resources gleam,
A collector's configuration dream!
Hop, hop, hooray for clean design! 🚀


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 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.

@srikanthccv srikanthccv marked this pull request as ready for review January 22, 2025 04:22
@srikanthccv srikanthccv requested a review from a team as a code owner January 22, 2025 04:22
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

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

795-809: Document the rationale for separate deployment configuration.

The implementation looks good, but consider expanding the TODO comment to better explain:

  • Why a separate k8sattributes config is needed for deployment mode
  • What "clearly defined" mode of operation means
  • The differences from the base k8sattributes config (e.g., disabled passthrough, metadata-only extraction)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 32de770 and eac455a.

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

92-94: LGTM! The k8sattributes configuration is correctly integrated.

The addition of k8sattributes processor for deployment mode is well-placed and aligns with the PR objectives.


681-696: LGTM! The implementation follows established patterns.

The function correctly handles all pipeline types and maintains proper processor ordering.

@srikanthccv srikanthccv merged commit 73bd547 into main Jan 24, 2025
5 checks passed
@srikanthccv srikanthccv deleted the k8sattributes branch January 24, 2025 04:38
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