Fix broken summary table in collector docs (#286)

2026-02-07 21:46:37 +00:00 · 2018-11-18 22:26:38 +01:00
parent 2766f0e3af
commit 080f80eb26
27 changed files with 95 additions and 43 deletions
--- a/README.md
+++ b/README.md
@@ -9,22 +9,22 @@ Prometheus exporter for Windows machines, using the WMI (Windows Management Inst

 Name     | Description | Enabled by default
 ---------|-------------|--------------------
-[ad](docs/collector.ad.md) | [Win32_PerfRawData_DirectoryServices_DirectoryServices](https://msdn.microsoft.com/en-us/library/ms803980.aspx) Active Directory |
-[cpu](docs/collector.cpu.md) | [Win32_PerfRawData_PerfOS_Processor](https://msdn.microsoft.com/en-us/library/aa394317(v=vs.90).aspx) metrics (cpu usage) | &#10003;
-[cs](docs/collector.cs.md) | [Win32_ComputerSystem](https://msdn.microsoft.com/en-us/library/aa394102) metrics (system properties, num cpus/total memory) | &#10003;
-[dns](docs/collector.dns.md) | [Win32_PerfRawData_DNS_DNS](https://technet.microsoft.com/en-us/library/cc977686.aspx) metrics (DNS Server) |
-[hyperv](docs/collector.hyperv.md) | Performance counters for Hyper-V hosts |
-[iis](docs/collector.iis.md) | [Win32_PerfRawData_W3SVC_WebService](https://msdn.microsoft.com/en-us/library/aa394345) IIS metrics |
-[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) | &#10003;
-[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) | &#10003;
+[ad](docs/collector.ad.md) | Active Directory Domain Services |
+[cpu](docs/collector.cpu.md) | CPU usage | &#10003;
+[cs](docs/collector.cs.md) | "Computer System" metrics (system properties, num cpus/total memory) | &#10003;
+[dns](docs/collector.dns.md) | DNS Server |
+[hyperv](docs/collector.hyperv.md) | Hyper-V hosts |
+[iis](docs/collector.iis.md) | IIS sites and applications |
+[logical_disk](docs/collector.logical_disk.md) | Logical disks, disk I/O | &#10003;
+[net](docs/collector.net.md) | Network interface I/O | &#10003;
 [memory](docs/collector.memory.md) | Memory usage metrics |
-[msmq](docs/collector.msmq.md) | [Win32_PerfRawData_MSMQ_MSMQQueue](http://wutils.com/wmi/root/cimv2/win32_perfrawdata_msmq_msmqqueue/) metrics (MSMQ/journal count) |
-[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  |
-[os](docs/collector.os.md) | [Win32_OperatingSystem](https://msdn.microsoft.com/en-us/library/aa394239) metrics (memory, processes, users) | &#10003;
-[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) |
+[msmq](docs/collector.msmq.md) | MSMQ queues |
+[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  |
+[os](docs/collector.os.md) | OS metrics (memory, processes, users) | &#10003;
+[process](docs/collector.process.md) | Per-process metrics |
 [service](docs/collector.service.md) | Service state metrics | &#10003;
-[system](docs/collector.system.md) | Win32_PerfRawData_PerfOS_System metrics (system calls) | &#10003;
-[tcp](docs/collector.tcp.md) | [Win32_PerfRawData_Tcpip_TCPv4](https://msdn.microsoft.com/en-us/library/aa394341(v=vs.85).aspx) metrics (tcp connections) |
+[system](docs/collector.system.md) | System calls | &#10003;
+[tcp](docs/collector.tcp.md) | TCP connections |
 [textfile](docs/collector.textfile.md) | Read prometheus metrics from a text file | &#10003;
 [vmware](docs/collector.vmware.md) | Performance counters installed by the Vmware Guest agent |

--- a/docs/collector-template.md
+++ b/docs/collector-template.md
@@ -2,7 +2,9 @@

 The %name% collector exposes metrics about ...

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

--- a/docs/collector.ad.md
+++ b/docs/collector.ad.md
@@ -2,7 +2,9 @@

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

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

--- a/docs/collector.cpu.md
+++ b/docs/collector.cpu.md
@@ -2,7 +2,9 @@

 The cpu collector exposes metrics about CPU usage

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

--- a/docs/collector.cs.md
+++ b/docs/collector.cs.md
@@ -2,7 +2,9 @@

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

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

--- a/docs/collector.dns.md
+++ b/docs/collector.dns.md
@@ -2,7 +2,9 @@

 The dns collector exposes metrics about the DNS server

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

--- a/docs/collector.hyperv.md
+++ b/docs/collector.hyperv.md
@@ -2,8 +2,10 @@

 The hyperv collector exposes metrics about the Hyper-V hypervisor

-Metric name prefix | `hyperv`
-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`
+|||
+-|-
+Metric name prefix  | `hyperv`
+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`
 Enabled by default? | No

 ## Flags
--- a/docs/collector.iis.md
+++ b/docs/collector.iis.md
@@ -2,8 +2,10 @@

 The iis collector exposes metrics about the IIS server

-Metric name prefix | `iis`
-Classes             | `Win32_PerfRawData_W3SVC_WebService`, `Win32_PerfRawData_APPPOOLCountersProvider_APPPOOLWAS`, `Win32_PerfRawData_W3SVCW3WPCounterProvider_W3SVCW3WP`, `Win32_PerfRawData_W3SVC_WebServiceCache`
+|||
+-|-
+Metric name prefix  | `iis`
+Classes             | `Win32_PerfRawData_W3SVC_WebService`<br/>`Win32_PerfRawData_APPPOOLCountersProvider_APPPOOLWAS`<br/>`Win32_PerfRawData_W3SVCW3WPCounterProvider_W3SVCW3WP`<br/>`Win32_PerfRawData_W3SVC_WebServiceCache`
 Enabled by default? | No

 ## Flags
--- a/docs/collector.logical_disk.md
+++ b/docs/collector.logical_disk.md
@@ -2,7 +2,9 @@

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

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

--- a/docs/collector.msmq.md
+++ b/docs/collector.msmq.md
@@ -2,7 +2,9 @@

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

-Metric name prefix | `msmq`
+|||
+-|-
+Metric name prefix  | `msmq`
 Classes             | `Win32_PerfRawData_MSMQ_MSMQQueue`
 Enabled by default? | No

--- a/docs/collector.mssql.md
+++ b/docs/collector.mssql.md
@@ -2,8 +2,10 @@

 The mssql collector exposes metrics about the MSSQL server

-Metric name prefix | `mssql`
-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)
+|||
+-|-
+Metric name prefix  | `mssql`
+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)
 Enabled by default? | No

 ## Flags
--- a/docs/collector.net.md
+++ b/docs/collector.net.md
@@ -2,7 +2,9 @@

 The net collector exposes metrics about network interfaces

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

--- a/docs/collector.netframework_clrexceptions.md
+++ b/docs/collector.netframework_clrexceptions.md
@@ -2,7 +2,9 @@

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

-Metric name prefix | `netframework_clrexceptions`
+|||
+-|-
+Metric name prefix  | `netframework_clrexceptions`
 Classes             | `Win32_PerfRawData_NETFramework_NETCLRExceptions`
 Enabled by default? | No

--- a/docs/collector.netframework_clrinterop.md
+++ b/docs/collector.netframework_clrinterop.md
@@ -2,7 +2,9 @@

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

-Metric name prefix | `netframework_clrinterop`
+|||
+-|-
+Metric name prefix  | `netframework_clrinterop`
 Classes             | `Win32_PerfRawData_NETFramework_NETCLRInterop`
 Enabled by default? | No

--- a/docs/collector.netframework_clrjit.md
+++ b/docs/collector.netframework_clrjit.md
@@ -2,7 +2,9 @@

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

-Metric name prefix | `netframework_clrjit`
+|||
+-|-
+Metric name prefix  | `netframework_clrjit`
 Classes             | `Win32_PerfRawData_NETFramework_NETCLRJit`
 Enabled by default? | No

--- a/docs/collector.netframework_clrloading.md
+++ b/docs/collector.netframework_clrloading.md
@@ -2,7 +2,9 @@

 The netframework_clrloading collector exposes metrics about the dotnet loader.

-Metric name prefix | `netframework_clrloading`
+|||
+-|-
+Metric name prefix  | `netframework_clrloading`
 Classes             | `Win32_PerfRawData_NETFramework_NETCLRLoading`
 Enabled by default? | No

--- a/docs/collector.netframework_clrlocksandthreads.md
+++ b/docs/collector.netframework_clrlocksandthreads.md
@@ -2,7 +2,9 @@

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

-Metric name prefix | `netframework_clrlocksandthreads`
+|||
+-|-
+Metric name prefix  | `netframework_clrlocksandthreads`
 Classes             | `Win32_PerfRawData_NETFramework_NETCLRLocksAndThreads`
 Enabled by default? | No

--- a/docs/collector.netframework_clrmemory.md
+++ b/docs/collector.netframework_clrmemory.md
@@ -2,7 +2,9 @@

 The netframework_clrmemory collector exposes metrics about memory in dotnet applications.

-Metric name prefix | `netframework_clrmemory`
+|||
+-|-
+Metric name prefix  | `netframework_clrmemory`
 Classes             | `Win32_PerfRawData_NETFramework_NETCLRMemory`
 Enabled by default? | No

--- a/docs/collector.netframework_clrremoting.md
+++ b/docs/collector.netframework_clrremoting.md
@@ -2,7 +2,9 @@

 The netframework_clrremoting collector exposes metrics about dotnet remoting.

-Metric name prefix | `netframework_clrremoting`
+|||
+-|-
+Metric name prefix  | `netframework_clrremoting`
 Classes             | `Win32_PerfRawData_NETFramework_NETCLRRemoting`
 Enabled by default? | No

--- a/docs/collector.netframework_clrsecurity.md
+++ b/docs/collector.netframework_clrsecurity.md
@@ -2,7 +2,9 @@

 The netframework_clrsecurity collector exposes metrics about security checks in dotnet applications

-Metric name prefix | `netframework_clrsecurity`
+|||
+-|-
+Metric name prefix  | `netframework_clrsecurity`
 Classes             | `Win32_PerfRawData_NETFramework_NETCLRSecurity`
 Enabled by default? | No

--- a/docs/collector.os.md
+++ b/docs/collector.os.md
@@ -2,7 +2,9 @@

 The os collector exposes metrics about the operating system

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

--- a/docs/collector.process.md
+++ b/docs/collector.process.md
@@ -2,7 +2,9 @@

 The process collector exposes metrics about processes

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

--- a/docs/collector.service.md
+++ b/docs/collector.service.md
@@ -2,7 +2,9 @@

 The service collector exposes metrics about Windows Services

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

--- a/docs/collector.system.md
+++ b/docs/collector.system.md
@@ -2,7 +2,9 @@

 The system collector exposes metrics about ...

-Metric name prefix | `system`
+|||
+-|-
+Metric name prefix  | `system`
 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)
 Enabled by default? | Yes

--- a/docs/collector.tcp.md
+++ b/docs/collector.tcp.md
@@ -2,7 +2,9 @@

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

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

--- a/docs/collector.textfile.md
+++ b/docs/collector.textfile.md
@@ -2,7 +2,9 @@

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

-Metric name prefix | `textfile`
+|||
+-|-
+Metric name prefix  | `textfile`
 Classes             | None
 Enabled by default? | Yes

--- a/docs/collector.vmware.md
+++ b/docs/collector.vmware.md
@@ -2,7 +2,9 @@

 The vmware collector exposes metrics about a VMware guest VM

-Metric name prefix | `vmware`
+|||
+-|-
+Metric name prefix  | `vmware`
 Classes             | `Win32_PerfRawData_vmGuestLib_VMem`, `Win32_PerfRawData_vmGuestLib_VCPU`
 Enabled by default? | No