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

fix: make label compliant with prometheus spec #4488

Merged
merged 2 commits into from
Feb 3, 2024
Merged

Conversation

srikanthccv
Copy link
Member

@srikanthccv srikanthccv commented Feb 2, 2024

Summary

Follow up on #4446, the See related X is an invalid label.

Summary by CodeRabbit

  • Refactor
    • Updated labels for related traces and logs in alerts to enhance clarity based on the alert type.

@github-actions github-actions bot added the bug Something isn't working label Feb 2, 2024
Copy link

coderabbitai bot commented Feb 2, 2024

Walkthrough

This update enhances the user experience by refining the labeling system for alerts in the ThresholdRule evaluation method. It ensures that the labels for related traces and logs are more intuitive and directly related to the alert type, improving clarity and usability for users.

Changes

File Path Change Summary
pkg/query-service/rules/thresholdRule.go Updated labels in ThresholdRule's Eval method for clarity in alerts.

"In the world of code and data streams,
A little change, a brighter gleam.
🐇 Where logs and traces intertwine,
Now labeled clear, by design."

  • 🐰 CodeRabbit

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 00b111f and 0337dd0.
Files selected for processing (1)
  • pkg/query-service/rules/thresholdRule.go (1 hunks)
Additional comments: 2
pkg/query-service/rules/thresholdRule.go (2)
  • 1060-1060: The label key "RelatedLogs" is set for traces-based alerts. This change aligns with the PR objectives to make labels Prometheus-compliant. However, ensure that all downstream systems or documentation that might rely on the old "See related traces/logs" labels are updated to accommodate this change.
  • 1065-1065: The label key "RelatedTraces" is set for logs-based alerts, which is consistent with the PR's goal of adhering to Prometheus specifications. Similar to the previous comment, verify that any dependent systems or documentation are updated to reflect this new labeling convention.

pkg/query-service/rules/thresholdRule.go Outdated Show resolved Hide resolved
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0337dd0 and 1bf9698.
Files selected for processing (1)
  • pkg/query-service/rules/thresholdRule.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • pkg/query-service/rules/thresholdRule.go

@srikanthccv srikanthccv merged commit 8fe0e60 into develop Feb 3, 2024
12 checks passed
@srikanthccv srikanthccv deleted the fix-label branch February 3, 2024 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants