src/go/plugin/go.d/modules/lvm/metadata.yaml
plugin_name: go.d.plugin
modules:
- meta:
id: collector-go.d.plugin-lvm
plugin_name: go.d.plugin
module_name: lvm
monitored_instance:
name: LVM logical volumes
link: ""
icon_filename: filesystem.svg
categories:
- data-collection.storage-mount-points-and-filesystems
keywords:
- lvm
- lvs
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ""
most_popular: false
overview:
data_collection:
metrics_description: >
This collector monitors the health of LVM logical volumes.
It relies on the [`lvs`](https://man7.org/linux/man-pages/man8/lvs.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.
method_description: ""
supported_platforms:
include: []
exclude: []
multi_instance: false
additional_permissions:
description: ""
default_behavior:
auto_detection:
description: ""
limits:
description: ""
performance_impact:
description: ""
setup:
prerequisites:
list: []
configuration:
file:
name: go.d/lvm.conf
options:
description: |
The following options can be defined globally: update_every.
folding:
title: Config options
enabled: true
list:
- name: update_every
description: Data collection frequency.
default_value: 10
required: false
- name: timeout
description: lvs binary execution timeout.
default_value: 2
required: false
examples:
folding:
title: Config
enabled: true
list:
- name: Custom update_every
description: Allows you to override the default data collection interval.
config: |
jobs:
- name: lvm
update_every: 5 # Collect logical volume statistics every 5 seconds
troubleshooting:
problems:
list: []
alerts:
- name: lvm_lv_data_space_utilization
metric: lvm.lv_data_space_utilization
info: LVM logical volume high data space usage (LV ${label:lv_name} VG ${label:vg_name} Type ${label:volume_type})
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/lvm.conf
- name: lvm_lv_metadata_space_utilization
metric: lvm.lv_metadata_space_utilization
info: LVM logical volume high metadata space usage (LV ${label:lv_name} VG ${label:vg_name} Type ${label:volume_type})
link: https://github.com/netdata/netdata/blob/master/src/health/health.d/lvm.conf
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: logical volume
description: These metrics refer to the LVM logical volume.
labels:
- name: lv_name
description: Logical volume name
- name: vg_name
description: Volume group name
- name: volume_type
description: Type of the volume
metrics:
- name: lvm.lv_data_space_utilization
description: Logical volume space allocated for data
unit: '%'
chart_type: area
dimensions:
- name: utilization
- name: lvm.lv_metadata_space_utilization
description: Logical volume space allocated for metadata
unit: '%'
chart_type: area
dimensions:
- name: utilization