summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorNetdata bot <43409846+netdatabot@users.noreply.github.com>2024-06-18 13:16:52 -0400
committerGitHub <noreply@github.com>2024-06-18 20:16:52 +0300
commit7a21567b19c335e3a4c05a316e27f9c4c621a220 (patch)
tree288fa334dd866ac8ea05158a7a716d636a23762d /src
parentbcaa5e7370df3ba5b7eaa5aba511320752726c50 (diff)
Regenerate integrations.js (#17950)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Diffstat (limited to 'src')
-rw-r--r--src/collectors/COLLECTORS.md2
l---------src/go/collectors/go.d.plugin/modules/dmcache/README.md1
-rw-r--r--src/go/collectors/go.d.plugin/modules/dmcache/integrations/dmcache_devices.md163
3 files changed, 166 insertions, 0 deletions
diff --git a/src/collectors/COLLECTORS.md b/src/collectors/COLLECTORS.md
index c007fb453b..ebd7b2a9a2 100644
--- a/src/collectors/COLLECTORS.md
+++ b/src/collectors/COLLECTORS.md
@@ -979,6 +979,8 @@ If you don't see the app/service you'd like to monitor in this list:
- [Ceph](https://github.com/netdata/netdata/blob/master/src/collectors/python.d.plugin/ceph/integrations/ceph.md)
+- [DMCache devices](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/dmcache/integrations/dmcache_devices.md)
+
- [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)
- [Dell EMC ScaleIO](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/modules/scaleio/integrations/dell_emc_scaleio.md)
diff --git a/src/go/collectors/go.d.plugin/modules/dmcache/README.md b/src/go/collectors/go.d.plugin/modules/dmcache/README.md
new file mode 120000
index 0000000000..9609ec8694
--- /dev/null
+++ b/src/go/collectors/go.d.plugin/modules/dmcache/README.md
@@ -0,0 +1 @@
+integrations/dmcache_devices.md \ No newline at end of file
diff --git a/src/go/collectors/go.d.plugin/modules/dmcache/integrations/dmcache_devices.md b/src/go/collectors/go.d.plugin/modules/dmcache/integrations/dmcache_devices.md
new file mode 100644
index 0000000000..7dfa898fbe
--- /dev/null
+++ b/src/go/collectors/go.d.plugin/modules/dmcache/integrations/dmcache_devices.md
@@ -0,0 +1,163 @@
+<!--startmeta
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/dmcache/README.md"
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/dmcache/metadata.yaml"
+sidebar_label: "DMCache devices"
+learn_status: "Published"
+learn_rel_path: "Collecting Metrics/Storage, Mount Points and Filesystems"
+most_popular: False
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
+endmeta-->
+
+# DMCache devices
+
+
+<img src="https://netdata.cloud/img/filesystem.svg" width="150"/>
+
+
+Plugin: go.d.plugin
+Module: dmcache
+
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
+
+## Overview
+
+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.
+
+
+
+
+This collector is supported on all platforms.
+
+This collector only supports collecting metrics from a single instance of this integration.
+
+
+### Default Behavior
+
+#### Auto-Detection
+
+This integration doesn't support auto-detection.
+
+#### Limits
+
+The default configuration for this integration does not impose any limits on data collection.
+
+#### Performance Impact
+
+The default configuration for this integration is not expected to impose a significant performance impact on the system.
+
+
+## Metrics
+
+Metrics grouped by *scope*.
+
+The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
+
+
+
+### Per dmcache device
+
+These metrics refer to the DMCache device.
+
+Labels:
+
+| Label | Description |
+|:-----------|:----------------|
+| device | Device name |
+
+Metrics:
+
+| Metric | Dimensions | Unit |
+|:------|:----------|:----|
+| dmcache.device_cache_space_usage | free, used | bytes |
+| dmcache.device_metadata_space_usage | free, used | bytes |
+| dmcache.device_cache_read_efficiency | hits, misses | requests/s |
+| dmcache.device_cache_write_efficiency | hits, misses | requests/s |
+| dmcache.device_cache_activity | promotions, demotions | bytes/s |
+| dmcache.device_cache_dirty_size | dirty | bytes |
+
+
+
+## Alerts
+
+There are no alerts configured by default for this integration.
+
+
+## Setup
+
+### Prerequisites
+
+No action required.
+
+### Configuration
+
+#### File
+
+The configuration file name for this integration is `go.d/dmcache.conf`.
+
+
+You can edit the configuration file using the `edit-config` script from the
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
+
+```bash
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
+sudo ./edit-config go.d/dmcache.conf
+```
+#### Options
+
+The following options can be defined globally: update_every.
+
+
+<details open><summary>Config options</summary>
+
+| Name | Description | Default | Required |
+|:----|:-----------|:-------|:--------:|
+| update_every | Data collection frequency. | 10 | no |
+| timeout | dmsetup binary execution timeout. | 2 | no |
+
+</details>
+
+#### Examples
+
+##### Custom update_every
+
+Allows you to override the default data collection interval.
+
+<details open><summary>Config</summary>
+
+```yaml
+jobs:
+ - name: dmcache
+ update_every: 5 # Collect DMCache statistics every 5 seconds
+
+```
+</details>
+
+
+
+## Troubleshooting
+
+### Debug Mode
+
+To troubleshoot issues with the `dmcache` collector, run the `go.d.plugin` with the debug option enabled. The output
+should give you clues as to why the collector isn't working.
+
+- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
+ your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.
+
+ ```bash
+ cd /usr/libexec/netdata/plugins.d/
+ ```
+
+- Switch to the `netdata` user.
+
+ ```bash
+ sudo -u netdata -s
+ ```
+
+- Run the `go.d.plugin` to debug the collector:
+
+ ```bash
+ ./go.d.plugin -d -m dmcache
+ ```
+
+