Regenerate integrations.js (#17950)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Jun 18, 2024 at 13:16 UTC
7a21567b19c335e3a4c05a316e27f9c4c621a220
5 files changed
+238
integrations/integrations.js
+36
@@ -3628,6 +3628,42 @@ export const integrations = [
3628
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/couchdb/metadata.yaml",
3629
"related_resources": ""
3630
},
3631
+ {
3632
+ "meta": {
3633
+ "id": "collector-go.d.plugin-dmcache",
3634
+ "plugin_name": "go.d.plugin",
3635
+ "module_name": "dmcache",
3636
+ "monitored_instance": {
3637
+ "name": "DMCache devices",
3638
+ "link": "",
3639
+ "icon_filename": "filesystem.svg",
3640
+ "categories": [
3641
+ "data-collection.storage-mount-points-and-filesystems"
3642
+ ]
3643
+ },
3644
+ "keywords": [
3645
+ "dmcache"
3646
+ ],
3647
+ "related_resources": {
3648
+ "integrations": {
3649
+ "list": []
3650
+ }
3651
+ },
3652
+ "info_provided_to_referring_integrations": {
3653
+ "description": ""
3654
+ },
3655
+ "most_popular": false
3656
+ },
3657
+ "overview": "# DMCache devices\n\nPlugin: go.d.plugin\nModule: dmcache\n\n## Overview\n\nThis collector monitors DMCache, providing insights into capacity usage, efficiency, and activity. It relies on the [`dmsetup`](https://man7.org/linux/man-pages/man8/dmsetup.8.html) CLI tool but avoids directly executing the binary. Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
3658
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/dmcache.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/dmcache.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| timeout | dmsetup binary execution timeout. | 2 | no |\n\n{% /details %}\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n{% details open=true summary=\"Config\" %}\n```yaml\njobs:\n - name: dmcache\n update_every: 5 # Collect DMCache statistics every 5 seconds\n\n```\n{% /details %}\n",
3659
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `dmcache` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m dmcache\n ```\n\n",
3660
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
3661
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per dmcache device\n\nThese metrics refer to the DMCache device.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| device | Device name |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| dmcache.device_cache_space_usage | free, used | bytes |\n| dmcache.device_metadata_space_usage | free, used | bytes |\n| dmcache.device_cache_read_efficiency | hits, misses | requests/s |\n| dmcache.device_cache_write_efficiency | hits, misses | requests/s |\n| dmcache.device_cache_activity | promotions, demotions | bytes/s |\n| dmcache.device_cache_dirty_size | dirty | bytes |\n\n",
3662
+ "integration_type": "collector",
3663
+ "id": "go.d.plugin-dmcache-DMCache_devices",
3664
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/dmcache/metadata.yaml",
3665
+ "related_resources": ""
3666
+ },
3667
{
3668
"meta": {
3669
"id": "collector-go.d.plugin-dns_query",
integrations/integrations.json
+36
@@ -3626,6 +3626,42 @@
3626
"edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/couchdb/metadata.yaml",
3627
"related_resources": ""
3628
},
3629
+ {
3630
+ "meta": {
3631
+ "id": "collector-go.d.plugin-dmcache",
3632
+ "plugin_name": "go.d.plugin",
3633
+ "module_name": "dmcache",
3634
+ "monitored_instance": {
3635
+ "name": "DMCache devices",
3636
+ "link": "",
3637
+ "icon_filename": "filesystem.svg",
3638
+ "categories": [
3639
+ "data-collection.storage-mount-points-and-filesystems"
3640
+ ]
3641
+ },
3642
+ "keywords": [
3643
+ "dmcache"
3644
+ ],
3645
+ "related_resources": {
3646
+ "integrations": {
3647
+ "list": []
3648
+ }
3649
+ },
3650
+ "info_provided_to_referring_integrations": {
3651
+ "description": ""
3652
+ },
3653
+ "most_popular": false
3654
+ },
3655
+ "overview": "# DMCache devices\n\nPlugin: go.d.plugin\nModule: dmcache\n\n## Overview\n\nThis collector monitors DMCache, providing insights into capacity usage, efficiency, and activity. It relies on the [`dmsetup`](https://man7.org/linux/man-pages/man8/dmsetup.8.html) CLI tool but avoids directly executing the binary. Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.\n\n\n\n\nThis collector is supported on all platforms.\n\nThis collector only supports collecting metrics from a single instance of this integration.\n\n\n### Default Behavior\n\n#### Auto-Detection\n\nThis integration doesn't support auto-detection.\n\n#### Limits\n\nThe default configuration for this integration does not impose any limits on data collection.\n\n#### Performance Impact\n\nThe default configuration for this integration is not expected to impose a significant performance impact on the system.\n",
3656
+ "setup": "## Setup\n\n### Prerequisites\n\nNo action required.\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `go.d/dmcache.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config go.d/dmcache.conf\n```\n#### Options\n\nThe following options can be defined globally: update_every.\n\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| update_every | Data collection frequency. | 10 | no |\n| timeout | dmsetup binary execution timeout. | 2 | no |\n\n#### Examples\n\n##### Custom update_every\n\nAllows you to override the default data collection interval.\n\n```yaml\njobs:\n - name: dmcache\n update_every: 5 # Collect DMCache statistics every 5 seconds\n\n```\n",
3657
+ "troubleshooting": "## Troubleshooting\n\n### Debug Mode\n\nTo troubleshoot issues with the `dmcache` collector, run the `go.d.plugin` with the debug option enabled. The output\nshould give you clues as to why the collector isn't working.\n\n- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on\n your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.\n\n ```bash\n cd /usr/libexec/netdata/plugins.d/\n ```\n\n- Switch to the `netdata` user.\n\n ```bash\n sudo -u netdata -s\n ```\n\n- Run the `go.d.plugin` to debug the collector:\n\n ```bash\n ./go.d.plugin -d -m dmcache\n ```\n\n",
3658
+ "alerts": "## Alerts\n\nThere are no alerts configured by default for this integration.\n",
3659
+ "metrics": "## Metrics\n\nMetrics grouped by *scope*.\n\nThe scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.\n\n\n\n### Per dmcache device\n\nThese metrics refer to the DMCache device.\n\nLabels:\n\n| Label | Description |\n|:-----------|:----------------|\n| device | Device name |\n\nMetrics:\n\n| Metric | Dimensions | Unit |\n|:------|:----------|:----|\n| dmcache.device_cache_space_usage | free, used | bytes |\n| dmcache.device_metadata_space_usage | free, used | bytes |\n| dmcache.device_cache_read_efficiency | hits, misses | requests/s |\n| dmcache.device_cache_write_efficiency | hits, misses | requests/s |\n| dmcache.device_cache_activity | promotions, demotions | bytes/s |\n| dmcache.device_cache_dirty_size | dirty | bytes |\n\n",
3660
+ "integration_type": "collector",
3661
+ "id": "go.d.plugin-dmcache-DMCache_devices",
3662
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/dmcache/metadata.yaml",
3663
+ "related_resources": ""
3664
+ },
3665
{
3666
"meta": {
3667
"id": "collector-go.d.plugin-dns_query",
src/collectors/COLLECTORS.md
+2
@@ -979,6 +979,8 @@ If you don't see the app/service you'd like to monitor in this list:
979
980
- [Ceph](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/ceph/integrations/ceph.md)
981
982
+- [DMCache devices](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/dmcache/integrations/dmcache_devices.md)
983
+
984
- [Dell EMC Isilon cluster](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/prometheus/integrations/dell_emc_isilon_cluster.md)
985
986
- [Dell EMC ScaleIO](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/scaleio/integrations/dell_emc_scaleio.md)
src/go/collectors/go.d.plugin/modules/dmcache/README.md
new
+1
@@ -0,0 +1 @@
1
+integrations/dmcache_devices.md
\ No newline at end of file
src/go/collectors/go.d.plugin/modules/dmcache/integrations/dmcache_devices.md
new
+163
@@ -0,0 +1,163 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/dmcache/README.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/dmcache/metadata.yaml"
4
+sidebar_label: "DMCache devices"
5
+learn_status: "Published"
6
+learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
7
+most_popular: False
8
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
9
+endmeta-->
10
+
11
+# DMCache devices
12
+
13
+
14
+<img src="https://netdata.cloud/img/filesystem.svg" width="150"/>
15
+
16
+
17
+Plugin: go.d.plugin
18
+Module: dmcache
19
+
20
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
21
+
22
+## Overview
23
+
24
+This collector monitors DMCache, providing insights into capacity usage, efficiency, and activity. It relies on the [`dmsetup`](https://man7.org/linux/man-pages/man8/dmsetup.8.html) CLI tool but avoids directly executing the binary. Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management.
25
+
26
+
27
+
28
+
29
+This collector is supported on all platforms.
30
+
31
+This collector only supports collecting metrics from a single instance of this integration.
32
+
33
+
34
+### Default Behavior
35
+
36
+#### Auto-Detection
37
+
38
+This integration doesn't support auto-detection.
39
+
40
+#### Limits
41
+
42
+The default configuration for this integration does not impose any limits on data collection.
43
+
44
+#### Performance Impact
45
+
46
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
47
+
48
+
49
+## Metrics
50
+
51
+Metrics grouped by *scope*.
52
+
53
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
54
+
55
+
56
+
57
+### Per dmcache device
58
+
59
+These metrics refer to the DMCache device.
60
+
61
+Labels:
62
+
63
+| Label | Description |
64
+|:-----------|:----------------|
65
+| device | Device name |
66
+
67
+Metrics:
68
+
69
+| Metric | Dimensions | Unit |
70
+|:------|:----------|:----|
71
+| dmcache.device_cache_space_usage | free, used | bytes |
72
+| dmcache.device_metadata_space_usage | free, used | bytes |
73
+| dmcache.device_cache_read_efficiency | hits, misses | requests/s |
74
+| dmcache.device_cache_write_efficiency | hits, misses | requests/s |
75
+| dmcache.device_cache_activity | promotions, demotions | bytes/s |
76
+| dmcache.device_cache_dirty_size | dirty | bytes |
77
+
78
+
79
+
80
+## Alerts
81
+
82
+There are no alerts configured by default for this integration.
83
+
84
+
85
+## Setup
86
+
87
+### Prerequisites
88
+
89
+No action required.
90
+
91
+### Configuration
92
+
93
+#### File
94
+
95
+The configuration file name for this integration is `go.d/dmcache.conf`.
96
+
97
+
98
+You can edit the configuration file using the `edit-config` script from the
99
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
100
+
101
+```bash
102
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
103
+sudo ./edit-config go.d/dmcache.conf
104
+```
105
+#### Options
106
+
107
+The following options can be defined globally: update_every.
108
+
109
+
110
+<details open><summary>Config options</summary>
111
+
112
+| Name | Description | Default | Required |
113
+|:----|:-----------|:-------|:--------:|
114
+| update_every | Data collection frequency. | 10 | no |
115
+| timeout | dmsetup binary execution timeout. | 2 | no |
116
+
117
+</details>
118
+
119
+#### Examples
120
+
121
+##### Custom update_every
122
+
123
+Allows you to override the default data collection interval.
124
+
125
+<details open><summary>Config</summary>
126
+
127
+```yaml
128
+jobs:
129
+ - name: dmcache
130
+ update_every: 5 # Collect DMCache statistics every 5 seconds
131
+
132
+```
133
+</details>
134
+
135
+
136
+
137
+## Troubleshooting
138
+
139
+### Debug Mode
140
+
141
+To troubleshoot issues with the `dmcache` collector, run the `go.d.plugin` with the debug option enabled. The output
142
+should give you clues as to why the collector isn't working.
143
+
144
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
145
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
146
+
147
+ ```bash
148
+ cd /usr/libexec/netdata/plugins.d/
149
+ ```
150
+
151
+- Switch to the `netdata` user.
152
+
153
+ ```bash
154
+ sudo -u netdata -s
155
+ ```
156
+
157
+- Run the `go.d.plugin` to debug the collector:
158
+
159
+ ```bash
160
+ ./go.d.plugin -d -m dmcache
161
+ ```
162
+
163
+