-
Notifications
You must be signed in to change notification settings - Fork 11.6k
/
azure_monitor_datasource.ts
299 lines (262 loc) · 10.5 KB
/
azure_monitor_datasource.ts
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
import { find, startsWith } from 'lodash';
import { DataSourceInstanceSettings, ScopedVars } from '@grafana/data';
import { DataSourceWithBackend, getTemplateSrv, TemplateSrv } from '@grafana/runtime';
import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { getAuthType, getAzureCloud, getAzurePortalUrl } from '../credentials';
import TimegrainConverter from '../time_grain_converter';
import {
AzureDataSourceJsonData,
AzureMonitorMetricNamespacesResponse,
AzureMonitorMetricNamesResponse,
AzureMonitorMetricsMetadataResponse,
AzureMonitorQuery,
AzureMonitorResourceGroupsResponse,
AzureQueryType,
DatasourceValidationResult,
GetMetricNamespacesQuery,
GetMetricNamesQuery,
GetMetricMetadataQuery,
AzureMetricQuery,
} from '../types';
import { routeNames } from '../utils/common';
import migrateQuery from '../utils/migrateQuery';
import ResponseParser from './response_parser';
import UrlBuilder from './url_builder';
const defaultDropdownValue = 'select';
function hasValue(item?: string) {
return !!(item && item !== defaultDropdownValue);
}
export default class AzureMonitorDatasource extends DataSourceWithBackend<AzureMonitorQuery, AzureDataSourceJsonData> {
apiVersion = '2018-01-01';
apiPreviewVersion = '2017-12-01-preview';
listByResourceGroupApiVersion = '2021-04-01';
defaultSubscriptionId?: string;
resourcePath: string;
azurePortalUrl: string;
declare resourceGroup: string;
declare resourceName: string;
timeSrv: TimeSrv;
templateSrv: TemplateSrv;
constructor(private instanceSettings: DataSourceInstanceSettings<AzureDataSourceJsonData>) {
super(instanceSettings);
this.timeSrv = getTimeSrv();
this.templateSrv = getTemplateSrv();
this.defaultSubscriptionId = instanceSettings.jsonData.subscriptionId;
const cloud = getAzureCloud(instanceSettings);
this.resourcePath = routeNames.azureMonitor;
this.azurePortalUrl = getAzurePortalUrl(cloud);
}
isConfigured(): boolean {
// If validation didn't return any error then the data source is properly configured
return !this.validateDatasource();
}
filterQuery(item: AzureMonitorQuery): boolean {
const hasResource =
hasValue(item?.azureMonitor?.resourceGroup) &&
hasValue(item?.azureMonitor?.resourceName) &&
hasValue(item?.azureMonitor?.metricDefinition || item?.azureMonitor?.metricNamespace);
const hasResourceUri = hasValue(item.azureMonitor?.resourceUri);
return !!(
item.hide !== true &&
(hasResource || hasResourceUri) &&
hasValue(item?.azureMonitor?.metricName) &&
hasValue(item?.azureMonitor?.aggregation)
);
}
applyTemplateVariables(target: AzureMonitorQuery, scopedVars: ScopedVars): AzureMonitorQuery {
const item = target.azureMonitor;
if (!item) {
// return target;
throw new Error('Query is not a valid Azure Monitor Metrics query');
}
// fix for timeGrainUnit which is a deprecated/removed field name
if (item.timeGrain && item.timeGrainUnit && item.timeGrain !== 'auto') {
item.timeGrain = TimegrainConverter.createISO8601Duration(item.timeGrain, item.timeGrainUnit);
}
const templateSrv = getTemplateSrv();
const subscriptionId = templateSrv.replace(target.subscription || this.defaultSubscriptionId, scopedVars);
const resourceGroup = templateSrv.replace(item.resourceGroup, scopedVars);
const resourceName = templateSrv.replace(item.resourceName, scopedVars);
const metricNamespace = templateSrv.replace(item.metricNamespace, scopedVars);
const customNamespace = templateSrv.replace(item.customNamespace, scopedVars);
const timeGrain = templateSrv.replace((item.timeGrain || '').toString(), scopedVars);
const aggregation = templateSrv.replace(item.aggregation, scopedVars);
const top = templateSrv.replace(item.top || '', scopedVars);
const dimensionFilters = (item.dimensionFilters ?? [])
.filter((f) => f.dimension && f.dimension !== 'None')
.map((f) => {
const filters = f.filters?.map((filter) => templateSrv.replace(filter ?? '', scopedVars));
return {
dimension: templateSrv.replace(f.dimension, scopedVars),
operator: f.operator || 'eq',
filters: filters || [],
};
});
const azMonitorQuery: AzureMetricQuery = {
resourceGroup,
metricNamespace,
customNamespace,
resourceName,
timeGrain,
allowedTimeGrainsMs: item.allowedTimeGrainsMs,
metricName: templateSrv.replace(item.metricName, scopedVars),
aggregation: aggregation,
dimensionFilters,
top: top || '10',
alias: item.alias,
};
if (item.metricDefinition) {
azMonitorQuery.metricDefinition = templateSrv.replace(item.metricDefinition, scopedVars);
}
if (item.resourceUri) {
azMonitorQuery.resourceUri = templateSrv.replace(item.resourceUri, scopedVars);
}
return migrateQuery({
...target,
subscription: subscriptionId,
queryType: AzureQueryType.AzureMonitor,
azureMonitor: azMonitorQuery,
});
}
async getSubscriptions(): Promise<Array<{ text: string; value: string }>> {
if (!this.isConfigured()) {
return [];
}
return this.getResource(`${this.resourcePath}/subscriptions?api-version=2019-03-01`).then((result: any) => {
return ResponseParser.parseSubscriptions(result);
});
}
getResourceGroups(subscriptionId: string) {
return this.getResource(
`${this.resourcePath}/subscriptions/${subscriptionId}/resourceGroups?api-version=${this.listByResourceGroupApiVersion}`
).then((result: AzureMonitorResourceGroupsResponse) => {
return ResponseParser.parseResponseValues(result, 'name', 'name');
});
}
getResourceNames(subscriptionId: string, resourceGroup?: string, metricNamespace?: string, skipToken?: string) {
const validMetricNamespace = startsWith(metricNamespace?.toLowerCase(), 'microsoft.storage/storageaccounts/')
? 'microsoft.storage/storageaccounts'
: metricNamespace;
let url = `${this.resourcePath}/subscriptions/${subscriptionId}`;
if (resourceGroup) {
url += `/resourceGroups/${resourceGroup}`;
}
url += `/resources?api-version=${this.listByResourceGroupApiVersion}`;
if (validMetricNamespace) {
url += `&$filter=resourceType eq '${validMetricNamespace}'`;
}
if (skipToken) {
url += `&$skiptoken=${skipToken}`;
}
return this.getResource(url).then(async (result: any) => {
let list: Array<{ text: string; value: string }> = [];
if (startsWith(metricNamespace?.toLowerCase(), 'microsoft.storage/storageaccounts/')) {
list = ResponseParser.parseResourceNames(result, 'microsoft.storage/storageaccounts');
for (let i = 0; i < list.length; i++) {
list[i].text += '/default';
list[i].value += '/default';
}
} else {
list = ResponseParser.parseResourceNames(result, metricNamespace);
}
if (result.nextLink) {
// If there is a nextLink, we should request more pages
const nextURL = new URL(result.nextLink);
const nextToken = nextURL.searchParams.get('$skiptoken');
if (!nextToken) {
throw Error('unable to request the next page of resources');
}
const nextPage = await this.getResourceNames(subscriptionId, resourceGroup, metricNamespace, nextToken);
list = list.concat(nextPage);
}
return list;
});
}
getMetricNamespaces(query: GetMetricNamespacesQuery, globalRegion: boolean) {
const url = UrlBuilder.buildAzureMonitorGetMetricNamespacesUrl(
this.resourcePath,
this.apiPreviewVersion,
this.replaceTemplateVariables(query),
globalRegion,
this.templateSrv
);
return this.getResource(url)
.then((result: AzureMonitorMetricNamespacesResponse) => {
return ResponseParser.parseResponseValues(
result,
'properties.metricNamespaceName',
'properties.metricNamespaceName'
);
})
.then((result) => {
if (url.toLowerCase().includes('microsoft.storage/storageaccounts')) {
const storageNamespaces = [
'microsoft.storage/storageaccounts',
'microsoft.storage/storageaccounts/blobservices',
'microsoft.storage/storageaccounts/fileservices',
'microsoft.storage/storageaccounts/tableservices',
'microsoft.storage/storageaccounts/queueservices',
];
for (const namespace of storageNamespaces) {
if (!find(result, ['value', namespace.toLowerCase()])) {
result.push({ value: namespace, text: namespace });
}
}
}
return result;
});
}
getMetricNames(query: GetMetricNamesQuery) {
const url = UrlBuilder.buildAzureMonitorGetMetricNamesUrl(
this.resourcePath,
this.apiVersion,
this.replaceTemplateVariables(query),
this.templateSrv
);
return this.getResource(url).then((result: AzureMonitorMetricNamesResponse) => {
return ResponseParser.parseResponseValues(result, 'name.localizedValue', 'name.value');
});
}
getMetricMetadata(query: GetMetricMetadataQuery) {
const { metricName } = query;
const url = UrlBuilder.buildAzureMonitorGetMetricNamesUrl(
this.resourcePath,
this.apiVersion,
this.replaceTemplateVariables(query),
this.templateSrv
);
return this.getResource(url).then((result: AzureMonitorMetricsMetadataResponse) => {
return ResponseParser.parseMetadata(result, metricName);
});
}
private validateDatasource(): DatasourceValidationResult | undefined {
const authType = getAuthType(this.instanceSettings);
if (authType === 'clientsecret') {
if (!this.isValidConfigField(this.instanceSettings.jsonData.tenantId)) {
return {
status: 'error',
message: 'The Tenant Id field is required.',
};
}
if (!this.isValidConfigField(this.instanceSettings.jsonData.clientId)) {
return {
status: 'error',
message: 'The Client Id field is required.',
};
}
}
return undefined;
}
private isValidConfigField(field?: string): boolean {
return typeof field === 'string' && field.length > 0;
}
private replaceTemplateVariables<T extends { [K in keyof T]: string }>(query: T) {
const templateSrv = getTemplateSrv();
const workingQuery: { [K in keyof T]: string } = { ...query };
const keys = Object.keys(query) as Array<keyof T>;
keys.forEach((key) => {
workingQuery[key] = templateSrv.replace(workingQuery[key]);
});
return workingQuery;
}
}