-
Notifications
You must be signed in to change notification settings - Fork 4.9k
/
client.go
277 lines (246 loc) · 10.3 KB
/
client.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
// Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
// or more contributor license agreements. Licensed under the Elastic License;
// you may not use this file except in compliance with the Elastic License.
package azure
import (
"fmt"
"strings"
"time"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/monitor/armmonitor"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
"github.com/elastic/beats/v7/metricbeat/mb"
"github.com/elastic/elastic-agent-libs/logp"
)
// Client represents the azure client which will make use of the azure sdk go metrics related clients
type Client struct {
AzureMonitorService Service
Config Config
ResourceConfigurations ResourceConfiguration
Log *logp.Logger
Resources []Resource
}
// mapResourceMetrics function type will map the configuration options to client metrics (depending on the metricset)
type mapResourceMetrics func(client *Client, resources []*armresources.GenericResourceExpanded, resourceConfig ResourceConfig) ([]Metric, error)
// NewClient instantiates the Azure monitoring client
func NewClient(config Config) (*Client, error) {
azureMonitorService, err := NewService(config)
if err != nil {
return nil, err
}
client := &Client{
AzureMonitorService: azureMonitorService,
Config: config,
Log: logp.NewLogger("azure monitor client"),
}
client.ResourceConfigurations.RefreshInterval = config.RefreshListInterval
return client, nil
}
// InitResources function will retrieve and validate the resources configured by the users and then map the information configured to client metrics.
// the mapMetric function sent in this case will handle the mapping part as different metric and aggregation options work for different metricsets
func (client *Client) InitResources(fn mapResourceMetrics) error {
if len(client.Config.Resources) == 0 {
return fmt.Errorf("no resource options defined")
}
// check if refresh interval has been set and if it has expired
if !client.ResourceConfigurations.Expired() {
return nil
}
var metrics []Metric
//reset client resources
client.Resources = []Resource{}
for _, resource := range client.Config.Resources {
// retrieve azure resources information
resourceList, err := client.AzureMonitorService.GetResourceDefinitions(resource.Id, resource.Group, resource.Type, resource.Query)
if err != nil {
err = fmt.Errorf("failed to retrieve resources: %w", err)
return err
}
if len(resourceList) == 0 {
err = fmt.Errorf("failed to retrieve resources: No resources returned using the configuration options resource ID %s, resource group %s, resource type %s, resource query %s",
resource.Id, resource.Group, resource.Type, resource.Query)
client.Log.Error(err)
continue
}
//map resources to the client
for _, resource := range resourceList {
if !containsResource(*resource.ID, client.Resources) {
client.Resources = append(client.Resources, Resource{
Id: *resource.ID,
Name: *resource.Name,
Location: *resource.Location,
Type: *resource.Type,
Group: getResourceGroupFromId(*resource.ID),
Tags: mapTags(resource.Tags),
Subscription: client.Config.SubscriptionId})
}
}
resourceMetrics, err := fn(client, resourceList, resource)
if err != nil {
return err
}
metrics = append(metrics, resourceMetrics...)
}
// users could add or remove resources while metricbeat is running so we could encounter the situation where resources are unavailable we log an error message (see above)
// we also log a debug message when absolutely no resources are found
if len(metrics) == 0 {
client.Log.Debug("no resources were found based on all the configurations options entered")
}
client.ResourceConfigurations.Metrics = metrics
return nil
}
// GetMetricValues returns the specified metric data points for the specified resource ID/namespace.
func (client *Client) GetMetricValues(metrics []Metric, report mb.ReporterV2) []Metric {
var resultedMetrics []Metric
// loop over the set of metrics
for _, metric := range metrics {
// select period to collect metrics, will double the interval value in order to retrieve any missing values
//if timegrain is larger than intervalx2 then interval will be assigned the timegrain value
interval := client.Config.Period
if t := convertTimegrainToDuration(metric.TimeGrain); t > interval*2 {
interval = t
}
endTime := time.Now().UTC()
startTime := endTime.Add(interval * (-2))
timespan := fmt.Sprintf("%s/%s", startTime.Format(time.RFC3339), endTime.Format(time.RFC3339))
// build the 'filter' parameter which will contain any dimensions configured
var filter string
if len(metric.Dimensions) > 0 {
var filterList []string
for _, dim := range metric.Dimensions {
filterList = append(filterList, dim.Name+" eq '"+dim.Value+"'")
}
filter = strings.Join(filterList, " AND ")
}
resp, timegrain, err := client.AzureMonitorService.GetMetricValues(metric.ResourceSubId, metric.Namespace, metric.TimeGrain, timespan, metric.Names,
metric.Aggregations, filter)
if err != nil {
err = fmt.Errorf("error while listing metric values by resource ID %s and namespace %s: %w", metric.ResourceSubId, metric.Namespace, err)
client.Log.Error(err)
report.Error(err)
} else {
for i, currentMetric := range client.ResourceConfigurations.Metrics {
if matchMetrics(currentMetric, metric) {
current := mapMetricValues(resp, currentMetric.Values, endTime.Truncate(time.Minute).Add(interval*(-1)), endTime.Truncate(time.Minute))
client.ResourceConfigurations.Metrics[i].Values = current
if client.ResourceConfigurations.Metrics[i].TimeGrain == "" {
client.ResourceConfigurations.Metrics[i].TimeGrain = timegrain
}
resultedMetrics = append(resultedMetrics, client.ResourceConfigurations.Metrics[i])
}
}
}
}
return resultedMetrics
}
// CreateMetric function will create a client metric based on the resource and metrics configured
func (client *Client) CreateMetric(resourceId string, subResourceId string, namespace string, metrics []string, aggregations string, dimensions []Dimension, timegrain string) Metric {
if subResourceId == "" {
subResourceId = resourceId
}
met := Metric{
ResourceId: resourceId,
ResourceSubId: subResourceId,
Namespace: namespace,
Names: metrics,
Dimensions: dimensions,
Aggregations: aggregations,
TimeGrain: timegrain,
}
for _, prevMet := range client.ResourceConfigurations.Metrics {
if len(prevMet.Values) != 0 && matchMetrics(prevMet, met) {
met.Values = prevMet.Values
}
}
return met
}
// MapMetricByPrimaryAggregation will map the primary aggregation of the metric definition to the client metric
func (client *Client) MapMetricByPrimaryAggregation(metrics []armmonitor.MetricDefinition, resourceId string, subResourceId string, namespace string, dim []Dimension, timegrain string) []Metric {
var clientMetrics []Metric
metricGroups := make(map[string][]armmonitor.MetricDefinition)
for _, met := range metrics {
metricGroups[string(*met.PrimaryAggregationType)] = append(metricGroups[string(*met.PrimaryAggregationType)], met)
}
for key, metricGroup := range metricGroups {
var metricNames []string
for _, metricName := range metricGroup {
metricNames = append(metricNames, *metricName.Name.Value)
}
clientMetrics = append(clientMetrics, client.CreateMetric(resourceId, subResourceId, namespace, metricNames, key, dim, timegrain))
}
return clientMetrics
}
// GetVMForMetaData func will retrieve the vm details in order to fill in the cloud metadata and also update the client resources
func (client *Client) GetVMForMetaData(resource *Resource, metricValues []MetricValue) VmResource {
var (
vm VmResource
resourceName = resource.Name
resourceId = resource.Id
)
// check first if this is a vm scaleset and the instance name is stored in the dimension value
if dimension, ok := getDimension("VMName", metricValues[0].dimensions); ok {
instanceId := getInstanceId(dimension.Value)
if instanceId != "" {
resourceId += fmt.Sprintf("/virtualMachines/%s", instanceId)
resourceName = dimension.Value
}
}
// if vm has been already added to the resource then it should be returned
if existingVM, ok := getVM(resourceName, resource.Vms); ok {
return existingVM
}
// an additional call is necessary in order to retrieve the vm specific details
expandedResource, err := client.AzureMonitorService.GetResourceDefinitionById(resourceId)
if err != nil {
client.Log.Error(err, "could not retrieve the resource details by resource ID %s", resourceId)
return VmResource{}
}
vm.Name = *expandedResource.Name
if expandedResource.Properties != nil {
if properties, ok := expandedResource.Properties.(map[string]interface{}); ok {
if hardware, ok := properties["hardwareProfile"]; ok {
if vmSz, ok := hardware.(map[string]interface{})["vmSize"]; ok {
vm.Size = vmSz.(string)
}
if vmID, ok := properties["vmId"]; ok {
vm.Id = vmID.(string)
}
}
}
}
if len(vm.Size) == 0 && expandedResource.SKU != nil && expandedResource.SKU.Name != nil {
vm.Size = *expandedResource.SKU.Name
}
// the client resource and selected resources are being updated in order to avoid additional calls
client.AddVmToResource(resource.Id, vm)
resource.Vms = append(resource.Vms, vm)
return vm
}
// GetResourceForMetaData will retrieve resource details for the selected metric configuration
func (client *Client) GetResourceForMetaData(grouped Metric) Resource {
for _, res := range client.Resources {
if res.Id == grouped.ResourceId {
return res
}
}
return Resource{}
}
// AddVmToResource will add the vm details to the resource
func (client *Client) AddVmToResource(resourceId string, vm VmResource) {
if len(vm.Id) > 0 && len(vm.Name) > 0 {
for i, res := range client.Resources {
if res.Id == resourceId {
client.Resources[i].Vms = append(client.Resources[i].Vms, vm)
}
}
}
}
// NewMockClient instantiates a new client with the mock azure service
func NewMockClient() *Client {
azureMockService := new(MockService)
client := &Client{
AzureMonitorService: azureMockService,
Config: Config{},
Log: logp.NewLogger("test azure monitor"),
}
return client
}