From e1141c3ec08c83a4a0ca47cb5769ac5070e4d1c8 Mon Sep 17 00:00:00 2001 From: Ben Reedy Date: Wed, 28 Aug 2019 21:06:23 +1000 Subject: [PATCH] Add documentation for tcp collector --- docs/collector.tcp.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/collector.tcp.md b/docs/collector.tcp.md index 4b971d17..e3bb0ad3 100644 --- a/docs/collector.tcp.md +++ b/docs/collector.tcp.md @@ -16,15 +16,15 @@ None Name | Description | Type | Labels -----|-------------|------|------- -`wmi_tcp_connection_failures` | _Not yet documented_ | counter | None -`wmi_tcp_connections_active` | _Not yet documented_ | counter | None -`wmi_tcp_connections_established` | _Not yet documented_ | counter | None -`wmi_tcp_connections_passive` | _Not yet documented_ | counter | None -`wmi_tcp_connections_reset` | _Not yet documented_ | counter | None -`wmi_tcp_segments_total` | _Not yet documented_ | counter | None -`wmi_tcp_segments_received_total` | _Not yet documented_ | counter | None -`wmi_tcp_segments_retransmitted_total` | _Not yet documented_ | counter | None -`wmi_tcp_segments_sent_total` | _Not yet documented_ | counter | None +`wmi_tcp_connection_failures` | Number of times TCP connections have made a direct transition to the CLOSED state from the SYN-SENT state or the SYN-RCVD state, plus the number of times TCP connections have made a direct transition from the SYN-RCVD state to the LISTEN state | counter | None +`wmi_tcp_connections_active` | Number of times TCP connections have made a direct transition from the CLOSED state to the SYN-SENT state.| counter | None +`wmi_tcp_connections_established` | Number of TCP connections for which the current state is either ESTABLISHED or CLOSE-WAIT. | counter | None +`wmi_tcp_connections_passive` | Number of times TCP connections have made a direct transition from the LISTEN state to the SYN-RCVD state. | counter | None +`wmi_tcp_connections_reset` | Number of times TCP connections have made a direct transition from the LISTEN state to the SYN-RCVD state. | counter | None +`wmi_tcp_segments_total` | Total segments sent or received using the TCP protocol | counter | None +`wmi_tcp_segments_received_total` | Total segments received, including those received in error. This count includes segments received on currently established connections | counter | None +`wmi_tcp_segments_retransmitted_total` | Total segments retransmitted. That is, segments transmitted that contain one or more previously transmitted bytes | counter | None +`wmi_tcp_segments_sent_total` | Total segments sent, including those on current connections, but excluding those containing *only* retransmitted bytes | counter | None ### Example metric _This collector does not yet have explained examples, we would appreciate your help adding them!_