summaryrefslogtreecommitdiffstats
path: root/src/go/collectors/go.d.plugin/modules/megacli/metadata.yaml
blob: 5df8718867a83ab1bb997eb7a7c9188fea34cddd (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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-megacli
      plugin_name: go.d.plugin
      module_name: megacli
      monitored_instance:
        name: MegaCLI MegaRAID
        link: "https://wikitech.wikimedia.org/wiki/MegaCli"
        icon_filename: "hard-drive.svg"
        categories:
          - data-collection.storage-mount-points-and-filesystems
      keywords:
        - storage
        - raid-controller
        - manage-disks
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          Monitors the health of MegaCLI Hardware RAID by tracking the status of RAID adapters, physical drives, and backup batteries in your storage system.
          It relies on the `megacli` 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.

          Executed commands:
          -  `megacli -LDPDInfo -aAll -NoLog`
          -  `megacli -AdpBbuCmd -aAll -NoLog`
        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/megacli.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: megacli 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: megacli
                    update_every: 5  # Collect MegaCli Hardware RAID statistics every 5 seconds
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: adapter
          description: These metrics refer to the MegaCLI Adapter.
          labels:
            - name: adapter_number
              description: Adapter number
          metrics:
            - name: megacli.adapter_health_state
              description: Adapter health state
              unit: state
              chart_type: line
              dimensions:
                - name: optimal
                - name: degraded
                - name: partially_degraded
                - name: failed
        - name: physical drive
          description: These metrics refer to the MegaCLI Physical Drive.
          labels:
            - name: adapter_number
              description: Adapter number
            - name: wwn
              description: World Wide Name
            - name: slot_number
              description: Slot number
            - name: drive_position
              description: "Position (e.g. DiskGroup: 0, Span: 0, Arm: 2)"
            - name: drive_type
              description: Type (e.g. SATA)
          metrics:
            - name: megacli.phys_drive_media_errors_rate
              description: Physical Drive media errors rate
              unit: errors/s
              chart_type: line
              dimensions:
                - name: media_errors
            - name: megacli.phys_drive_predictive_failures_rate
              description: Physical Drive predictive failures rate
              unit: failures/s
              chart_type: line
              dimensions:
                - name: predictive_failures
        - name: backup battery unit
          description: These metrics refer to the MegaCLI Backup Battery Unit.
          labels:
            - name: adapter_number
              description: Adapter number
            - name: battery_type
              description: Battery type (e.g. BBU)
          metrics:
            - name: megacli.bbu_relative_charge
              description: BBU relative charge
              unit: percentage
              chart_type: area
              dimensions:
                - name: charge
            - name: megacli.bbu_recharge_cycles
              description: BBU relative charge
              unit: cycles
              chart_type: line
              dimensions:
                - name: recharge
            - name: megacli.bbu_temperature
              description: BBU bbu_temperature
              unit: Celsius
              chart_type: line
              dimensions:
                - name: temperature