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

View File

@@ -0,0 +1,45 @@
# %name% collector
The %name% collector exposes metrics about ...
Metric name prefix | `%name%`
Classes | [`...`](https://msdn.microsoft.com/en-us/library/...)
Enabled by default? | Yes/No
## Flags
### `--collector....`
Add description...
Example: `--collector....`
## Metrics
Name | Description | Type | Labels
-----|-------------|------|-------
`wmi_...` | ... | counter/gauge/histogram/summary | ...
### Example metric
...:
`wmi_...{...} 1`
## Useful queries
### Add queries...
`...`
## Alerting examples
### Add alerts...
```yaml
- alert: ""
expr: ""
for: ""
labels:
urgency: ""
annotations:
summary: ""
```