-
Notifications
You must be signed in to change notification settings - Fork 304
Update docs #1874
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
Merged
Merged
Update docs #1874
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
96a440d
docs: reorganize integrations page to focus on alert forwarding
aantn e6945b4
docs: move sinks from Integrations to Notifications & Routing section
aantn 1a00d80
docs: fix integration page hierarchy and remove redundancy
aantn 6453e54
docs: major reorganization - separate Alert Sources, AI Analysis, and…
aantn d26f620
docs: improve notifications navigation with proper hierarchy
aantn 2db9341
docs: move Nagios and SolarWinds to top-level Alert Sources
aantn 7909e2d
docs: make Alert Sources overview more concise and actionable
aantn 70ace66
docs: remove negative labels like 'legacy' and 'enterprise'
aantn 8f447cd
docs: add helpful link to webhook documentation for other systems
aantn a431002
docs: fix webhook link to point to correct API documentation
aantn a8178f7
docs: move webhook API to Alert Sources section where it belongs
aantn a1cfef6
docs: switch from horizontal tabs to left sidebar navigation
aantn 2fdd287
switch to sidebar navigation
aantn 745ed97
clarify on pro features
aantn 7993d67
put robusta pro features in the right place
aantn 8fde0e5
docs
aantn ac04986
Update index.rst
aantn 6e56877
fixes
aantn f4a96e1
Improve documentation content and organization (#1883)
pavangudiwada 042370e
Merge branch 'master' into update-integrations-page
aantn 9510c8a
Updated Robusta signup link
pavangudiwada 5cb7041
Merge branch 'master' into update-integrations-page
pavangudiwada File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| Custom Webhooks | ||
| =============== | ||
|
|
||
| Send alerts from any monitoring system to Robusta via HTTP webhooks. | ||
|
|
||
| .. note:: | ||
| This feature requires Robusta Pro (SaaS or self-hosted commercial plans). | ||
|
|
||
| Overview | ||
| -------- | ||
|
|
||
| Forward alerts from any system that can send HTTP POST requests. Robusta will automatically enrich these alerts with Kubernetes context and apply your automation rules. | ||
|
|
||
| Webhook Endpoint | ||
| ---------------- | ||
|
|
||
| Send alerts to Robusta using the following endpoint: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| POST https://api.robusta.dev/api/alerts | ||
|
|
||
| Authentication | ||
| -------------- | ||
|
|
||
| You'll need your API key and account ID: | ||
|
|
||
| 1. **Account ID**: Found in your ``generated_values.yaml`` file | ||
| 2. **API Key**: Generate this in the Robusta platform under **Settings** → **API Keys** → **New API Key** | ||
|
|
||
| For detailed API documentation including request format, authentication, and examples, see :doc:`Alert History Import and Export API <exporting-data>`. | ||
|
|
||
| Quick Example | ||
| ------------- | ||
|
|
||
| Here's a simple example of sending a custom alert: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| curl --location --request POST 'https://api.robusta.dev/api/alerts' \ | ||
| --header 'Authorization: Bearer YOUR_API_KEY' \ | ||
| --header 'Content-Type: application/json' \ | ||
| --data-raw '{ | ||
| "account_id": "YOUR_ACCOUNT_ID", | ||
| "alerts": [ | ||
| { | ||
| "title": "Test Service Down", | ||
| "description": "The Test Service is not responding.", | ||
| "source": "monitoring-system", | ||
| "priority": "high", | ||
| "aggregation_key": "test-service-issues" | ||
| } | ||
| ] | ||
| }' | ||
|
pavangudiwada marked this conversation as resolved.
|
||
|
|
||
| Next Steps | ||
| ---------- | ||
|
|
||
| For complete API documentation including all available fields and response formats, see :doc:`Alert History Import and Export API <exporting-data>`. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| Robusta Pro Features | ||
| ==================== | ||
|
|
||
| .. note:: | ||
| These features are available with the Robusta SaaS platform and self-hosted commercial plans. They are not available in the open-source version. | ||
|
|
||
| Robusta Pro adds a web UI, additional integrations, and enterprise APIs to the open-source engine. Available as SaaS (we handle hosting) or self-hosted on-premise. | ||
|
|
||
| Custom Alert Ingestion | ||
| ----------------------- | ||
|
|
||
| Send alerts to Robusta from any monitoring system using HTTP webhooks. | ||
|
|
||
| :doc:`Custom Webhooks <custom-webhooks>` | ||
| Send alerts from any system that supports HTTP webhooks, including custom monitoring solutions. | ||
|
|
||
| :doc:`Nagios Integration <../alertmanager-integration/nagios>` | ||
| Forward alerts from Nagios to Robusta for enrichment and automation. | ||
|
|
||
| :doc:`SolarWinds Integration <../alertmanager-integration/solarwinds>` | ||
| Configure SolarWinds to send alert webhooks directly to Robusta. | ||
|
|
||
| Data Export and Reporting APIs | ||
| ------------------------------- | ||
|
|
||
| Export alert history and generate reports using Robusta's REST APIs. | ||
|
|
||
| :doc:`Alert History Import and Export API <exporting-data>` | ||
| Comprehensive API for exporting alert history, generating reports, and sending custom alerts programmatically. | ||
|
|
||
| Features include: | ||
|
|
||
| * **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 | ||
|
|
||
| AI Analysis | ||
| ----------- | ||
|
|
||
| Optional AI-powered alert investigation using HolmesGPT. | ||
|
|
||
| :doc:`AI Analysis (HolmesGPT) <../holmesgpt/index>` | ||
| Automatically analyze Kubernetes alerts, logs, and metrics. Get potential root causes and remediation suggestions. | ||
|
|
||
| Additional Pro Features | ||
| ----------------------- | ||
|
|
||
| Additional capabilities in Robusta Pro: | ||
|
|
||
| * **Web UI**: Manage alerts, playbooks, and configuration through a browser interface | ||
| * **Alert Templates**: Create Prometheus alerts without writing PromQL | ||
| * **Historical Data**: Query alert history and trends | ||
| * **Enterprise Support**: Production support and SLA options | ||
|
|
||
| For more details on the differences between open-source and SaaS, see :doc:`Open Source vs SaaS <../../how-it-works/oss-vs-saas>`. | ||
|
|
||
| Getting Started | ||
| --------------- | ||
|
|
||
| To access these features: | ||
|
|
||
| 1. **Robusta SaaS**: `Sign up for free <https://platform.robusta.dev/signup>`_ to get started with the full platform | ||
| 2. **Self-hosted Commercial**: Contact support@robusta.dev for enterprise plans with self-hosted UI | ||
| 3. **API Access**: Generate API keys in the Robusta platform under **Settings** → **API Keys** | ||
|
|
||
| For detailed API documentation and examples, see :doc:`Alert History Import and Export API <exporting-data>`. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.