About the SNMP Server Events in TDV

TDV Server creates SNMP events that are compliant with SNMPv3 protocol. The CompositeSoftware-MIB.mib file contains details of these server events.

You can modify SNMP log settings from Studio by selecting the Administration > Configuration menu option, and navigating to Server > Events and Logging > Logging > SNMP.

To enable SNMP traps in TDV

1. Review the available TDV SNMP traps by opening the following MIB file:
<TDV_install_dir>\apps\server\CompositeSoftware-MIB.mib
2. Optionally, you can add a new trap definition to CompositeSoftware-MIB.mib. For example:
csSecurityRBSAssign TRAP-TYPE
    ENTERPRISE csTrapsV3
    VARIABLES{ trapTime, trapServerHostName, trapServerPort, trapPolicyName, trapResourceName }
    DESCRIPTION "This trap is generated when a Row Based Security policy has been assigned."
    ::= 22005
3. Optionally, for any new trap definitions, define the trap variables. For example, a variable definition in the MIB is:
trapResourceName OBJECT-TYPE
   SYNTAX DisplayString (SIZE(1..256))
   ACCESS read-only
   STATUS mandatory
   DESCRIPTION "A string that indicates the resource name for the generated trap."
   ::= { trapVars 140 }
trapPolicyName OBJECT-TYPE
   SYNTAX DisplayString (SIZE(1..256))
   ACCESS read-only
   STATUS mandatory
   DESCRIPTION "A string that indicates the policy name for the Row Based Security policy."
   ::= { trapVars 185 }
4. In Studio, select Administration > Configuration.
5. Navigate to Server > Events and Logging > Logging > SNMP.
6. Specify values for the following configuration parameters.

Configuration Parameter

Description of Value to Set

Enable SNMP Events

True

Trap Community

Community string to which to send SNMP traps. Default: public.

Make sure the SNMP client uses the same value as you set here.

Trap Host List

A comma-separated list of host names or IPs that will be sent the SNMP v3 trap messages.

Trap Port

Specify the port for the trap receiver.

7. Navigate to Event Generation.
8. Add SNMP to the list for event types you want to send to SNMP.

For example, to monitor Request Start events, add a comma and SNMP to the Value for the Request Start configuration parameter under Event Generation > Request Events. This sends the SNMP trap to the trap receiver that you specified using the Trap Port configuration parameter.

Information to Monitor

Description of Notice

Configuration Steps

TDV Session

Alert if it reaches a certain threshold

Create a query that uses the /services/databases/system/SYS_SESSIONS published view in the SYSTEM repository.

TDV Cache

Monitor required for cache success or failure

Define the following traps under Events and Logging > Event Generation > Cache Events configuration parameters:

Cache Refresh Start, Cache Refresh Fail, Cache RefreshEnd

You can instead define a query that uses the STATUS column from the /services/databases/system/SYS_CACHES view to capture the information and write it to the log files or SNMP monitor program.

Data Sources

Determine whether the data source is up and running or not

Define the following traps under Events and Logging > Event Generation > Data Source Events:

Data Source Up, Data Source Down

You can instead define a query that uses the STATUS column in /services/databases/system/SYS_DATASOURCES to capture the information and write it to the log files or SNMP monitor program.

Trigger

Alert on failure

Define the following traps under Events and Logging > Event Generation > Trigger Events:

Trigger Start, Trigger Fail, Trigger End

You can instead define a query that uses the STATUS column in /services/databases/system/SYS_TRIGGERS to capture the information and write it to the log files or SNMP monitor program.

Long-running queries

Alert if it reaches a certain threshold

Define the threshold value for the duration which is considered as long in Events and Logging > Event Generation > Request Events:

Request Run Time

This value must be in minutes and controls the period of time after which a request is considered to be long-running, resulting in the generation of a RequestRunForTooLong event.

Number of waiting requests

Alert if it reaches a certain threshold

  1. Add “SNMP” to the value of the Events and Logging > Event Generation > Request Events > Request Wait Queue Threshold Passed configuration parameter.

  2. Set the Server > Runtime Processing Information > Wait Queue > Wait Queue Threshold configuration parameter. This is the number of requests in the wait queue at which a wait queue threshold event is triggered.

This generates a csRequestWaitQueueThresholdPass trap.