forked from raystack/siren
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
81 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Alert | ||
|
||
Alert is being one of the source of notification in Siren. Alert is ingested via ![Alert Webhook](../apis/siren-service-create-alerts.api.mdx) and the webhook is registered to a Monitoring System (e.g. Prometheus, Cortex). | ||
Once ingested by Siren, alert will be stored as Alert History. Alerts that are being sent by provider will be translated to a `Notification` by `Notification Service`. From this point, the notification is being dispatched by a `Notification Dispatcher` according to the strategy that it took. | ||
|
||
The next process could be found under ![Notification](./notification.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Receiver | ||
|
||
## Parent vs Child Receiver | ||
|
||
In Siren, one receiver could depends to other receiver and inherit its configuration. However it only supports one level parent-child relation.The receiver that depends on other receiver is called a `Child Receiver` but the receiver that other receiver depends on is called a `Parent Receiver`. | ||
|
||
There is never an orphan `Child Receiver` in Siren. That means, a `Child Receiver` always has to have a `Parent Receiver`. However, not every receiver could be a `Child Receiver`. Only a specific receiver type that could be a `Child Receiver`. | ||
|
||
Currently the only receiver type that is a `Child Receiver` is: | ||
- Slack Channel receiver, that depends on Slack receiver | ||
|
||
The Slack Channel receiver has config | ||
``` | ||
{ | ||
"channel_name": "xxx" | ||
} | ||
``` | ||
While the Slack receiver has config | ||
``` | ||
{ | ||
"token": "1234", | ||
"workspace": "gotocompany" | ||
} | ||
``` | ||
|
||
When rendering a message, if a message is a child receiver, Siren would merge the configs of parent receiver to the child receiver. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.