If you are currently using version 5.x.x, we advise you to upgrade to the latest version before the EOL date. You can find the latest documentation here.
Introduction
The Geneos X Traffic plugin monitors user-defined TCP/IP conversations and displays the data send and receive rates and connection state. When a connection is terminated, the plugin can also detect which side of the connection initiated termination.
The Netprobe must run in a location that it can "listen" to TCP/IP traffic. This typically means it must run on a host which is participating in the TCP/IP conversation which you wish to monitor.
Views
View
The X Traffic plugin produces a single view, which is described below. Depending upon the plugin mode selected, the view may display summary rows, details rows or a combination of the two.
Summary rows display a summary of statistics for all conversations matching that plugin configuration item, whereas detail rows show details for a particular TCP/IP conversation. This distinction is particularly relevant when configuring conversations that only partially specify an end-point.
Headline Legend
The headlines produced by this plugin are only available in details mode.
| Name | Description |
|---|---|
| pktSendRate | Total packet send rate in packets per second. |
| pktRecvRate | Total packet receive rate in packets per second. |
| dataSendRate | Total data send rate in kilobytes/s. |
| dataRecvRate | Total data receive rate in kilobytes/s. |
Table Legend
| Name | Description |
|---|---|
| name | The session (or conversation) name, as configured by the user. |
| state | The connection state, either "connected" or "disconnected" followed by the time at which this state occurred. |
| connectionCount | The number of connections for this session. This field is only populated for summary rows. |
| pktSendRate | Packets sent per second, averaged over the sample interval. |
| pktRecvRate | Packets received per second, averaged over the sample interval. |
| dataSendRate | Data sent in kilobytes/s, averaged over the sample interval. |
| dataRecvRate | Data received in kilobytes/s, averaged over the sample interval. |
| tmSinceLastPacket | Number of seconds elapsed since the last packet sent or received. |
| localAddress | The IP address of the local side of the connection. |
| localPort | The port number of the local side of the connection. |
| remoteAddress | The IP address of the remote side of the connection. |
| remotePort | The port number of the remote side of the connection. |
Plugin Configuration
The X Traffic plugin listens to all TCP/IP data received by a host, and matches the local/remote host and ports as configured by the user.
Plugin configuration is placed in the x-traffic configuration section.
var-recvInterfaces
Specifies a comma-separated list of network interface names used to monitor incoming TCP/IP data.
On UNIX machines, interface names can be found using the command "ifconfig -a". Example names are "eth0" or "ce0".
On Windows machines, interface names can be listed by running Netprobe using the "-ifconfig" command-line option. A Windows interface name will look similar to the following:
\\Device\\NPF\_{BDFE3EAC-0275-440A-923C-C9C4CE3B37F2}Mandatory: Yes
sendInterface
The name of the network interface to be used to send packets (e.g. hme0). Usually the same as recvInterface parameter, but can be set to a different value in certain network configurations.
Mandatory: Yes
sessions
Specifies the list of (at least one) TCP/IP sessions that this plugin will monitor. Sessions specify the source and destination host and ports of the TCP/IP connection, and each host or port may be configured as a wildcard. Connections matching this session will then be monitored.
Note
It is an invalid configuration to specify all parts of a connection configuration as a wildcard - you must specify at least one host or port.
Mandatory: Yes
sessions > session > var-name
The name of the session (or conversation) - this is the name which will be displayed in the view (as the row name). Session names should be unique within each plugin instance.
Mandatory: Yes
sessions > session > src
Specifies the source host/IP address and port for the session. The host/IP or port may be set to a wildcard (*) to indicate a match against any host or port.
Mandatory: Yes
sessions > session > dst
Specifies the remote host/IP address and port and port for the session. The host/IP or port may be set to a wildcard (*) to indicate a match against any host or port.
Mandatory: Yes
displayMode
Specifies the display mode for this plugin. Possible values are SUMMARY, DETAILS or SUMMARY+DETAILS.
Summary mode only shows the top-level summaries for the configured sessions. Details mode shows only the details (i.e. the individual connections that match the configured sessions) while summary and details mode shows both. See the view section for an example.
var-cleanUpTime
The length of time for which a disconnected TCP/IP connection will be displayed before it is removed from the view. This setting takes a positive integer (at least 1) which specifies the number of seconds before a connection is cleared.
Note: X Traffic periodically checks idle connection that does not have packet exchange for more than 60 seconds against the OS tcp table to verify if it still connected or not.
checkTargetHostHasChangedIp
Forces X Route to detect if the underlying IP address of a host name has +changed. This will restart the packet capture engine so X Route will +continue to check the correct host. In between restarts there is a +potential for losing packets.
Note: Restarting the packet capture engine will affect all X-Set plugins as they too might miss packets
Permissions
The plugin needs to open network devices, so you should run the Netprobe using root or administrator permission on and , respectively.
On kernel versions 2.6.24 and higher, an
alternative to running the Netprobe as root is
by setting the CAP_NET_RAW and CAP_NET_ADMIN capabilities on the Netprobe binary using the following command:
setcap cap_net_raw,cap_net_admin+eip <netprobe binary>
When running the Netprobe with set capabilities, the
lib64/startup folder in the Netprobe directory should be in
the ld.so trusted paths. Otherwise, the runtime
libraries will not load properly. For guidance, see Run Netprobe under elevated privileges in Linux in Quickstart: Linux and other platforms.
Third Party Libraries
: The Npcap packet capture library needs to be installed on the host. If Npcap is not installed using WinPcap API-compatible mode, then the Npcap installation directory must be added in the PATH environment variable or the DLL_PATH registry variable.
: The shared library libpcap.so needs to be in the netprobe/lib64 directory. It is recommended to use libpcap.so version 1.0.0 or later.
Note: As the Netprobe needs to be run as
root, the LD_LIBRARY_PATH is ignored for security
reasons.