Collector documentation (#113)

* Initial draft of collector documentation

* Add docs for all collectors

* Update main README with links to docs

* Fix link syntax
This commit is contained in:
Calle Pettersson
2018-11-18 17:05:37 +01:00
committed by Martin Lindhe
parent cb9da1ae22
commit 9ed68ae86c
28 changed files with 1428 additions and 18 deletions

27
docs/collector.cs.md Normal file
View File

@@ -0,0 +1,27 @@
# cs collector
The cs collector exposes metrics detailing the hardware of the computer system
Metric name prefix | `cs`
Classes | [`Win32_ComputerSystem`](https://msdn.microsoft.com/en-us/library/aa394102)
Enabled by default? | Yes
## Flags
None
## Metrics
Name | Description | Type | Labels
-----|-------------|------|-------
`wmi_cs_logical_processors` | Number of installed logical processors | gauge | None
`wmi_cs_physical_memory_bytes` | Total installed physical memory | gauge | None
### Example metric
_This collector does not yet have explained examples, we would appreciate your help adding them!_
## Useful queries
_This collector does not yet have any useful queries added, we would appreciate your help adding them!_
## Alerting examples
_This collector does not yet have alerting examples, we would appreciate your help adding them!_