Docs » Integrations Guide » Integrations Reference » Protocols

image0 Protocols

Metadata associated with the Protocols collectd plugin can be found here. The relevant code for the plugin can be found here.

DESCRIPTION

From collectdwiki:

The Protocols plugin collects information about the network protocols supported by the system, for example Internet Protocol (IP) and Transmission Control Protocol (TCP). Currently the plugin is only available under Linux and reads its information from the following two files in the /proc file-system:

  • /proc/net/snmp
  • /proc/net/netstat

Because the available information is usually far too much to be useful, the interesting values can be selected using the configuration file.

REQUIREMENTS AND DEPENDENCIES

This plugin requires:

Software Version
collectd 4.7+

INSTALLATION

If you are using the new Smart Agent, see the docs for thecollectd/protocolsmonitor for more information. The configuration documentation below may be helpful as well, but consult the Smart Agent repo’s docs for the exact schema.

Installation and initial configuration options are available as part of the SignalFx collectdagent.

CONFIGURATION

Configuration for this plugin is kept in the main collectd.conf file.

From collectdwiki:

Configuration Option Type Definition
Value Selector Selects whether or not to select a specific value. The string being matched is of the form Protocol:ValueName where Protocol will be used as the plugin instance and ValueName will be used as type instance. An example of the string being used would be Tcp:RetransSegs You can use regular expressions to match a large number of values with just one configuration option. To select all “extended” TCP values, you could use the following statement: Value "/^TcpExt:/" Whether only matched values are selected or all matched values are ignored depends on the IgnoreSelected. By default, only matched values are selected. If no value is configured at all, all values will be selected.
IgnoreSelected true/false If set to true, inverts the selection made by Value, i. e. all matching values will be ignored.

USAGE

This is a plugin used to gather data about specific protocols in use by a host or collectd instance. By default the protocols that the SignalFx configuration gather metrics on are:

Value default Definition
Icmp Icmp:InDestUnreachs  
Tcp Tcp:CurrEstab The number of TCP connections for which the current state is either ESTABLISHED or CLOSE- WAIT.
Tcp Tcp:OutSegs The total number of segments that have been sent, including those on current connections but excluding those containing only retransmitted octets.
Tcp Tcp:RetransSegs The total number of TCP segments that have been transmitted containing one or more previously transmitted octets.
TcpExt TcpExt:DelayedACKs delayed acknowledgements
Tcp Tcp:.*Opens/ To select all TCP values with an extension including the variable Opens
TcpExt /^TcpExt:.*Octets/ To select all “extended” TCP values with an extension including the variable Octets

METRICS

Below is a list of all metrics.

Metric Name Brief Type
protocol_counter.ActiveOpens The number of times TCP connections transitioned from the CLOSED state to the SYN-SENT state. cumulative counter
protocol_counter.CurrEstab The number of TCP connections currently in either ESTABLISHED or CLOSE-WAIT state. cumulative counter
protocol_counter.DelayedACKs The number of acknowledgements delayed by TCP Delayed Acknowledgement cumulative counter
protocol_counter.InDestUnreachs The number of ICMP Destination Unreachable messages received cumulative counter
protocol_counter.PassiveOpens The number of times that a server opened a connection, due to receiving a TCP SYN packet. cumulative counter
protocol_counter.RetransSegs The total number of segments retransmitted cumulative counter

protocol_counter.ActiveOpens

cumulative counter

The number of times TCP connections transitioned from the CLOSED state to the SYN-SENT state.

protocol_counter.CurrEstab

cumulative counter

The number of TCP connections currently in either ESTABLISHED or CLOSE-WAIT state.

protocol_counter.DelayedACKs

cumulative counter

The number of acknowledgements which were delayed because of TCP Delayed Acknowledgement algorithm.

protocol_counter.InDestUnreachs

cumulative counter

The ICMP destination unreachable message is generated by a router to inform the source host
that the destination unicast address is unreachable.

protocol_counter.PassiveOpens

cumulative counter

The number of times that a server opened a connection due to receiving a TCP SYN packet.

protocol_counter.RetransSegs

cumulative counter

The number of times a TCP segment was retransmitted because it was perceived to be lost. If this number is high, you should check for network hardware or configuration problems. See TCP congestion avoidance algorithms.