69 lines
1.7 KiB
Plaintext
69 lines
1.7 KiB
Plaintext
<!--
|
|
title: $COLLECTOR_NAME monitoring with Netdata
|
|
description: Short summary (will be displayed in search engines)
|
|
custom_edit_url: Edit URL of the source file
|
|
keywords: [keywords, describing, the main topics]
|
|
-->
|
|
|
|
# Title
|
|
|
|
import {
|
|
EnableCollector,
|
|
CollectorDebug,
|
|
} from '@site/src/components/Collectors/_collector-components.jsx';
|
|
|
|
Short description of what the collector does on a high level.
|
|
Why should I use this collector?
|
|
|
|
## Configuring $COLLECTOR_NAME
|
|
|
|
#### Prerequisites
|
|
|
|
List all needed prerequisites:
|
|
|
|
- Prerequisite 1
|
|
- Prerequisite 2
|
|
- Prerequisite 3
|
|
|
|
<CollectorConfiguration configURL="" moduleName="PLUGIN/COLLECTOR.conf" />
|
|
|
|
### Example
|
|
|
|
TODO: Check if we can automatically fetch the [JOBS] section of netdata.conf
|
|
|
|
## Other configuration information
|
|
|
|
Explain other configuration options, as needed.
|
|
|
|
#### Prerequisites
|
|
|
|
<!-- If there is only one requirement, use a paragraph instead of a single bullet item. Bullets are social animals and only appear in groups of 2 or more :) -->
|
|
|
|
Optional. List all needed prerequisites:
|
|
|
|
- Prerequisite 1
|
|
- Prerequisite 2
|
|
- Prerequisite 3
|
|
|
|
To do x:
|
|
|
|
1. Step 1 written in active voice
|
|
```bash
|
|
Code sample for step
|
|
```
|
|
2. Step 2
|
|
Result of step 2, for example a system reaction; written in passive voice
|
|
3. Step 3
|
|
|
|
## Debugging $COLLECTOR_NAME (optional)
|
|
|
|
<CollectorDebug pluginName="" collectorName="" />
|
|
|
|
## Metrics and Alerts produced by this collector
|
|
|
|
| Chart | Metrics | Alert |
|
|
| ---------- | ----------- | ------------------------ |
|
|
| Chart Name | Metric name | [Alert 1](Link to alert) |
|
|
| Chart Name | Metric name | [Alert 2](Link to alert) |
|
|
| Chart Name | Metric name | [Alert 3](Link to alert) |
|