| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-dmcache |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: dmcache |
| 7 | monitored_instance: |
| 8 | name: DMCache devices |
| 9 | link: "" |
| 10 | icon_filename: filesystem.svg |
| 11 | categories: |
| 12 | - data-collection.storage |
| 13 | keywords: |
| 14 | - dmcache |
| 15 | related_resources: |
| 16 | integrations: |
| 17 | list: [] |
| 18 | info_provided_to_referring_integrations: |
| 19 | description: "" |
| 20 | overview: |
| 21 | data_collection: |
| 22 | metrics_description: > |
| 23 | This collector monitors DMCache, providing insights into capacity usage, efficiency, and activity. |
| 24 | It relies on the [`dmsetup`](https://man7.org/linux/man-pages/man8/dmsetup.8.html) CLI tool but avoids directly executing the binary. |
| 25 | Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. |
| 26 | This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management. |
| 27 | method_description: "" |
| 28 | supported_platforms: |
| 29 | include: [] |
| 30 | exclude: [] |
| 31 | multi_instance: false |
| 32 | additional_permissions: |
| 33 | description: "" |
| 34 | default_behavior: |
| 35 | auto_detection: |
| 36 | description: "" |
| 37 | limits: |
| 38 | description: "" |
| 39 | performance_impact: |
| 40 | description: "" |
| 41 | setup: |
| 42 | prerequisites: |
| 43 | list: [] |
| 44 | configuration: |
| 45 | file: |
| 46 | name: go.d/dmcache.conf |
| 47 | options: |
| 48 | description: | |
| 49 | The following options can be defined globally: update_every. |
| 50 | folding: |
| 51 | title: Config options |
| 52 | enabled: true |
| 53 | list: |
| 54 | - name: update_every |
| 55 | description: Data collection frequency. |
| 56 | default_value: 10 |
| 57 | required: false |
| 58 | - name: timeout |
| 59 | description: dmsetup binary execution timeout. |
| 60 | default_value: 2 |
| 61 | required: false |
| 62 | examples: |
| 63 | folding: |
| 64 | title: Config |
| 65 | enabled: true |
| 66 | list: |
| 67 | - name: Custom update_every |
| 68 | description: Allows you to override the default data collection interval. |
| 69 | config: | |
| 70 | jobs: |
| 71 | - name: dmcache |
| 72 | update_every: 5 # Collect DMCache statistics every 5 seconds |
| 73 | troubleshooting: |
| 74 | problems: |
| 75 | list: [] |
| 76 | alerts: [] |
| 77 | metrics: |
| 78 | folding: |
| 79 | title: Metrics |
| 80 | enabled: false |
| 81 | description: "" |
| 82 | availability: [] |
| 83 | scopes: |
| 84 | - name: dmcache device |
| 85 | description: These metrics refer to the DMCache device. |
| 86 | labels: |
| 87 | - name: device |
| 88 | description: Device name |
| 89 | metrics: |
| 90 | - name: dmcache.device_cache_space_usage |
| 91 | description: DMCache space usage |
| 92 | unit: bytes |
| 93 | chart_type: stacked |
| 94 | dimensions: |
| 95 | - name: free |
| 96 | - name: used |
| 97 | - name: dmcache.device_metadata_space_usage |
| 98 | description: DMCache metadata space usage |
| 99 | unit: bytes |
| 100 | chart_type: stacked |
| 101 | dimensions: |
| 102 | - name: free |
| 103 | - name: used |
| 104 | - name: dmcache.device_cache_read_efficiency |
| 105 | description: DMCache read efficiency |
| 106 | unit: requests/s |
| 107 | chart_type: stacked |
| 108 | dimensions: |
| 109 | - name: hits |
| 110 | - name: misses |
| 111 | - name: dmcache.device_cache_write_efficiency |
| 112 | description: DMCache write efficiency |
| 113 | unit: requests/s |
| 114 | chart_type: stacked |
| 115 | dimensions: |
| 116 | - name: hits |
| 117 | - name: misses |
| 118 | - name: dmcache.device_cache_activity |
| 119 | description: DMCache activity |
| 120 | unit: bytes/s |
| 121 | chart_type: area |
| 122 | dimensions: |
| 123 | - name: promotions |
| 124 | - name: demotions |
| 125 | - name: dmcache.device_cache_dirty_size |
| 126 | description: DMCache dirty data size |
| 127 | unit: bytes |
| 128 | chart_type: area |
| 129 | dimensions: |
| 130 | - name: dirty |