[ROB-2580] Coralogix docs updated

[Avi-Robusta]

No description provided.

[coderabbitai]

Walkthrough

Documentation update for Coralogix managed Prometheus integration, replacing YAML examples with JSON-based webhook payloads. Restructures configuration into separate Firing and Resolved Alerts Webhook sections with updated field mappings, timestamp formats, and additional metadata fields for alert payloads.

Changes

Cohort / File(s)	Summary
Documentation: Coralogix Webhook Examples docs/configuration/alertmanager-integration/coralogix_managed_prometheus.rst	Replaces YAML examples with JSON webhook payloads for firing and resolved alerts; updates timestamp format from millisecond to ISO format; adds new payload fields (source, fingerprint, severity, application, subsystem, team, alert_url); restructures configuration into two distinct webhook sections with test guidance.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Verify JSON webhook payload structure matches Coralogix API requirements
• Confirm timestamp format changes ($EVENT_TIMESTAMP_ISO vs $EVENT_TIMESTAMP_MS) are correct
• Validate new field additions and their mapping to alert metadata

Possibly related PRs

• Coralogix prometheus + opsgenie Docs update #1858: Modifies the same Coralogix managed Prometheus documentation file with webhook configuration and integration reference updates.

Suggested reviewers

• pavangudiwada
• arikalon1
• RoiGlinik

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	No pull request description was provided by the author; the description field is empty.	Add a brief description explaining the purpose of the documentation updates, such as the migration to JSON format and webhook configuration changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title directly references the main change: updating Coralogix documentation with YAML-to-JSON conversion and webhook configuration updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch coralogix-docs-updated

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/configuration/alertmanager-integration/coralogix_managed_prometheus.rst (2)

54-54: Clarify the epoch timestamp for firing alerts.

The endsAt field in the firing alerts webhook (line 54) is set to "1970-01-01T00:00:00Z" (Unix epoch), which may confuse users. While this may be intentional per Coralogix's API design, consider adding an inline comment or expanding the documentation to explain why a firing alert uses an epoch end time rather than a future or null value.

For example, a comment like "endsAt": "1970-01-01T00:00:00Z" # Firing alerts use epoch; resolved time is unknown would clarify the intent.

Consider adding clarification—either inline in the JSON or as explanatory text—about why the epoch timestamp is used for firing alerts:

-          "endsAt": "1970-01-01T00:00:00Z",
+          "endsAt": "1970-01-01T00:00:00Z",  # Firing alerts: end time unknown; epoch used by convention

Alternatively, add a note in the documentation explaining this difference between firing and resolved alerts.

---

60-70: Consider consolidating repeated cluster_name guidance.

The instruction to update cluster_name in both webhook bodies is repeated on lines 61 and 104. While redundancy can be beneficial for user awareness, the final note (lines 119–121) already emphasizes this requirement. You may consider whether the inline comments in both webhooks are necessary or if a single placement (e.g., in the note) would suffice without redundancy.

Also applies to: 103-111

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 82edbfe and 10b8e82.

📒 Files selected for processing (1)

• docs/configuration/alertmanager-integration/coralogix_managed_prometheus.rst (3 hunks)

⏰ 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 (1)

docs/configuration/alertmanager-integration/coralogix_managed_prometheus.rst (1)

1-122: Overall structure and documentation clarity look good.

The restructuring into Common Configuration, Firing Alerts Webhook, and Resolved Alerts Webhook sections is clear and easy to follow. The step-by-step instructions are well-organized, and the JSON examples are properly formatted. The reference to Coralogix documentation is helpful. No broken links or grammatical issues detected.