nOutput EmailWarnings
This output sends email notifications whenever a specific type or types of warnings (usually ‘High’ level) are created. The email will follow the template in object.assets/noutputemailwarnings displaying all the current warnings for all warning levels (e.g. High, Medium, Low and Info).
Example of use of the execArgs
output:
name : Output EMail warning
chSubscribe : nattrmon::warnings
waitForFinish: true
onlyForEvent : true
execFrom : nOutput_EmailWarnings
execArgs :
to :
- email1@openaf.io
- email2@openaf.io
subject : "[nattrmon] My monitoring"
from : nattrmon@openaf.io
server : smtp.openaf.io
#port : 465
#credentials:
# user : mylogin
# password: mypassword
#debug : false
#warnTypes :
# - High
# - Medium
#include :
# - Warning to include
#exclude :
# - Warning to exclude
Description of execArgs
execArgs | Type | Mandatory | Description |
---|---|---|---|
to | Array/String | Yes | An array or string containing the email address to send the email to |
subject | String | Yes | The email subject |
from | String | Yes | The email from address |
server | String | Yes | The email SMTP server |
port | Number | No | The specific email SMTP server port |
credentials.user | String | No | The user credential to access an email SMTP server |
credentials.password | String | No | The password credential to access an email SMTP server (can be encrypted) |
debug | Boolean | No | If true it will output all the communication with the email SMTP server |
warnTypes | Array | No | Defines a list of warning levels/types for which to trigger an email |
include | Array | No | An array of warning titles to restrict which warnings should be displayed on the email and trigger the email |
exclude | Array | No | An array of warning titles to exclude from displaying on the email and triggering the email |
includeRE | Array | No | Equivalent to include but providing regular expressions for warning titles |
excludeRE | Array | No | Equivalent to exclude but providing regular expressions for warning titles |
groupBySimilarity | Number | No | If defined warnings that have the provided percentage similarity between their descriptions will be grouped and an extra message will be suffixed on the email template reducing the cluttering of similar warnings (usually 10% as good starting point). |
descriptionLimit | Number | No | If defined will limit the description size displayed on the email template replacing by ‘…’ after the limit |
tls | Boolean | No | Specifies that the connection to the SMTP server should use TLS (sometimes you might need also to specify secure = true depending on the server). |
secure | Boolean | No | Specifies that the connection to the SMTP server should be made using SSL. |
template | String | No | Provide an alternative handlebars template to config/objects.assets/noutputemailwarnings/warningEmailTemplate.hbs. The entry will be prefixed with config/objects.assets/noutputemailwarnings/ |
templateImages | Map | No | A map of images to be embeeded on the email. Each key refers to the cid that will be referenced on the template and the value is the image file prefixed with config/objects.assets/noutputemailwarnings. The “logo” reference will be always forced to point to the logo.png image. Please refer to each key of the map on the template in a similar form to: <img src=”cid:myMapKey”>. |