master
yaml 230 lines 7.73 KB
Raw
1 plugin_name: go.d.plugin
2 modules:
3 - meta:
4 id: collector-go.d.plugin-monit
5 plugin_name: go.d.plugin
6 module_name: monit
7 monitored_instance:
8 name: Monit
9 link: https://mmonit.com/monit/
10 categories:
11 - data-collection.synthetic-testing
12 icon_filename: monit.png
13 related_resources:
14 integrations:
15 list: []
16 alternative_monitored_instances: []
17 info_provided_to_referring_integrations:
18 description: ""
19 keywords:
20 - monit
21 - mmonit
22 - supervision tool
23 - monitrc
24 overview:
25 data_collection:
26 metrics_description: |
27 This collector monitors status of Monit's service checks.
28 method_description: |
29 It sends HTTP requests to the Monit `/_status?format=xml&level=full` endpoint.
30 default_behavior:
31 auto_detection:
32 description: |
33 By default, it detects Monit instances running on localhost that are listening on port 2812.
34 On startup, it tries to collect metrics from:
35
36 - http://127.0.0.1:2812
37 limits:
38 description: ""
39 performance_impact:
40 description: ""
41 additional_permissions:
42 description: ""
43 multi_instance: true
44 supported_platforms:
45 include: []
46 exclude: []
47 setup:
48 prerequisites:
49 list:
50 - title: Enable TCP PORT
51 description:
52 See [Syntax for TCP port](https://mmonit.com/monit/documentation/monit.html#TCP-PORT) for details.
53 configuration:
54 file:
55 name: go.d/monit.conf
56 options:
57 description: |
58 The following options can be defined globally: update_every, autodetection_retry.
59 folding:
60 title: Config options
61 enabled: true
62 list:
63 - name: update_every
64 description: Data collection interval (seconds).
65 default_value: 1
66 required: false
67 group: Collection
68 - name: autodetection_retry
69 description: Autodetection retry interval (seconds). Set 0 to disable.
70 default_value: 0
71 required: false
72 group: Collection
73
74 - name: url
75 description: Target endpoint URL.
76 default_value: http://127.0.0.1:2812
77 required: true
78 group: Target
79 - name: timeout
80 description: HTTP request timeout (seconds).
81 default_value: 1
82 required: false
83 group: Target
84
85 - name: username
86 description: Username for Basic HTTP authentication.
87 default_value: "admin"
88 required: false
89 group: HTTP Auth
90 - name: password
91 description: Password for Basic HTTP authentication.
92 default_value: "monit"
93 required: false
94 group: HTTP Auth
95 - name: bearer_token_file
96 description: "Path to a file containing a bearer token (used for `Authorization: Bearer`)."
97 default_value: ""
98 required: false
99 group: HTTP Auth
100
101 - name: tls_skip_verify
102 description: Skip TLS certificate and hostname verification (insecure).
103 default_value: no
104 required: false
105 group: TLS
106 - name: tls_ca
107 description: Path to CA bundle used to validate the server certificate.
108 default_value: ""
109 required: false
110 group: TLS
111 - name: tls_cert
112 description: Path to client TLS certificate (for mTLS).
113 default_value: ""
114 required: false
115 group: TLS
116 - name: tls_key
117 description: Path to client TLS private key (for mTLS).
118 default_value: ""
119 required: false
120 group: TLS
121
122 - name: proxy_url
123 description: HTTP proxy URL.
124 default_value: ""
125 required: false
126 group: Proxy
127 - name: proxy_username
128 description: Username for proxy Basic HTTP authentication.
129 default_value: ""
130 required: false
131 group: Proxy
132 - name: proxy_password
133 description: Password for proxy Basic HTTP authentication.
134 default_value: ""
135 required: false
136 group: Proxy
137
138 - name: method
139 description: HTTP method to use.
140 default_value: "GET"
141 required: false
142 group: Request
143 - name: body
144 description: Request body (e.g., for POST/PUT).
145 default_value: ""
146 required: false
147 group: Request
148 - name: headers
149 description: "Additional HTTP headers (one per line as key: value)."
150 default_value: ""
151 required: false
152 group: Request
153 - name: not_follow_redirects
154 description: Do not follow HTTP redirects.
155 default_value: no
156 required: false
157 group: Request
158 - name: force_http2
159 description: Force HTTP/2 (including h2c over TCP).
160 default_value: no
161 required: false
162 group: Request
163
164 - name: vnode
165 description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes).
166 default_value: ""
167 required: false
168 group: Virtual Node
169 examples:
170 folding:
171 title: Config
172 enabled: true
173 list:
174 - name: HTTP authentication
175 description: Basic HTTP authentication.
176 config: |
177 jobs:
178 - name: local
179 url: http://127.0.0.1:2812
180 username: admin
181 password: monit
182 - name: HTTPS with self-signed certificate
183 description: With enabled HTTPS and self-signed certificate.
184 config: |
185 jobs:
186 - name: local
187 url: http://127.0.0.1:2812
188 tls_skip_verify: yes
189 - name: Multi-instance
190 description: |
191 > **Note**: When you define multiple jobs, their names must be unique.
192
193 Collecting metrics from local and remote instances.
194 config: |
195 jobs:
196 - name: local
197 url: http://127.0.0.1:2812
198
199 - name: remote
200 url: http://192.0.2.1:2812
201 troubleshooting:
202 problems:
203 list: []
204 alerts: []
205 metrics:
206 folding:
207 title: Metrics
208 enabled: false
209 description: ""
210 availability: []
211 scopes:
212 - name: service
213 description: These metrics refer to the monitored Service.
214 labels:
215 - name: server_hostname
216 description: Hostname of the Monit server.
217 - name: service_check_name
218 description: Service check name.
219 - name: service_check_type
220 description: Service check type.
221 metrics:
222 - name: monit.service_check_status
223 description: Service Check Status
224 unit: status
225 chart_type: line
226 dimensions:
227 - name: ok
228 - name: error
229 - name: initializing
230 - name: not_monitored