Skip to content

Latest commit

 

History

History
83 lines (55 loc) · 3.63 KB

collectd-protocols.md

File metadata and controls

83 lines (55 loc) · 3.63 KB
Raw

collectd/protocols

Monitor Type: collectd/protocols (Source)

Accepts Endpoints: No

Multiple Instances Allowed: No

Overview

Gathers metrics about the network protocol stacks running on the system by using the collectd protocols plugin.

See the integrations doc for more information.

Configuration

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: collectd/protocols
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

This monitor has no configuration options.

Metrics

These are the metrics available for this monitor. Metrics that are categorized as container/host (default) are in bold and italics in the list below.

  • protocol_counter.ActiveOpens (cumulative)
    The number of times TCP connections transitioned from the CLOSED state to the SYN-SENT state.

  • protocol_counter.CurrEstab (cumulative)
    The number of TCP connections currently in either ESTABLISHED or CLOSE-WAIT state.

  • protocol_counter.DelayedACKs (cumulative)
    The number of acknowledgements delayed by TCP Delayed Acknowledgement

  • protocol_counter.InDestUnreachs (cumulative)
    The number of ICMP Destination Unreachable messages received

  • protocol_counter.OutSegs (cumulative)
    The total number of segments that have been sent, including those on current connections but excluding those containing only retransmitted octets.

  • protocol_counter.PassiveOpens (cumulative)
    The number of times that a server opened a connection, due to receiving a TCP SYN packet.

  • protocol_counter.RetransSegs (cumulative)
    The total number of segments retransmitted

Non-default metrics (version 4.7.0+)

The following information applies to the agent version 4.7.0+ that has enableBuiltInFiltering: true set on the top level of the agent config.

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics config option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.

Legacy non-default metrics (version < 4.7.0)

The following information only applies to agent version older than 4.7.0. If you have a newer agent and have set enableBuiltInFiltering: true at the top level of your agent config, see the section above. See upgrade instructions in Old-style whitelist filtering.

If you have a reference to the whitelist.json in your agent's top-level metricsToExclude config option, and you want to emit metrics that are not in that whitelist, then you need to add an item to the top-level metricsToInclude config option to override that whitelist (see Inclusion filtering. Or you can just copy the whitelist.json, modify it, and reference that in metricsToExclude.