| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-lvm |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: lvm |
| 7 | monitored_instance: |
| 8 | name: LVM logical volumes |
| 9 | link: "" |
| 10 | icon_filename: filesystem.svg |
| 11 | categories: |
| 12 | - data-collection.storage |
| 13 | keywords: |
| 14 | - lvm |
| 15 | - lvs |
| 16 | related_resources: |
| 17 | integrations: |
| 18 | list: [] |
| 19 | info_provided_to_referring_integrations: |
| 20 | description: "" |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: > |
| 24 | This collector monitors the health of LVM logical volumes. |
| 25 | It relies on the [`lvs`](https://man7.org/linux/man-pages/man8/lvs.8.html) CLI tool but avoids directly executing the binary. |
| 26 | Instead, it utilizes `ndsudo`, a Netdata helper specifically designed to run privileged commands securely within the Netdata environment. |
| 27 | This approach eliminates the need to use `sudo`, improving security and potentially simplifying permission management. |
| 28 | method_description: "" |
| 29 | supported_platforms: |
| 30 | include: [Linux, NetBSD] |
| 31 | exclude: [] |
| 32 | multi_instance: false |
| 33 | additional_permissions: |
| 34 | description: "" |
| 35 | default_behavior: |
| 36 | auto_detection: |
| 37 | description: "" |
| 38 | limits: |
| 39 | description: "" |
| 40 | performance_impact: |
| 41 | description: "" |
| 42 | setup: |
| 43 | prerequisites: |
| 44 | list: [] |
| 45 | configuration: |
| 46 | file: |
| 47 | name: go.d/lvm.conf |
| 48 | options: |
| 49 | description: | |
| 50 | The following options can be defined globally: update_every. |
| 51 | folding: |
| 52 | title: Config options |
| 53 | enabled: true |
| 54 | list: |
| 55 | - name: update_every |
| 56 | description: Data collection frequency. |
| 57 | default_value: 10 |
| 58 | required: false |
| 59 | - name: timeout |
| 60 | description: lvs binary execution timeout. |
| 61 | default_value: 2 |
| 62 | required: false |
| 63 | examples: |
| 64 | folding: |
| 65 | title: Config |
| 66 | enabled: true |
| 67 | list: |
| 68 | - name: Custom update_every |
| 69 | description: Allows you to override the default data collection interval. |
| 70 | config: | |
| 71 | jobs: |
| 72 | - name: lvm |
| 73 | update_every: 5 # Collect logical volume statistics every 5 seconds |
| 74 | troubleshooting: |
| 75 | problems: |
| 76 | list: [] |
| 77 | alerts: |
| 78 | - name: lvm_lv_data_space_utilization |
| 79 | metric: lvm.lv_data_space_utilization |
| 80 | info: LVM logical volume high data space usage (LV ${label:lv_name} VG ${label:vg_name} Type ${label:volume_type}) |
| 81 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/lvm.conf |
| 82 | - name: lvm_lv_metadata_space_utilization |
| 83 | metric: lvm.lv_metadata_space_utilization |
| 84 | info: LVM logical volume high metadata space usage (LV ${label:lv_name} VG ${label:vg_name} Type ${label:volume_type}) |
| 85 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/lvm.conf |
| 86 | metrics: |
| 87 | folding: |
| 88 | title: Metrics |
| 89 | enabled: false |
| 90 | description: "" |
| 91 | availability: [] |
| 92 | scopes: |
| 93 | - name: logical volume |
| 94 | description: These metrics refer to the LVM logical volume. |
| 95 | labels: |
| 96 | - name: lv_name |
| 97 | description: Logical volume name |
| 98 | - name: vg_name |
| 99 | description: Volume group name |
| 100 | - name: volume_type |
| 101 | description: Type of the volume |
| 102 | metrics: |
| 103 | - name: lvm.lv_data_space_utilization |
| 104 | description: Logical volume space allocated for data |
| 105 | unit: '%' |
| 106 | chart_type: area |
| 107 | dimensions: |
| 108 | - name: utilization |
| 109 | - name: lvm.lv_metadata_space_utilization |
| 110 | description: Logical volume space allocated for metadata |
| 111 | unit: '%' |
| 112 | chart_type: area |
| 113 | dimensions: |
| 114 | - name: utilization |