-
Couldn't load subscription status.
- Fork 1.1k
[OPIK-2745][Docs] Alert native integrations documentation #3815
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
base: main
Are you sure you want to change the base?
[OPIK-2745][Docs] Alert native integrations documentation #3815
Conversation
There was a problem hiding this 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 |
apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/events/webhooks/AlertJob.java
Show resolved
Hide resolved
|
🌿 Preview your docs: https://opik-preview-f7bdf309-cafb-4ec0-8c3e-caab41641dd7.docs.buildwithfern.com/docs/opik The following broken links where found: Page: Page: |
|
Images automagically compressed by Calibre's image-actions ✨ Compression reduced images by 22.3%, saving 179.64 KB.
315 images did not require optimisation. Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions. |
|
🌿 Preview your docs: https://opik-preview-9099f05c-0a4d-4488-8ce0-71b098f853d3.docs.buildwithfern.com/docs/opik No broken links found |
Details
Update documentation for alerts native integrations with Slack and PagerDuty
Change checklist
Issues
Testing
NA
Documentation
https://www.notion.so/cometml/Opik-Webhook-Alerts-MVP-2207124010a38009a153dc7402c69857