Difference between revisions of "API events"

From Veloopti Help
Jump to: navigation, search
m
m
 
Line 14: Line 14:
 
{| class="wikitable"
 
{| class="wikitable"
 
! Parameter
 
! Parameter
 +
! Required
 
! Description
 
! Description
 
|-
 
|-
 
| /severity=<severity>
 
| /severity=<severity>
−
| can be expressed as /sev
+
 
−
Specifies the severity of the event. The following severities are supported: information, warning, critical and
+
''or''
−
matching shortened versions.
+
 
−
e.g.
+
/sev=<severity>
−
/sev=info
+
| True
−
/severity warning
+
| Specifies the severity of the event. The following severities are supported: information, warning, and critical. matching shortened versions.
 +
 
 +
<code>/sev=info</code>
 +
 
 +
<code>/severity=warning</code>
 
|-
 
|-
 
| /short_description=&#34;&#60;short&nbsp;description>&#34;
 
| /short_description=&#34;&#60;short&nbsp;description>&#34;
−
| can be expressed as /short
+
 
−
Specifies the short description of the event. This argument is limited to 80 characters and will be truncated if                                       more are supplied.
+
''or''
−
This argument will need to quoted as it will probably contain spaces.
+
 
−
e.g.
+
/short=&#34;&#60;short&nbsp;description>&#34;
−
/short_description="Greater than 100 emails are in the deferred queue"
+
| True
−
/short "Greater than 100 emails are in the deferred queue"
+
| 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.
 +
 
 +
<code>/short_description="Greater than 100 emails are in the deferred queue"</code>
 +
 
 +
<code>/short="Greater than 100 emails are in the deferred queue"</code>
 
|-
 
|-
 
| /long_description="<long&#8239;description>"
 
| /long_description="<long&#8239;description>"
−
| Set Long Description
+
 
 +
''or''
 +
 
 +
/long="<long&#8239;description>"
 +
| False
 +
| Specifies the optional long description of the event. If not provided then the long description will be set to the same value as the short description.
 +
 
 +
<code>/long_description="The application is processing a larger number of requests that normal. More than 1000 have been processed in the last minute and the average is less than 50."</code>
 +
 
 +
<code>/long="The application is processing a larger number of requests that normal. More than 1000 have been processed in the last minute and the average is less than 50."</code>
 
|-
 
|-
 
| /application=<Alias>
 
| /application=<Alias>
−
| Set the application alias
+
 
 +
''or''
 +
 
 +
/app=<Alias>
 +
| True
 +
| Specifies the application short name of the event. This argument requires a valid "application alias" to have been configured in Veloopti for a given application.
 +
<code>/app=OS</code>
 +
 
 +
<code>/app=MyApplication</code>
 
|-
 
|-
 
| /itil=<classification>
 
| /itil=<classification>
−
| Set ITIL Classification
+
| False
 +
| Specifies the (optional) [https://en.wikipedia.org/wiki/ITIL ITIL] classification of the event. The following values  are supported: availability, performance, capacity, and security.  There are matching shortened versions.
 +
<code>/itil=avail</code>
 +
 
 +
<code>/itil=cap</code>
 +
 
 +
<code>/itil sec</code>
 +
 
 +
<code>/itil performance</code>
 
|-
 
|-
 
| /key="<event key>"
 
| /key="<event key>"
−
| Set Message Key
+
| False
 +
| Specifies the (optional) 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 (\")
 +
 
 +
<code>/key="MyAPP:Calculator:Calc:1"</code>
 +
 
 +
<code>/key="EastCoast:Web:LoadBalance:availability:main web site"</code>
 
|-
 
|-
 
| /node_id&#61;&quot;&lt;event&nbsp;source&nbsp;node&nbsp;id&gt;&quot;
 
| /node_id&#61;&quot;&lt;event&nbsp;source&nbsp;node&nbsp;id&gt;&quot;
−
| Set Event Source Node Id
+
| False
 +
| Specifies the (optional) source node id for the event. The node_id setting is used to specify a different node id rather than associating the event with the node where the command is run. The node_id is the unique Node Id.
 +
 
 +
<code>/node_id="f7a0d939-0434-45ed-8548-895d35a54623"</code>
 +
 
 +
<code>/node_id="29c3b745-067c-4715-b799-60c70171be2f"</code>
 
|-
 
|-
 
| /property="<name>:<value>"
 
| /property="<name>:<value>"
−
| Add Property
+
| False
 +
| Specifies additional custom properties of the event. May be entered multiple times as required. Can be expressed as /prop These properties are displayed under the Event Details and provide extra context to the event. These properties are also passed to Integrations for use in external services. This argument may need to quoted as it could likely contain spaces.
 +
This argument value consists of two (2) parts separated by a colon (:) "<KEY>:<VALUE>".
 +
 
 +
<code>/prop="logfile:/var/log/audit/audit.log"</code>
 +
 
 +
<code>/property="disk:C:\"</code>
 +
 
 +
<code>/prop="file:config.txt"</code>
 +
''NOTE: only the first colon (:) is used when delimiting in the example of /property "disk:C:\"''
 
|-
 
|-
 
| /add_help="<help&nbsp;text>"
 
| /add_help="<help&nbsp;text>"
−
| Add Help Text
+
 
 +
''or''
 +
 
 +
/add="<help&nbsp;text>"
 +
| False
 +
| Specifies the optional Help Text of the event. The Help Text is displayed under the Event Details and included in notifications and integrations.  It is useful for including information to operators on how or why an event is likely to have occurred or instructions to assist with further diagnosis or how to resolve the event.
 +
 
 +
<code>/add_help="It is possible that the data disk is full and more space is needed. Check the log files. Restart the application once fixed."</code>
 +
 
 +
<code>/add="It is possible that the data disk is full and more space is needed. Check the log files. Restart the application once fixed."</code>
 
|-
 
|-
 
| /close
 
| /close
−
| Set Close
+
| False
−
|-  
+
| Sets the closed flag on the event. Veloopti will match the event on existing open events based on the Short Description or Key (if provided). If an existing open event is found, it will be auto-closed by Veloopti. This option does not take an argument value.
−
| /help
+
 
−
| Display command line usage help
+
<code>/help</code>
 
|-
 
|-
 
| /info
 
| /info
−
| Display detailed command line usage and examples
+
| False
 +
| Shows the detailed synopsis, command line help and examples. This option does not take an argument value.
 +
/info       
 
|-
 
|-
 
| /version
 
| /version
−
| Display command version information
+
 
 +
''or''
 +
 
 +
/ver
 +
| False
 +
| Shows the version information of the "veloopti-event" command. This option does not take an argument value.
 +
<code>/ver</code>
 
|}
 
|}
  

Latest revision as of 21:11, 6 December 2018

Home > Administration > Event Administration > API events

1 Overview

There are multiple ways to get events into Veloopti.

  1. Using the veloopti-event.exe program
  2. Using a web post

1.1 Using the veloopti-event.exe program

This method allows you to create a Veloopti event using the veloopt-event.exe program. This program comes with every agent.

1.1.1 Usage

Parameter Required Description
/severity=<severity>

or

/sev=<severity>

True Specifies the severity of the event. The following severities are supported: information, warning, and critical. matching shortened versions.

/sev=info

/severity=warning

/short_description="<short description>"

or

/short="<short description>"

True 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"

/long_description="<long description>"

or

/long="<long description>"

False Specifies the optional long description of the event. If not provided then the long description will be set to the same value as the short description.

/long_description="The application is processing a larger number of requests that normal. More than 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 than 1000 have been processed in the last minute and the average is less than 50."

/application=<Alias>

or

/app=<Alias>

True Specifies the application short name of the event. This argument requires a valid "application alias" to have been configured in Veloopti for a given application.

/app=OS

/app=MyApplication

/itil=<classification> False Specifies the (optional) ITIL classification of the event. The following values are supported: availability, performance, capacity, and security. There are matching shortened versions.

/itil=avail

/itil=cap

/itil sec

/itil performance

/key="<event key>" False Specifies the (optional) 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>" False Specifies the (optional) source node id for the event. The node_id setting is used to specify a different node id rather than associating the event with the node where the command is run. The node_id is the unique Node Id.

/node_id="f7a0d939-0434-45ed-8548-895d35a54623"

/node_id="29c3b745-067c-4715-b799-60c70171be2f"

/property="<name>:<value>" False Specifies additional custom properties of the event. May be entered multiple times as required. Can be expressed as /prop These properties are displayed under the Event Details and provide extra context to the event. These properties are also passed to Integrations for use in external services. This argument may need to quoted as it could likely contain spaces.

This argument value consists of two (2) parts separated by a colon (:) "<KEY>:<VALUE>".

/prop="logfile:/var/log/audit/audit.log"

/property="disk:C:\"

/prop="file:config.txt" NOTE: only the first colon (:) is used when delimiting in the example of /property "disk:C:\"

/add_help="<help text>"

or

/add="<help text>"

False Specifies the optional Help Text of the event. The Help Text is displayed under the Event Details and included in notifications and integrations. It is useful for including information to operators on how or why an event is likely to have occurred or instructions to assist with further diagnosis or how to resolve the event.

/add_help="It is possible that the data disk is full and more space is needed. Check the log files. Restart the application once fixed."

/add="It is possible that the data disk is full and more space is needed. Check the log files. Restart the application once fixed."

/close False Sets the closed flag on the event. Veloopti will match the event on existing open events based on the Short Description or Key (if provided). If an existing open event is found, it will be auto-closed by Veloopti. This option does not take an argument value.

/help

/info False Shows the detailed synopsis, command line help and examples. This option does not take an argument value.

/info

/version

or

/ver

False Shows the version information of the "veloopti-event" command. This option does not take an argument value.

/ver

1.1.2 Alias mappings

The Alias directs the event to the correct application.

To create an alias you need a role that has the Global Rename Application or Application "Manage Alias" permission. From the application view click on the more option menu item and select Rename application. From this dialogue box fill in the Alias that you want to use for the application.


1.1.3 Examples

veloopti-event.exe /severity=warning /short_description="Testing event " /long_description="This is the long description, amazing, eh?" /app=test2


1.2 Using a web post

Coming soon!

Retrieved from "http://help.veloopti.com.au/index.php?title=API_events&oldid=4568"