centralcloud/oncall-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
oncall-engine/engine/config_integrations
History
Ildar Iskhakov 14b692674a
Fix bugs in web title and message templates rendering and visual representation (#1747) 
# What this PR does

## Which issue(s) this PR fixes

## Checklist

- [ ] Unit, integration, and e2e (if applicable) tests updated
- [ ] Documentation added (or `pr:no public docs` PR label added if not
required)
- [ ] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)
2023-05-02 16:57:52 +08:00
..
alertmanager.py Fix bugs in web title and message templates rendering and visual representation (#1747) 2023-05-02 16:57:52 +08:00
direct_paging.py Add escalation chain option when creating a direct page alert group (#1143) 2023-01-18 12:58:26 -03:00
elastalert.py Restore email notifications (#621) 2022-10-19 12:32:56 +01:00
formatted_webhook.py Restore email notifications (#621) 2022-10-19 12:32:56 +01:00
grafana.py Fix bugs in web title and message templates rendering and visual representation (#1747) 2023-05-02 16:57:52 +08:00
grafana_alerting.py Fix bugs in web title and message templates rendering and visual representation (#1747) 2023-05-02 16:57:52 +08:00
heartbeat.py Alert group search (#488) 2022-09-06 11:30:12 +01:00
inbound_email.py Inbound email integration (#837) 2023-03-16 13:59:21 +08:00
kapacitor.py Restore email notifications (#621) 2022-10-19 12:32:56 +01:00
maintenance.py Restore email notifications (#621) 2022-10-19 12:32:56 +01:00
manual.py Restore email notifications (#621) 2022-10-19 12:32:56 +01:00
README.md add precommit rules for markdown/json files (#915) 2022-12-01 14:26:54 +01:00
slack_channel.py Alert group search (#488) 2022-09-06 11:30:12 +01:00
webhook.py Restore email notifications (#621) 2022-10-19 12:32:56 +01:00
zabbix.py Inbound email integration (#837) 2023-03-16 13:59:21 +08:00

README.md

Contribute the new Integration to OnCall

Related: DEVELOPER.md

"Integration" in OnCall is a pre-configured webhook for alert consumption from alert sources. Usually, alert sources are monitoring systems such as Grafana or Zabbix.

Integration is a set of "templates" which are dumped from the integration config once the integration is created. Further changes to "templates" don't reflect on the integration config. Read more about templates here.

This instruction is supposed to help you to build templates to integrate OnCall with a new source of alerts. If you don't want to contribute to OnCall and are looking for a help integrating with custom alert source as a user, refer to this instruction.

Files related to Integrations

  1. Refer to "Grafana" integration as the most complete example.
  2. Each integration should have a {{integration_name_in_snake_case}}.py file in /engine/config_integrations. There you'll find Templates that will be copied to the Integration Templates once the integration is created by the user in the OnCall UI; Example Payload; and Tests which should match the result of the rendering of Example Payload as using Templates. The best way to build such a file is to create Webhook Integration, write & debug templates in the UI first and copy-paste them to the file after.
  3. Each integration should be listed in the /engine/settings/base.py file, section INSTALLED_ONCALL_INTEGRATIONS.
  4. Each integration should have "How to connect" instruction stored as integration_{{integration_name_in_snake_case}}.html in the engine/apps/integrations/html folder. .py file has a slug field that is used to locate .html file.

What do we expect from high-quality integration?

  1. User-friendly integration instruction.
  2. Proper grouping following source's logics. If source generates multiple alerts per "detection" it would be nice to provide suitable grouping & resolving configuration in the templates.
  3. Awesome rendering. We all love when alerts look good in Slack, SMS and all other rendering destinations.