Skip to content

Conversation

@BorisTkachenko
Copy link
Contributor

Details

Update documentation for alerts native integrations with Slack and PagerDuty

Change checklist

  • User facing
  • Documentation update

Issues

  • Resolves #
  • OPIK-2745

Testing

NA

Documentation

https://www.notion.so/cometml/Opik-Webhook-Alerts-MVP-2207124010a38009a153dc7402c69857

@BorisTkachenko BorisTkachenko self-assigned this Oct 27, 2025
@BorisTkachenko BorisTkachenko requested a review from a team as a code owner October 27, 2025 11:41
Copilot AI review requested due to automatic review settings October 27, 2025 11:41
@BorisTkachenko BorisTkachenko requested a review from a team as a code owner October 27, 2025 11:41
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the documentation for Opik's alert system to include native integrations with Slack and PagerDuty, alongside the existing general webhook functionality. The changes introduce three destination types for alerts and provide comprehensive setup instructions for each integration method.

Key changes:

  • Added documentation for native Slack and PagerDuty integrations with automatic message formatting
  • Reorganized integration examples to distinguish between native integrations, general webhooks, and optional middleware approaches
  • Updated setup instructions to include destination type selection and routing key configuration for PagerDuty

Reviewed Changes

Copilot reviewed 2 out of 5 changed files in this pull request and generated 1 comment.

File Description
apps/opik-documentation/documentation/fern/docs/production/alerts.mdx Added comprehensive documentation for Slack and PagerDuty native integrations, reorganized integration examples, and updated configuration instructions
apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/events/webhooks/AlertJob.java Minor code formatting change - moved annotation position for consistency

@github-actions
Copy link
Contributor

🌿 Preview your docs: https://opik-preview-f7bdf309-cafb-4ec0-8c3e-caab41641dd7.docs.buildwithfern.com/docs/opik

The following broken links where found:

Page:
❌ Broken link: {} ()

Page:
❌ Broken link: ] ()

@github-actions
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 22.3%, saving 179.64 KB.

Filename Before After Improvement Visual comparison
apps/opik-documentation/documentation/fern/img/production/alerts_configuration.png 248.13 KB 194.80 KB -21.5% View diff
apps/opik-documentation/documentation/fern/img/production/alerts_list.png 248.13 KB 194.80 KB -21.5% View diff
apps/opik-documentation/documentation/fern/img/production/create_alert_form.png 308.87 KB 235.89 KB -23.6% View diff

315 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

andrescrz
andrescrz previously approved these changes Oct 27, 2025
@github-actions
Copy link
Contributor

🌿 Preview your docs: https://opik-preview-9099f05c-0a4d-4488-8ce0-71b098f853d3.docs.buildwithfern.com/docs/opik

No broken links found

@github-actions
Copy link
Contributor

Backend Tests Results

  259 files  +  1    259 suites  +1   47m 22s ⏱️ + 6m 42s
5 250 tests + 45  5 243 ✅ + 45  7 💤 ±0  0 ❌ ±0 
5 212 runs  +146  5 205 ✅ +146  7 💤 ±0  0 ❌ ±0 

Results for commit 80819a0. ± Comparison against base commit d41b7ce.

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