Skip to content

Commit 080f80e

Browse files
carlpettmartinlindhe
carlpett
authored and
martinlindhe
committed
Fix broken summary table in collector docs (prometheus-community#286)
1 parent 2766f0e commit 080f80e

27 files changed

+95
-43
lines changed

‎README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,22 @@ Prometheus exporter for Windows machines, using the WMI (Windows Management Inst
99

1010
Name | Description | Enabled by default
1111
---------|-------------|--------------------
12-
[ad](docs/collector.ad.md) | [Win32_PerfRawData_DirectoryServices_DirectoryServices](https://msdn.microsoft.com/en-us/library/ms803980.aspx) Active Directory |
13-
[cpu](docs/collector.cpu.md) | [Win32_PerfRawData_PerfOS_Processor](https://msdn.microsoft.com/en-us/library/aa394317(v=vs.90).aspx) metrics (cpu usage) | ✓
14-
[cs](docs/collector.cs.md) | [Win32_ComputerSystem](https://msdn.microsoft.com/en-us/library/aa394102) metrics (system properties, num cpus/total memory) | ✓
15-
[dns](docs/collector.dns.md) | [Win32_PerfRawData_DNS_DNS](https://technet.microsoft.com/en-us/library/cc977686.aspx) metrics (DNS Server) |
16-
[hyperv](docs/collector.hyperv.md) | Performance counters for Hyper-V hosts |
17-
[iis](docs/collector.iis.md) | [Win32_PerfRawData_W3SVC_WebService](https://msdn.microsoft.com/en-us/library/aa394345) IIS metrics |
18-
[logical_disk](docs/collector.logical_disk.md) | [Win32_PerfRawData_PerfDisk_LogicalDisk](https://msdn.microsoft.com/en-us/windows/hardware/aa394307(v=vs.71)) metrics (disk I/O) | ✓
19-
[net](docs/collector.net.md) | [Win32_PerfRawData_Tcpip_NetworkInterface](https://technet.microsoft.com/en-us/security/aa394340(v=vs.80)) metrics (network interface I/O) | ✓
12+
[ad](docs/collector.ad.md) | Active Directory Domain Services |
13+
[cpu](docs/collector.cpu.md) | CPU usage | ✓
14+
[cs](docs/collector.cs.md) | "Computer System" metrics (system properties, num cpus/total memory) | ✓
15+
[dns](docs/collector.dns.md) | DNS Server |
16+
[hyperv](docs/collector.hyperv.md) | Hyper-V hosts |
17+
[iis](docs/collector.iis.md) | IIS sites and applications |
18+
[logical_disk](docs/collector.logical_disk.md) | Logical disks, disk I/O | ✓
19+
[net](docs/collector.net.md) | Network interface I/O | ✓
2020
[memory](docs/collector.memory.md) | Memory usage metrics |
21-
[msmq](docs/collector.msmq.md) | [Win32_PerfRawData_MSMQ_MSMQQueue](http://wutils.com/wmi/root/cimv2/win32_perfrawdata_msmq_msmqqueue/) metrics (MSMQ/journal count) |
22-
[mssql](docs/collector.mssql.md) | various [SQL Server Performance Objects](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/use-sql-server-objects#SQLServerPOs) metrics |
23-
[os](docs/collector.os.md) | [Win32_OperatingSystem](https://msdn.microsoft.com/en-us/library/aa394239) metrics (memory, processes, users) | ✓
24-
[process](docs/collector.process.md) | [Win32_PerfRawData_PerfProc_Process](https://msdn.microsoft.com/en-us/library/aa394323(v=vs.85).aspx) metrics (per-process stats) |
21+
[msmq](docs/collector.msmq.md) | MSMQ queues |
22+
[mssql](docs/collector.mssql.md) | [SQL Server Performance Objects](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/use-sql-server-objects#SQLServerPOs) metrics |
23+
[os](docs/collector.os.md) | OS metrics (memory, processes, users) | ✓
24+
[process](docs/collector.process.md) | Per-process metrics |
2525
[service](docs/collector.service.md) | Service state metrics | ✓
26-
[system](docs/collector.system.md) | Win32_PerfRawData_PerfOS_System metrics (system calls) | ✓
27-
[tcp](docs/collector.tcp.md) | [Win32_PerfRawData_Tcpip_TCPv4](https://msdn.microsoft.com/en-us/library/aa394341(v=vs.85).aspx) metrics (tcp connections) |
26+
[system](docs/collector.system.md) | System calls | ✓
27+
[tcp](docs/collector.tcp.md) | TCP connections |
2828
[textfile](docs/collector.textfile.md) | Read prometheus metrics from a text file | ✓
2929
[vmware](docs/collector.vmware.md) | Performance counters installed by the Vmware Guest agent |
3030

‎docs/collector-template.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The %name% collector exposes metrics about ...
44

5-
Metric name prefix | `%name%`
5+
|||
6+
-|-
7+
Metric name prefix | `%name%`
68
Classes | [`...`](https://msdn.microsoft.com/en-us/library/...)
79
Enabled by default? | Yes/No
810

‎docs/collector.ad.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The ad collector exposes metrics about a Active Directory Domain Services domain controller
44

5-
Metric name prefix | `ad`
5+
|||
6+
-|-
7+
Metric name prefix | `ad`
68
Classes | [`Win32_PerfRawData_DirectoryServices_DirectoryServices`](https://msdn.microsoft.com/en-us/library/ms803980.aspx)
79
Enabled by default? | No
810

‎docs/collector.cpu.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The cpu collector exposes metrics about CPU usage
44

5-
Metric name prefix | `cpu`
5+
|||
6+
-|-
7+
Metric name prefix | `cpu`
68
Classes | [`Win32_PerfRawData_PerfOS_Processor`](https://msdn.microsoft.com/en-us/library/aa394317(v=vs.90).aspx)
79
Enabled by default? | Yes
810

‎docs/collector.cs.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The cs collector exposes metrics detailing the hardware of the computer system
44

5-
Metric name prefix | `cs`
5+
|||
6+
-|-
7+
Metric name prefix | `cs`
68
Classes | [`Win32_ComputerSystem`](https://msdn.microsoft.com/en-us/library/aa394102)
79
Enabled by default? | Yes
810

‎docs/collector.dns.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The dns collector exposes metrics about the DNS server
44

5-
Metric name prefix | `dns`
5+
|||
6+
-|-
7+
Metric name prefix | `dns`
68
Classes | [`Win32_PerfRawData_DNS_DNS`](https://technet.microsoft.com/en-us/library/cc977686.aspx)
79
Enabled by default? | No
810

‎docs/collector.hyperv.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
The hyperv collector exposes metrics about the Hyper-V hypervisor
44

5-
Metric name prefix | `hyperv`
6-
Classes | `Win32_PerfRawData_VmmsVirtualMachineStats_HyperVVirtualMachineHealthSummary`, `Win32_PerfRawData_VidPerfProvider_HyperVVMVidPartition`, `Win32_PerfRawData_HvStats_HyperVHypervisorRootPartition`, `Win32_PerfRawData_HvStats_HyperVHypervisor`, `Win32_PerfRawData_HvStats_HyperVHypervisorRootVirtualProcessor`, `Win32_PerfRawData_HvStats_HyperVHypervisorVirtualProcessor`, `Win32_PerfRawData_NvspSwitchStats_HyperVVirtualSwitch`, `Win32_PerfRawData_EthernetPerfProvider_HyperVLegacyNetworkAdapter`, `Win32_PerfRawData_Counters_HyperVVirtualStorageDevice`, `Win32_PerfRawData_NvspNicStats_HyperVVirtualNetworkAdapter`
5+
|||
6+
-|-
7+
Metric name prefix | `hyperv`
8+
Classes | `Win32_PerfRawData_VmmsVirtualMachineStats_HyperVVirtualMachineHealthSummary`<br/>`Win32_PerfRawData_VidPerfProvider_HyperVVMVidPartition`<br/>`Win32_PerfRawData_HvStats_HyperVHypervisorRootPartition`<br/>`Win32_PerfRawData_HvStats_HyperVHypervisor`<br/>`Win32_PerfRawData_HvStats_HyperVHypervisorRootVirtualProcessor`<br/>`Win32_PerfRawData_HvStats_HyperVHypervisorVirtualProcessor`<br/>`Win32_PerfRawData_NvspSwitchStats_HyperVVirtualSwitch`<br/>`Win32_PerfRawData_EthernetPerfProvider_HyperVLegacyNetworkAdapter`<br/>`Win32_PerfRawData_Counters_HyperVVirtualStorageDevice`<br/>`Win32_PerfRawData_NvspNicStats_HyperVVirtualNetworkAdapter`
79
Enabled by default? | No
810

911
## Flags

‎docs/collector.iis.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
The iis collector exposes metrics about the IIS server
44

5-
Metric name prefix | `iis`
6-
Classes | `Win32_PerfRawData_W3SVC_WebService`, `Win32_PerfRawData_APPPOOLCountersProvider_APPPOOLWAS`, `Win32_PerfRawData_W3SVCW3WPCounterProvider_W3SVCW3WP`, `Win32_PerfRawData_W3SVC_WebServiceCache`
5+
|||
6+
-|-
7+
Metric name prefix | `iis`
8+
Classes | `Win32_PerfRawData_W3SVC_WebService`<br/>`Win32_PerfRawData_APPPOOLCountersProvider_APPPOOLWAS`<br/>`Win32_PerfRawData_W3SVCW3WPCounterProvider_W3SVCW3WP`<br/>`Win32_PerfRawData_W3SVC_WebServiceCache`
79
Enabled by default? | No
810

911
## Flags

‎docs/collector.logical_disk.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The logical_disk collector exposes metrics about logical disks (in contrast to physical disks)
44

5-
Metric name prefix | `logical_disk`
5+
|||
6+
-|-
7+
Metric name prefix | `logical_disk`
68
Classes | [`Win32_PerfRawData_PerfDisk_LogicalDisk`](https://msdn.microsoft.com/en-us/windows/hardware/aa394307(v=vs.71))
79
Enabled by default? | Yes
810

‎docs/collector.msmq.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The msmq collector exposes metrics about the queues on a MSMQ server
44

5-
Metric name prefix | `msmq`
5+
|||
6+
-|-
7+
Metric name prefix | `msmq`
68
Classes | `Win32_PerfRawData_MSMQ_MSMQQueue`
79
Enabled by default? | No
810

‎docs/collector.mssql.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
The mssql collector exposes metrics about the MSSQL server
44

5-
Metric name prefix | `mssql`
6-
Classes | [`Win32_PerfRawData_MSSQLSERVER_SQLServerAccessMethods`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-access-methods-object), [`Win32_PerfRawData_MSSQLSERVER_SQLServerAvailabilityReplica`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-availability-replica), [`Win32_PerfRawData_MSSQLSERVER_SQLServerBufferManager`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-buffer-manager-object), [`Win32_PerfRawData_MSSQLSERVER_SQLServerDatabaseReplica`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-database-replica), [`Win32_PerfRawData_MSSQLSERVER_SQLServerDatabases`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-databases-object?view=sql-server-2017), [`Win32_PerfRawData_MSSQLSERVER_SQLServerGeneralStatistics`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-general-statistics-object), [`Win32_PerfRawData_MSSQLSERVER_SQLServerLocks`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-locks-object), [`Win32_PerfRawData_MSSQLSERVER_SQLServerMemoryManager`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-memory-manager-object), [`Win32_PerfRawData_MSSQLSERVER_SQLServerSQLStatistics`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-sql-statistics-object)
5+
|||
6+
-|-
7+
Metric name prefix | `mssql`
8+
Classes | [`Win32_PerfRawData_MSSQLSERVER_SQLServerAccessMethods`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-access-methods-object)<br/>[`Win32_PerfRawData_MSSQLSERVER_SQLServerAvailabilityReplica`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-availability-replica)<br/>[`Win32_PerfRawData_MSSQLSERVER_SQLServerBufferManager`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-buffer-manager-object)<br/>[`Win32_PerfRawData_MSSQLSERVER_SQLServerDatabaseReplica`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-database-replica)<br/>[`Win32_PerfRawData_MSSQLSERVER_SQLServerDatabases`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-databases-object?view=sql-server-2017)<br/>[`Win32_PerfRawData_MSSQLSERVER_SQLServerGeneralStatistics`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-general-statistics-object)<br/>[`Win32_PerfRawData_MSSQLSERVER_SQLServerLocks`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-locks-object)<br/>[`Win32_PerfRawData_MSSQLSERVER_SQLServerMemoryManager`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-memory-manager-object)<br/>[`Win32_PerfRawData_MSSQLSERVER_SQLServerSQLStatistics`](https://docs.microsoft.com/en-us/sql/relational-databases/performance-monitor/sql-server-sql-statistics-object)
79
Enabled by default? | No
810

911
## Flags

‎docs/collector.net.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The net collector exposes metrics about network interfaces
44

5-
Metric name prefix | `net`
5+
|||
6+
-|-
7+
Metric name prefix | `net`
68
Classes | [`Win32_PerfRawData_Tcpip_NetworkInterface`](https://technet.microsoft.com/en-us/security/aa394340(v=vs.80))
79
Enabled by default? | Yes
810

‎docs/collector.netframework_clrexceptions.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The netframework_clrexceptions collector exposes metrics about CLR exceptions in the dotnet framework.
44

5-
Metric name prefix | `netframework_clrexceptions`
5+
|||
6+
-|-
7+
Metric name prefix | `netframework_clrexceptions`
68
Classes | `Win32_PerfRawData_NETFramework_NETCLRExceptions`
79
Enabled by default? | No
810

‎docs/collector.netframework_clrinterop.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The netframework_clrinterop collector exposes metrics about interop between the dotnet framework and outside components.
44

5-
Metric name prefix | `netframework_clrinterop`
5+
|||
6+
-|-
7+
Metric name prefix | `netframework_clrinterop`
68
Classes | `Win32_PerfRawData_NETFramework_NETCLRInterop`
79
Enabled by default? | No
810

‎docs/collector.netframework_clrjit.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The netframework_clrjit collector exposes metrics about the dotnet Just-in-Time compiler.
44

5-
Metric name prefix | `netframework_clrjit`
5+
|||
6+
-|-
7+
Metric name prefix | `netframework_clrjit`
68
Classes | `Win32_PerfRawData_NETFramework_NETCLRJit`
79
Enabled by default? | No
810

‎docs/collector.netframework_clrloading.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The netframework_clrloading collector exposes metrics about the dotnet loader.
44

5-
Metric name prefix | `netframework_clrloading`
5+
|||
6+
-|-
7+
Metric name prefix | `netframework_clrloading`
68
Classes | `Win32_PerfRawData_NETFramework_NETCLRLoading`
79
Enabled by default? | No
810

‎docs/collector.netframework_clrlocksandthreads.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The netframework_clrlocksandthreads collector exposes metrics about locks and threads in dotnet applications.
44

5-
Metric name prefix | `netframework_clrlocksandthreads`
5+
|||
6+
-|-
7+
Metric name prefix | `netframework_clrlocksandthreads`
68
Classes | `Win32_PerfRawData_NETFramework_NETCLRLocksAndThreads`
79
Enabled by default? | No
810

‎docs/collector.netframework_clrmemory.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The netframework_clrmemory collector exposes metrics about memory in dotnet applications.
44

5-
Metric name prefix | `netframework_clrmemory`
5+
|||
6+
-|-
7+
Metric name prefix | `netframework_clrmemory`
68
Classes | `Win32_PerfRawData_NETFramework_NETCLRMemory`
79
Enabled by default? | No
810

‎docs/collector.netframework_clrremoting.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The netframework_clrremoting collector exposes metrics about dotnet remoting.
44

5-
Metric name prefix | `netframework_clrremoting`
5+
|||
6+
-|-
7+
Metric name prefix | `netframework_clrremoting`
68
Classes | `Win32_PerfRawData_NETFramework_NETCLRRemoting`
79
Enabled by default? | No
810

‎docs/collector.netframework_clrsecurity.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The netframework_clrsecurity collector exposes metrics about security checks in dotnet applications
44

5-
Metric name prefix | `netframework_clrsecurity`
5+
|||
6+
-|-
7+
Metric name prefix | `netframework_clrsecurity`
68
Classes | `Win32_PerfRawData_NETFramework_NETCLRSecurity`
79
Enabled by default? | No
810

‎docs/collector.os.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The os collector exposes metrics about the operating system
44

5-
Metric name prefix | `os`
5+
|||
6+
-|-
7+
Metric name prefix | `os`
68
Classes | [`Win32_OperatingSystem`](https://msdn.microsoft.com/en-us/library/aa394239)
79
Enabled by default? | Yes
810

‎docs/collector.process.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The process collector exposes metrics about processes
44

5-
Metric name prefix | `process`
5+
|||
6+
-|-
7+
Metric name prefix | `process`
68
Classes | [`Win32_PerfRawData_PerfProc_Process`](https://msdn.microsoft.com/en-us/library/aa394323(v=vs.85).aspx)
79
Enabled by default? | No
810

‎docs/collector.service.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The service collector exposes metrics about Windows Services
44

5-
Metric name prefix | `service`
5+
|||
6+
-|-
7+
Metric name prefix | `service`
68
Classes | [`Win32_Service`](https://msdn.microsoft.com/en-us/library/aa394418(v=vs.85).aspx)
79
Enabled by default? | Yes
810

‎docs/collector.system.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The system collector exposes metrics about ...
44

5-
Metric name prefix | `system`
5+
|||
6+
-|-
7+
Metric name prefix | `system`
68
Classes | [`Win32_PerfRawData_PerfOS_System`](https://web.archive.org/web/20050830140516/http://msdn.microsoft.com/library/en-us/wmisdk/wmi/win32_perfrawdata_perfos_system.asp)
79
Enabled by default? | Yes
810

‎docs/collector.tcp.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The tcp collector exposes metrics about the TCP/IPv4 network stack.
44

5-
Metric name prefix | `tcp`
5+
|||
6+
-|-
7+
Metric name prefix | `tcp`
68
Classes | [`Win32_PerfRawData_Tcpip_TCPv4`](https://msdn.microsoft.com/en-us/library/aa394341(v=vs.85).aspx)
79
Enabled by default? | No
810

‎docs/collector.textfile.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The textfile collector exposes metrics from files written by other processes.
44

5-
Metric name prefix | `textfile`
5+
|||
6+
-|-
7+
Metric name prefix | `textfile`
68
Classes | None
79
Enabled by default? | Yes
810

‎docs/collector.vmware.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
The vmware collector exposes metrics about a VMware guest VM
44

5-
Metric name prefix | `vmware`
5+
|||
6+
-|-
7+
Metric name prefix | `vmware`
68
Classes | `Win32_PerfRawData_vmGuestLib_VMem`, `Win32_PerfRawData_vmGuestLib_VCPU`
79
Enabled by default? | No
810

0 commit comments

Comments
 (0)