OpenSearch Integration

Create alerts in ilert from OpenSearch monitor alerts — with ilert's OpenSearch inbound integration.

OpenSearch is an open-source search, analytics, and observability suite. Its Alerting plugin lets you monitor your data and trigger actions when conditions are met. With this integration, alerts raised by OpenSearch monitors automatically create alerts in ilert, so the right responders are notified and escalations happen reliably.

In ilert: Create an OpenSearch alert source

Go to Alert sources --> Alert sources and click on Create new alert source
Search for OpenSearch in the search field, click on the tile and click on Next.
Give your alert source a name, optionally assign teams and click Next.
Select an escalation policy by creating a new one or assigning an existing one.
Select your Alert grouping preference and click Continue setup. You may click Do not group alerts for now and change it later.
The next page shows additional settings such as custom alert templates or notification priority. Click on Finish setup for now.
On the final page, ilert generates a webhook URL for your alert source. Copy it — you will need it in the next section.

In OpenSearch: Create a notification channel

Click the side menu button.
Scroll down and click on Notifications.
Click on Create channel.
Give the channel a name, choose Custom webhook as the channel type, and paste the webhook URL you copied from ilert into the Webhook URL field.

In OpenSearch: Create a monitor and action

Click the side menu button again and choose Alerting.
Click on Monitors, then Create monitor.
Fill in the monitor details as needed, then click Add action.
Give your action a name, choose the channel you just created, and copy and paste the template below into the message box.
Click Create. You are done.

Payload template

{
  "monitor_name": "{{ctx.monitor.name}}",
  "monitor_type": "{{ctx.monitor.monitor_type}}",
  "trigger_name": "{{ctx.trigger.name}}",
  "trigger_id": "{{ctx.trigger.id}}",
  "severity": "{{ctx.trigger.severity}}",
  "period_start": "{{ctx.periodStart}}",
  "period_end": "{{ctx.periodEnd}}",
  "alert_id": "{{ctx.alert.id}}",
  "alert_version": "{{ctx.alert.version}}",
  "alert_state": "{{ctx.alert.state}}",
  "alert_error_message": "{{ctx.alert.error_message}}",
  "alert_acknowledged_time": "{{ctx.alert.acknowledged_time}}",
  "action_name": "{{ctx.action.name}}"
}

When a monitor's trigger fires, OpenSearch runs the action and posts this payload to ilert, which creates an alert.

FAQ

Will alerts in ilert be resolved automatically?

Yes. ilert uses the alert_state field from the payload: when it is COMPLETED or DELETED (the trigger condition is no longer met), the corresponding ilert alert is resolved automatically.

Is this integration bidirectional?

No. The integration is one-directional: OpenSearch sends alerts to ilert. Acknowledging or resolving an alert in ilert is not synced back to OpenSearch, and vice versa.

Can I connect OpenSearch with multiple alert sources in ilert?

Yes. Create an additional notification channel in OpenSearch for each alert source and point it at that alert source's webhook URL, then reference the channel from the relevant monitor actions.

PreviousOpenObserve Integration NextOpsgenie Integration

Last updated 11 days ago

Was this helpful?