DBAmon Userexits

DBAmon

Userexits

User Exits

User Exits have now been supplied to provide additional opportunity to customize DBAmon without making code changes. All users exits must be stored in /opt/dbamon/bin/userexit and must be named the names specified below. They may be coded in any scripting language (KSH, Perl, Awk, ...) providing that they supply the correct #! string in the first line. They must be executable.

If a particular User Exit exsits, then it is invoked. For example, when DBAmon deems it necessary to create a Help Desk ticket, it looks for an executable called /opt/dbamon/bin/userexit/ticket. If it exists, then DBAmon will invoke it with the proper environment (see below). If /opt/dbamon/bin/userexit/ticket does not exist, then DBAmon takes no action.

In the install package all exits will be provide in EXAMPLE form, not activated. When you install DBAmon, if you look in the /opt/dbamon/bin/userexit directory, you will see:

-rwxr-xr-x    1 dbamon   vhost         137 Jul  1  1998 pager.EXAMPLE
-rwxr-xr-x    1 dbamon   vhost         316 May 14 13:42 ticket.EXAMPLE
-rwxr-xr-x    1 dbamon   vhost         143 Jul  1  1998 warn_msg.EXAMPLE

For example, to active the "ticket" User Exit:

cd /opt/dbamon/bin/userexit
cp ticket.EXAMPLE ticket
(Make script changes to /opt/dbamon/bin/userexit/ticket)

User Exits Currently Provided:

Warning Event - /opt/dbamon/bin/userexit/warn_msg
Any time that a WARNING event is triggered, immediately before the OpC message (if so configured) is issued, a user exit called /opt/dbamon/bin/userexit/warn_msg is invoked.
It is passed the parameters (in order):
1. Title - Example:
```
 i3107ppp:PP-OLTP 
```
2. Message - Example:
```
 *** DBSpace(s) exceed warning threshold of 90 *** 
```
3. File Name - If the message has accompanying information in a file, the name of the file. Example:
```
 /opt/dbamon/tmp/filename 
```
Pager - /opt/dbamon/bin/userexit/pager
If a CRITICAL event is triggered and the Pager_Subject: parameter for an instance is specified, /opt/dbamon/bin/userexit/warn_msg is invoked.
It is passed the parameters (in order):
1. Title - Example:
```
 i3107ppp:PP-OLTP 
```
2. Message - Example:
```
 *** DBSpace(s) exceed warning threshold of 90 *** 
```
3. File Name - If the message has accompanying information in a file, the name of the file. Example:
```
 /opt/dbamon/tmp/filename 
```
Ticket - /opt/dbamon/bin/userexit/ticket
If a CRITICAL event is triggered and the Make_Tickets: dbamonrc parameter is Y, /opt/dbamon/bin/userexit/ticket is invoked if it exists. You must customize /opt/dbamon/bin/userexit/ticket to create a ticket.
The following env vars are set before invocation:
- $ENV{"INSTANCE"}
- $ENV{"ERRFILE"}
- $ENV{"ERRMSG"}
- $ENV{"DBMS"}
- $ENV{"HOST"}
- $ENV{"ID1"}
- $ENV{"ID2"}
- $ENV{"ID3"}
MSSQL - Pre-Probe - /opt/dbamon/bin/userexit/inc_sqlup_pre
This exit is called for every MSSQL Instance that you monitor - BEFORE the probe is executed.
MSSQL - Post-Probe - /opt/dbamon/bin/userexit/inc_sqlup
This exit is called for every MSSQL Instance that you monitor - AFTER the probe is executed and after all sqlUp events are processed.
MSSQL - Pre-Event - /opt/dbamon/bin/userexit/inc_event
This exit is called any time that a DBAmon Event occurs. If this userexit ends with a return of 0, then the event will still be created. If the return is non-zero, then the event will not be created.

DBAmon.com
This Document: http://dbamon.com/config/userexit.shtml