This repository has been archived by the owner on Feb 2, 2023. It is now read-only.
/
collector.go
445 lines (386 loc) · 16.7 KB
/
collector.go
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
// Copyright 2019, Pure Storage Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package flashblade
import (
"fmt"
"time"
"github.com/PureStorage-OpenConnect/pure1-unplugged/pkg/common"
"github.com/PureStorage-OpenConnect/pure1-unplugged/pkg/common/resources"
"github.com/PureStorage-OpenConnect/pure1-unplugged/pkg/common/resources/metrics"
"github.com/PureStorage-OpenConnect/pure1-unplugged/pkg/common/timing"
log "github.com/sirupsen/logrus"
)
// NewCollector creates both a new array collector and its underlying array client
func NewCollector(arrayID string, displayName string, managementEndpoint string, apiToken string, metaConnection resources.ArrayMetadata) (resources.ArrayCollector, error) {
timer := timing.NewStageTimer("flashblade.NewCollector", log.Fields{"display_name": displayName})
defer timer.Finish()
arrayClient, err := NewClient(displayName, managementEndpoint, apiToken)
if err != nil {
log.WithFields(log.Fields{
"display_name": displayName,
}).Error("Could not create FlashBlade Collector")
return nil, err
}
collector := Collector{
ArrayID: arrayID,
ArrayType: common.FlashBlade,
Client: arrayClient,
DisplayName: displayName,
MgmtEndpoint: managementEndpoint,
metaConnection: metaConnection,
}
log.WithFields(log.Fields{
"array_type": collector.ArrayType,
"display_name": collector.DisplayName,
}).Info("Successfully created FlashBlade Collector")
return &collector, nil
}
// GetAllArrayData makes multiple underlying requests to get metric data for alerts and the array
func (collector *Collector) GetAllArrayData() (*metrics.AllArrayData, error) {
log.WithFields(log.Fields{
"display_name": collector.DisplayName,
}).Trace("Getting all data")
timer := timing.NewStageTimer("flashblade.Collector.GetAllArrayData", log.Fields{"display_name": collector.DisplayName})
defer timer.Finish()
// Get the basic array info
arrayInfo, err := collector.Client.GetArrayInfo()
if err != nil {
return nil, err // Can't mark the data without the array name
}
// Fetch all alerts
alertsChan := make(chan []*AlertResponse)
go collector.fetchAllAlerts(alertsChan)
// Fetch the array metrics
arrayMetricsChan := make(chan ArrayMetricsResponseBundle)
go collector.fetchArrayMetrics(arrayMetricsChan)
// Fetch the object counts
objectCountChan := make(chan ObjectCountResponseBundle)
go collector.fetchObjectCounts(objectCountChan)
// Fetch the array tags
arrayTags, err := collector.GetArrayTags()
if err != nil {
arrayTags = map[string]string{}
}
// Await all responses before proceeded to process them
var alertResponses []*AlertResponse
var arrayMetricsResponseBundle ArrayMetricsResponseBundle
var objectCountResponseBundle ObjectCountResponseBundle
for i := 0; i < 3; i++ {
select {
case message1 := <-alertsChan:
alertResponses = message1
case message2 := <-arrayMetricsChan:
arrayMetricsResponseBundle = message2
case message3 := <-objectCountChan:
objectCountResponseBundle = message3
}
}
timer.Stage("parse_responses")
// Record the current time for the metrics
creationTime := time.Now().Unix()
// Convert the alerts
alerts := make([]*metrics.Alert, 0, len(alertResponses))
for _, alert := range alertResponses {
alerts = append(alerts, convertAlertsResponse(alert, collector.ArrayID, arrayInfo.Name, collector.DisplayName, collector.MgmtEndpoint))
}
// Count the open and flagged alerts
openFlaggedAlertCount := 0
for _, alert := range alertResponses {
if alert.Flagged == true || alert.State == "open" {
openFlaggedAlertCount++
}
}
// Combine the array objects metric
arrayObjectsMetric := &metrics.ArrayObjectsMetric{
AlertMessageCount: uint32(openFlaggedAlertCount),
FileSystemCount: objectCountResponseBundle.FileSystemCount,
HostCount: 0, // Does not apply to FlashBlade
SnapshotCount: objectCountResponseBundle.SnapshotCount,
VolumeCount: 0, // Does not apply to FlashBlade
VolumePendingEradicationCount: 0, // Does not apply to FlashBlade
}
// Convert and combine the array metrics
arrayCapacityMetric := convertArrayCapacityMetricsResponse(arrayMetricsResponseBundle.CapacityMetricsResponse)
arrayPerformanceMetric := convertArrayPerformanceMetricsResponse(arrayMetricsResponseBundle.PerformanceMetricsResponse)
arrayMetric := &metrics.ArrayMetric{
ArrayCapacityMetric: arrayCapacityMetric,
ArrayObjectsMetric: arrayObjectsMetric,
ArrayPerformanceMetric: arrayPerformanceMetric,
ArrayID: collector.ArrayID,
ArrayName: arrayInfo.Name,
ArrayType: collector.ArrayType,
CreatedAt: creationTime,
DisplayName: collector.DisplayName,
Tags: arrayTags,
}
// Combine all metrics together
allArrayData := metrics.AllArrayData{
Alerts: alerts,
ArrayMetric: arrayMetric,
}
return &allArrayData, nil
}
// GetAllVolumeData makes multiple underlying requests to get metric data for all volumes (file systems)
func (collector *Collector) GetAllVolumeData(timeWindow int64) (*metrics.AllVolumeData, error) {
log.WithFields(log.Fields{
"display_name": collector.DisplayName,
}).Trace("Getting all data")
timer := timing.NewStageTimer("flashblade.Collector.GetAllVolumeData", log.Fields{"display_name": collector.DisplayName})
defer timer.Finish()
// Get the basic array info
arrayInfo, err := collector.Client.GetArrayInfo()
if err != nil {
return nil, err // Can't mark the data without the array name
}
// Get the various file system metrics
timer.Stage("GetFileSystemCapacityMetrics")
capacityResponse, err := collector.Client.GetFileSystemCapacityMetrics()
if err != nil {
collector.logIncompleteData(err, "GetFileSystemCapacityMetrics")
capacityResponse = []*FileSystemCapacityMetricsResponse{}
}
timer.Stage("GetFileSystemPerformanceMetrics")
performanceResponse, err := collector.Client.GetFileSystemPerformanceMetrics(timeWindow)
if err != nil {
return nil, err // If we are missing performance data, it's too messy to tie things together
}
timer.Stage("GetFileSystemSnapshots")
snapshotsResponse, err := collector.Client.GetFileSystemSnapshots()
if err != nil {
collector.logIncompleteData(err, "GetFileSystemSnapshots")
snapshotsResponse = []*FileSystemSnapshotResponse{}
}
// Fetch the array tags
arrayTags, err := collector.GetArrayTags()
if err != nil {
arrayTags = map[string]string{}
}
timer.Stage("parse_responses")
// Map the snapshots to their file systems to get a count
volumeSnapshotCountMap := make(map[string]uint32)
for _, snapshot := range snapshotsResponse {
if _, ok := volumeSnapshotCountMap[snapshot.Source]; !ok {
volumeSnapshotCountMap[snapshot.Source] = 0
}
volumeSnapshotCountMap[snapshot.Source]++
}
// Convert the capacity metrics (we want a map so we can look up a metric by name)
var capacityMetricsMap = make(map[string]*metrics.VolumeCapacityMetric)
for _, response := range capacityResponse {
metric := convertVolumeCapacityMetricsResponse(response, volumeSnapshotCountMap[response.Name])
capacityMetricsMap[response.Name] = metric
}
// Convert the performance metrics and combine the metrics together
// Note: each file system may have multiple data points here, order does not matter
var combinedVolumeMetrics []*metrics.VolumeMetric
for _, response := range performanceResponse {
performanceMetric := convertVolumePerformanceMetricsResponse(response)
var capacityMetric *metrics.VolumeCapacityMetric
if _, ok := capacityMetricsMap[response.Name]; ok {
capacityMetric = capacityMetricsMap[response.Name]
}
volumeMetric := &metrics.VolumeMetric{
VolumeCapacityMetric: capacityMetric,
VolumePerformanceMetric: performanceMetric,
ArrayDisplayName: collector.DisplayName,
ArrayID: collector.ArrayID,
ArrayName: arrayInfo.Name,
ArrayTags: arrayTags,
CreatedAt: int64(response.Time) / 1000, // sec
Type: "FileSystem",
VolumeName: response.Name,
}
combinedVolumeMetrics = append(combinedVolumeMetrics, volumeMetric)
}
return &metrics.AllVolumeData{
VolumeMetricsTimeSeries: combinedVolumeMetrics,
}, nil
}
// GetArrayID returns the ID of the array
func (collector *Collector) GetArrayID() string {
return collector.ArrayID
}
// GetArrayModel returns the model of the array (always "FlashBlade")
func (collector *Collector) GetArrayModel() (string, error) {
return common.FlashBlade, nil
}
// GetArrayName returns the name of the array
func (collector *Collector) GetArrayName() (string, error) {
timer := timing.NewStageTimer("flashblade.Collector.GetArrayName", log.Fields{"display_name": collector.DisplayName})
defer timer.Finish()
arrayInfo, err := collector.Client.GetArrayInfo()
if err != nil {
return "", err
}
return arrayInfo.Name, nil
}
// GetArrayTags returns the tags of the array from the API server
func (collector *Collector) GetArrayTags() (map[string]string, error) {
timer := timing.NewStageTimer("flashblade.Collector.GetArrayTags", log.Fields{"display_name": collector.DisplayName})
defer timer.Finish()
return collector.metaConnection.GetTags(collector.ArrayID)
}
// GetArrayType returns the type of array
func (collector *Collector) GetArrayType() string {
return collector.ArrayType
}
// GetArrayVersion returns the version of the array
func (collector *Collector) GetArrayVersion() (string, error) {
timer := timing.NewStageTimer("flashblade.Collector.GetArrayVersion", log.Fields{"display_name": collector.DisplayName})
defer timer.Finish()
arrayInfo, err := collector.Client.GetArrayInfo()
if err != nil {
return "", err
}
return arrayInfo.Version, nil
}
// GetDisplayName returns the display name for the array
func (collector *Collector) GetDisplayName() string {
return collector.DisplayName
}
// fetchAllAlerts is a helper function that makes a large request for all alerts and adds them to the channel
func (collector *Collector) fetchAllAlerts(alertsChan chan []*AlertResponse) {
timer := timing.NewStageTimer("flashblade.Collector.fetchAllAlerts", log.Fields{"display_name": collector.DisplayName})
defer timer.Finish()
alertsResponse, err := collector.Client.GetAlerts()
if err != nil {
collector.logIncompleteData(err, "GetAlerts")
alertsResponse = []*AlertResponse{}
}
alertsChan <- alertsResponse
}
// fetchArrayMetrics is a helper function that makes requests for array metrics and adds a bundled response to the channel
func (collector *Collector) fetchArrayMetrics(arrayMetricsChan chan ArrayMetricsResponseBundle) {
timer := timing.NewStageTimer("flashblade.Collector.fetchArrayMetrics", log.Fields{"display_name": collector.DisplayName})
defer timer.Finish()
capacityResponse, err := collector.Client.GetArrayCapacityMetrics()
if err != nil {
collector.logIncompleteData(err, "GetArrayCapacityMetrics")
capacityResponse = &ArrayCapacityMetricsResponse{}
}
performanceResponse, err := collector.Client.GetArrayPerformanceMetrics()
if err != nil {
collector.logIncompleteData(err, "GetArrayPerformanceMetrics")
performanceResponse = &ArrayPerformanceMetricsResponse{}
}
responseBundle := ArrayMetricsResponseBundle{
CapacityMetricsResponse: capacityResponse,
PerformanceMetricsResponse: performanceResponse,
}
arrayMetricsChan <- responseBundle
}
// fetchObjectCounts is a helper function that makes requests for various object counts and adds
// a bundled response to the channel
func (collector *Collector) fetchObjectCounts(itemCountChan chan ObjectCountResponseBundle) {
timer := timing.NewStageTimer("flashblade.Collector.fetchObjectCounts", log.Fields{"display_name": collector.DisplayName})
defer timer.Finish()
fileSystemCount, err := collector.Client.GetFileSystemCount()
if err != nil {
collector.logIncompleteData(err, "GetFileSystemCount")
}
snapshotCount, err := collector.Client.GetFileSystemSnapshotCount()
if err != nil {
collector.logIncompleteData(err, "GetFileSystemSnapshotCount")
}
responseBundle := ObjectCountResponseBundle{
FileSystemCount: fileSystemCount,
SnapshotCount: snapshotCount,
}
itemCountChan <- responseBundle
}
// logIncompleteData is a helper function to log errors when data gathering failed at some stage
func (collector *Collector) logIncompleteData(err error, subject string) {
log.WithFields(log.Fields{
"display_name": collector.DisplayName,
"error": err,
"subject": subject,
}).Warn(fmt.Sprintf("Error gathering data; response will be incomplete"))
}
// ConvertAlertsResponse converts an alert response into the desired resource
func convertAlertsResponse(response *AlertResponse, arrayID string, arrayName string, arrayDisplayName string, arrayHostname string) *metrics.Alert {
alert := &metrics.Alert{
Action: response.Action,
AlertID: response.Index,
ArrayDisplayName: arrayDisplayName,
ArrayHostname: arrayHostname,
ArrayID: arrayID,
ArrayName: arrayName,
Code: response.Code,
Created: int64(response.Created) / 1000, // Convert to seconds
Description: response.Description,
Flagged: response.Flagged,
Notified: int64(response.Notified) / 1000, // Convert to seconds
Severity: response.Severity,
State: response.State,
Summary: response.Subject,
Updated: int64(response.Updated) / 1000, // Convert to seconds
Variables: response.Variables,
}
alert.PopulateSeverityIndex()
return alert
}
// ConvertArrayCapacityMetricsResponse converts an array capacity metric response into the desired resource
func convertArrayCapacityMetricsResponse(response *ArrayCapacityMetricsResponse) *metrics.ArrayCapacityMetric {
return &metrics.ArrayCapacityMetric{
DataReduction: response.Space.DataReduction,
PercentFull: float64(response.Space.TotalPhysical) / float64(response.Capacity),
SharedSpace: 0, // Does not apply to FlashBlade
SnapshotSpace: response.Space.Snapshots,
SystemSpace: 0, // Does not apply to FlashBlade
TotalReduction: 0, // Does not apply to FlashBlade
TotalSpace: response.Capacity,
UsedSpace: response.Space.TotalPhysical,
VolumeSpace: response.Space.Unique,
}
}
// ConvertArrayPerformanceMetricsResponse converts an array performance metric response into the desired resource
func convertArrayPerformanceMetricsResponse(response *ArrayPerformanceMetricsResponse) *metrics.ArrayPerformanceMetric {
return &metrics.ArrayPerformanceMetric{
BytesPerOp: uint64(response.BytesPerOp),
BytesPerRead: uint64(response.BytesPerRead),
BytesPerWrite: uint64(response.BytesPerWrite),
OtherIOPS: uint64(response.OthersPerSec),
OtherLatency: uint64(response.UsecPerOtherOp),
QueueDepth: 0, // Does not apply to FlashBlade
ReadBandwidth: uint64(response.OutputPerSec),
ReadIOPS: uint64(response.ReadsPerSec),
ReadLatency: uint64(response.UsecPerReadOp),
WriteBandwidth: uint64(response.InputPerSec),
WriteIOPS: uint64(response.WritesPerSec),
WriteLatency: uint64(response.UsecPerWriteOp),
}
}
// ConvertVolumeCapacityMetricsResponse converts a file system capacity metric response into the desired volume resource
func convertVolumeCapacityMetricsResponse(response *FileSystemCapacityMetricsResponse, snapshotCount uint32) *metrics.VolumeCapacityMetric {
return &metrics.VolumeCapacityMetric{
DataReduction: response.Space.DataReduction,
ProvisionedSpace: response.Provisioned,
SnapshotCount: snapshotCount,
TotalReduction: 0, // Does not apply to FlashBlade
UsedSpace: response.Space.TotalPhysical,
}
}
// ConvertVolumePerformanceMetricsResponse converts a file system performance metric response into the desired volume resource
func convertVolumePerformanceMetricsResponse(response *FileSystemPerformanceMetricsResponse) *metrics.VolumePerformanceMetric {
return &metrics.VolumePerformanceMetric{
ReadBandwidth: uint64(response.ReadBytesPerSec),
ReadIOPS: uint64(response.ReadsPerSec),
ReadLatency: uint64(response.UsecPerReadOp),
OtherIOPS: uint64(response.OthersPerSec),
OtherLatency: uint64(response.UsecPerOtherOp),
WriteBandwidth: uint64(response.WriteBytesPerSec),
WriteIOPS: uint64(response.WritesPerSec),
WriteLatency: uint64(response.UsecPerWriteOp),
}
}