@cryptotaxi247 / netdata-1
Code Commits Issues Pulls Sessions CI/CD
master
master
mdx 68 lines 1.67 KB
Raw
1 <!--
2 title: $COLLECTOR_NAME monitoring with Netdata
3 description: Short summary (will be displayed in search engines)
4 custom_edit_url: Edit URL of the source file
5 keywords: [keywords, describing, the main topics]
6 -->
7
8 # Title
9
10 import {
11 EnableCollector,
12 CollectorDebug,
13 } from '@site/src/components/Collectors/_collector-components.jsx';
14
15 Short description of what the collector does on a high level.
16 Why should I use this collector?
17
18 ## Configuring $COLLECTOR_NAME
19
20 #### Prerequisites
21
22 List all needed prerequisites:
23
24 - Prerequisite 1
25 - Prerequisite 2
26 - Prerequisite 3
27
28 <CollectorConfiguration configURL="" moduleName="PLUGIN/COLLECTOR.conf" />
29
30 ### Example
31
32 TODO: Check if we can automatically fetch the [JOBS] section of netdata.conf
33
34 ## Other configuration information
35
36 Explain other configuration options, as needed.
37
38 #### Prerequisites
39
40 <!-- 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 :) -->
41
42 Optional. List all needed prerequisites:
43
44 - Prerequisite 1
45 - Prerequisite 2
46 - Prerequisite 3
47
48 To do x:
49
50 1. Step 1 written in active voice
51 ```bash
52 Code sample for step
53 ```
54 2. Step 2
55 Result of step 2, for example a system reaction; written in passive voice
56 3. Step 3
57
58 ## Debugging $COLLECTOR_NAME (optional)
59
60 <CollectorDebug pluginName="" collectorName="" />
61
62 ## Metrics and Alerts produced by this collector
63
64 | Chart | Metrics | Alert |
65 | ---------- | ----------- | ------------------------ |
66 | Chart Name | Metric name | [Alert 1](Link to alert) |
67 | Chart Name | Metric name | [Alert 2](Link to alert) |
68 | Chart Name | Metric name | [Alert 3](Link to alert) |