Conversation
- Remove sinks/destinations from integrations overview - Restructure page to highlight "Forward Alerts to Robusta" - Add dedicated section for Prometheus, Nagios, and SolarWinds - Simplify description to focus on alert forwarding and AI analysis 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Move sinks reference from Integrations nav to Notifications & Routing nav - Place sinks as first item in Notifications & Routing section - Remove sinks from Integrations section to reduce confusion - Keep logical grouping of alert destinations with notification routing 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Redesign integrations overview to be truly high-level with categories - Rename "Integrating with Prometheus" to "Alert Sources" for broader scope - Remove duplicate content between overview and subpages - Focus overview on integration categories rather than detailed setup - Update navigation labels to match new page structure - Make user journey clearer: overview → specific alert source setup 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
… Automation - Rename "Integrations" section to "Alert Sources" - much clearer purpose - Create dedicated "AI Analysis" section for Holmes GPT only - Move KRR, Popeye, and data export to "Automation" section - Update Alert Sources overview to focus purely on monitoring integrations - Remove mixed content categories that confused users - Improve logical flow: Alert Sources → AI Analysis → Notifications → Automation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Create new notifications overview page as entry point - Reorder navigation: Overview → Configuring Sinks → Sink Reference - Fix information hierarchy so users start with concepts, not specific sinks - Prevent sphinx menu expansion pushing basic setup pages down - Add clear getting started flow and common workflows - Update sink reference title to match new structure 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Move Nagios and SolarWinds from Prometheus subpages to top-level Alert Sources - Remove confusing navigation hierarchy where non-Prometheus systems appeared under Prometheus - Clean up Prometheus page to focus purely on Prometheus/AlertManager integrations - Remove "Other Alerting Systems" section since they're now top-level - Create clearer navigation: Overview → Prometheus → Nagios → SolarWinds 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Remove verbose explanations and get straight to the point - Lead with clear action: "Choose your monitoring system" - Make card descriptions more direct and useful - Add practical note about webhook compatibility for other systems - Cut word count by ~60% while improving clarity 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Change 'Legacy systems' to 'Nagios monitoring' - Change 'Enterprise monitoring' to 'SolarWinds monitoring' - Keep descriptions neutral and product-focused - Avoid terms that might make users feel bad about their tech choices 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Link 'HTTP webhooks' to webhook triggers documentation - Provides users with concrete next steps if their system isn't listed - Makes the fallback option actionable rather than just informational 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Link HTTP webhooks to exporting-data.rst which contains POST /api/alerts endpoint - This is the correct endpoint for sending alerts from any system via HTTP - Previous link was to webhook triggers which is for different use case 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Move exporting-data.rst from Automation to Alert Sources as "Custom Webhooks" - This contains the POST /api/alerts endpoint for sending alerts TO Robusta - Makes it discoverable for users wanting to integrate custom monitoring systems - Logical placement with other alert source integrations 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Remove navigation.tabs and navigation.tabs.sticky features - Add navigation.sections and navigation.expand for better sidebar - This provides more room for additional top-level sections - Makes navigation more scalable for future section additions 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
WalkthroughThis update restructures and refines the documentation, focusing on alert source integrations and Robusta Pro features. It simplifies navigation, adds new pages for Pro-exclusive features and custom webhooks, and clarifies the availability of integrations like Nagios and SolarWinds. Configuration and FAQ sections are condensed, and navigation behavior is adjusted in Sphinx settings. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Robusta Docs
participant Robusta Pro
User->>Robusta Docs: Reads about alert source integrations
alt Pro-only integration (Nagios/SolarWinds)
Robusta Docs-->>User: Shows Pro-only note
User->>Robusta Pro: Uses Pro features (custom webhooks, APIs)
else Open Source integration
Robusta Docs-->>User: Shows setup instructions
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~30–60 minutes Possibly related PRs
Suggested reviewers
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ 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). (2)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🔭 Outside diff range comments (2)
run_runner_locally.sh (2)
28-31: Fix incorrect variable expansion in version printout
$(PYTHON_BINARY --version)tries to execute a literal command namedPYTHON_BINARY.
Use command substitution on the value of the variable instead.- echo "You are using $(PYTHON_BINARY --version) located at $(which $PYTHON_BINARY)" + echo "You are using $($PYTHON_BINARY --version) located at $(which $PYTHON_BINARY)"
70-75: Typo in expected file-path messageThe help text points users to
active_playboks.yaml(missing “o”), which can waste debugging time.- echo "This file must be located at ./deployment/playbooks/active_playboks.yaml" + echo "This file must be located at ./deployment/playbooks/active_playbooks.yaml"
🧹 Nitpick comments (11)
run_runner_locally.sh (1)
91-93: Expose run-mode selection via flag instead of manual comment togglingCommenting / uncommenting runtime options is error-prone and easy to forget in commits.
Consider a--profile/--no-mirrordflag (or environment variable) and a smallcaseto choose the command, e.g.:RUN_CMD="mirrord exec -f mirrord.json -- poetry run python3 -m robusta.runner.main" [ "$PROFILE" = "memray" ] && RUN_CMD="mirrord exec -f mirrord.json -- poetry run memray run -m robusta.runner.main" [ "$NO_MIRRORD" = "1" ] && RUN_CMD="poetry run python3 -m robusta.runner.main" eval "$RUN_CMD"This keeps the script declarative, avoids merge noise, and lets CI toggle modes easily.
docs/how-it-works/oss-vs-saas.rst (2)
6-8: Spell-out “Teams” to avoid ambiguityReaders who aren’t familiar with Microsoft Teams may misinterpret “Teams”.
Recommend expanding to “Microsoft Teams” for clarity.- - **Open Source**: MIT-licensed engine that sends alerts to Slack, Teams, etc. No web UI. + - **Open Source**: MIT-licensed engine that sends alerts to Slack, Microsoft Teams, etc. No web UI.
12-13: Consider adding an internal link to the SaaS pricing pageYou already mention the SaaS plan in line 18 with an external link. Placing the same link (or a short reference) here saves scrolling for users who immediately want pricing details.
docs/notification-routing/index.rst (1)
22-51: Use concise card titlesCard titles like “Configure Sinks” and “Popular Sinks” are fine, but “Reduce Noise” could be renamed to “Alert Grouping” to align with the actual concept and improve skimmability.
- .. grid-item-card:: Reduce Noise + .. grid-item-card:: Alert Groupingdocs/configuration/exporting/custom-webhooks.rst (1)
31-33: Duplicate link wordingLines 31 and 59 both say “For complete API documentation…”. Consider removing one to avoid redundancy.
docs/how-it-works/usage-faq.rst (2)
8-11: Minor grammar – hyphenate compound adjective- Yes, you can install all-in-one bundle to install Robusta along with well-tested enriched alerts. + Yes, you can install the all-in-one bundle to deploy Robusta together with well-tested, enriched alerts.
14-17: Clarify “alert correlation” wordingSome readers might not know what “correlation” refers to. Consider “AI analysis and cross-alert correlation” or link to the Pro-features page for context.
docs/configuration/exporting/robusta-pro-features.rst (1)
31-37: Add punctuation for a polished, consistent bullet list.Every other section in the docs ends list items with a period.
Finishing each line here with a period keeps style consistent and avoids noisy Sphinx warnings when--nitpickyis enabled.-* **Alert Export API**: Export historical alert data with filtering by time range, alert name, and account -* **Alert Reporting API**: Get aggregated statistics and counts for different alert types -* **Custom Alert API**: Send alerts programmatically from external systems -* **Configuration Changes API**: Track configuration changes in your environment +* **Alert Export API**: Export historical alert data with filtering by time range, alert name, and account. +* **Alert Reporting API**: Get aggregated statistics and counts for different alert types. +* **Custom Alert API**: Send alerts programmatically from external systems. +* **Configuration Changes API**: Track configuration changes in your environment.docs/configuration/alertmanager-integration/index.rst (1)
56-60: Coralogix card: keep naming consistent with filename.The link points to
coralogix_managed_prometheus, but the card title is just “Coralogix”.
For discoverability in the sidebar, consider “Coralogix Managed Prometheus”.docs/index.rst (2)
38-43: Broken toctree entry lacks explicit bullet – may render as text.
notification-routing/configuring-sinksis the only line in this toctree that is not an inline captioned link.
Either add a caption or make it a captioned link like its neighbours to prevent Sphinx treating it as bare text.- notification-routing/configuring-sinks + Configuring Sinks <notification-routing/configuring-sinks>
96-97: Minor wording tweak for clarity.“Need to go beyond Kubernetes?” reads smoother as a standalone sentence when followed by a question mark and colon combo can feel clunky.
-Need to go beyond Kubernetes? `Try Robusta Pro <https://home.robusta.dev>`_. +Need to go beyond Kubernetes? `Try Robusta Pro <https://home.robusta.dev>`_.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
docs/conf.py(1 hunks)docs/configuration/alertmanager-integration/index.rst(2 hunks)docs/configuration/alertmanager-integration/nagios.rst(1 hunks)docs/configuration/alertmanager-integration/solarwinds.rst(1 hunks)docs/configuration/exporting/custom-webhooks.rst(1 hunks)docs/configuration/exporting/exporting-data.rst(1 hunks)docs/configuration/exporting/robusta-pro-features.rst(1 hunks)docs/configuration/index.rst(1 hunks)docs/configuration/sinks/index.rst(1 hunks)docs/how-it-works/oss-vs-saas.rst(1 hunks)docs/how-it-works/usage-faq.rst(1 hunks)docs/index.rst(3 hunks)docs/notification-routing/index.rst(1 hunks)docs/setup-robusta/installation/all-in-one-installation.rst(0 hunks)docs/setup-robusta/installation/extend-prometheus-installation.rst(0 hunks)docs/setup-robusta/installation/standalone-installation.rst(0 hunks)run_runner_locally.sh(1 hunks)
💤 Files with no reviewable changes (3)
- docs/setup-robusta/installation/extend-prometheus-installation.rst
- docs/setup-robusta/installation/standalone-installation.rst
- docs/setup-robusta/installation/all-in-one-installation.rst
🧰 Additional context used
🪛 Gitleaks (8.27.2)
docs/configuration/exporting/custom-webhooks.rst
40-41: 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: run_tests
- GitHub Check: run_tests
- GitHub Check: Deploy docs
🔇 Additional comments (10)
docs/configuration/sinks/index.rst (1)
5-5: LGTM: Terminology improvementThe change from "Sinks Reference" to "Sink Reference" improves grammatical consistency and aligns with standard documentation naming conventions.
docs/configuration/alertmanager-integration/solarwinds.rst (1)
4-6: LGTM: Important feature availability clarificationThe note clearly communicates that SolarWinds integration is a Pro feature, helping users understand licensing requirements upfront. The placement and formatting are appropriate.
docs/configuration/alertmanager-integration/nagios.rst (1)
4-6: LGTM: Consistent Pro feature clarificationThe note maintains consistency with other Pro feature documentation and clearly communicates licensing requirements to users.
docs/conf.py (1)
280-280: LGTM: Navigation UX improvementChanging
globaltoc_collapsetoTruewill make the documentation navigation more compact by collapsing sections by default, which improves readability and reduces visual clutter.Note: The AI summary mentions removal of navigation tabs features, but these changes aren't visible in the provided code snippet.
Likely an incorrect or invalid review comment.
docs/configuration/exporting/exporting-data.rst (2)
4-6: LGTM: Important API availability clarificationThe note clearly communicates that these HTTP APIs are Pro features, helping users understand licensing requirements before attempting to use them.
7-14: LGTM: Improved API overview and navigationThe bulleted list with descriptions makes it easy for users to understand available APIs, and the reference to Custom Webhooks provides helpful alternative integration options.
docs/notification-routing/index.rst (1)
11-18: Broken / ambiguous doc references may break Sphinx build
routing-with-scopes,notification-grouping, androuting-silencingare referenced without a path prefix. Verify these files exist in the same directory; otherwise the build will emit “unknown document” warnings.- :doc:`Routing <routing-with-scopes>` + :doc:`Routing <./routing-with-scopes>`Replicate the relative prefix (./) for the other two links if they live in the same folder.
docs/configuration/index.rst (1)
34-34: Check relative path for custom-webhooks docPath
exporting/custom-webhooksis two levels up; verify that Sphinx resolves it, otherwise prepend../:- :doc:`HTTP webhooks <exporting/custom-webhooks>` + :doc:`HTTP webhooks <../configuration/exporting/custom-webhooks>`docs/configuration/alertmanager-integration/index.rst (1)
31-41: All linked documents are presentBoth
alert-manager.rstandoutofcluster-prometheus.rstexist underdocs/configuration/alertmanager-integration, so the:link:targets will resolve correctly. No broken links detected.docs/index.rst (1)
52-56: Reference Verified:alert-custom-prometheus.rstExists
The filedocs/configuration/alertmanager-integration/alert-custom-prometheus.rstwas found—no update needed.
* Improve documentation content and organization - Update main page alert features to match README with better descriptions - Revamp architecture page with detailed component explanations and data flow - Add links to Pro Features and pricing in Open Source vs SaaS comparison - Add community tutorial by Naren P on Kubernetes monitoring automation
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
docs/how-it-works/architecture.rst (2)
17-19: Add explicit alt text for accessibilityThe image directive lacks an
:alt:option, so screen-reader users get no context... image:: ../images/arch-1/arch-1.png :width: 600 + :alt: High-level Robusta architecture diagram :align: center
24-28: Consider terminating list items with periods for consistent styleThe numbered “Data Flow” steps are full sentences yet lack terminating punctuation, whereas later sentences do include periods. Aligning the style improves readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/community-tutorials.rst(1 hunks)docs/how-it-works/architecture.rst(1 hunks)docs/how-it-works/oss-vs-saas.rst(2 hunks)docs/index.rst(3 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/community-tutorials.rst
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/how-it-works/oss-vs-saas.rst
- docs/index.rst
⏰ 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: run_tests
- GitHub Check: run_tests
- GitHub Check: Deploy docs
2 participants
No description provided.