Standard event attributes in Entuity
To view values of the standard attributes
In Entuity, event attributes are useful in the following cases:
- when you define actions that set the value of an attribute, e.g. the supplied flapping unify rules include a set event type action.
- when you define conditions based on the testing of an attribute.
- when you add additional information to the event (enrich the event) and store it within the database.
- when you include event details in emails.
Standard event attributes in Entuity:
Please find below the standard event and incident attributes in Entuity. Events and incidents share the same standard set of attributes. You can also enrich events with additional attributes - please see this article for help and information on how to add additional attributes to events in Entuity.
Event Attribute | Description |
---|---|
type | identifier of the event type or incident type. |
name | name of the event or incident. |
severity | severity level of the event or incident. |
reason | reason the event was raised, e.g. for an SNMP failure, it may be 100% of 4 SNMP requests failed in the past 40 seconds. |
context | textual information for the event. It may include a description of the state that the object was in before raising the event, or another environment description that is helpfuil in understanding the cause of the event. This field is not always present. |
reportId | identification of the process that has sent the event. This field is not always present. |
source |
source of the incidence within Entuity, e.g. com.entuity.events.engine.groovy.InventoryObjectProxy@3c5 |
sourcecompleteIdString |
internal identifier of the object within Entuity. Each component may have two identifiers; the separate identifier is the StormWorks identifier. |
sourceExternalId |
additional textual identification for the object, which may be useful in identifying objects which may not be represented by StormWorks. Values may be an IP address of the object, but may be any text. |
SourceName |
name of the source object - it may be a resolved name or an IP address. |
To view values of the standard attributes:
When developing events and incidents, or familiarising yourself with the Entuity event management system (EMS), you may want to see values of the standard attributes associated with an event or incident. The following example demonstrates how to send an email containing event attributes. This example uses the following techniques:
- variables to set the email recipient, and to control when the email is sent.
- variable test condition.
- send email action.
- set the email throttle action. This allows the server to combine emails to the same recipient when they are raised within a defined period.
- assign the email action to an incident.
Please see this article for help and information on how to add a variable to Entuity.
To define an incident that triggers an email when raised:
- Click Main Menu and then Administration. This will open the Administration page.
- Click Event Administration. This will open the Event Administration page.
- Click the Variables tab and Add two variables that will be used with the email action:
- a variable with the Name: email_boolean_send_control. This can contain one of two Values:
- true when you want the email action with which it will be associated to run.
- false when you want the email action with which it will be associated to not run.
- a variable with the Name: email_network_admin. Set the Value to the email address of the recipient:
- e.g. john.smith@entuity.com
- a variable with the Name: email_boolean_send_control. This can contain one of two Values:
- Click the Actions tab and Add a new event action.
- enter an appropriate Name and Description.
- Add a new email parameter.
- click Choose, and for Value Kind select Variable Reference.
- for Variable select email_network_admin.
- Add the body of the email in a parameter. The following example includes all standard attributes available against events and incidents, with each attribute labelled and starting on its own line:
"Source: " + source + "\nSourceName: " + sourceName + "\nSourceCompIdString: " + sourceCompIdString + "\nSourceExternalId: " + sourceExternalId + "\nContext:" + context + "\nType: " + type + "\nreportId: " +
reportId + "\nReason: " + reason - Add the throttle parameter and set it to true.
- Add an Action Step:
- set the Type to Groovy Script.
- enter the following example that tests if email_boolean_send_control is set true, and within the sendEmail section specifies the email content:
if (var("email_boolean_send_control") == true ) {
sendEmail (
param('recipients'),
param('subject'),
param('body'),
param('throttle')
)
}
- Save the action. The action is now available as a Named Action that you can select when adding triggers to incidents.
Comments
0 comments
Please sign in to leave a comment.