SNMP
SNMP Trap Thresholds
The Spectra Analyze appliance can receive notifications (traps) about important system events via the Simple Network Management Protocol (SNMP).
Traps used for monitoring the average system load, as well as memory and disk usage, are generated by the Distributed Management Event Management Information Base (MIB) (DISMAN-EVENT-MIB::mteTriggerFired). Traps related to Spectra Detect and classification queue sizes are generated by the tswQueueThreshold MIB.
To enable SNMP traps and configure the address of the trap sink server, adjust the values in the Administration ‣ Configuration ‣ SNMP dialog on the Spectra Analyze appliance. The dialog also allows setting thresholds for supported types of events, which are described in more detail below.
Average system load
This trap is sent if the average load of the local system exceeds specified values (1-minute, 5-minute and 15-minute averages). Values should be provided as percentages, which are recalculated into appropriate thresholds as reported with uptime
or top
commands.
The following examples show traps triggered by a high 1-minute, 5-minute and 15-minute system load average, respectively:
2018-01-26 14:35:54 <UNKNOWN> [UDP: [192.168.123.247]:60418->[192.168.123.17]:162]:
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (13) 0:00:00.13
SNMPv2-MIB::snmpTrapOID.0 = OID:
DISMAN-EVENT-MIB::mteTriggerFired
DISMAN-EVENT-MIB::mteHotTrigger.0 = STRING: laTable
DISMAN-EVENT-MIB::mteHotTargetName.0 = STRING:
DISMAN-EVENT-MIB::mteHotContextName.0 = STRING:
DISMAN-EVENT-MIB::mteHotOID.0 = OID:
UCD-SNMP-MIB::laErrorFlag.1
DISMAN-EVENT-MIB::mteHotValue.0 = INTEGER: 1
UCD-SNMP-MIB::laNames.1 = STRING: Load-1
UCD-SNMP-MIB::laErrMessage.1 = STRING: 1 min Load Average too high (= 2.56)
2018-01-26 14:35:54 <UNKNOWN> [UDP: [192.168.123.247]:60418->[192.168.123.17]:162]:
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (13) 0:00:00.13
SNMPv2-MIB::snmpTrapOID.0 = OID:
DISMAN-EVENT-MIB::mteTriggerFired
DISMAN-EVENT-MIB::mteHotTrigger.0 = STRING: laTable
DISMAN-EVENT-MIB::mteHotTargetName.0 = STRING:
DISMAN-EVENT-MIB::mteHotContextName.0 = STRING:
DISMAN-EVENT-MIB::mteHotOID.0 = OID:
UCD-SNMP-MIB::laErrorFlag.2
DISMAN-EVENT-MIB::mteHotValue.0 = INTEGER: 1
UCD-SNMP-MIB::laNames.2 = STRING: Load-5
UCD-SNMP-MIB::laErrMessage.2 = STRING: 5 min Load Average too high (= 2.00)
2018-01-26 14:35:54 <UNKNOWN> [UDP: [192.168.123.247]:60418->[192.168.123.17]:162]:
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (13) 0:00:00.13
SNMPv2-MIB::snmpTrapOID.0 = OID:
DISMAN-EVENT-MIB::mteTriggerFired
DISMAN-EVENT-MIB::mteHotTrigger.0 = STRING: laTable
DISMAN-EVENT-MIB::mteHotTargetName.0 = STRING:
DISMAN-EVENT-MIB::mteHotContextName.0 = STRING:
DISMAN-EVENT-MIB::mteHotOID.0 = OID:
UCD-SNMP-MIB::laErrorFlag.3
DISMAN-EVENT-MIB::mteHotValue.0 = INTEGER: 1
UCD-SNMP-MIB::laNames.3 = STRING: Load-15
UCD-SNMP-MIB::laErrMessage.3 = STRING: 15 min Load Average too high (= 2.05)
Used memory
This trap is sent if used memory on the local system exceeds the specified percentage. The default value is 80%. The following example shows an event triggered by memory usage that exceeded the configured trap threshold:
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (8) 0:00:00.08
SNMPv2-MIB::snmpTrapOID.0 = OID:
DISMAN-EVENT-MIB::mteTriggerFired
DISMAN-EVENT-MIB::mteHotTrigger.0 = STRING: memoryFree
DISMAN-EVENT-MIB::mteHotTargetName.0 = STRING:
DISMAN-EVENT-MIB::mteHotContextName.0 = STRING:
DISMAN-EVENT-MIB::mteHotOID.0 = OID:
UCD-SNMP-MIB::memTotalFree.0
DISMAN-EVENT-MIB::mteHotValue.0 = INTEGER: 2124816
UCD-SNMP-MIB::memTotalReal.0 = INTEGER: 16467096 kB
Used disk space
This trap is sent if used disk space on any of the mounted disks exceeds the specified percentage. The default value is 90%. The following example shows an event triggered by a disk with less than 10% of free disk space on the /boot partition:
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (25) 0:00:00.25
SNMPv2-MIB::snmpTrapOID.0 = OID:
DISMAN-EVENT-MIB::mteTriggerFired
DISMAN-EVENT-MIB::mteHotTrigger.0 = STRING: dskTable
DISMAN-EVENT-MIB::mteHotTargetName.0 = STRING:
DISMAN-EVENT-MIB::mteHotContextName.0 = STRING:
DISMAN-EVENT-MIB::mteHotOID.0 = OID:
UCD-SNMP-MIB::dskErrorFlag.26
DISMAN-EVENT-MIB::mteHotValue.0 = INTEGER: 1
UCD-SNMP-MIB::dskPath.26 = STRING: /boot
UCD-SNMP-MIB::dskErrorMsg.26 = STRING: /boot: less than 10% free (= 8%)
Spectra Detect queue size
This trap is sent if the number of messages in any of the queues used for Spectra Detect communication exceeds the specified value. Since the check is performed once every minute, it is possible to have the peak message count in the queue higher than the threshold, if the duration of the peak was shorter than 1 minute.
Logged events have two values: name of the queue that triggered the event and the size of the queue at the moment the event was triggered.
Classifications queue size
This trap is sent if the number of messages in any of the queues used for classifications exceeds the specified value. Since the check is performed once every minute, it is possible to have the peak message count in the queue higher than the threshold, if the duration of the peak was shorter than 1 minute.
Logged events have two values: name of the queue that triggered the event and the size of the queue at the moment the event was triggered.
Spectra Analyze MIB Descriptions
MIB file | Value | Description | Usage |
---|---|---|---|
RL-MIB.txt | a1000 | Device identifier | not displayed |
RL-TCBASE-MIB.txt | tcbQueuesApiLongState | State for api_longrunning queue | Spectra Detect Manager > Spectra Analyze > Queues table |
tcbQueuesApiLongCons | Number of consumers for api_longrunning queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesApiLongMsg | Number of messages for api_longrunning queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesApiReqsState | State for api_requests queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesApiReqsCons | Number of consumers for api_requests queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesApiReqsMsg | Number of messages for api_requests queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesCeleryState | State for celery queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesCeleryCons | Number of consumers for celery queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesCeleryMsg | Number of messages for celery queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesDefaultState | State for default queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesDefaultCons | Number of consumers for default queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesDefaultMsg | Number of messages for default queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksApiState | State for tasks.api queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksApiCons | Number of consumers for tasks.api queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksApiMsg | Number of messages for tasks.api queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksApiLongState | State for tasks.api.longrunning queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksApiLongCons | Number of consumers for tasks.api.longrunning queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksApiLongMsg | Number of messages for tasks.api.longrunning queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksApiReqState | State for tasks.api.requests queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksApiReqCons | Number of consumers for tasks.api.requests queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksApiReqMsg | Number of messages for tasks.api.requests queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksClassState | State for tasks.classification queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksClassCons | Number of consumers for tasks.classification queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksClassMsg | Number of messages for tasks.classification queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksDefaultState | State for tasks.default queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksDefaultCons | Number of consumers for tasks.default queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksDefaultMsg | Number of messages for tasks.default queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksTransferState | State for tasks.transfer queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksTransferCons | Number of consumers for tasks.transfer queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksTransferMsg | Number of messages for tasks.transfer queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksIntegrationsState | State for tasks.integrations queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksIntegrationsCons | Number of consumers for tasks.integrations queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTasksIntegrationsMsg | Number of messages for tasks.integrations queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTcbaseCollectorState | State for tcbase.collector queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTcbaseCollectorCons | Number of consumers for tcbase.collector queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesTcbaseCollectorMsg | Number of messages for tcbase.collector queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesHagentErrorState | State for tiscale.hagent_error queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesHagentErrorCons | Number of consumers for tiscale.hagent_error queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesHagentErrorMsg | Number of messages for tiscale.hagent_error queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesHagentInputState | State for tiscale.hagent_input queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesHagentInputCons | Number of consumers for tiscale.hagent_input queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesHagentInputMsg | Number of messages for tiscale.hagent_input queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesHagentRetryState | State for tiscale.hagent_retry queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesHagentRetryCons | Number of consumers for tiscale.hagent_retry queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueuesHagentRetryMsg | Number of messages for tiscale.hagent_retry queue | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueueName | Queue name | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueueSize | Queue size | Spectra Detect Manager > Spectra Analyze > Queues table | |
tcbQueueThreshold | Queue size exceeded configured threshold | Spectra Detect Manager > Spectra Analyze > Queues table | |
redundancyTrigger | Failover on HA system | not displayed (Spectra Analyze > redundancy) | |
redundancyTriggerOk | HA System resumed operation | not displayed (Spectra Analyze > redundancy) | |
SNMPv2-MIB.txt | sysName | An administratively-assigned name for this managed node. By convention, this is the node’s fully-qualified domain name. If the name is unknown, the value is the zero-length string. | Spectra Detect Manager > Spectra Analyze > System table |
sysUpTime | The time (in hundredths of a second) since the network management portion of the system was last re-initialized. | Spectra Detect Manager > Spectra Analyze > System table | |
sysContact | The textual identification of the contact person for this managed node, together with information on how to contact this person. If no contact information is known, the value is the zero-length string. | not displayed | |
sysLocation | The physical location of this node (e.g., ‘telephone closet, 3rd floor’). If the location is unknown, the value is the zero-length string. | Spectra Detect Manager > Spectra Analyze > System table | |
sysDescr | A textual description of the entity. This value should include the full name and version identification of the system’s hardware type, software operating-system, and networking software. | Spectra Detect Manager > Spectra Analyze > System table | |
HOST-RESOURCES-MIB.txt | hrProcessorLoad | The average, over the last minute, of the percentage of time that this processor was not idle. Implementations may approximate this one minute smoothing period if necessary. | Spectra Detect Manager > Spectra Analyze > CPU table |
hrStorageTable | A (conceptual) entry for one logical storage area on the host. As an example, an instance of the hrStorageType object might be named hrStorageType.3 | Spectra Detect Manager > Spectra Analyze > Storage table | |
hrStorageSize | The size of the storage represented by this entry, in units of hrStorageAllocationUnits. This object is writable to allow remote configuration of the size of the storage area in those cases where such an operation makes sense and is possible on the underlying system. For example, the amount of main memory allocated to a buffer pool might be modified or the amount of disk space allocated to virtual memory might be modified. | Spectra Detect Manager > Spectra Analyze > Storage table | |
hrStorageType | The type of storage represented by this entry. | Spectra Detect Manager > Spectra Analyze > Storage table | |
hrStorageUsed | The amount of the storage represented by this entry that is allocated, in units of hrStorageAllocationUnits. | Spectra Detect Manager > Spectra Analyze > Storage table | |
hrStorageDescr | A description of the type and instance of the storage described by this entry. | Spectra Detect Manager > Spectra Analyze > Storage table | |
hrStorageAllocationUnits | The size, in bytes, of the data objects allocated from this pool. If this entry is monitoring sectors, blocks, buffers, or packets, for example, this number will commonly be greater than one. Otherwise this number will typically be one. | Spectra Detect Manager > Spectra Analyze > Storage table | |
UCD-SNMP-MIB.txt | memory | Memory usage/watch reporting object. | Spectra Detect Manager > Spectra Analyze > Memory table |
memIndex | Bogus Index. This should always return the integer 0. | Spectra Detect Manager > Spectra Analyze > Memory table | |
memBuffer | The total amount of real or virtual memory currently allocated for use as memory buffers. This object will not be implemented on hosts where the underlying operating system does not explicitly identify memory as specifically reserved for this purpose. | Spectra Detect Manager > Spectra Analyze > Memory table | |
memCached | The total amount of real or virtual memory currently allocated for use as cached memory. This object will not be implemented on hosts where the underlying operating system does not explicitly identify memory as specifically reserved for this purpose. | Spectra Detect Manager > Spectra Analyze > Memory table | |
memAvailReal | The amount of real/physical memory currently unused or available. | Spectra Detect Manager > Spectra Analyze > Memory table | |
memAvailSwap | The amount of swap space currently unused or available. | Spectra Detect Manager > Spectra Analyze > Memory table | |
memErrorName | Bogus Name. This should always return the string ‘swap’. | Spectra Detect Manager > Spectra Analyze > Memory table | |
memTotalReal | The total amount of real/physical memory installed on this host. | Spectra Detect Manager > Spectra Analyze > Memory table | |
memTotalSwap | The total amount of swap space configured for this host. | Spectra Detect Manager > Spectra Analyze > Memory table | |
IF-MIB.txt | ifType | The type of interface. Additional values for ifType are assigned by the Internet Assigned Numbers Authority (IANA), through updating the syntax of the IANAifType textual convention. | Spectra Detect Manager > Spectra Analyze > Network table |
ifSpeed | An estimate of the interface’s current bandwidth in bits per second. For interfaces which do not vary in bandwidth or for those where no accurate estimation can be made, this object should contain the nominal bandwidth. If the bandwidth of the interface is greater than the maximum value reportable by this object then this object should report its maximum value (4,294,967,295) and ifHighSpeed must be used to report the interace’s speed. For a sub-layer which has no concept of bandwidth, this object should be zero. | Spectra Detect Manager > Spectra Analyze > Network table | |
ifInOctets | The total number of octets received on the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime. | Spectra Detect Manager > Spectra Analyze > Network table | |
ifOutOctets | The total number of octets transmitted out of the interface, including framing characters. Discontinuities in the value of this counter can occur at re-initialization of the management system, and at other times as indicated by the value of ifCounterDiscontinuityTime.” | Spectra Detect Manager > Spectra Analyze > Network table | |
ifDescr | A textual string containing information about the interface. This string should include the name of the manufacturer, the product name and the version of the interface hardware/software. | Spectra Detect Manager > Spectra Analyze > Network table | |
ifPhysAddress | The interface’s address at its protocol sub-layer. For example, for an 802.x interface, this object normally contains a MAC address. The interface’s media-specific MIB must define the bit and byte ordering and the format of the value of this object. For interfaces which do not have such an address (e.g., a serial line), this object should contain an octet string of zero length. | Spectra Detect Manager > Spectra Analyze > Network table | |
ifOperStatus | The current operational state of the interface. The testing(3) state indicates that no operational packets can be passed. If ifAdminStatus is down(2) then ifOperStatus should be down(2). If ifAdminStatus is changed to up(1) then ifOperStatus should change to up(1) if the interface is ready to transmit and receive network traffic; it should change to dormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection); it should remain in the down(2) state if and only if there is a fault that prevents it from going to the up(1) state; it should remain in the notPresent(6) state if the interface has missing (typically, hardware) components. | Spectra Detect Manager > Spectra Analyze > Network table | |
ifAdminStatus | The desired state of the interface. The testing(3) state indicates that no operational packets can be passed. When a managed system initializes, all interfaces start with ifAdminStatus in the down(2) state. As a result of either explicit management action or per configuration information retained by the managed system, ifAdminStatus is then changed to either the up(1) or testing(3) states (or remains in the down(2) state). | Spectra Detect Manager > Spectra Analyze > Network table |