Skip to content

Copied mimir docs from robusta - #882

Merged
aantn merged 1 commit into
masterfrom
add-mimi-docs-from-robusta
Aug 20, 2025
Merged

aantn merged 1 commit into
masterfrom
add-mimi-docs-from-robusta

Conversation

@pavangudiwada

Copy link
Copy Markdown
Contributor

@pavangudiwada
pavangudiwada requested a review from aantn August 20, 2025 16:40
@coderabbitai

coderabbitai Bot commented Aug 20, 2025 •

Copy link
Copy Markdown
Contributor

Walkthrough

Updates Prometheus toolset documentation: adds a Capabilities section, removes a previous capabilities table under Coralogix config, introduces Grafana Cloud (Mimir) configuration steps and important notes, and clarifies proxy usage and metadata settings. No code or API changes.

Changes

Cohort / File(s) Summary
Docs: Prometheus toolset updates
docs/data-sources/builtin-toolsets/prometheus.md
- Added Capabilities section (list_available_metrics, execute_prometheus_instant_query, execute_prometheus_range_query, get_current_time)
- Removed Capabilities table under Coralogix Prometheus Configuration
- Added Grafana Cloud (Mimir) Configuration with step-by-step setup (service account token, datasource UID retrieval, HolmesGPT proxy configuration, headers)
- Added Important notes on proxy endpoint usage, Mimir compatibility, and metadata retrieval settings

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant HolmesGPT
  participant Proxy as Prometheus Proxy
  participant Mimir as Grafana Cloud Prometheus/Mimir

  Note over User,HolmesGPT: Pre-setup: Service account token (glsa_), datasource UID, proxy URL, headers configured

  User->>HolmesGPT: Request metric query (instant/range)
  HolmesGPT->>Proxy: Execute query (Authorization header, configured flags)
  Proxy->>Mimir: Forward PromQL request
  Mimir-->>Proxy: Query response (JSON)
  Proxy-->>HolmesGPT: Response
  HolmesGPT-->>User: Results

  Note over HolmesGPT,Mimir: Metadata fetched via /series API (labels API disabled per config)
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • arikalon1
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-mimi-docs-from-robusta

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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
docs/data-sources/builtin-toolsets/prometheus.md (2)

156-159: Add a blank line before the nested list to follow docs style and ensure consistent rendering

Per docs guidelines, add a blank line between a bold line and a following list (here, a nested list).

-1. **Create a service account token in Grafana Cloud:**
-   - Navigate to "Administration → Service accounts"
+1. **Create a service account token in Grafana Cloud:**
+
+   - Navigate to "Administration → Service accounts"
    - Create a new service account
    - Generate a service account token (starts with `glsa_`)

175-180: Recommend adding a Mimir-ready healthcheck

Helps the built-in healthcheck hit the correct readiness probe via Grafana’s proxy.

            prometheus_url: https://YOUR-INSTANCE.grafana.net/api/datasources/proxy/uid/PROMETHEUS_DATASOURCE_UID
+           healthcheck: "/ready"  # Recommended for Grafana Mimir via Grafana Cloud
            fetch_labels_with_labels_api: false  # Important for Mimir
            fetch_metadata_with_series_api: true  # Important for Mimir
            headers:
-             Authorization: Bearer YOUR_GLSA_TOKEN
+             Authorization: "{{ env.GRAFANA_CLOUD_TOKEN }}"
📜 Review details

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

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a9bf9e8 and db55634.

📒 Files selected for processing (1)
  • docs/data-sources/builtin-toolsets/prometheus.md (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.md

📄 CodeRabbit Inference Engine (CLAUDE.md)

In MkDocs docs, always add a blank line between a header/bold text and a following list

Files:

  • docs/data-sources/builtin-toolsets/prometheus.md
🪛 LanguageTool
docs/data-sources/builtin-toolsets/prometheus.md

[grammar] ~104-~104: There might be a mistake here.
Context: ...apabilities | Tool Name | Description | |-----------|-------------| | list_avail...

(QB_NEW_EN)


[grammar] ~105-~105: There might be a mistake here.
Context: ...escription | |-----------|-------------| | list_available_metrics | List all avai...

(QB_NEW_EN)


[grammar] ~106-~106: There might be a mistake here.
Context: ... List all available Prometheus metrics | | execute_prometheus_instant_query | Exe...

(QB_NEW_EN)


[grammar] ~107-~107: There might be a mistake here.
Context: ...uery | Execute an instant PromQL query | | execute_prometheus_range_query | Execu...

(QB_NEW_EN)


[grammar] ~108-~108: There might be a mistake here.
Context: ...ange PromQL query for time series data | | get_current_time | Get current timesta...

(QB_NEW_EN)


[grammar] ~156-~156: There might be a mistake here.
Context: ... service account token in Grafana Cloud:** - Navigate to "Administration → Service ac...

(QB_NEW_EN)

🪛 Gitleaks (8.27.2)
docs/data-sources/builtin-toolsets/prometheus.md

163-163: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.

(curl-auth-header)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Pre-commit checks
  • GitHub Check: llm_evals
  • GitHub Check: Pre-commit checks
🔇 Additional comments (1)
docs/data-sources/builtin-toolsets/prometheus.md (1)

102-110: Capabilities section looks good

Clear, concise, and matches the toolset scope.

Comment thread docs/data-sources/builtin-toolsets/prometheus.md
@github-actions

Copy link
Copy Markdown
Contributor

Results of HolmesGPT evals

  • ask_holmes: 34/39 test cases were successful, 1 regressions, 2 skipped, 2 setup failures
Test suite Test case Status
ask 01_how_many_pods ✅
ask 02_what_is_wrong_with_pod ✅
ask 03_what_is_the_command_to_port_forward ✅
ask 04_related_k8s_events ↪️
ask 05_image_version ✅
ask 09_crashpod ✅
ask 10_image_pull_backoff ✅
ask 11_init_containers ✅
ask 14_pending_resources ✅
ask 15_failed_readiness_probe ✅
ask 17_oom_kill ✅
ask 18_crash_looping_v2 ✅
ask 19_detect_missing_app_details ✅
ask 20_long_log_file_search ✅
ask 24_misconfigured_pvc ✅
ask 28_permissions_error 🚧
ask 29_events_from_alert_manager ↪️
ask 39_failed_toolset ✅
ask 41_setup_argo ✅
ask 42_dns_issues_steps_new_tools ✅
ask 43_current_datetime_from_prompt ✅
ask 45_fetch_deployment_logs_simple ✅
ask 51_logs_summarize_errors ✅
ask 53_logs_find_term ✅
ask 54_not_truncated_when_getting_pods ✅
ask 59_label_based_counting ✅
ask 60_count_less_than 🚧
ask 61_exact_match_counting ✅
ask 63_fetch_error_logs_no_errors ✅
ask 79_configmap_mount_issue ✅
ask 83_secret_not_found ✅
ask 86_configmap_like_but_secret ✅
ask 93_calling_datadog ✅
ask 93_calling_datadog ✅
ask 93_calling_datadog ✅
ask 97_logs_clarification_needed ❌
ask 110_k8s_events_image_pull ✅
ask 24a_misconfigured_pvc_basic ✅
ask 13a_pending_node_selector_basic ✅

Legend

  • ✅ the test was successful
  • ↪️ the test was skipped
  • ⚠️ the test failed but is known to be flaky or known to fail
  • 🚧 the test had a setup failure (not a code regression)
  • 🔧 the test failed due to mock data issues (not a code regression)
  • ❌ the test failed and should be fixed before merging the PR

@aantn
aantn enabled auto-merge (squash) August 20, 2025 17:33
@aantn
aantn merged commit 6550389 into master Aug 20, 2025
2 checks passed
@aantn
aantn deleted the add-mimi-docs-from-robusta branch August 20, 2025 17:33
This was referenced Jan 21, 2026
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