summaryrefslogtreecommitdiffstats
path: root/src/go/plugin/go.d/modules/hpssa/metadata.yaml
blob: 6cf7a6377fb2cc76c9104afb2b335e1f869bdcba (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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
plugin_name: go.d.plugin
modules:
  - meta:
      id: collector-go.d.plugin-hpssa
      plugin_name: go.d.plugin
      module_name: hpssa
      monitored_instance:
        name: HPE Smart Arrays
        link: "https://buy.hpe.com/us/en/options/controller-controller-options/smart-array-controllers-smart-host-bus-adapters/c/7109730"
        icon_filename: "hp.svg"
        categories:
          - data-collection.storage-mount-points-and-filesystems
      keywords:
        - storage
        - raid-controller
        - hp
        - hpssa
        - array
      related_resources:
        integrations:
          list: []
      info_provided_to_referring_integrations:
        description: ""
      most_popular: false
    overview:
      data_collection:
        metrics_description: |
          Monitors the health of HPE Smart Arrays by tracking the status of controllers, arrays, logical and physical drives in your storage system.
          It relies on the `ssacli` 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:
          -  `ssacli ctrl all show config detail`
        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:
          - title: Install ssacli
            description: |
              See [official installation instructions](https://support.hpe.com/connect/s/softwaredetails?language=en_US&collectionId=MTX-0cb3f808e2514d3d).
      configuration:
        file:
          name: go.d/ssacli.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: ssacli 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: hpssa
                    update_every: 5  # Collect HPE Smart Array statistics every 5 seconds
    troubleshooting:
      problems:
        list: []
    alerts: []
    metrics:
      folding:
        title: Metrics
        enabled: false
      description: ""
      availability: []
      scopes:
        - name: controller
          description: These metrics refer to the Controller.
          labels:
            - name: slot
              description: Slot number
            - name: model
              description: Controller model
          metrics:
            - name: hpssa.controller_status
              description: Controller status
              unit: status
              chart_type: line
              dimensions:
                - name: ok
                - name: nok
            - name: hpssa.controller_temperature
              description: Controller temperature
              unit: Celsius
              chart_type: line
              dimensions:
                - name: temperature
            - name: hpssa.controller_cache_module_presence_status
              description: Controller cache module presence
              unit: status
              chart_type: line
              dimensions:
                - name: present
                - name: not_present
            - name: hpssa.controller_cache_module_status
              description: Controller cache module status
              unit: status
              chart_type: line
              dimensions:
                - name: ok
                - name: nok
            - name: hpssa.controller_cache_module_temperature
              description: Controller cache module temperature
              unit: Celsius
              chart_type: line
              dimensions:
                - name: temperature
            - name: hpssa.controller_cache_module_battery_status
              description: Controller cache module battery status
              unit: status
              chart_type: line
              dimensions:
                - name: ok
                - name: nok
        - name: array
          description: These metrics refer to the Array.
          labels:
            - name: slot
              description: Slot number
            - name: array_id
              description: Array id
            - name: interface_type
              description: Array interface type (e.g. SATA)
            - name: array_type
              description: Array type (e.g. Data)
          metrics:
            - name: hpssa.array_status
              description: Array status
              unit: status
              chart_type: line
              dimensions:
                - name: ok
                - name: nok
        - name: logical drive
          description: These metrics refer to the Logical Drive.
          labels:
            - name: slot
              description: Slot number
            - name: array_id
              description: Array id
            - name: logical_drive_id
              description: Logical Drive id (number)
            - name: disk_name
              description: Disk name (e.g. /dev/sda)
            - name: drive_type
              description: Drive type (e.g. Data)
          metrics:
            - name: hpssa.logical_drive_status
              description: Logical Drive status
              unit: status
              chart_type: line
              dimensions:
                - name: ok
                - name: nok
        - name: physical drive
          description: These metrics refer to the Physical Drive.
          labels:
            - name: slot
              description: Slot number
            - name: array_id
              description: Array id or "na" if unassigned
            - name: logical_drive_id
              description: Logical Drive id or "na" if unassigned
            - name: location
              description: Drive location in port:box:bay format (e.g. 1I:1:1)
            - name: interface_type
              description: Drive interface type (e.g. SATA)
            - name: drive_type
              description: Drive type (e.g. Data Drive, Unassigned Drive)
            - name: model
              description: Drive model
          metrics:
            - name: hpssa.physical_drive_status
              description: Physical Drive status
              unit: status
              chart_type: line
              dimensions:
                - name: ok
                - name: nok
            - name: hpssa.physical_drive_temperature
              description: Physical Drive temperature
              unit: status
              chart_type: line
              dimensions:
                - name: temperature