From b635ecc6c126c353e1476bcc9ff4ec0efdca2f77 Mon Sep 17 00:00:00 2001 From: Ben Reedy Date: Wed, 28 Aug 2019 20:57:34 +1000 Subject: [PATCH 1/2] Add documentation for os collector --- docs/collector.os.md | 56 ++++++++++++++++++++++++++++++++------------ 1 file changed, 41 insertions(+), 15 deletions(-) diff --git a/docs/collector.os.md b/docs/collector.os.md index 30fb029f..29c525a3 100644 --- a/docs/collector.os.md +++ b/docs/collector.os.md @@ -16,24 +16,50 @@ None Name | Description | Type | Labels -----|-------------|------|------- -`wmi_os_paging_limit_bytes` | _Not yet documented_ | gauge | None -`wmi_os_paging_free_bytes` | _Not yet documented_ | gauge | None -`wmi_os_physical_memory_free_bytes` | _Not yet documented_ | gauge | None -`wmi_os_time` | _Not yet documented_ | gauge | None -`wmi_os_timezone` | _Not yet documented_ | gauge | `timezone` -`wmi_os_processes` | _Not yet documented_ | gauge | None -`wmi_os_processes_limit` | _Not yet documented_ | gauge | None -`wmi_os_process_memory_limix_bytes` | _Not yet documented_ | gauge | None -`wmi_os_users` | _Not yet documented_ | gauge | None -`wmi_os_virtual_memory_bytes` | _Not yet documented_ | gauge | None -`wmi_os_visible_memory_bytes` | _Not yet documented_ | gauge | None -`wmi_os_virtual_memory_free_bytes` | _Not yet documented_ | gauge | None +`wmi_os_paging_limit_bytes` | Total number of bytes that can be sotred in the operating system paging files. 0 (zero) indicates that there are no paging files | gauge | None +`wmi_os_paging_free_bytes` | Number of bytes that can be mapped into the operating system paging files without causing any other pages to be swapped out | gauge | None +`wmi_os_physical_memory_free_bytes` | Bytes of physical memory currently unused and available | gauge | None +`wmi_os_time` | Current time as reported by the operating system, in [Unix time](https://en.wikipedia.org/wiki/Unix_time). See [time.Unix()](https://golang.org/pkg/time/#Unix) for details | gauge | None +`wmi_os_timezone` | Current timezone as reported by the operating system. See [time.Zone()](https://golang.org/pkg/time/#Time.Zone) for details | gauge | `timezone` +`wmi_os_processes` | Number of process contexts currently loaded or running on the operating system | gauge | None +`wmi_os_processes_limit` | Maximum number of process contexts the operating system can support. The default value set by the provider is 4294967295 (0xFFFFFFFF) | gauge | None +`wmi_os_process_memory_limit_bytes` | Maximum number of bytes of memory that can be allocated to a process | gauge | None +`wmi_os_users` | Number of user sessions for which the operating system is storing state information currently. For a list of current active logon sessions, see [`logon`](collector.logon.md) | gauge | None +`wmi_os_virtual_memory_bytes` | Bytes of virtual memory | gauge | None +`wmi_os_visible_memory_bytes` | Total bytes of physical memory available to the operating system. This value does not necessarily indicate the true amount of physical memory, but what is reported to the operating system as available to it | gauge | None +`wmi_os_virtual_memory_free_bytes` | Bytes of virtual memory currently unused and available | gauge | None ### Example metric -_This collector does not yet have explained examples, we would appreciate your help adding them!_ +Show current number of processes +``` +wmi_os_processes{instance="localhost"} +``` ## Useful queries -_This collector does not yet have any useful queries added, we would appreciate your help adding them!_ +Find all devices not set to UTC timezone +``` +wmi_os_timezone{timezone != "UTC"} +``` ## Alerting examples -_This collector does not yet have alerting examples, we would appreciate your help adding them!_ +**prometheus.rules** +``` +# Alert on hosts that have exhausted all available physical memory +- alert: MemoryExhausted + expr: wmi_os_physical_memory_free_bytes == 0 + for: 10m + labels: + severity: high + annotations: + summary: "Host {{ $labels.instance }} is out of memory" + description: "{{ $labels.instance }} has exhausted all available physical memory" + +# Alert on hosts with greater than 90% memory usage +- alert: MemoryLow + expr: 100 - 100 * wmi_os_physical_memory_free_bytes / wmi_cs_physical_memory_bytes > 90 + for: 10m + labels: + severity: warning + annotations: + summary: "Memory usage for host {{ $labels.instance }} is greater than 90%" +``` From e1141c3ec08c83a4a0ca47cb5769ac5070e4d1c8 Mon Sep 17 00:00:00 2001 From: Ben Reedy Date: Wed, 28 Aug 2019 21:06:23 +1000 Subject: [PATCH 2/2] 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!_