...
Follow along below to configure notifications:
1. Choose a Notifier Component:
Expand |
---|
title | Select a component you want to use to send notifications to your team |
---|
|
You can use any component you wish to receive the triggered log messages and send notifications to your team. For example, you can build a custom component or modify the Email Sender Iguana X Notifications (email), Slack Notifier Adapter, or ServiceNow Adapter to use as your Notifier component. Image RemovedImage Added |
2. Create Notification Rules:
Notification rules are created by specifying four criteria:
Expand |
---|
title | Matching Rule - apply notification conditions to components using pattern matching techniques |
---|
|
Every notification rule will have a Matching Rule to assign a notification rule to components. Iguana supports glob expression (*), boolean(and/or), or regular expressions (regex) with Tags to create matching rules. To use regex, simply enclose the expression in slash characters /<regex>/ . Info |
---|
IguanaX does not support the | exclamation point for V6 bang regex syntax !<regex> use /<regex> | .The table below provides an overview of example pattern matching techniques you can combine to create a matching rule. Type | Sample | Description |
---|
Wildcard | *
| Apply to all components. | #dev*
| Apply to components with #dev followed by 0 or more characters | OR | #prod #dev
| Apply to components with either #prod or #dev tags. | AND | "#prod #dev"
| Apply to components with both #prod and #dev tags. | Negation | -#prod
| Apply to all components without the #prod tag. | “#prod -#dev”
| Apply to all components with the #prod tag and without #dev. |
|
...
Expand |
---|
title | Limit - the number of notifications to be sent by a triggered condition within a 1 hour period |
---|
|
You can set a limit to the number of log triggers generated to control the number of notifications sent within a 1 hour period. The default is set to 6 notifications per hour, the maximum can be set to 60 notifications per hour. |
3. Test your Notification Rules:
Expand |
---|
title | When a Notification Rule is triggered, a log message is generated and sent to the Notifier Component |
---|
|
When a notification rule is triggered, a log message is generated for the set Notifier Component. The log message is a JSON object containing the notification details such as component guid, the criteria (condition triggered), the threshold set and priority rating. Code Block |
---|
| [{"component":"Custom_ByvlKqIG5aLpSZ","criteria":"error_count","priority":"low","threshold":"1"}] |
|
Expand |
---|
title | Use the testing links to generate test alerts based on your configured rules |
---|
|
After creating a notification rule, it can be quickly tested by using the provided testing links. Use the click here link to have Iguana check your notification rules. Click on the logs link to view the log created by your notification rules. Image Addedyou You can test all conditions expect for the “Log Contains” conditions as this is only triggered on newly generated logs. You can test this out by interacting with your components directly. | Image Removed |