Skip to main content
Version: Spectra Analyze 9.7.0

Appendix: Technical reference

Overview

This section provides a technical reference for some of the Spectra Analyze appliance configuration options.

SNMP trap thresholds

info

For more information, see SNMP.

The Spectra Analyze appliance can receive notifications, or traps, about important system events via the Simple Network Management Protocol (SNMP).

Traps used for monitoring the average system load, and 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 & Update > Configuration > SNMP dialog on the Spectra Analyze appliance. The dialog also allows setting thresholds for Supported events, described in more detail below.

Average system load

This trap is sent if the average load of the local system exceeds specified values of 1-minute, 5-minute or 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, the 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, the 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 ModuleValueOIDDescription
RL-MIBdevice.1.3.6.1.4.1.48699.1.1
RL-MIBa1000.1.3.6.1.4.1.48699.1.1.2
RL-TCBASE-MIBtcbMib.1.3.6.1.4.1.48699.1.1.2.1
RL-TCBASE-MIBtcbMibObjects.1.3.6.1.4.1.48699.1.1.2.1.1
RL-TCBASE-MIBtcbScalars.1.3.6.1.4.1.48699.1.1.2.1.1.1
RL-TCBASE-MIBtcbQueuesApiLongState.1.3.6.1.4.1.48699.1.1.2.1.1.1.1State for api_longrunning queue.
RL-TCBASE-MIBtcbQueuesApiLongCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.2Number of consumers for api_longrunning queue.
RL-TCBASE-MIBtcbQueuesApiLongMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.3Number of messages for api_longrunning queue.
RL-TCBASE-MIBtcbQueuesApiReqsState.1.3.6.1.4.1.48699.1.1.2.1.1.1.4State for api_requests queue.
RL-TCBASE-MIBtcbQueuesApiReqsCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.5Number of consumers for api_requests queue.
RL-TCBASE-MIBtcbQueuesApiReqsMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.6Number of messages for api_requests queue.
RL-TCBASE-MIBtcbQueuesCeleryState.1.3.6.1.4.1.48699.1.1.2.1.1.1.7State for celery queue.
RL-TCBASE-MIBtcbQueuesCeleryCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.8Number of consumers for celery queue.
RL-TCBASE-MIBtcbQueuesCeleryMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.9Number of messages for celery queue.
RL-TCBASE-MIBtcbQueuesDefaultState.1.3.6.1.4.1.48699.1.1.2.1.1.1.10State for default queue queue.
RL-TCBASE-MIBtcbQueuesDefaultCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.11Number of consumers for default queue.
RL-TCBASE-MIBtcbQueuesDefaultMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.12Number of messages for default queue.
RL-TCBASE-MIBtcbQueuesTasksApiState.1.3.6.1.4.1.48699.1.1.2.1.1.1.13State for tasks.api queue.
RL-TCBASE-MIBtcbQueuesTasksApiCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.14Number of consumers for tasks.api queue.
RL-TCBASE-MIBtcbQueuesTasksApiMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.15Number of messages for tasks.api queue.
RL-TCBASE-MIBtcbQueuesTasksApiLongState.1.3.6.1.4.1.48699.1.1.2.1.1.1.16State for tasks.api.longrunning queue.
RL-TCBASE-MIBtcbQueuesTasksApiLongCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.17Number of consumers for tasks.api.longrunning queue.
RL-TCBASE-MIBtcbQueuesTasksApiLongMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.18Number of messages for tasks.api.longrunning queue.
RL-TCBASE-MIBtcbQueuesTasksApiReqState.1.3.6.1.4.1.48699.1.1.2.1.1.1.19State for tasks.api.requests queue.
RL-TCBASE-MIBtcbQueuesTasksApiReqCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.20Number of consumers for tasks.api.requests queue.
RL-TCBASE-MIBtcbQueuesTasksApiReqMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.21Number of messages for tasks.api.requests queue.
RL-TCBASE-MIBtcbQueuesTasksClassState.1.3.6.1.4.1.48699.1.1.2.1.1.1.22State for tasks.classification queue.
RL-TCBASE-MIBtcbQueuesTasksClassCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.23Number of consumers for tasks.classification queue.
RL-TCBASE-MIBtcbQueuesTasksClassMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.24Number of messages for tasks.classification queue.
RL-TCBASE-MIBtcbQueuesTasksDefaultState.1.3.6.1.4.1.48699.1.1.2.1.1.1.25State for tasks.default queue.
RL-TCBASE-MIBtcbQueuesTasksDefaultCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.26Number of consumers for tasks.default queue.
RL-TCBASE-MIBtcbQueuesTasksDefaultMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.27Number of messages for tasks.default queue.
RL-TCBASE-MIBtcbQueuesTasksTransferState.1.3.6.1.4.1.48699.1.1.2.1.1.1.28State for tasks.transfer queue.
RL-TCBASE-MIBtcbQueuesTasksTransferCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.29Number of consumers for tasks.transfer queue.
RL-TCBASE-MIBtcbQueuesTasksTransferMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.30Number of messages for tasks.transfer queue.
RL-TCBASE-MIBtcbQueuesTcbaseCollectorState.1.3.6.1.4.1.48699.1.1.2.1.1.1.31State for tcbase.collector queue.
RL-TCBASE-MIBtcbQueuesTcbaseCollectorCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.32Number of consumers for tcbase.collector queue.
RL-TCBASE-MIBtcbQueuesTcbaseCollectorMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.33Number of messages for tcbase.collector queue.
RL-TCBASE-MIBtcbQueuesHagentErrorState.1.3.6.1.4.1.48699.1.1.2.1.1.1.34State for tiscale.hagent_error queue.
RL-TCBASE-MIBtcbQueuesHagentErrorCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.35Number of consumers for tiscale.hagent_error queue.
RL-TCBASE-MIBtcbQueuesHagentErrorMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.36Number of messages for tiscale.hagent_error queue.
RL-TCBASE-MIBtcbQueuesHagentInputState.1.3.6.1.4.1.48699.1.1.2.1.1.1.37State for tiscale.hagent_input queue.
RL-TCBASE-MIBtcbQueuesHagentInputCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.38Number of consumers for tiscale.hagent_input queue.
RL-TCBASE-MIBtcbQueuesHagentInputMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.39Number of messages for tiscale.hagent_input queue.
RL-TCBASE-MIBtcbQueuesHagentRetryState.1.3.6.1.4.1.48699.1.1.2.1.1.1.40State for tiscale.hagent_retry queue.
RL-TCBASE-MIBtcbQueuesHagentRetryCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.41Number of consumers for tiscale.hagent_retry queue.
RL-TCBASE-MIBtcbQueuesHagentRetryMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.42Number of messages for tiscale.hagent_retry queue.
RL-TCBASE-MIBtcbQueueName.1.3.6.1.4.1.48699.1.1.2.1.1.1.43Queue name.
RL-TCBASE-MIBtcbQueueSize.1.3.6.1.4.1.48699.1.1.2.1.1.1.44Queue size.
RL-TCBASE-MIBtcbQueuesTasksIntegrationsState.1.3.6.1.4.1.48699.1.1.2.1.1.1.45State for tasks.integrations queue.
RL-TCBASE-MIBtcbQueuesTasksIntegrationsCons.1.3.6.1.4.1.48699.1.1.2.1.1.1.46Number of consumers for tasks.integrations queue.
RL-TCBASE-MIBtcbQueuesTasksIntegrationsMsg.1.3.6.1.4.1.48699.1.1.2.1.1.1.47Number of messages for tasks.integrations queue.
RL-TCBASE-MIBtcbTables.1.3.6.1.4.1.48699.1.1.2.1.1.2
RL-TCBASE-MIBtcbMibNotifications.1.3.6.1.4.1.48699.1.1.2.1.2
RL-TCBASE-MIBtcbQueueThreshold.1.3.6.1.4.1.48699.1.1.2.1.2.1Queue size exceeded configured threshold.
RL-TCBASE-MIBredundancyTrigger.1.3.6.1.4.1.48699.1.1.2.1.2.2Failover on HA system.
RL-TCBASE-MIBredundancyTriggerOk.1.3.6.1.4.1.48699.1.1.2.1.2.3HA System resumed operation.
RL-TCBASE-MIBtcbMibConformance.1.3.6.1.4.1.48699.1.1.2.1.3

Download the MIB file in CSV format.

System alerting

info

For more information, see System alerting.

If system alerting is enabled under Administration > Configuration & Update > Configuration > System alerting, the following system operations and services are monitored. Syslog notifications are sent when any of the services or operations meets the condition(s) defined in the table.

SYSTEM OPERATION OR SERVICENOTIFICATION TRIGGER
RAMUsage is over 90% for 10 minutes.
CPUUsage is over 40% for 2 minutes.
CPU wait (waiting for IO)Over 20% for 2 minutes.
Disk usageOver 90% for 10 minutes.
UWSGI serviceDown for 2 minutes.
NGINX serviceDown for 2 minutes.
RABBIT-MQ serviceDown for 2 minutes.
POSTGRES serviceDown for 2 minutes.
MEMCACHED serviceDown for 2 minutes.
CROND serviceDown for 2 minutes.
SSHD serviceDown for 2 minutes.
SUPERVISORD serviceDown for 2 minutes.
SMTPEnabled, but stopped for 4 minutes.
NTPDEnabled, but stopped for 4 minutes.
Any of the SUPERVISORD servicesCrashed.
SCALE socketNot detected/does not exist for 4 minutes.
SCALE INPUT queueReceiving over 500 messages for 10 minutes.
SCALE RETRY queueReceiving over 100 messages for 10 minutes.
COLLECTOR queueReceiving over 1000 messages for 10 minutes.
CLASSIFICATION queueReceiving over 5000 messages for 10 minutes.

Connector alerts

When Connectors are configured and running, CEF messages for supported events are sent to syslog if system alerting is properly configured on the appliance.

Most alerts are shared between connectors, but there are some connector-specific messages. For the full list of all supported CEF event fields, refer to the table below.

info

Threat detection CEF messages are sent only when the Enable automatic file sorting option is selected in the Connectors configuration dialog.

CEF event formatting schema

CEF:0|{device.vendor}|{device.name}|{device.version}|{signature.id}|{name}|{severity}|
csxLabel={label.value} csx={field.value}

CEF event fields

Signature IDsCEF event fieldDescriptionSupported connectors
Threat detectioncs1Labelcs1 field label. Always equals classification.Network File Share, AbuseBox, S3
Threat detectioncs1File classification status (malicious, suspicious, goodware, unknown).Network File Share, AbuseBox, S3
Threat detectioncs2labelcs2 field label. Always equals detectionName.Network File Share, AbuseBox, S3
Threat detectioncs2The detected threat name, formatted according to the Malware naming standard.Network File Share, AbuseBox, S3
Threat detectioncs3labelcs3 field label. Always equals detectionReason.Network File Share, AbuseBox, S3
Threat detectioncs3The appliance that analyzed and classified the file. Possible values are A1000, TitaniumScale.Network File Share, AbuseBox, S3
connector_healthcs4Labelcs4 field label. Always equals app_health.Network File Share, AbuseBox, S3
connector_healthcs4Sent if there are any errors or performance issues with the connector or the appliance. Always equals FAILED.Network File Share, AbuseBox, S3
connector_mount_success, connector_mount_failurecs5Labelcs5 field label. Always equals mount.Network File Share
connector_mount_success, connector_mount_failurecs5Sent on network resource mount events. Possible values are SUCCESS for connector_mount_success and FAILED for connector_mount_failure.Network File Share
connector_readcs6Labelcs6 field label. Always equals file_read.Network File Share, AbuseBox, S3
connector_readcs6Sent when the connector fails to read the file from the connected storage/mail account. Always equals FAILED.Network File Share, AbuseBox, S3
connector_uploadcs7Labelcs7 field label. Always equals analysis.Network File Share, AbuseBox, S3
connector_uploadcs7Sent when files fail to upload to the appliance for analysis. Always equals FAILED.Network File Share, AbuseBox, S3
connector_move_filescs8Labelcs8 field label. Always equals file_moving.Network File Share, S3
connector_move_filescs8If advanced file sorting is enabled for the connector, this event is sent for each file move. Possible values are FAILED, SUCCESS.Network File Share, S3
connector_unmount_success, connector_unmount_failurecs9Labelcs9 field label for connector unmount events. Always equals unmount.Network File Share
connector_unmount_success, connector_unmount_failurecs9Shows the network resource unmount status. Possible values are SUCCESS for connector_unmount_success and FAILED for connector_unmount_failure.Network File Share
Threat detection, connector_move_files, connector_upload, connector_readcs9Labelcs9 field label for events related to file operations. Always equals fileName.Network File Share, S3
Threat detection, connector_move_files, connector_upload, connector_readcs9Shows the name of the file related to the specific event.Network File Share, S3
connector_unmount_success, connector_unmount_failurecs10Labelcs10 field label. Always equals mountAddress.Network File Share
All event types except Threat detectioncs10The address of the network resource.Network File Share
connector_email_fetch_failure, connector_email_fetch_successcs11Labelcs11 field label. Always equals email_fetch.AbuseBox
connector_email_fetch_failure, connector_email_fetch_successcs11Sent when the connector fails/succeeds in downloading an email message from the connected email account to the appliance. Always equals FAILED for connector_email_fetch_failure and SUCCESS for connector_email_fetch_success.AbuseBox
connector_email_fetch_failure, connector_email_fetch_successcs12Labelcs12 field label. Always equals exchangeServer.AbuseBox
connector_email_fetch_failure, connector_email_fetch_successcs12The address of the Exchange server (without the protocol scheme) from which the connector is attempting to retrieve email.AbuseBox
connector_email_fetch_failurecs13Labelcs13 field label. Always equals failure_reason.AbuseBox
connector_email_fetch_failurecs13The reason why email failed to download. Possible values are:connection error, non_existing_smtp_address,authentication_error, non_existing_inbox_folder,disk_threshold_reached.AbuseBox
connector_move_filescs14Labelcs14 field label. Always equals destination.AbuseBox
connector_move_filescs14If advanced file sorting is enabled for the connector, this is the destination where the file was moved during processing.Network File Share, S3
All CEF messages except those that already contain the mountAddress fieldcs15Labelcs15 field label. Always equals sourceAddress.Network File Share, S3
All CEF messages except those that already contain the mountAddress fieldcs15The address of the file source (for example, a network file share, or an S3 bucket).Network File Share, S3

Examples

Success mounting a network drive (Network File Share)

CEF:0|ReversingLabs|TitaniumCore|3.9.3.0|connector_mount_success|connector_mount_success|0|
cs5Label=mount cs5=SUCCESS

Failure reading files from a network drive (Network File Share)

CEF:0|ReversingLabs|TitaniumCore|3.9.3.0|connector_read|connector_read|10|cs6Label=file_read
cs6=FAILED cs9Label=fileName cs9=/mnt/incoming/installer.msi

Threat detection for files uploaded from a network drive (Network File Share)

CEF:0|ReversingLabs|TitaniumCore|3.9.3.0|detection|Threat detection|10|fileHash=93f5a83b850becd35f12fca8acs907ead
cs2Label=classification cs2=malicious cs1Label=detectionName cs1=ByteCode-MSIL.Trojan.Genkryptik reason=cloud

Success fetching email (AbuseBox)

CEF:0|ReversingLabs|A1000|5.11.0|connector_email_fetch_success|connector_email_fetch_success|0|
cs12Label=exchangeServer cs12=devops-exchange.exch.rl.lan cs11Label=email_fetch cs11=SUCCESS

Failure fetching email (AbuseBox)

CEF:0|ReversingLabs|A1000|5.11.0|connector_email_fetch_failure|connector_email_fetch_failure|10|
cs13Label=failure_reason cs13=authentication_error cs12Label=exchangeServer cs12=devops-exchange.exch.rl.lan cs11Label=email_fetch cs11=FAILED

Connector/appliance in an unhealthy state (Network File Share, AbuseBox, S3)

CEF:0|ReversingLabs|A1000|5.11.0|connector_health|connector_health|10|cs4Label=app_health cs4=FAILED

Failed file upload (Network File Share, AbuseBox, S3)

CEF:0|ReversingLabs|A1000|5.11.0|connector_upload|connector_upload|10|cs9Label=fileName cs9=application_windows.exe cs7Label=analysis cs7=FAILED

Successful file move (Network File Share, S3)

CEF:0|ReversingLabs|A1000|5.10.8-1|connector_move_files|connector_move_files|0|cs9Label=fileName cs9=BavPro_Setup_GL.zip cs8Label=file_moving cs8=SUCCESS cs14Label=destination cs14=/Malicious/BavPro_Setup_GL.zip