Skip to content

Conversation

@arikalon1
Copy link
Contributor

Summary

This PR adds comprehensive API documentation for two new Robusta features: the Prometheus Query API and the Holmes Chat API. These are commercial features available in the Robusta SaaS platform and self-hosted commercial plans.

Key Changes

  • New Prometheus Query API Documentation (docs/configuration/exporting/prometheus-query-api.rst)

    • Complete endpoint reference with path parameters and request body specifications
    • Authentication requirements and API key permissions
    • Multiple example requests demonstrating duration-based and date range queries
    • Response format documentation with field descriptions
    • Common PromQL query examples for resource quotas, CPU/memory, and pod status
  • New Holmes Chat API Documentation (docs/configuration/holmesgpt/holmes-chat-api.rst)

    • Full API endpoint documentation with URL parameters and request body specifications
    • Detailed example curl command with placeholder instructions
    • Request headers and authentication requirements
    • Response format with example analysis output
    • Error response codes and descriptions
    • Cluster resolution logic explanation
  • Updated Navigation

    • Added Holmes Chat API link to HolmesGPT section in docs/index.rst
    • Added Prometheus Query API link to exporting APIs section in docs/index.rst
    • Updated docs/configuration/exporting/robusta-pro-features.rst to reference the new Prometheus Query API

Notable Details

  • Both APIs include clear notes indicating they are commercial features only
  • Comprehensive examples with actual curl commands for easy testing
  • Detailed parameter tables with required/optional indicators and defaults
  • Error handling and response format documentation for better integration
  • Both APIs require Bearer token authentication with specific permission requirements

https://claude.ai/code/session_01MLXAVw9RVcPfGyUhy1XeDQ

Add documentation for two new API endpoints:
- Prometheus Query API: Run PromQL queries against connected clusters
- Holmes Chat API: Send questions to Holmes AI for root cause analysis

https://claude.ai/code/session_01MLXAVw9RVcPfGyUhy1XeDQ
@github-actions
Copy link

github-actions bot commented Feb 2, 2026

Docker image ready for b916a73 (built in 37s)

⚠️ Warning: does not support ARM (ARM images are built on release only - not on every PR)

Use this tag to pull the image for testing.

📋 Copy commands

⚠️ Temporary images are deleted after 30 days. Copy to a permanent registry before using them:

gcloud auth configure-docker us-central1-docker.pkg.dev
docker pull us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:b916a73
docker tag us-central1-docker.pkg.dev/robusta-development/temporary-builds/robusta-runner:b916a73 me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:b916a73
docker push me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:b916a73

Patch Helm values in one line:

helm upgrade --install robusta robusta/robusta \
  --reuse-values \
  --set runner.image=me-west1-docker.pkg.dev/robusta-development/development/robusta-runner-dev:b916a73

@coderabbitai
Copy link

coderabbitai bot commented Feb 2, 2026

Walkthrough

Adds documentation pages for two new APIs—Prometheus Query API and Holmes Chat API—and updates the docs index and Robusta Pro features page to reference them.

Changes

Cohort / File(s) Summary
New API documentation
docs/configuration/exporting/prometheus-query-api.rst, docs/configuration/holmesgpt/holmes-chat-api.rst
New comprehensive docs describing endpoints, request/response schemas, authentication, parameters, examples, error cases, and cluster-resolution behavior.
Documentation index & features
docs/index.rst, docs/configuration/exporting/robusta-pro-features.rst
Added table-of-contents and Robusta Pro features entries referencing the new Prometheus Query API and Holmes Chat API.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • API Doc tweaks #1905: Edits Robusta Pro features documentation to add/restructure API references (overlaps feature docs changes).
  • Update docs #1874: Adds/updates Pro features and AI/API documentation around Holmes/Prometheus (overlapping docs area).
  • Docs reorganize clean #1902: Updates docs/index.rst and Pro features entries for Holmes/Prometheus APIs (highly related files).

Suggested reviewers

  • pavangudiwada
  • aantn
  • RoiGlinik
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for two new APIs (Prometheus Query API and Holmes Chat API).
Description check ✅ Passed The description is well-detailed and directly related to the changeset, explaining the new documentation files, navigation updates, and key features of both APIs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch claude/add-prometheus-api-docs-x6sud

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

Comment @coderabbitai help to get the list of available commands and usage tips.

- Fix ask parameter to be mandatory in Holmes Chat API
- Add API key generation instructions to Prometheus Query API
- Add Holmes Chat API reference to Robusta Pro Features
- Add markdown response handling examples for Holmes Chat API

https://claude.ai/code/session_01MLXAVw9RVcPfGyUhy1XeDQ
@arikalon1 arikalon1 merged commit e024114 into master Feb 3, 2026
7 checks passed
@arikalon1 arikalon1 deleted the claude/add-prometheus-api-docs-x6sud branch February 3, 2026 13:53
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.

4 participants