Event Definitions: Difference between revisions
m (Dmorris moved page Events to Event Definitions without leaving a redirect) |
No edit summary |
||
Line 29: | Line 29: | ||
|String | |String | ||
|The key | |The key | ||
|- | |||
|oldValue | |||
|String | |||
|The old value | |||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 66: | Line 70: | ||
|String | |String | ||
|The MAC address | |The MAC address | ||
|- | |||
|oldValue | |||
|String | |||
|The old value | |||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 78: | Line 86: | ||
== | == UserTableEvent == | ||
<section begin=' | <section begin='UserTableEvent' /> | ||
These events are created by the | These events are created by the base system and inserted to the [[Database_Schema#user_table_updates|user_table_updates]] table when the user table is modified. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 87: | Line 95: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |- | ||
|class | |class | ||
Line 100: | Line 100: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |key | ||
| | |String | ||
|The | |The key | ||
|- | |- | ||
| | |oldValue | ||
| | |String | ||
|The | |The old value | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|- | |||
|username | |||
|String | |||
|The username | |||
|- | |||
|value | |||
|String | |||
|The value | |||
|} | |} | ||
<section end=' | <section end='UserTableEvent' /> | ||
Line 148: | Line 156: | ||
|long | |long | ||
|The number of bytes sent from the server to Untangle | |The number of bytes sent from the server to Untangle | ||
|- | |||
|sessionEvent | |||
|SessionEvent | |||
|The session event | |||
|- | |- | ||
|sessionId | |sessionId | ||
Line 170: | Line 182: | ||
! Description | ! Description | ||
|- | |- | ||
| | |CClientAddr | ||
|InetAddress | |InetAddress | ||
|The client-side (pre-NAT) client address | |The client-side (pre-NAT) client address | ||
|- | |- | ||
| | |CClientPort | ||
|Integer | |Integer | ||
|The client-side (pre-NAT) client port | |The client-side (pre-NAT) client port | ||
|- | |- | ||
| | |CServerAddr | ||
|InetAddress | |InetAddress | ||
|The client-side (pre-NAT) server address | |The client-side (pre-NAT) server address | ||
|- | |- | ||
| | |CServerPort | ||
|Integer | |Integer | ||
|The client-side (pre-NAT) server port | |The client-side (pre-NAT) server port | ||
|- | |- | ||
| | |SClientAddr | ||
|InetAddress | |InetAddress | ||
|The server-side (post-NAT) client address | |The server-side (post-NAT) client address | ||
|- | |- | ||
| | |SClientPort | ||
|Integer | |Integer | ||
|The server-side (post-NAT) client port | |The server-side (post-NAT) client port | ||
|- | |- | ||
| | |SServerAddr | ||
|InetAddress | |InetAddress | ||
|The server-side (post-NAT) server address | |The server-side (post-NAT) server address | ||
|- | |- | ||
| | |SServerPort | ||
|Integer | |Integer | ||
|The server-side (post-NAT) server port | |The server-side (post-NAT) server port | ||
Line 285: | Line 297: | ||
|Long | |Long | ||
|The session ID | |The session ID | ||
|- | |||
|tagsString | |||
|String | |||
|The string value of all tags | |||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 340: | Line 356: | ||
! Description | ! Description | ||
|- | |- | ||
| | |SClientAddr | ||
|InetAddress | |InetAddress | ||
|The server-side (post-NAT) client address | |The server-side (post-NAT) client address | ||
|- | |- | ||
| | |SClientPort | ||
|Integer | |Integer | ||
|The server-side (post-NAT) client port | |The server-side (post-NAT) client port | ||
|- | |- | ||
| | |SServerAddr | ||
|InetAddress | |InetAddress | ||
|The server-side (post-NAT) server address | |The server-side (post-NAT) server address | ||
|- | |- | ||
| | |SServerPort | ||
|Integer | |Integer | ||
|The server-side (post-NAT) server port | |The server-side (post-NAT) server port | ||
Line 363: | Line 379: | ||
|Integer | |Integer | ||
|The server interface ID | |The server interface ID | ||
|- | |||
|sessionEvent | |||
|SessionEvent | |||
|The session event | |||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 384: | Line 404: | ||
|int | |int | ||
|The action (1=Quota Given, 2=Quota Exceeded) | |The action (1=Quota Given, 2=Quota Exceeded) | ||
|- | |- | ||
|class | |class | ||
|Class | |Class | ||
|The class name | |The class name | ||
|- | |||
|entity | |||
|String | |||
|The entity | |||
|- | |- | ||
|quotaSize | |quotaSize | ||
Line 441: | Line 461: | ||
== | == AdminLoginEvent == | ||
<section begin=' | <section begin='AdminLoginEvent' /> | ||
These base | These events are created by the base system and inserted to the [[Database_Schema#user_table_updates|admin_logins]] table when an administrator login is attempted or successful. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 454: | Line 474: | ||
|Class | |Class | ||
|The class name | |The class name | ||
|- | |||
|clientAddress | |||
|InetAddress | |||
|The client address | |||
|- | |||
|local | |||
|boolean | |||
|1 if login is done via local console, 0 otherwise | |||
|- | |||
|login | |||
|String | |||
|The login username | |||
|- | |||
|reason | |||
|String | |||
|The reason | |||
|- | |||
|succeeded | |||
|boolean | |||
|1 if successful, 0 otherwise | |||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 459: | Line 499: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='AdminLoginEvent' /> | ||
== | == AlertEvent == | ||
<section begin=' | <section begin='AlertEvent' /> | ||
These events are created by | These events are created by [[Reports]] and inserted to the [[Database_Schema#alerts|alerts]] table when an alert fires. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 471: | Line 511: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |||
|causalRule | |||
|EventRule | |||
|The causal rule | |||
|- | |||
|cause | |||
|LogEvent | |||
|The cause | |||
|- | |- | ||
|class | |class | ||
Line 476: | Line 524: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |description | ||
| | |String | ||
|The | |The description | ||
|- | |||
|eventSent | |||
|Boolean | |||
|True if the event was sent, false otherwise | |||
|- | |||
|json | |||
|String | |||
|The JSON string | |||
|- | |- | ||
| | |summaryText | ||
| | |String | ||
|The | |The summary text | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='AlertEvent' /> | ||
== | == LogEvent == | ||
<section begin=' | <section begin='LogEvent' /> | ||
These events | These base class for all events. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 505: | Line 557: | ||
! Description | ! Description | ||
|- | |- | ||
| | |class | ||
| | |Class | ||
|The | |The class name | ||
|- | |||
|timeStamp | |||
|Timestamp | |||
|The timestamp | |||
|} | |||
<section end='LogEvent' /> | |||
== InterfaceStatEvent == | |||
<section begin='InterfaceStatEvent' /> | |||
These events are created by the base system and inserted to the [[Database_Schema#settings_changes|interface_stat_events]] table periodically with interface stats. | |||
{| border="1" cellpadding="2" width="90%" align="center" | |||
! Attribute Name | |||
! Type | |||
! Description | |||
|- | |- | ||
|class | |class | ||
Line 513: | Line 582: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |interfaceId | ||
| | |int | ||
|The | |The interface ID | ||
|- | |- | ||
| | |rxBytes | ||
| | |double | ||
|The | |The total of received bytes | ||
|- | |- | ||
| | |rxRate | ||
| | |double | ||
|The | |The RX rate in byte/s | ||
|- | |- | ||
| | |timeStamp | ||
| | |Timestamp | ||
|The | |The timestamp | ||
|- | |- | ||
| | |txBytes | ||
| | |double | ||
|The total | |The total of transmitted bytes | ||
|- | |- | ||
| | |txRate | ||
| | |double | ||
|The | |The TX rate in byte/s | ||
|} | |||
<section end='InterfaceStatEvent' /> | |||
== SystemStatEvent == | |||
<section begin='SystemStatEvent' /> | |||
These events are created by the base system and inserted to the [[Database_Schema#server_events|server_events]] table periodically. | |||
{| border="1" cellpadding="2" width="90%" align="center" | |||
! Attribute Name | |||
! Type | |||
! Description | |||
|- | |||
|activeHosts | |||
|int | |||
|The active host count | |||
|- | |- | ||
| | |class | ||
| | |Class | ||
|The | |The class name | ||
|- | |- | ||
| | |cpuSystem | ||
|float | |float | ||
|The | |The system CPU utilization | ||
|- | |- | ||
|load15 | |cpuUser | ||
|float | |||
|The user CPU utilization | |||
|- | |||
|diskFree | |||
|long | |||
|The amount of disk free | |||
|- | |||
|diskFreePercent | |||
|float | |||
|The percentage of disk free | |||
|- | |||
|diskTotal | |||
|long | |||
|The total size of the disk | |||
|- | |||
|diskUsed | |||
|long | |||
|The amount of disk used | |||
|- | |||
|diskUsedPercent | |||
|float | |||
|The percentage of disk used | |||
|- | |||
|load1 | |||
|float | |||
|The 1-minute CPU load | |||
|- | |||
|load15 | |||
|float | |float | ||
|The 15-minute CPU load | |The 15-minute CPU load | ||
Line 608: | Line 722: | ||
== | == CaptivePortalUserEvent == | ||
<section begin=' | <section begin='CaptivePortalUserEvent' /> | ||
These events are created by [[Captive Portal]] and inserted to the [[Database_Schema#captive_portal_user_events|captive_portal_user_events]] table when Captive Portal user takes amconsole: | |||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
! Attribute Name | ! Attribute Name | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |||
|authenticationType | |||
|CaptivePortalSettings$AuthenticationType | |||
|The authentication type | |||
|- | |||
|authenticationTypeValue | |||
|String | |||
|The authentication type as a string | |||
|- | |- | ||
|class | |class | ||
Line 622: | Line 743: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |clientAddr | ||
| | |String | ||
|The | |The client address | ||
|- | |- | ||
| | |event | ||
| | |CaptivePortalUserEvent$EventType | ||
|The | |The event (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT) | ||
|- | |- | ||
| | |eventValue | ||
| | |String | ||
|The | |The event value as a string (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT) | ||
|- | |- | ||
| | |loginName | ||
|String | |String | ||
|The name | |The login name | ||
|- | |||
|policyId | |||
|Integer | |||
|The policy ID | |||
|- | |||
|timeStamp | |||
|Timestamp | |||
|The timestamp | |||
|} | |} | ||
<section end=' | <section end='CaptivePortalUserEvent' /> | ||
== | == CaptureRuleEvent == | ||
<section begin=' | <section begin='CaptureRuleEvent' /> | ||
These events are created by [[ | These events are created by [[Captive Portal]] and update the [[Database_Schema#sessions|sessions]] table when Captive Portal processes a session. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 650: | Line 779: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |||
|captured | |||
|boolean | |||
|True if captured, false otherwise | |||
|- | |- | ||
|class | |class | ||
Line 655: | Line 788: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |ruleId | ||
| | |Integer | ||
|The | |The rule ID | ||
|- | |- | ||
| | |sessionEvent | ||
| | |SessionEvent | ||
|The session event | |||
|The event | |||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 695: | Line 800: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='CaptureRuleEvent' /> | ||
== | == TunnelStatusEvent == | ||
<section begin=' | <section begin='TunnelStatusEvent' /> | ||
These events are created by [[ | These events are created by [[IPsec VPN]] and inserted to the [[Database_Schema#ipsec_tunnel_stats|ipsec_tunnel_stats]] table periodically. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 707: | Line 812: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |- | ||
|class | |class | ||
Line 716: | Line 817: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |inBytes | ||
| | |long | ||
|The | |The number of bytes received from this tunnel | ||
|- | |- | ||
| | |outBytes | ||
| | |long | ||
|The | |The number of bytes sent in this tunnel | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|- | |||
|tunnelName | |||
|String | |||
|The name of this tunnel | |||
|} | |} | ||
<section end=' | <section end='TunnelStatusEvent' /> | ||
== | == VirtualUserEvent == | ||
<section begin=' | <section begin='VirtualUserEvent' /> | ||
These events are created by [[ | These events are created by [[IPsec VPN]] and inserted to the [[Database_Schema#ipsec_user_events|ipsec_user_events]] table when a user event occurs. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 749: | Line 850: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |clientAddress | ||
|InetAddress | |||
|The client address | |||
|- | |||
|clientProtocol | |||
|String | |String | ||
|The | |The client protocol | ||
|- | |- | ||
| | |clientUsername | ||
|String | |String | ||
|The | |The client username | ||
|- | |- | ||
| | |elapsedTime | ||
| | |String | ||
| | |The elapsed time | ||
|- | |- | ||
|timeStamp | |eventId | ||
|Timestamp | |Long | ||
|The timestamp | |The event ID | ||
|- | |||
|netInterface | |||
|String | |||
|The net interface | |||
|- | |||
|netProcess | |||
|String | |||
|The net process | |||
|- | |||
|netRXbytes | |||
|Long | |||
|The number of RX (received) bytes | |||
|- | |||
|netTXbytes | |||
|Long | |||
|The number of TX (transmitted) bytes | |||
|- | |||
|timeStamp | |||
|Timestamp | |||
|The timestamp | |||
|} | |} | ||
<section end=' | <section end='VirtualUserEvent' /> | ||
== | == ConfigurationBackupEvent == | ||
<section begin=' | <section begin='ConfigurationBackupEvent' /> | ||
These events are created by [[ | These events are created by [[Configuration Backup]] and inserted to the [[Database_Schema#configuratio_backup_events|configuratio_backup_events]] table when a backup occurs. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 778: | Line 903: | ||
! Description | ! Description | ||
|- | |- | ||
|class | |||
|Class | |||
|class | |||
|Class | |||
|The class name | |The class name | ||
|- | |- | ||
| | |destination | ||
| | |String | ||
|The | |The destination | ||
|- | |- | ||
| | |detail | ||
| | |String | ||
|The | |The details | ||
|- | |- | ||
| | |success | ||
| | |boolean | ||
| | |True if successful, false otherwise | ||
|- | |- | ||
|timeStamp | |||
|Timestamp | |||
|The timestamp | |||
|} | |||
<section end='ConfigurationBackupEvent' /> | |||
|timeStamp | |||
|Timestamp | |||
|The timestamp | |||
|} | |||
<section end=' | |||
== | == IntrusionPreventionLogEvent == | ||
<section begin=' | <section begin='IntrusionPreventionLogEvent' /> | ||
These events are created by | These events are created by [[Intrusion Prevention]] and inserted to the [[Database_Schema#intrusion_prevention_events|intrusion_prevention_events]] table when a rule matches. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 826: | Line 935: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |||
|blocked | |||
|short | |||
|1 if blocked, 0 otherwise | |||
|- | |||
|category | |||
|String | |||
|The category | |||
|- | |- | ||
|class | |class | ||
Line 831: | Line 948: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |classificationId | ||
|long | |||
|The classification ID | |||
|- | |||
|classtype | |||
|String | |||
|The classtype | |||
|- | |||
|dportIcode | |||
|int | |int | ||
|The | |The dportIcode | ||
|- | |- | ||
| | |eventId | ||
| | |long | ||
|The | |The event ID | ||
|- | |- | ||
| | |eventMicrosecond | ||
| | |long | ||
|The | |The event microsecond | ||
|- | |- | ||
| | |eventSecond | ||
| | |long | ||
|The | |The event second | ||
|- | |- | ||
| | |eventType | ||
| | |long | ||
|The | |The event type | ||
|- | |- | ||
| | |generatorId | ||
|long | |long | ||
|The | |The generator ID | ||
|- | |- | ||
| | |impact | ||
| | |short | ||
|The | |The impact | ||
|- | |- | ||
| | |impactFlag | ||
| | |short | ||
|The | |The impact flag | ||
|- | |- | ||
| | |ipDestination | ||
| | |InetAddress | ||
|The | |The IP address destination | ||
|- | |- | ||
| | |ipSource | ||
| | |InetAddress | ||
|The | |The IP address source | ||
|- | |- | ||
| | |mplsLabel | ||
| | |long | ||
|The | |The mplsLabel | ||
|- | |- | ||
| | |msg | ||
| | |String | ||
|The | |The msg | ||
|- | |- | ||
| | |padding | ||
| | |int | ||
|The | |The padding | ||
|- | |- | ||
| | |priorityId | ||
| | |long | ||
|The | |The priority ID | ||
|- | |- | ||
| | |protocol | ||
| | |short | ||
|The | |The protocol | ||
|- | |- | ||
| | |sensorId | ||
| | |long | ||
|The | |The sensor ID | ||
|- | |- | ||
| | |signatureId | ||
| | |long | ||
|The | |The signature ID | ||
|- | |- | ||
| | |signatureRevision | ||
| | |long | ||
|The | |The signature revision | ||
|- | |- | ||
| | |sportItype | ||
| | |int | ||
|The | |The sportItype | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|- | |||
|vlanId | |||
|int | |||
|The VLAN Id | |||
|} | |} | ||
<section end=' | <section end='IntrusionPreventionLogEvent' /> | ||
== | == SslInspectorLogEvent == | ||
<section begin=' | <section begin='SslInspectorLogEvent' /> | ||
These events are created by [[ | These events are created by [[SSL Inspector]] and update the [[Database_Schema#sessions|sessions]] table when a session is processed by SSL Inspector. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 950: | Line 1,053: | ||
! Description | ! Description | ||
|- | |- | ||
|class | |||
|class | |||
|Class | |Class | ||
|The class name | |The class name | ||
|- | |- | ||
| | |detail | ||
|String | |String | ||
|The | |The details | ||
|- | |||
|ruleId | |||
|Integer | |||
|The rule ID | |||
|- | |||
|sessionEvent | |||
|SessionEvent | |||
|The session event | |||
|- | |- | ||
| | |status | ||
| | |String | ||
|The | |The status | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 970: | Line 1,077: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='SslInspectorLogEvent' /> | ||
== | == ApplicationControlLiteEvent == | ||
<section begin=' | <section begin='ApplicationControlLiteEvent' /> | ||
These events are created by [[ | These events are created by [[Application Control Lite]] and update the [[Database_Schema#sessions|sessions]] table when application control lite identifies a session. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 991: | Line 1,098: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |protocol | ||
| | |String | ||
|The protocol | |||
|The | |||
|- | |- | ||
|sessionId | |sessionId | ||
Line 1,007: | Line 1,110: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='ApplicationControlLiteEvent' /> | ||
== | == ApplicationControlLogEvent == | ||
<section begin=' | <section begin='ApplicationControlLogEvent' /> | ||
These events are created by [[ | These events are created by [[Application Control]] and update the [[Database_Schema#sessions|sessions]] table when application control identifies a session. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,019: | Line 1,122: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |||
|application | |||
|String | |||
|The application | |||
|- | |||
|blocked | |||
|boolean | |||
|True if blocked, false otherwise | |||
|- | |||
|category | |||
|String | |||
|The category | |||
|- | |- | ||
|class | |class | ||
Line 1,024: | Line 1,139: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |confidence | ||
| | |Integer | ||
|The | |The confidence (0-100) | ||
|- | |- | ||
| | |detail | ||
|String | |String | ||
|The | |The details | ||
|- | |- | ||
| | |flagged | ||
| | |boolean | ||
| | |True if flagged, false otherwise | ||
|- | |- | ||
| | |protochain | ||
|String | |String | ||
|The | |The protochain | ||
|- | |- | ||
| | |ruleId | ||
| | |Integer | ||
|The | |The rule ID | ||
|- | |- | ||
|sessionEvent | |sessionEvent | ||
Line 1,052: | Line 1,163: | ||
|The session event | |The session event | ||
|- | |- | ||
| | |state | ||
| | |Integer | ||
|The | |The state | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 1,060: | Line 1,171: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='ApplicationControlLogEvent' /> | ||
== | == CookieEvent == | ||
<section begin=' | <section begin='CookieEvent' /> | ||
These events are created by [[ | These events are created by [[Ad Blocker]] and update the [[Database_Schema#http_events|http_events]] table when a cookie is blocked. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,072: | Line 1,183: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |- | ||
|class | |class | ||
Line 1,085: | Line 1,188: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |identification | ||
|String | |String | ||
|The | |The identification string | ||
|- | |- | ||
| | |requestId | ||
| | |Long | ||
|The | |The request ID | ||
|- | |||
|sessionEvent | |||
|SessionEvent | |||
|The session event | |||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 1,101: | Line 1,204: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='CookieEvent' /> | ||
== | == AdBlockerEvent == | ||
<section begin=' | <section begin='AdBlockerEvent' /> | ||
These events are created by [[ | These events are created by [[Ad Blocker]] and update the [[Database_Schema#http_events|http_events]] table when an ad is blocked. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,114: | Line 1,217: | ||
! Description | ! Description | ||
|- | |- | ||
| | |action | ||
| | |Action | ||
|The | |The action | ||
|- | |- | ||
|class | |class | ||
Line 1,130: | Line 1,225: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |reason | ||
| | |String | ||
|The | |The reason | ||
|- | |- | ||
| | |requestId | ||
| | |Long | ||
|The | |The request ID | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 1,162: | Line 1,237: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='AdBlockerEvent' /> | ||
== | == WebFilterQueryEvent == | ||
<section begin=' | <section begin='WebFilterQueryEvent' /> | ||
These events are created by [[ | These events are created by [[Web Filter]] and inserted to the [[Database_Schema#http_query_events|http_query_events]] table when web filter processes a search engine search. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,174: | Line 1,249: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |||
|appName | |||
|String | |||
|The name of the application | |||
|- | |- | ||
|class | |class | ||
Line 1,179: | Line 1,258: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |contentLength | ||
|long | |||
|The content length | |||
|- | |||
|host | |||
|String | |String | ||
|The | |The host | ||
|- | |||
|method | |||
|HttpMethod | |||
|The method | |||
|- | |||
|requestId | |||
|Long | |||
|The request ID | |||
|- | |- | ||
| | |requestUri | ||
| | |URI | ||
|The | |The request URI | ||
|- | |- | ||
|sessionEvent | |sessionEvent | ||
Line 1,191: | Line 1,282: | ||
|The session event | |The session event | ||
|- | |- | ||
| | |term | ||
|String | |String | ||
|The | |The search term/phrase | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 1,199: | Line 1,290: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='WebFilterQueryEvent' /> | ||
== | == WebFilterEvent == | ||
<section begin=' | <section begin='WebFilterEvent' /> | ||
These events are created by [[ | These events are created by [[Web Filter]] and update the [[Database_Schema#http_events|http_events]] table when web filter processes a web request. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,212: | Line 1,303: | ||
! Description | ! Description | ||
|- | |- | ||
| | |appName | ||
| | |String | ||
|The | |The name of the application | ||
|- | |||
|blocked | |||
|Boolean | |||
|True if blocked, false otherwise | |||
|- | |||
|category | |||
|String | |||
|The category | |||
|- | |- | ||
|class | |class | ||
Line 1,220: | Line 1,319: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |flagged | ||
| | |Boolean | ||
| | |True if flagged, false otherwise | ||
|- | |- | ||
|sessionEvent | |reason | ||
|Reason | |||
|The reason | |||
|- | |||
|requestLine | |||
|RequestLine | |||
|The request line | |||
|- | |||
|sessionEvent | |||
|SessionEvent | |SessionEvent | ||
|The session event | |The session event | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='WebFilterEvent' /> | ||
== | == PrioritizeEvent == | ||
<section begin=' | <section begin='PrioritizeEvent' /> | ||
These events are created by [[ | These events are created by the [[Bandwidth Control]] and update the [[Database_Schema#sessions|session]] table when a session is prioritized. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,252: | Line 1,351: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |- | ||
|class | |class | ||
Line 1,261: | Line 1,356: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |priority | ||
| | |int | ||
|The | |The priority | ||
|- | |- | ||
| | |ruleId | ||
|int | |int | ||
|The | |The rule ID | ||
|- | |- | ||
| | |sessionEvent | ||
| | |SessionEvent | ||
|The | |The session event | ||
|- | |- | ||
| | |timeStamp | ||
| | |Timestamp | ||
|The | |The timestamp | ||
|} | |||
<section end='PrioritizeEvent' /> | |||
== WanFailoverTestEvent == | |||
<section begin='WanFailoverTestEvent' /> | |||
These events are created by [[WAN Failover]] and inserted to the [[Database_Schema#wan_failover_test_events|wan_failover_test_events]] table when a test is run. | |||
{| border="1" cellpadding="2" width="90%" align="center" | |||
! Attribute Name | |||
! Type | |||
! Description | |||
|- | |- | ||
| | |class | ||
| | |Class | ||
|The | |The class name | ||
|- | |- | ||
| | |description | ||
|String | |String | ||
|The | |The description | ||
|- | |- | ||
| | |interfaceId | ||
|int | |int | ||
|The | |The interface ID | ||
|- | |- | ||
| | |name | ||
| | |String | ||
|The | |The test name | ||
|- | |- | ||
| | |osName | ||
|String | |String | ||
|The | |The O/S interface name | ||
|- | |- | ||
| | |success | ||
| | |Boolean | ||
| | |True if successful, false otherwise | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='WanFailoverTestEvent' /> | ||
== | == WanFailoverEvent == | ||
<section begin=' | <section begin='WanFailoverEvent' /> | ||
These events are created by [[ | These events are created by [[WAN Failover]] and inserted to the [[Database_Schema#wan_failover_action_events|wan_failover_action_events]] table when WAN Failover takes an action. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,330: | Line 1,426: | ||
! Description | ! Description | ||
|- | |- | ||
| | |action | ||
| | |WanFailoverEvent$Action | ||
|The | |The action | ||
|- | |- | ||
|class | |class | ||
Line 1,338: | Line 1,434: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |interfaceId | ||
|int | |||
|The interface ID | |||
|- | |||
|name | |||
|String | |String | ||
|The | |The name | ||
|- | |- | ||
| | |osName | ||
| | |String | ||
|The | |The O/S interface name | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='WanFailoverEvent' /> | ||
== | == SpamSmtpTarpitEvent == | ||
<section begin=' | <section begin='SpamSmtpTarpitEvent' /> | ||
These events are created by [[Spam Blocker]] and | These events are created by [[Spam Blocker]] and inserted to the [[Database_Schema#smtp_tarpit_events|smtp_tarpit_events]] table when a session is tarpitted. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,371: | Line 1,463: | ||
! Description | ! Description | ||
|- | |- | ||
| | |IPAddr | ||
| | |InetAddress | ||
|The | |The IP address | ||
|- | |- | ||
|class | |class | ||
Line 1,379: | Line 1,471: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |hostname | ||
| | |String | ||
|The | |The hostname | ||
|- | |- | ||
| | |sessionEvent | ||
| | |SessionEvent | ||
|The | |The session event | ||
|- | |- | ||
| | |sessionId | ||
|Long | |Long | ||
|The | |The session ID | ||
|- | |- | ||
| | |timeStamp | ||
| | |Timestamp | ||
|The | |The timestamp | ||
|- | |- | ||
| | |vendorName | ||
|String | |String | ||
|The | |The application name | ||
|- | |} | ||
| | <section end='SpamSmtpTarpitEvent' /> | ||
== SpamLogEvent == | |||
<section begin='SpamLogEvent' /> | |||
These events are created by [[Spam Blocker]] and update the [[Database_Schema#mail_msgs|mail_msgs]] table when an email is scanned. | |||
{| border="1" cellpadding="2" width="90%" align="center" | |||
! Attribute Name | |||
! Type | |||
! Description | |||
|- | |||
|action | |||
|SpamMessageAction | |||
|The action | |||
|- | |||
|class | |||
|Class | |||
|The class name | |||
|- | |||
|clientAddr | |||
|InetAddress | |InetAddress | ||
|The | |The client address | ||
|- | |- | ||
| | |clientPort | ||
|int | |int | ||
|The | |The client port | ||
|- | |- | ||
|smtpMessageEvent | |messageId | ||
|SmtpMessageEvent | |Long | ||
|The message ID | |||
|- | |||
|receiver | |||
|String | |||
|The receiver | |||
|- | |||
|score | |||
|float | |||
|The score | |||
|- | |||
|sender | |||
|String | |||
|The sender | |||
|- | |||
|serverAddr | |||
|InetAddress | |||
|The server address | |||
|- | |||
|serverPort | |||
|int | |||
|The server port | |||
|- | |||
|smtpMessageEvent | |||
|SmtpMessageEvent | |||
|The parent SMTP message event | |The parent SMTP message event | ||
|- | |- | ||
Line 1,438: | Line 1,571: | ||
== | == FirewallEvent == | ||
<section begin=' | <section begin='FirewallEvent' /> | ||
These events are created by [[ | These events are created by [[Firewall]] and update the [[Database_Schema#sessions|sessions]] table when a firewall rule matches a session. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,447: | Line 1,580: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |||
|blocked | |||
|boolean | |||
|True if blocked, false otherwise | |||
|- | |- | ||
|class | |class | ||
Line 1,452: | Line 1,589: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |flagged | ||
| | |boolean | ||
|The | |True if flagged, false otherwise | ||
|- | |||
|ruleId | |||
|long | |||
|The rule ID | |||
|- | |- | ||
| | |sessionId | ||
|Long | |Long | ||
|The | |The session ID | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 1,468: | Line 1,605: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='FirewallEvent' /> | ||
== | == LoginEvent == | ||
<section begin=' | <section begin='LoginEvent' /> | ||
These events are created by [[ | These events are created by [[Directory Connector]] and inserted to the [[Database_Schema#directory_connector_login_events|directory_connector_login_events]] table for each login. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,481: | Line 1,618: | ||
! Description | ! Description | ||
|- | |- | ||
|class | |||
|class | |||
|Class | |Class | ||
|The class name | |The class name | ||
|- | |- | ||
| | |clientAddr | ||
|InetAddress | |||
|The client address | |||
|- | |||
|domain | |||
|String | |||
|The domain | |||
|- | |||
|event | |||
|String | |String | ||
|The | |The event | ||
|- | |- | ||
| | |loginName | ||
| | |String | ||
|The | |The login name | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 1,501: | Line 1,642: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='LoginEvent' /> | ||
== | == SmtpMessageAddressEvent == | ||
<section begin=' | <section begin='SmtpMessageAddressEvent' /> | ||
These events are created by | These events are created by SMTP subsystem and inserted to the [[Database_Schema#mail_addrs|mail_addrs]] table for each address on each email. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,514: | Line 1,655: | ||
! Description | ! Description | ||
|- | |- | ||
| | |addr | ||
|String | |String | ||
|The | |The address | ||
|- | |- | ||
|class | |class | ||
Line 1,526: | Line 1,663: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |kind | ||
| | |AddressKind | ||
|The | |The type for this address (F=From, T=To, C=CC, G=Envelope From, B=Envelope To, X=Unknown) | ||
|- | |||
|messageId | |||
|Long | |||
|The message ID | |||
|- | |- | ||
| | |personal | ||
|String | |String | ||
| | |personal | ||
|- | |- | ||
| | |timeStamp | ||
| | |Timestamp | ||
|The | |The timestamp | ||
| | |} | ||
| | <section end='SmtpMessageAddressEvent' /> | ||
| | |||
== SmtpMessageEvent == | |||
<section begin='SmtpMessageEvent' /> | |||
These events are created by SMTP subsystem and inserted to the [[Database_Schema#mail_msgs|mail_msgs]] table for each email. | |||
{| border="1" cellpadding="2" width="90%" align="center" | |||
! Attribute Name | |||
! Type | |||
! Description | |||
|- | |- | ||
| | |addresses | ||
| | |Set | ||
|The | |The addresses | ||
|- | |- | ||
| | |class | ||
| | |Class | ||
|The | |The class name | ||
|- | |- | ||
| | |envelopeFromAddress | ||
| | |String | ||
|The | |The envelop FROM address | ||
|- | |- | ||
| | |envelopeToAddress | ||
| | |String | ||
|The | |The envelope TO address | ||
|- | |- | ||
| | |messageId | ||
| | |Long | ||
|The | |The message ID | ||
|- | |- | ||
| | |receiver | ||
| | |String | ||
|The | |The receiver | ||
|- | |- | ||
| | |sender | ||
| | |String | ||
|The | |The sender | ||
|- | |- | ||
| | |sessionEvent | ||
| | |SessionEvent | ||
|The | |The session event | ||
|- | |- | ||
| | |sessionId | ||
| | |Long | ||
|The | |The session ID | ||
|- | |- | ||
| | |subject | ||
|String | |String | ||
|The | |The subject | ||
|- | |- | ||
| | |timeStamp | ||
| | |Timestamp | ||
|The | |The timestamp | ||
|- | |- | ||
| | |tmpFile | ||
| | |File | ||
|The | |The /tmp file | ||
| | |} | ||
<section end='SmtpMessageEvent' /> | |||
| | |||
| | == VirusSmtpEvent == | ||
<section begin='VirusSmtpEvent' /> | |||
These events are created by [[Virus Blocker]] and update the [[Database_Schema#mail_msgs|mail_msgs]] table when Virus Blocker scans an email. | |||
{| border="1" cellpadding="2" width="90%" align="center" | |||
! Attribute Name | |||
! Type | |||
! Description | |||
|- | |- | ||
| | |action | ||
| | |String | ||
|The | |The action | ||
|- | |- | ||
| | |appName | ||
| | |String | ||
|The | |The name of the application | ||
|- | |- | ||
| | |class | ||
| | |Class | ||
|The | |The class name | ||
|- | |- | ||
|timeStamp | |clean | ||
|boolean | |||
|True if clean, false otherwise | |||
|- | |||
|messageId | |||
|Long | |||
|The message ID | |||
|- | |||
|timeStamp | |||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|- | |- | ||
| | |virusName | ||
| | |String | ||
|The | |The virus name, if not clean | ||
|} | |} | ||
<section end=' | <section end='VirusSmtpEvent' /> | ||
== | == VirusFtpEvent == | ||
<section begin=' | <section begin='VirusFtpEvent' /> | ||
These events are created by [[ | These events are created by [[Virus Blocker]] and update the [[Database_Schema#ftp_events|ftp_events]] table when Virus Blocker scans an FTP transfer. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,630: | Line 1,793: | ||
! Type | ! Type | ||
! Description | ! Description | ||
|- | |||
|appName | |||
|String | |||
|The name of the application | |||
|- | |- | ||
|class | |class | ||
Line 1,635: | Line 1,802: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |clean | ||
| | |boolean | ||
| | |True if clean, false otherwise | ||
|- | |- | ||
| | |sessionEvent | ||
| | |SessionEvent | ||
|The | |The session event | ||
|- | |||
|timeStamp | |||
|Timestamp | |||
|The timestamp | |||
|- | |- | ||
| | |uri | ||
|String | |String | ||
|The | |The URI | ||
|- | |- | ||
| | |virusName | ||
|String | |String | ||
|The | |The virus name, if not clean | ||
|} | |} | ||
<section end=' | <section end='VirusFtpEvent' /> | ||
== | == VirusHttpEvent == | ||
<section begin=' | <section begin='VirusHttpEvent' /> | ||
These events are created by [[ | These events are created by [[Virus Blocker]] and update the [[Database_Schema#http_events|http_events]] table when Virus Blocker scans an HTTP transfer. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,672: | Line 1,835: | ||
! Description | ! Description | ||
|- | |- | ||
| | |appName | ||
| | |String | ||
|The | |The name of the application | ||
|- | |- | ||
|class | |class | ||
Line 1,680: | Line 1,843: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |clean | ||
| | |boolean | ||
| | |True if clean, false otherwise | ||
|- | |- | ||
| | |requestId | ||
| | |Long | ||
|The | |The request ID | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|- | |||
|virusName | |||
|String | |||
|The virus name, if not clean | |||
|} | |} | ||
<section end=' | <section end='VirusHttpEvent' /> | ||
== | == SpamSmtpTarpitEvent == | ||
<section begin=' | <section begin='SpamSmtpTarpitEvent' /> | ||
These events are created by [[ | These events are created by [[Spam Blocker]] and inserted to the [[Database_Schema#smtp_tarpit_events|smtp_tarpit_events]] table when a session is tarpitted. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,709: | Line 1,872: | ||
! Description | ! Description | ||
|- | |- | ||
| | |IPAddr | ||
| | |InetAddress | ||
|The | |The IP address | ||
|- | |- | ||
|class | |class | ||
Line 1,721: | Line 1,880: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |hostname | ||
| | |String | ||
|The | |The hostname | ||
|- | |- | ||
| | |sessionEvent | ||
| | |SessionEvent | ||
|The event | |The session event | ||
|- | |- | ||
| | |sessionId | ||
| | |Long | ||
|The | |The session ID | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|- | |||
|vendorName | |||
|String | |||
|The application name | |||
|} | |} | ||
<section end=' | <section end='SpamSmtpTarpitEvent' /> | ||
== | == SpamLogEvent == | ||
<section begin=' | <section begin='SpamLogEvent' /> | ||
These events are created by [[ | These events are created by [[Spam Blocker]] and update the [[Database_Schema#mail_msgs|mail_msgs]] table when an email is scanned. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,758: | Line 1,913: | ||
! Description | ! Description | ||
|- | |- | ||
| | |action | ||
| | |SpamMessageAction | ||
| | |The action | ||
|- | |- | ||
|class | |class | ||
Line 1,766: | Line 1,921: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |clientAddr | ||
| | |InetAddress | ||
|The | |The client address | ||
|- | |- | ||
| | |clientPort | ||
| | |int | ||
|The | |The client port | ||
|- | |- | ||
| | |messageId | ||
| | |Long | ||
|The | |The message ID | ||
|- | |- | ||
| | |receiver | ||
|String | |String | ||
|The | |The receiver | ||
|- | |- | ||
| | |score | ||
| | |float | ||
|The | |The score | ||
|- | |- | ||
| | |sender | ||
| | |String | ||
| | |The sender | ||
|- | |- | ||
| | |serverAddr | ||
| | |InetAddress | ||
|The | |The server address | ||
|- | |- | ||
| | |serverPort | ||
| | |int | ||
|The | |The server port | ||
|- | |- | ||
| | |smtpMessageEvent | ||
| | |SmtpMessageEvent | ||
|The | |The parent SMTP message event | ||
|- | |- | ||
| | |isSpam | ||
|boolean | |||
|True if spam, false otherwise | |||
|- | |||
|subject | |||
|String | |||
|The subject | |||
|- | |||
|testsString | |||
|String | |||
|The tests string from the spam engine | |||
|- | |||
|timeStamp | |||
|Timestamp | |||
|The timestamp | |||
|- | |||
|vendorName | |||
|String | |String | ||
|The | |The application name | ||
|} | |} | ||
<section end=' | <section end='SpamLogEvent' /> | ||
== | == HttpResponseEvent == | ||
<section begin=' | <section begin='HttpResponseEvent' /> | ||
These events are created by | These events are created by HTTP subsystem and update the [[Database_Schema#http_events|http_events]] table when a web response happens. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,836: | Line 1,994: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |contentLength | ||
| | |long | ||
| | |The content length | ||
|- | |- | ||
| | |contentType | ||
|String | |String | ||
|The | |The content type | ||
|- | |||
|httpRequestEvent | |||
|HttpRequestEvent | |||
|The corresponding HTTP request event | |||
|- | |- | ||
| | |requestLine | ||
| | |RequestLine | ||
|The | |The request line | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='HttpResponseEvent' /> | ||
== | == HttpRequestEvent == | ||
<section begin=' | <section begin='HttpRequestEvent' /> | ||
These events are created by | These events are created by HTTP subsystem and inserted to the [[Database_Schema#http_events|http_events]] table when a web request happens. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 1,877: | Line 2,031: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |contentLength | ||
| | |long | ||
| | |The content length | ||
|- | |||
|domain | |||
|String | |||
|The domain | |||
|- | |||
|host | |||
|String | |||
|The host | |||
|- | |||
|method | |||
|HttpMethod | |||
|The HTTP method | |||
|- | |- | ||
| | |referer | ||
|String | |String | ||
|The | |The referer | ||
|- | |- | ||
|requestId | |requestId | ||
|Long | |Long | ||
|The request ID | |The request ID | ||
|- | |||
|requestUri | |||
|URI | |||
|The request URI | |||
|- | |||
|sessionEvent | |||
|SessionEvent | |||
|The session event | |||
|- | |- | ||
|timeStamp | |timeStamp | ||
|Timestamp | |Timestamp | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='HttpRequestEvent' /> | ||
Line 1,998: | Line 2,168: | ||
== | == WebCacheEvent == | ||
<section begin=' | <section begin='WebCacheEvent' /> | ||
These events are created by | These events are created by [[Web Cache]] and inserted to the [[Database_Schema#web_cache_stats|web_cache_stats]] table periodically. | ||
{| border="1" cellpadding="2" width="90%" align="center" | {| border="1" cellpadding="2" width="90%" align="center" | ||
Line 2,008: | Line 2,178: | ||
! Description | ! Description | ||
|- | |- | ||
| | |bypassCount | ||
| | |long | ||
|The | |The number of bypasses | ||
|- | |- | ||
|class | |class | ||
Line 2,016: | Line 2,186: | ||
|The class name | |The class name | ||
|- | |- | ||
| | |hitBytes | ||
| | |long | ||
|The | |The number of bytes worth of hits | ||
|- | |- | ||
| | |hitCount | ||
| | |long | ||
|The | |The number of hits | ||
|- | |- | ||
| | |missBytes | ||
| | |long | ||
| | |The number of bytes worth of misses | ||
|- | |- | ||
| | |missCount | ||
| | |long | ||
|The | |The number of misses | ||
|- | |- | ||
| | |policyId | ||
| | |Long | ||
|The | |The policy ID | ||
|- | |- | ||
| | |systemCount | ||
| | |long | ||
|The | |The number of system bypasses | ||
|- | |- | ||
|timeStamp | |timeStamp | ||
Line 2,130: | Line 2,214: | ||
|The timestamp | |The timestamp | ||
|} | |} | ||
<section end=' | <section end='WebCacheEvent' /> |
Revision as of 18:17, 10 August 2017
All event data is stored in the Database Schema in a relational database. As Untangle and applications process traffic they create Event objects that add and modify content in the database. Each event has it's own class/object with certain fields that modify the database in a certain way.
The list below shows the classes used in the event logging and the attributes of each event object. These can be used to add alerts in Reports or for other event handling within Untangle.
HostTableEvent
<section begin='HostTableEvent' />
These events are created by the base system and inserted to the host_table_updates table when the host table is modified.
Attribute Name | Type | Description |
---|---|---|
address | InetAddress | The address |
class | Class | The class name |
key | String | The key |
oldValue | String | The old value |
timeStamp | Timestamp | The timestamp |
value | String | The value |
<section end='HostTableEvent' />
DeviceTableEvent
<section begin='DeviceTableEvent' />
These events are created by the base system and inserted to the device_table_updates table when the device list is modified.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
device | DeviceTableEntry | The Device |
key | String | The key |
macAddress | String | The MAC address |
oldValue | String | The old value |
timeStamp | Timestamp | The timestamp |
value | String | The value |
<section end='DeviceTableEvent' />
UserTableEvent
<section begin='UserTableEvent' />
These events are created by the base system and inserted to the user_table_updates table when the user table is modified.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
key | String | The key |
oldValue | String | The old value |
timeStamp | Timestamp | The timestamp |
username | String | The username |
value | String | The value |
<section end='UserTableEvent' />
SessionStatsEvent
<section begin='SessionStatsEvent' />
These events are created by the base system and update the sessions table when a session ends with the updated stats.
Attribute Name | Type | Description |
---|---|---|
c2pBytes | long | The number of bytes sent from the client to Untangle |
class | Class | The class name |
endTime | long | The end time/date |
p2cBytes | long | The number of bytes sent to the client from Untangle |
p2sBytes | long | The number of bytes sent to the server from Untangle |
s2pBytes | long | The number of bytes sent from the server to Untangle |
sessionEvent | SessionEvent | The session event |
sessionId | Long | The session ID |
timeStamp | Timestamp | The timestamp |
<section end='SessionStatsEvent' />
SessionEvent
<section begin='SessionEvent' />
These events are created by the base system and update the sessions table each time a session is created.
Attribute Name | Type | Description |
---|---|---|
CClientAddr | InetAddress | The client-side (pre-NAT) client address |
CClientPort | Integer | The client-side (pre-NAT) client port |
CServerAddr | InetAddress | The client-side (pre-NAT) server address |
CServerPort | Integer | The client-side (pre-NAT) server port |
SClientAddr | InetAddress | The server-side (post-NAT) client address |
SClientPort | Integer | The server-side (post-NAT) client port |
SServerAddr | InetAddress | The server-side (post-NAT) server address |
SServerPort | Integer | The server-side (post-NAT) server port |
bypassed | boolean | True if bypassed, false otherwise |
class | Class | The class name |
clientCountry | String | The client country |
clientIntf | Integer | The client interface ID |
clientLatitude | Double | The client latitude |
clientLongitude | Double | The client longitude |
entitled | boolean | The entitled status |
filterPrefix | String | The filter prefix if blocked by the filter rules |
hostname | String | The hostname |
icmpType | Short | The ICMP type |
localAddr | InetAddress | The local host address |
policyId | Integer | The policy ID |
policyRuleId | Integer | The policy rule ID |
protocol | Short | The protocol |
protocolName | String | The protocol name |
remoteAddr | InetAddress | The remote host address |
serverCountry | String | The server country |
serverIntf | Integer | The server interface ID |
serverLatitude | Double | The server latitude |
serverLongitude | Double | The server longitude |
sessionId | Long | The session ID |
tagsString | String | The string value of all tags |
timeStamp | Timestamp | The timestamp |
username | String | The username |
<section end='SessionEvent' />
SessionMinuteEvent
<section begin='SessionMinuteEvent' />
These events are created by the base system and update the session_minutes table each minute a session exists.
Attribute Name | Type | Description |
---|---|---|
c2sBytes | long | The number of bytes sent from the client to the server |
class | Class | The class name |
s2cBytes | long | The number of bytes sent from the server to the client |
sessionId | long | The session ID |
timeStamp | Timestamp | The timestamp |
<section end='SessionMinuteEvent' />
SessionNatEvent
<section begin='SessionNatEvent' />
These events are created by the base system and update the sessions table each time a session is NATd with the post-NAT information.
Attribute Name | Type | Description |
---|---|---|
SClientAddr | InetAddress | The server-side (post-NAT) client address |
SClientPort | Integer | The server-side (post-NAT) client port |
SServerAddr | InetAddress | The server-side (post-NAT) server address |
SServerPort | Integer | The server-side (post-NAT) server port |
class | Class | The class name |
serverIntf | Integer | The server interface ID |
sessionEvent | SessionEvent | The session event |
timeStamp | Timestamp | The timestamp |
<section end='SessionNatEvent' />
QuotaEvent
<section begin='QuotaEvent' />
These events are created by the Bandwidth Control and inserted or update the quotas table when quotas are given or exceeded.
Attribute Name | Type | Description |
---|---|---|
action | int | The action (1=Quota Given, 2=Quota Exceeded) |
class | Class | The class name |
entity | String | The entity |
quotaSize | long | The quota size |
reason | String | The reason |
timeStamp | Timestamp | The timestamp |
<section end='QuotaEvent' />
SettingsChangesEvent
<section begin='SettingsChangesEvent' />
These events are created by the base system and inserted to the settings_changes table when settings are changed.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
hostname | String | The hostname |
settingsFile | String | The settings file |
timeStamp | Timestamp | The timestamp |
username | String | The username |
<section end='SettingsChangesEvent' />
AdminLoginEvent
<section begin='AdminLoginEvent' />
These events are created by the base system and inserted to the admin_logins table when an administrator login is attempted or successful.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
clientAddress | InetAddress | The client address |
local | boolean | 1 if login is done via local console, 0 otherwise |
login | String | The login username |
reason | String | The reason |
succeeded | boolean | 1 if successful, 0 otherwise |
timeStamp | Timestamp | The timestamp |
<section end='AdminLoginEvent' />
AlertEvent
<section begin='AlertEvent' />
These events are created by Reports and inserted to the alerts table when an alert fires.
Attribute Name | Type | Description |
---|---|---|
causalRule | EventRule | The causal rule |
cause | LogEvent | The cause |
class | Class | The class name |
description | String | The description |
eventSent | Boolean | True if the event was sent, false otherwise |
json | String | The JSON string |
summaryText | String | The summary text |
timeStamp | Timestamp | The timestamp |
<section end='AlertEvent' />
LogEvent
<section begin='LogEvent' />
These base class for all events.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
timeStamp | Timestamp | The timestamp |
<section end='LogEvent' />
InterfaceStatEvent
<section begin='InterfaceStatEvent' />
These events are created by the base system and inserted to the interface_stat_events table periodically with interface stats.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
interfaceId | int | The interface ID |
rxBytes | double | The total of received bytes |
rxRate | double | The RX rate in byte/s |
timeStamp | Timestamp | The timestamp |
txBytes | double | The total of transmitted bytes |
txRate | double | The TX rate in byte/s |
<section end='InterfaceStatEvent' />
SystemStatEvent
<section begin='SystemStatEvent' />
These events are created by the base system and inserted to the server_events table periodically.
Attribute Name | Type | Description |
---|---|---|
activeHosts | int | The active host count |
class | Class | The class name |
cpuSystem | float | The system CPU utilization |
cpuUser | float | The user CPU utilization |
diskFree | long | The amount of disk free |
diskFreePercent | float | The percentage of disk free |
diskTotal | long | The total size of the disk |
diskUsed | long | The amount of disk used |
diskUsedPercent | float | The percentage of disk used |
load1 | float | The 1-minute CPU load |
load15 | float | The 15-minute CPU load |
load5 | float | The 5-minute CPU load |
memBuffers | long | The amount of memory used by buffers |
memCache | long | The amount of memory used by cache |
memFree | long | The amount of free memory |
memFreePercent | float | The percentage of total memory that is free |
memTotal | long | The total amount of memory |
memUsed | long | The amount of used memory |
memUsedPercent | float | The percentage of total memory that is used |
swapFree | long | The amount of free swap |
swapFreePercent | float | The percentage of total swap that is free |
swapTotal | long | The total size of swap |
swapUsed | long | The amount of used swap |
swapUsedPercent | float | The percentage of total swap that is used |
timeStamp | Timestamp | The timestamp |
<section end='SystemStatEvent' />
CaptivePortalUserEvent
<section begin='CaptivePortalUserEvent' />
These events are created by Captive Portal and inserted to the captive_portal_user_events table when Captive Portal user takes amconsole:
Attribute Name | Type | Description |
---|---|---|
authenticationType | CaptivePortalSettings$AuthenticationType | The authentication type |
authenticationTypeValue | String | The authentication type as a string |
class | Class | The class name |
clientAddr | String | The client address |
event | CaptivePortalUserEvent$EventType | The event (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT) |
eventValue | String | The event value as a string (LOGIN, FAILED, TIMEOUT, INACTIVE, USER_LOGOUT, ADMIN_LOGOUT) |
loginName | String | The login name |
policyId | Integer | The policy ID |
timeStamp | Timestamp | The timestamp |
<section end='CaptivePortalUserEvent' />
CaptureRuleEvent
<section begin='CaptureRuleEvent' />
These events are created by Captive Portal and update the sessions table when Captive Portal processes a session.
Attribute Name | Type | Description |
---|---|---|
captured | boolean | True if captured, false otherwise |
class | Class | The class name |
ruleId | Integer | The rule ID |
sessionEvent | SessionEvent | The session event |
timeStamp | Timestamp | The timestamp |
<section end='CaptureRuleEvent' />
TunnelStatusEvent
<section begin='TunnelStatusEvent' />
These events are created by IPsec VPN and inserted to the ipsec_tunnel_stats table periodically.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
inBytes | long | The number of bytes received from this tunnel |
outBytes | long | The number of bytes sent in this tunnel |
timeStamp | Timestamp | The timestamp |
tunnelName | String | The name of this tunnel |
<section end='TunnelStatusEvent' />
VirtualUserEvent
<section begin='VirtualUserEvent' />
These events are created by IPsec VPN and inserted to the ipsec_user_events table when a user event occurs.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
clientAddress | InetAddress | The client address |
clientProtocol | String | The client protocol |
clientUsername | String | The client username |
elapsedTime | String | The elapsed time |
eventId | Long | The event ID |
netInterface | String | The net interface |
netProcess | String | The net process |
netRXbytes | Long | The number of RX (received) bytes |
netTXbytes | Long | The number of TX (transmitted) bytes |
timeStamp | Timestamp | The timestamp |
<section end='VirtualUserEvent' />
ConfigurationBackupEvent
<section begin='ConfigurationBackupEvent' />
These events are created by Configuration Backup and inserted to the configuratio_backup_events table when a backup occurs.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
destination | String | The destination |
detail | String | The details |
success | boolean | True if successful, false otherwise |
timeStamp | Timestamp | The timestamp |
<section end='ConfigurationBackupEvent' />
IntrusionPreventionLogEvent
<section begin='IntrusionPreventionLogEvent' />
These events are created by Intrusion Prevention and inserted to the intrusion_prevention_events table when a rule matches.
Attribute Name | Type | Description |
---|---|---|
blocked | short | 1 if blocked, 0 otherwise |
category | String | The category |
class | Class | The class name |
classificationId | long | The classification ID |
classtype | String | The classtype |
dportIcode | int | The dportIcode |
eventId | long | The event ID |
eventMicrosecond | long | The event microsecond |
eventSecond | long | The event second |
eventType | long | The event type |
generatorId | long | The generator ID |
impact | short | The impact |
impactFlag | short | The impact flag |
ipDestination | InetAddress | The IP address destination |
ipSource | InetAddress | The IP address source |
mplsLabel | long | The mplsLabel |
msg | String | The msg |
padding | int | The padding |
priorityId | long | The priority ID |
protocol | short | The protocol |
sensorId | long | The sensor ID |
signatureId | long | The signature ID |
signatureRevision | long | The signature revision |
sportItype | int | The sportItype |
timeStamp | Timestamp | The timestamp |
vlanId | int | The VLAN Id |
<section end='IntrusionPreventionLogEvent' />
SslInspectorLogEvent
<section begin='SslInspectorLogEvent' />
These events are created by SSL Inspector and update the sessions table when a session is processed by SSL Inspector.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
detail | String | The details |
ruleId | Integer | The rule ID |
sessionEvent | SessionEvent | The session event |
status | String | The status |
timeStamp | Timestamp | The timestamp |
<section end='SslInspectorLogEvent' />
ApplicationControlLiteEvent
<section begin='ApplicationControlLiteEvent' />
These events are created by Application Control Lite and update the sessions table when application control lite identifies a session.
Attribute Name | Type | Description |
---|---|---|
blocked | boolean | True if blocked, false otherwise |
class | Class | The class name |
protocol | String | The protocol |
sessionId | Long | The session ID |
timeStamp | Timestamp | The timestamp |
<section end='ApplicationControlLiteEvent' />
ApplicationControlLogEvent
<section begin='ApplicationControlLogEvent' />
These events are created by Application Control and update the sessions table when application control identifies a session.
Attribute Name | Type | Description |
---|---|---|
application | String | The application |
blocked | boolean | True if blocked, false otherwise |
category | String | The category |
class | Class | The class name |
confidence | Integer | The confidence (0-100) |
detail | String | The details |
flagged | boolean | True if flagged, false otherwise |
protochain | String | The protochain |
ruleId | Integer | The rule ID |
sessionEvent | SessionEvent | The session event |
state | Integer | The state |
timeStamp | Timestamp | The timestamp |
<section end='ApplicationControlLogEvent' />
CookieEvent
<section begin='CookieEvent' />
These events are created by Ad Blocker and update the http_events table when a cookie is blocked.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
identification | String | The identification string |
requestId | Long | The request ID |
sessionEvent | SessionEvent | The session event |
timeStamp | Timestamp | The timestamp |
<section end='CookieEvent' />
AdBlockerEvent
<section begin='AdBlockerEvent' />
These events are created by Ad Blocker and update the http_events table when an ad is blocked.
Attribute Name | Type | Description |
---|---|---|
action | Action | The action |
class | Class | The class name |
reason | String | The reason |
requestId | Long | The request ID |
timeStamp | Timestamp | The timestamp |
<section end='AdBlockerEvent' />
WebFilterQueryEvent
<section begin='WebFilterQueryEvent' />
These events are created by Web Filter and inserted to the http_query_events table when web filter processes a search engine search.
Attribute Name | Type | Description |
---|---|---|
appName | String | The name of the application |
class | Class | The class name |
contentLength | long | The content length |
host | String | The host |
method | HttpMethod | The method |
requestId | Long | The request ID |
requestUri | URI | The request URI |
sessionEvent | SessionEvent | The session event |
term | String | The search term/phrase |
timeStamp | Timestamp | The timestamp |
<section end='WebFilterQueryEvent' />
WebFilterEvent
<section begin='WebFilterEvent' />
These events are created by Web Filter and update the http_events table when web filter processes a web request.
Attribute Name | Type | Description |
---|---|---|
appName | String | The name of the application |
blocked | Boolean | True if blocked, false otherwise |
category | String | The category |
class | Class | The class name |
flagged | Boolean | True if flagged, false otherwise |
reason | Reason | The reason |
requestLine | RequestLine | The request line |
sessionEvent | SessionEvent | The session event |
timeStamp | Timestamp | The timestamp |
<section end='WebFilterEvent' />
PrioritizeEvent
<section begin='PrioritizeEvent' />
These events are created by the Bandwidth Control and update the session table when a session is prioritized.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
priority | int | The priority |
ruleId | int | The rule ID |
sessionEvent | SessionEvent | The session event |
timeStamp | Timestamp | The timestamp |
<section end='PrioritizeEvent' />
WanFailoverTestEvent
<section begin='WanFailoverTestEvent' />
These events are created by WAN Failover and inserted to the wan_failover_test_events table when a test is run.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
description | String | The description |
interfaceId | int | The interface ID |
name | String | The test name |
osName | String | The O/S interface name |
success | Boolean | True if successful, false otherwise |
timeStamp | Timestamp | The timestamp |
<section end='WanFailoverTestEvent' />
WanFailoverEvent
<section begin='WanFailoverEvent' />
These events are created by WAN Failover and inserted to the wan_failover_action_events table when WAN Failover takes an action.
Attribute Name | Type | Description |
---|---|---|
action | WanFailoverEvent$Action | The action |
class | Class | The class name |
interfaceId | int | The interface ID |
name | String | The name |
osName | String | The O/S interface name |
timeStamp | Timestamp | The timestamp |
<section end='WanFailoverEvent' />
SpamSmtpTarpitEvent
<section begin='SpamSmtpTarpitEvent' />
These events are created by Spam Blocker and inserted to the smtp_tarpit_events table when a session is tarpitted.
Attribute Name | Type | Description |
---|---|---|
IPAddr | InetAddress | The IP address |
class | Class | The class name |
hostname | String | The hostname |
sessionEvent | SessionEvent | The session event |
sessionId | Long | The session ID |
timeStamp | Timestamp | The timestamp |
vendorName | String | The application name |
<section end='SpamSmtpTarpitEvent' />
SpamLogEvent
<section begin='SpamLogEvent' />
These events are created by Spam Blocker and update the mail_msgs table when an email is scanned.
Attribute Name | Type | Description |
---|---|---|
action | SpamMessageAction | The action |
class | Class | The class name |
clientAddr | InetAddress | The client address |
clientPort | int | The client port |
messageId | Long | The message ID |
receiver | String | The receiver |
score | float | The score |
sender | String | The sender |
serverAddr | InetAddress | The server address |
serverPort | int | The server port |
smtpMessageEvent | SmtpMessageEvent | The parent SMTP message event |
isSpam | boolean | True if spam, false otherwise |
subject | String | The subject |
testsString | String | The tests string from the spam engine |
timeStamp | Timestamp | The timestamp |
vendorName | String | The application name |
<section end='SpamLogEvent' />
FirewallEvent
<section begin='FirewallEvent' />
These events are created by Firewall and update the sessions table when a firewall rule matches a session.
Attribute Name | Type | Description |
---|---|---|
blocked | boolean | True if blocked, false otherwise |
class | Class | The class name |
flagged | boolean | True if flagged, false otherwise |
ruleId | long | The rule ID |
sessionId | Long | The session ID |
timeStamp | Timestamp | The timestamp |
<section end='FirewallEvent' />
LoginEvent
<section begin='LoginEvent' />
These events are created by Directory Connector and inserted to the directory_connector_login_events table for each login.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
clientAddr | InetAddress | The client address |
domain | String | The domain |
event | String | The event |
loginName | String | The login name |
timeStamp | Timestamp | The timestamp |
<section end='LoginEvent' />
SmtpMessageAddressEvent
<section begin='SmtpMessageAddressEvent' />
These events are created by SMTP subsystem and inserted to the mail_addrs table for each address on each email.
Attribute Name | Type | Description |
---|---|---|
addr | String | The address |
class | Class | The class name |
kind | AddressKind | The type for this address (F=From, T=To, C=CC, G=Envelope From, B=Envelope To, X=Unknown) |
messageId | Long | The message ID |
personal | String | personal |
timeStamp | Timestamp | The timestamp |
<section end='SmtpMessageAddressEvent' />
SmtpMessageEvent
<section begin='SmtpMessageEvent' />
These events are created by SMTP subsystem and inserted to the mail_msgs table for each email.
Attribute Name | Type | Description |
---|---|---|
addresses | Set | The addresses |
class | Class | The class name |
envelopeFromAddress | String | The envelop FROM address |
envelopeToAddress | String | The envelope TO address |
messageId | Long | The message ID |
receiver | String | The receiver |
sender | String | The sender |
sessionEvent | SessionEvent | The session event |
sessionId | Long | The session ID |
subject | String | The subject |
timeStamp | Timestamp | The timestamp |
tmpFile | File | The /tmp file |
<section end='SmtpMessageEvent' />
VirusSmtpEvent
<section begin='VirusSmtpEvent' />
These events are created by Virus Blocker and update the mail_msgs table when Virus Blocker scans an email.
Attribute Name | Type | Description |
---|---|---|
action | String | The action |
appName | String | The name of the application |
class | Class | The class name |
clean | boolean | True if clean, false otherwise |
messageId | Long | The message ID |
timeStamp | Timestamp | The timestamp |
virusName | String | The virus name, if not clean |
<section end='VirusSmtpEvent' />
VirusFtpEvent
<section begin='VirusFtpEvent' />
These events are created by Virus Blocker and update the ftp_events table when Virus Blocker scans an FTP transfer.
Attribute Name | Type | Description |
---|---|---|
appName | String | The name of the application |
class | Class | The class name |
clean | boolean | True if clean, false otherwise |
sessionEvent | SessionEvent | The session event |
timeStamp | Timestamp | The timestamp |
uri | String | The URI |
virusName | String | The virus name, if not clean |
<section end='VirusFtpEvent' />
VirusHttpEvent
<section begin='VirusHttpEvent' />
These events are created by Virus Blocker and update the http_events table when Virus Blocker scans an HTTP transfer.
Attribute Name | Type | Description |
---|---|---|
appName | String | The name of the application |
class | Class | The class name |
clean | boolean | True if clean, false otherwise |
requestId | Long | The request ID |
timeStamp | Timestamp | The timestamp |
virusName | String | The virus name, if not clean |
<section end='VirusHttpEvent' />
SpamSmtpTarpitEvent
<section begin='SpamSmtpTarpitEvent' />
These events are created by Spam Blocker and inserted to the smtp_tarpit_events table when a session is tarpitted.
Attribute Name | Type | Description |
---|---|---|
IPAddr | InetAddress | The IP address |
class | Class | The class name |
hostname | String | The hostname |
sessionEvent | SessionEvent | The session event |
sessionId | Long | The session ID |
timeStamp | Timestamp | The timestamp |
vendorName | String | The application name |
<section end='SpamSmtpTarpitEvent' />
SpamLogEvent
<section begin='SpamLogEvent' />
These events are created by Spam Blocker and update the mail_msgs table when an email is scanned.
Attribute Name | Type | Description |
---|---|---|
action | SpamMessageAction | The action |
class | Class | The class name |
clientAddr | InetAddress | The client address |
clientPort | int | The client port |
messageId | Long | The message ID |
receiver | String | The receiver |
score | float | The score |
sender | String | The sender |
serverAddr | InetAddress | The server address |
serverPort | int | The server port |
smtpMessageEvent | SmtpMessageEvent | The parent SMTP message event |
isSpam | boolean | True if spam, false otherwise |
subject | String | The subject |
testsString | String | The tests string from the spam engine |
timeStamp | Timestamp | The timestamp |
vendorName | String | The application name |
<section end='SpamLogEvent' />
HttpResponseEvent
<section begin='HttpResponseEvent' />
These events are created by HTTP subsystem and update the http_events table when a web response happens.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
contentLength | long | The content length |
contentType | String | The content type |
httpRequestEvent | HttpRequestEvent | The corresponding HTTP request event |
requestLine | RequestLine | The request line |
timeStamp | Timestamp | The timestamp |
<section end='HttpResponseEvent' />
HttpRequestEvent
<section begin='HttpRequestEvent' />
These events are created by HTTP subsystem and inserted to the http_events table when a web request happens.
Attribute Name | Type | Description |
---|---|---|
class | Class | The class name |
contentLength | long | The content length |
domain | String | The domain |
host | String | The host |
method | HttpMethod | The HTTP method |
referer | String | The referer |
requestId | Long | The request ID |
requestUri | URI | The request URI |
sessionEvent | SessionEvent | The session event |
timeStamp | Timestamp | The timestamp |
<section end='HttpRequestEvent' />
OpenVpnEvent
<section begin='OpenVpnEvent' />
These events are created by OpenVPN and update the openvpn_events table when OpenVPN processes a client action.
Attribute Name | Type | Description |
---|---|---|
address | InetAddress | The address |
class | Class | The class name |
clientName | String | The client name |
poolAddress | InetAddress | The pool address |
timeStamp | Timestamp | The timestamp |
type | OpenVpnEvent$EventType | The type |
<section end='OpenVpnEvent' />
OpenVpnStatusEvent
<section begin='OpenVpnStatusEvent' />
These events are created by OpenVPN and update the openvpn_stats table periodically.
Attribute Name | Type | Description |
---|---|---|
address | InetAddress | The address |
bytesRxDelta | long | The delta number of RX (received) bytes from the previous event |
bytesRxTotal | long | The total number of RX (received) bytes |
bytesTxDelta | long | The delta number of TX (transmitted) bytes from the previous event |
bytesTxTotal | long | The total number of TX (transmitted) bytes |
class | Class | The class name |
clientName | String | The client name |
end | Timestamp | The end |
poolAddress | InetAddress | The pool address |
port | int | The port |
start | Timestamp | The start |
timeStamp | Timestamp | The timestamp |
<section end='OpenVpnStatusEvent' />
WebCacheEvent
<section begin='WebCacheEvent' />
These events are created by Web Cache and inserted to the web_cache_stats table periodically.
Attribute Name | Type | Description |
---|---|---|
bypassCount | long | The number of bypasses |
class | Class | The class name |
hitBytes | long | The number of bytes worth of hits |
hitCount | long | The number of hits |
missBytes | long | The number of bytes worth of misses |
missCount | long | The number of misses |
policyId | Long | The policy ID |
systemCount | long | The number of system bypasses |
timeStamp | Timestamp | The timestamp |
<section end='WebCacheEvent' />