1 Overview
When executed the Linux binary "veloopti-event" or windows executable "veloopti-event.exe" creates and sends an event to the nodes Veloopti Organisation. The event is sent to a specific application using an "Application Alias" that must be prepared beforehand.
2 Usage
The usage of veloopti-event is:
veloopti-event /sev=<severity> /short="<short_description>" /app=<application alias> [OTHER ARGUMENTS]
The command requires at least the mandatory arguments in order to create a Veloopti event.
2.1 Mandatory arguments
These arguments are required in order for an event to be created.
| Argument | Description | Examples |
|---|---|---|
| /severity=<severity>
/sev=<severity> |
Specifies the severity of the event.
The following severities are supported: information, warning, critical or the matching shortened versions of: info, warn, crit |
/severity=warning
/sev=info |
| /short_description="<short description>"
/short="<short description>" |
Specifies the short description of the event. This argument is limited to 80 characters and will be truncated if more are supplied.
This argument will need to quoted as it will probably contain spaces. |
/short_description="Greater than 100 emails are in the deferred queue"
/short="Greater than 100 emails are in the deferred queue" |
| /application=<Application Alias>
/app=<Application Alias> |
Specifies the application short name of the event. This argument requires a valid "application short name" to have been configured in Veloopti for a given application. | /application=OS
/app=MyApplication |
2.2 Optional arguments
| Argument | Description | Example |
|---|---|---|
| /long_description="<long description>" | Specifies the long description of the event. If not provided, the long description will be set to the same value as the short description.
This argument will need to quoted as it will probably contain spaces. |
/long_description="The application is processing a larger number of requests that normal. More that 1000 have been processed in the last minute and the average is less than 50."
/long="The application is processing a larger number of requests that normal. More that 1000 have been processed in the last minute and the average is less than 50." |
| /itil=<classification> | Specifies the (optional) itil classification of the event. The following values are supported: availability, performance, capacity, security and matching shortened versions of avail, perf, cap,sec | /itil=availability
/itil=cap /itil security /itil perf |
| /key="<event key>" | Specifies the key for the event. The key is used to specify uniqueness of an event for use with duplicate suppression and auto closing.
The key can be set to any string of alphanumeric characters including: spaces ( ), colons (:), commas (,), periods (.), forward slashes (/), back slashes (\\), note: back slashes require delimiting single quotes ('), note: single quotes may require delimiting (\') double quotes ("), note: double quotes may require delimiting (\") |
/key="MyAPP:Calculator:Calc:1"
/key "EastCoast:Web:LoadBalance:availability:main web site" |
| /node_id="<event source node id>" | ||
| /property="<name>:<value>" | ||
| /add_help="<help text>" | ||
| /close |
2.3 Other arguments
| Argument | Description | Example |
|---|---|---|
| /long_description="<long description>" | ||
| /help | ||
| /info | ||
| /version |
== Configuring an Application Alias" An Application Alias directs the created event to the application that it belongs in. No event in Veloopti is able to exist without having an application so this is required. If the command is run with an application alias that does not exist the following error is generated:
C:\>veloopti-event.exe /app=AppNOtExist /sev=Warning /short="This is the short description" Specified application: not permitted 2020-01-29 12:56:03.835 - Fatal - - Event::validateShortName 515 (0): Specified application is not permitted: appnotexist