Skip to content

Ability to get the related pod label name via an environment variable. #457

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.

Sign up for GitHub

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

Jump to bottom
Merged
arikalon1 merged 1 commit into from
Jul 31, 2025
Merged

Ability to get the related pod label name via an environment variable. #457

arikalon1 merged 1 commit into from
Jul 31, 2025

Conversation

@StFS
Copy link
Contributor

@StFS StFS commented Jul 31, 2025

This PR adds the ability to specify the KRR_RELATED_POD_LABEL environment variable to provide the name of the label to use to discover a K8S object related pods. The default behavior, if this env variable is not set, is to use pod as before.

This is helpful for example when the honor_labels setting in Prometheus is set to false (the default value) and there is a conflict between labels that are being scraped and labels that Prometheus attaches.
See documentation here: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config

This can result in the metrics using the label exported_pod instead of pod.

@CLAassistant
Copy link

CLAassistant commented Jul 31, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link

coderabbitai bot commented Jul 31, 2025 •
edited
Loading

Walkthrough

The load_pods async method in the Prometheus metrics service was updated to use a configurable environment variable (KRR_RELATED_POD_LABEL) for the pod label key in Prometheus queries, defaulting to "pod" if unset. All internal references to the pod label in query result processing now use this dynamic value.

Changes

Cohort / File(s) Change Summary
Prometheus pod label configurability
robusta_krr/core/integrations/prometheus/metrics_service/prometheus_metrics_service.py		 Made the pod label key in Prometheus queries configurable via KRR_RELATED_POD_LABEL env var; updated all internal usages to reference this variable instead of the hardcoded "pod" label.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 7356b98 and 99b36e0.

📒 Files selected for processing (1)
  • robusta_krr/core/integrations/prometheus/metrics_service/prometheus_metrics_service.py (2 hunks)
🔇 Additional comments (3)
robusta_krr/core/integrations/prometheus/metrics_service/prometheus_metrics_service.py (3)

361-362: LGTM! Clean implementation of configurable pod label.

The environment variable approach provides good flexibility while maintaining backward compatibility with the default "pod" label. This addresses the PR objective of handling Prometheus label conflicts when honor_labels=false.

373-373: Consistent usage of dynamic pod label in Prometheus query.

The dynamic related_pod_label is correctly used in the kube_pod_status_phase query, ensuring consistency with the configurable label approach.

379-379: Proper extraction using dynamic pod label.

The pod name extraction from the query results correctly uses the configurable related_pod_label, maintaining consistency throughout the method.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

@StFS StFS mentioned this pull request Jul 31, 2025
Open
arikalon1
arikalon1 approved these changes Jul 31, 2025
View reviewed changes
Copy link
Contributor

@arikalon1 arikalon1 left a comment

Choose a reason for hiding this comment

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

nice and clean

Thanks for the PR @StFS

@arikalon1 arikalon1 merged commit 90cbfc8 into robusta-dev:main Jul 31, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arikalon1 arikalon1 arikalon1 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@StFS @CLAassistant @arikalon1