Skip to main content

Overview

The following topics will describe how to use Siren.

Managing providers and multi-tenancy​

Siren can be used to define alerting rules inside monitoring provider. List of supported providers are here. Support for other providers is on the roadmap, feel free to contribute. Siren also respects the multi-tenancy provided by various monitoring providers using namespace. A namespace represents a tenant inside a provider. Learn in more detail here.

Managing Templates​

Siren templates are abstraction to make data definition reusable (e.g. Prometheus rules to reuse same rule body to create multiple rules). Template could be used to define alerting rule body with go templates. Learn in more detail here.

Managing Rules​

Siren rules are defined using a template by providing value for the variables defined inside that template. Learn in more details here.

Managing bulk rules and templates​

For org wide use cases, where teams need to manage multiple templates and rules Siren CLI can be highly useful. Think GitOps but for alerting. Learn in more detail here.

Alerts Subscription​

Siren capables to subscribe to an alert and route notifications to the registered receivers in a subscription. Siren uses key-value label matching for routing. For each alerts coming to Siren's webhook, a notification will be generated and routed to specific receivers based on the subscriptions.

Sending On-demand Notifications​

Siren provides a way to the user to send direct notification to a supported receiver by calling an API /receivers/{receiver_id}/send with a custom payload message.

Receivers​

Receivers represent a notification medium e.g. Slack, PagerDuty, HTTP, which can be used in a subscription to define notification routing configuration in Siren. You can use receivers to send notifications on demand as well as on certain matching conditions. Learn in more detail here.

Subscriptions​

Siren can be used to route your notifications (non-alerts or alerts notification) to proper channels (receivers) based on the labels match conditions. You define your own set of label matchers and subscribe to alerts matching these labels in the notification mediums of your choice. Learn in more detail here.

Alert History Subscription​

Siren expect provider to call Siren back when an alert is triggered, allowing storage of triggered alerts and sending susbcribed notification via Siren. Storing triggered alerts is beneficial to be used for auditing and analytics purposes. Learn in more detail here.

Deployment​

Refer here to learn how to deploy Siren in production.