summaryrefslogtreecommitdiffstats
path: root/src/go/plugin/go.d/modules/dmcache/metadata.yaml
blob: 58d9e462178b7e67bb58cb56af8e196c2db0c430 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-dmcache
      plugin_name: go.d.plugin
      module_name: dmcache
      monitored_instance:
        name: DMCache devices
        link: ""
        icon_filename: filesystem.svg
        categories:
          - data-collection.storage-mount-points-and-filesystems
      keywords:
        - dmcache
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      most_popular: false
    overview:
      data_collection:
        metrics_description: >
          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.
        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/dmcache.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: dmsetup 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: dmcache
                    update_every: 5  # Collect DMCache statistics every 5 seconds
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: dmcache device
          description: These metrics refer to the DMCache device.
          labels:
            - name: device
              description: Device name
          metrics:
            - name: dmcache.device_cache_space_usage
              description: DMCache space usage
              unit: bytes
              chart_type: stacked
              dimensions:
                - name: free
                - name: used
            - name: dmcache.device_metadata_space_usage
              description: DMCache metadata space usage
              unit: bytes
              chart_type: stacked
              dimensions:
                - name: free
                - name: used
            - name: dmcache.device_cache_read_efficiency
              description: DMCache read efficiency
              unit: requests/s
              chart_type: stacked
              dimensions:
                - name: hits
                - name: misses
            - name: dmcache.device_cache_write_efficiency
              description: DMCache write efficiency
              unit: requests/s
              chart_type: stacked
              dimensions:
                - name: hits
                - name: misses
            - name: dmcache.device_cache_activity
              description: DMCache activity
              unit: bytes/s
              chart_type: area
              dimensions:
                - name: promotions
                - name: demotions
            - name: dmcache.device_cache_dirty_size
              description: DMCache dirty data size
              unit: bytes
              chart_type: area
              dimensions:
                - name: dirty