Skip to content
This repository was archived by the owner on Mar 27, 2024. It is now read-only.

Commit 5d19075

Browse files
Integrations Documentation (#1457)
Co-authored-by: ilyam8 <ilyam8@users.noreply.github.com>
1 parent ee8b2c5 commit 5d19075

281 files changed

Lines changed: 4242 additions & 6 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

modules/httpcheck/integrations/http_endpoints.md

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Metrics:
7070
|:------|:----------|:----|
7171
| httpcheck.response_time | time | ms |
7272
| httpcheck.response_length | length | characters |
73-
| httpcheck.status | success, timeout, redirect, no_connection, bad_content, bad_status | boolean |
73+
| httpcheck.status | success, timeout, redirect, no_connection, bad_content, bad_header, bad_status | boolean |
7474
| httpcheck.in_state | time | boolean |
7575

7676

@@ -114,6 +114,10 @@ The following options can be defined globally: update_every, autodetection_retry
114114
| url | Server URL. | | yes |
115115
| status_accepted | HTTP accepted response statuses. Anything else will result in 'bad status' in the status chart. | [200] | no |
116116
| response_match | If the status code is accepted, the content of the response will be matched against this regular expression. | | no |
117+
| headers_match | This option defines a set of rules that check for specific key-value pairs in the HTTP headers of the response. | [] | no |
118+
| headers_match.exclude | This option determines whether the rule should check for the presence of the specified key-value pair or the absence of it. | no | no |
119+
| headers_match.key | The exact name of the HTTP header to check for. | | yes |
120+
| headers_match.value | The [pattern](https://github.com/netdata/go.d.plugin/tree/master/pkg/matcher#supported-format) to match against the value of the specified header. | | no |
117121
| cookie_file | Path to cookie file. See [cookie file format](https://everything.curl.dev/http/cookies/fileformat). | | no |
118122
| timeout | HTTP request timeout. | 1 | no |
119123
| username | Username for basic HTTP authentication. | | no |
@@ -148,7 +152,7 @@ jobs:
148152
```
149153
</details>
150154

151-
##### With status_accepted
155+
##### With `status_accepted`
152156

153157
A basic example configuration with non-default status_accepted.
154158

@@ -165,6 +169,53 @@ jobs:
165169
```
166170
</details>
167171

172+
##### With `header_match`
173+
174+
Example configurations with `header_match`. See the value [pattern](https://github.com/netdata/go.d.plugin/tree/master/pkg/matcher#supported-format) syntax.
175+
176+
<details><summary>Config</summary>
177+
178+
```yaml
179+
jobs:
180+
# The "X-Robots-Tag" header must be present in the HTTP response header,
181+
# but the value of the header does not matter.
182+
# This config checks for the presence of the header regardless of its value.
183+
- name: local
184+
url: http://127.0.0.1:8080
185+
header_match:
186+
- key: X-Robots-Tag
187+
188+
# The "X-Robots-Tag" header must be present in the HTTP response header
189+
# only if its value is equal to "noindex, nofollow".
190+
# This config checks both the presence of the header and its value.
191+
- name: local
192+
url: http://127.0.0.1:8080
193+
header_match:
194+
- key: X-Robots-Tag
195+
value: '= noindex,nofollow'
196+
197+
# The "X-Robots-Tag" header must not be present in the HTTP response header
198+
# but the value of the header does not matter.
199+
# This config checks for the presence of the header regardless of its value.
200+
- name: local
201+
url: http://127.0.0.1:8080
202+
header_match:
203+
- key: X-Robots-Tag
204+
exclude: yes
205+
206+
# The "X-Robots-Tag" header must not be present in the HTTP response header
207+
# only if its value is equal to "noindex, nofollow".
208+
# This config checks both the presence of the header and its value.
209+
- name: local
210+
url: http://127.0.0.1:8080
211+
header_match:
212+
- key: X-Robots-Tag
213+
exclude: yes
214+
value: '= noindex,nofollow'
215+
216+
```
217+
</details>
218+
168219
##### HTTP authentication
169220

170221
Basic HTTP authentication.

modules/mongodb/integrations/mongodb.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ An example configuration.
283283
```yaml
284284
jobs:
285285
- name: local
286-
uri: mongodb://netconfig:password@localhost:27017
286+
uri: mongodb://netdata:password@localhost:27017
287287

288288
```
289289
</details>
@@ -297,7 +297,7 @@ An example configuration.
297297
```yaml
298298
jobs:
299299
- name: local
300-
uri: mongodb://netconfig:password@localhost:27017
300+
uri: mongodb://netdata:password@localhost:27017
301301
databases:
302302
includes:
303303
- "* *"
@@ -317,10 +317,10 @@ Local and remote instances.
317317
```yaml
318318
jobs:
319319
- name: local
320-
uri: mongodb://netconfig:password@localhost:27017
320+
uri: mongodb://netdata:password@localhost:27017
321321

322322
- name: remote
323-
uri: mongodb://netconfig:password@203.0.113.0:27017
323+
uri: mongodb://netdata:password@203.0.113.0:27017
324324

325325
```
326326
</details>

modules/prometheus/integrations/4d_server.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,21 @@ jobs:
187187
url: http://127.0.0.1:9090/metrics
188188

189189
```
190+
##### Read metrics from a file
191+
192+
An example configuration to read metrics from a file.
193+
194+
<details><summary>Config</summary>
195+
196+
```yaml
197+
# use "file://" scheme
198+
jobs:
199+
- name: myapp
200+
url: file:///opt/metrics/myapp/metrics.txt
201+
202+
```
203+
</details>
204+
190205
##### HTTP authentication
191206

192207
> **Note**: Change the port of the monitored application on which it provides metrics.

modules/prometheus/integrations/8430ft_modem.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,21 @@ jobs:
187187
url: http://127.0.0.1:9090/metrics
188188

189189
```
190+
##### Read metrics from a file
191+
192+
An example configuration to read metrics from a file.
193+
194+
<details><summary>Config</summary>
195+
196+
```yaml
197+
# use "file://" scheme
198+
jobs:
199+
- name: myapp
200+
url: file:///opt/metrics/myapp/metrics.txt
201+
202+
```
203+
</details>
204+
190205
##### HTTP authentication
191206

192207
> **Note**: Change the port of the monitored application on which it provides metrics.

modules/prometheus/integrations/a10_acos_network_devices.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,21 @@ jobs:
187187
url: http://127.0.0.1:9090/metrics
188188

189189
```
190+
##### Read metrics from a file
191+
192+
An example configuration to read metrics from a file.
193+
194+
<details><summary>Config</summary>
195+
196+
```yaml
197+
# use "file://" scheme
198+
jobs:
199+
- name: myapp
200+
url: file:///opt/metrics/myapp/metrics.txt
201+
202+
```
203+
</details>
204+
190205
##### HTTP authentication
191206

192207
> **Note**: Change the port of the monitored application on which it provides metrics.

modules/prometheus/integrations/airthings_waveplus_air_sensor.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,21 @@ jobs:
187187
url: http://127.0.0.1:9090/metrics
188188

189189
```
190+
##### Read metrics from a file
191+
192+
An example configuration to read metrics from a file.
193+
194+
<details><summary>Config</summary>
195+
196+
```yaml
197+
# use "file://" scheme
198+
jobs:
199+
- name: myapp
200+
url: file:///opt/metrics/myapp/metrics.txt
201+
202+
```
203+
</details>
204+
190205
##### HTTP authentication
191206

192207
> **Note**: Change the port of the monitored application on which it provides metrics.

modules/prometheus/integrations/akamai_edge_dns_traffic.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,21 @@ jobs:
187187
url: http://127.0.0.1:9090/metrics
188188

189189
```
190+
##### Read metrics from a file
191+
192+
An example configuration to read metrics from a file.
193+
194+
<details><summary>Config</summary>
195+
196+
```yaml
197+
# use "file://" scheme
198+
jobs:
199+
- name: myapp
200+
url: file:///opt/metrics/myapp/metrics.txt
201+
202+
```
203+
</details>
204+
190205
##### HTTP authentication
191206

192207
> **Note**: Change the port of the monitored application on which it provides metrics.

modules/prometheus/integrations/akamai_global_traffic_management.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,21 @@ jobs:
187187
url: http://127.0.0.1:9090/metrics
188188

189189
```
190+
##### Read metrics from a file
191+
192+
An example configuration to read metrics from a file.
193+
194+
<details><summary>Config</summary>
195+
196+
```yaml
197+
# use "file://" scheme
198+
jobs:
199+
- name: myapp
200+
url: file:///opt/metrics/myapp/metrics.txt
201+
202+
```
203+
</details>
204+
190205
##### HTTP authentication
191206

192207
> **Note**: Change the port of the monitored application on which it provides metrics.

modules/prometheus/integrations/akami_cloudmonitor.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,21 @@ jobs:
187187
url: http://127.0.0.1:9090/metrics
188188

189189
```
190+
##### Read metrics from a file
191+
192+
An example configuration to read metrics from a file.
193+
194+
<details><summary>Config</summary>
195+
196+
```yaml
197+
# use "file://" scheme
198+
jobs:
199+
- name: myapp
200+
url: file:///opt/metrics/myapp/metrics.txt
201+
202+
```
203+
</details>
204+
190205
##### HTTP authentication
191206

192207
> **Note**: Change the port of the monitored application on which it provides metrics.

modules/prometheus/integrations/alamos_fe2_server.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,21 @@ jobs:
187187
url: http://127.0.0.1:9090/metrics
188188

189189
```
190+
##### Read metrics from a file
191+
192+
An example configuration to read metrics from a file.
193+
194+
<details><summary>Config</summary>
195+
196+
```yaml
197+
# use "file://" scheme
198+
jobs:
199+
- name: myapp
200+
url: file:///opt/metrics/myapp/metrics.txt
201+
202+
```
203+
</details>
204+
190205
##### HTTP authentication
191206

192207
> **Note**: Change the port of the monitored application on which it provides metrics.

0 commit comments

Comments
 (0)