/
EnvelopeCreator.ts
444 lines (379 loc) · 18.8 KB
/
EnvelopeCreator.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
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
import {
IEnvelope, Data, Envelope,
RemoteDependencyData, Event, Exception,
Metric, PageView, Trace, PageViewPerformance, IDependencyTelemetry,
IPageViewPerformanceTelemetry, CtxTagKeys,
HttpMethod, IPageViewTelemetryInternal, IWeb,
Util,
IExceptionTelemetry,
IExceptionInternal,
SampleRate
} from '@microsoft/applicationinsights-common';
import {
ITelemetryItem, CoreUtils,
IDiagnosticLogger, LoggingSeverity, _InternalMessageId,
hasJSON, getJSON
} from '@microsoft/applicationinsights-core-js';
// these two constants are used to filter out properties not needed when trying to extract custom properties and measurements from the incoming payload
const baseType: string = "baseType";
const baseData: string = "baseData";
export abstract class EnvelopeCreator {
public static Version = "2.5.5";
protected static extractPropsAndMeasurements(data: { [key: string]: any }, properties: { [key: string]: any }, measurements: { [key: string]: any }) {
if (!CoreUtils.isNullOrUndefined(data)) {
for (const key in data) {
if (data.hasOwnProperty(key)) {
const value = data[key];
if (CoreUtils.isNumber(value)) {
measurements[key] = value;
} else if (CoreUtils.isString(value)) {
properties[key] = value;
} else if (hasJSON()) {
properties[key] = getJSON().stringify(value);
}
}
}
}
}
// TODO: Do we want this to take logger as arg or use this._logger as nonstatic?
protected static createEnvelope<T>(logger: IDiagnosticLogger, envelopeType: string, telemetryItem: ITelemetryItem, data: Data<T>): IEnvelope {
const envelope = new Envelope(logger, data, envelopeType);
if (telemetryItem[SampleRate]) {
envelope.sampleRate = telemetryItem[SampleRate];
}
envelope.iKey = telemetryItem.iKey;
const iKeyNoDashes = telemetryItem.iKey.replace(/-/g, "");
envelope.name = envelope.name.replace("{0}", iKeyNoDashes);
// extract all extensions from ctx
EnvelopeCreator.extractPartAExtensions(telemetryItem, envelope);
// loop through the envelope tags (extension of Part A) and pick out the ones that should go in outgoing envelope tags
if (!telemetryItem.tags) {
telemetryItem.tags = [];
}
return envelope;
}
/*
* Maps Part A data from CS 4.0
*/
private static extractPartAExtensions(item: ITelemetryItem, env: IEnvelope) {
// todo: switch to keys from common in this method
if (!env.tags) {
env.tags = {};
}
if (!item.ext) {
item.ext = {};
}
if (!item.tags) {
item.tags = [];
}
if (item.ext.user) {
if (item.ext.user.authId) {
env.tags[CtxTagKeys.userAuthUserId] = item.ext.user.authId;
}
const userId = item.ext.user.id || item.ext.user.localId;
if (userId) {
env.tags[CtxTagKeys.userId] = userId;
}
}
if (item.ext.app) {
if (item.ext.app.sesId) {
env.tags[CtxTagKeys.sessionId] = item.ext.app.sesId;
}
}
if (item.ext.device) {
if (item.ext.device.id || item.ext.device.localId) {
env.tags[CtxTagKeys.deviceId] = item.ext.device.id || item.ext.device.localId;
}
if (item.ext.device.deviceClass) {
env.tags[CtxTagKeys.deviceType] = item.ext.device.deviceClass;
}
if (item.ext.device.ip) {
env.tags[CtxTagKeys.deviceIp] = item.ext.device.ip;
}
}
if (item.ext.web) {
const web: IWeb = item.ext.web as IWeb;
if (web.browserLang) {
env.tags[CtxTagKeys.deviceLanguage] = web.browserLang;
}
if (web.browserVer) {
env.tags[CtxTagKeys.deviceBrowserVersion] = web.browserVer;
}
if (web.browser) {
env.tags[CtxTagKeys.deviceBrowser] = web.browser;
}
env.data = env.data || {};
env.data.baseData = env.data.baseData || {};
env.data.baseData.properties = env.data.baseData.properties || {};
if (web.domain) {
env.data.baseData.properties['domain'] = web.domain;
}
if (web.isManual) {
env.data.baseData.properties['isManual'] = web.isManual.toString();
}
if (web.screenRes) {
env.data.baseData.properties['screenRes'] = web.screenRes;
}
if (web.userConsent) {
env.data.baseData.properties['userConsent'] = web.userConsent.toString();
}
}
if (item.ext.device) {
if (item.ext.device.model) {
env.tags[CtxTagKeys.deviceModel] = item.ext.device.model;
}
}
if (item.ext.os && item.ext.os.name) {
env.tags[CtxTagKeys.deviceOS] = item.ext.os.name;
}
if (item.ext.device) {
if (item.ext.device.deviceType) {
env.tags[CtxTagKeys.deviceType] = item.ext.device.deviceType;
}
}
// No support for mapping Trace.traceState to 2.0 as it is currently empty
if (item.ext.trace) {
if (item.ext.trace.parentID) {
env.tags[CtxTagKeys.operationParentId] = item.ext.trace.parentID;
}
if (item.ext.trace.name) {
env.tags[CtxTagKeys.operationName] = item.ext.trace.name;
}
if (item.ext.trace.traceID) {
env.tags[CtxTagKeys.operationId] = item.ext.trace.traceID;
}
}
// Sample 4.0 schema
// {
// "time" : "2018-09-05T22:51:22.4936Z",
// "name" : "MetricWithNamespace",
// "iKey" : "ABC-5a4cbd20-e601-4ef5-a3c6-5d6577e4398e",
// "ext": { "cloud": {
// "role": "WATSON3",
// "roleInstance": "CO4AEAP00000260"
// },
// "device": {}, "correlation": {} },
// "tags": [
// { "amazon.region" : "east2" },
// { "os.expid" : "wp:02df239" }
// ]
// }
const tgs = {};
// deals with tags.push({object})
for(let i = item.tags.length - 1; i >= 0; i--){
const tg = item.tags[i];
// CoreUtils.objKeys returns an array of keys
CoreUtils.arrForEach(CoreUtils.objKeys(tg), key => {
tgs[key] = tg[key];
})
item.tags.splice(i, 1);
}
// deals with tags[key]=value
for(const tg in item.tags){
tgs[tg] = item.tags[tg];
}
env.tags = { ...env.tags, ...tgs };
if(!env.tags[CtxTagKeys.internalSdkVersion]) {
// Append a version in case it is not already set
env.tags[CtxTagKeys.internalSdkVersion] = `javascript:${EnvelopeCreator.Version}`;
}
}
protected _logger: IDiagnosticLogger;
abstract Create(logger: IDiagnosticLogger, telemetryItem: ITelemetryItem): IEnvelope;
}
export class DependencyEnvelopeCreator extends EnvelopeCreator {
static DependencyEnvelopeCreator = new DependencyEnvelopeCreator();
Create(logger: IDiagnosticLogger, telemetryItem: ITelemetryItem): IEnvelope {
this._logger = logger;
if (CoreUtils.isNullOrUndefined(telemetryItem.baseData)) {
this._logger.throwInternal(
LoggingSeverity.CRITICAL,
_InternalMessageId.TelemetryEnvelopeInvalid, "telemetryItem.baseData cannot be null.");
}
const customMeasurements = telemetryItem.baseData.measurements || {};
const customProperties = telemetryItem.baseData.properties || {};
EnvelopeCreator.extractPropsAndMeasurements(telemetryItem.data, customProperties, customMeasurements);
const bd = telemetryItem.baseData as IDependencyTelemetry;
if (CoreUtils.isNullOrUndefined(bd)) {
logger.warnToConsole("Invalid input for dependency data");
return null;
}
const id = bd.id;
const absoluteUrl = bd.target;
const command = bd.name;
const duration = bd.duration;
const success = bd.success;
const resultCode = bd.responseCode;
const requestAPI = bd.type;
const correlationContext = bd.correlationContext;
const method = bd.properties && bd.properties[HttpMethod] ? bd.properties[HttpMethod] : "GET";
const baseData = new RemoteDependencyData(logger, id, absoluteUrl, command, duration, success, resultCode, method, requestAPI, correlationContext, customProperties, customMeasurements);
const data = new Data<RemoteDependencyData>(RemoteDependencyData.dataType, baseData);
return EnvelopeCreator.createEnvelope<RemoteDependencyData>(logger, RemoteDependencyData.envelopeType, telemetryItem, data);
}
}
export class EventEnvelopeCreator extends EnvelopeCreator {
static EventEnvelopeCreator = new EventEnvelopeCreator();
Create(logger: IDiagnosticLogger, telemetryItem: ITelemetryItem): IEnvelope {
this._logger = logger;
if (CoreUtils.isNullOrUndefined(telemetryItem.baseData)) {
this._logger.throwInternal(
LoggingSeverity.CRITICAL,
_InternalMessageId.TelemetryEnvelopeInvalid, "telemetryItem.baseData cannot be null.");
}
let customProperties = {};
let customMeasurements = {};
if (telemetryItem.baseType !== Event.dataType) {
customProperties['baseTypeSource'] = telemetryItem.baseType; // save the passed in base type as a property
}
if (telemetryItem.baseType === Event.dataType) { // take collection
customProperties = telemetryItem.baseData.properties || {};
customMeasurements = telemetryItem.baseData.measurements || {};
} else { // if its not a known type, convert to custom event
if (telemetryItem.baseData) {
EnvelopeCreator.extractPropsAndMeasurements(telemetryItem.baseData, customProperties, customMeasurements);
}
}
// Exract root level properties from part C telemetryItem.data
EnvelopeCreator.extractPropsAndMeasurements(telemetryItem.data, customProperties, customMeasurements);
const eventName = telemetryItem.baseData.name;
const baseData = new Event(logger, eventName, customProperties, customMeasurements);
const data = new Data<Event>(Event.dataType, baseData);
return EnvelopeCreator.createEnvelope<Event>(logger, Event.envelopeType, telemetryItem, data);
}
}
export class ExceptionEnvelopeCreator extends EnvelopeCreator {
static ExceptionEnvelopeCreator = new ExceptionEnvelopeCreator();
Create(logger: IDiagnosticLogger, telemetryItem: ITelemetryItem): IEnvelope {
this._logger = logger;
if (CoreUtils.isNullOrUndefined(telemetryItem.baseData)) {
this._logger.throwInternal(
LoggingSeverity.CRITICAL,
_InternalMessageId.TelemetryEnvelopeInvalid, "telemetryItem.baseData cannot be null.");
}
const bd = telemetryItem.baseData as IExceptionInternal;
const baseData = Exception.CreateFromInterface(logger, bd);
const data = new Data<Exception>(Exception.dataType, baseData);
return EnvelopeCreator.createEnvelope<Exception>(logger, Exception.envelopeType, telemetryItem, data);
}
}
export class MetricEnvelopeCreator extends EnvelopeCreator {
static MetricEnvelopeCreator = new MetricEnvelopeCreator();
Create(logger: IDiagnosticLogger, telemetryItem: ITelemetryItem): IEnvelope {
this._logger = logger;
if (CoreUtils.isNullOrUndefined(telemetryItem.baseData)) {
this._logger.throwInternal(
LoggingSeverity.CRITICAL,
_InternalMessageId.TelemetryEnvelopeInvalid, "telemetryItem.baseData cannot be null.");
}
const props = telemetryItem.baseData.properties || {};
const measurements = telemetryItem.baseData.measurements || {};
EnvelopeCreator.extractPropsAndMeasurements(telemetryItem.data, props, measurements);
const name = telemetryItem.baseData.name;
const average = telemetryItem.baseData.average;
const sampleCount = telemetryItem.baseData.sampleCount;
const min = telemetryItem.baseData.min;
const max = telemetryItem.baseData.max;
const baseData = new Metric(logger, name, average, sampleCount, min, max, props, measurements);
const data = new Data<Metric>(Metric.dataType, baseData);
return EnvelopeCreator.createEnvelope<Metric>(logger, Metric.envelopeType, telemetryItem, data);
}
}
export class PageViewEnvelopeCreator extends EnvelopeCreator {
static PageViewEnvelopeCreator = new PageViewEnvelopeCreator();
Create(logger: IDiagnosticLogger, telemetryItem: ITelemetryItem): IEnvelope {
this._logger = logger;
if (CoreUtils.isNullOrUndefined(telemetryItem.baseData)) {
this._logger.throwInternal(
LoggingSeverity.CRITICAL,
_InternalMessageId.TelemetryEnvelopeInvalid, "telemetryItem.baseData cannot be null.");
}
// Since duration is not part of the domain properties in Common Schema, extract it from part C
let duration;
if (!CoreUtils.isNullOrUndefined(telemetryItem.baseData) &&
!CoreUtils.isNullOrUndefined(telemetryItem.baseData.properties) &&
!CoreUtils.isNullOrUndefined(telemetryItem.baseData.properties.duration)) { // from part B properties
duration = telemetryItem.baseData.properties.duration;
delete telemetryItem.baseData.properties.duration;
} else if (!CoreUtils.isNullOrUndefined(telemetryItem.data) &&
!CoreUtils.isNullOrUndefined(telemetryItem.data["duration"])) { // from custom properties
duration = telemetryItem.data["duration"];
delete telemetryItem.data["duration"];
}
const bd = telemetryItem.baseData as IPageViewTelemetryInternal;
// special case: pageview.id is grabbed from current operation id. Analytics plugin is decoupled from properties plugin, so this is done here instead. This can be made a default telemetry intializer instead if needed to be decoupled from channel
let currentContextId;
if (telemetryItem.ext && telemetryItem.ext.trace && telemetryItem.ext.trace.traceID) {
currentContextId = telemetryItem.ext.trace.traceID;
}
const id = bd.id || currentContextId
const name = bd.name;
const url = bd.uri;
const properties = bd.properties || {};
const measurements = bd.measurements || {};
// refUri is a field that Breeze still does not recognize as part of Part B. For now, put it in Part C until it supports it as a domain property
if (!CoreUtils.isNullOrUndefined(bd.refUri)) {
properties["refUri"] = bd.refUri;
}
// pageType is a field that Breeze still does not recognize as part of Part B. For now, put it in Part C until it supports it as a domain property
if (!CoreUtils.isNullOrUndefined(bd.pageType)) {
properties["pageType"] = bd.pageType;
}
// isLoggedIn is a field that Breeze still does not recognize as part of Part B. For now, put it in Part C until it supports it as a domain property
if (!CoreUtils.isNullOrUndefined(bd.isLoggedIn)) {
properties["isLoggedIn"] = bd.isLoggedIn.toString();
}
// pageTags is a field that Breeze still does not recognize as part of Part B. For now, put it in Part C until it supports it as a domain property
if (!CoreUtils.isNullOrUndefined(bd.properties)) {
const pageTags = bd.properties;
for (const key in pageTags) {
if (pageTags.hasOwnProperty(key)) {
properties[key] = pageTags[key];
}
}
}
EnvelopeCreator.extractPropsAndMeasurements(telemetryItem.data, properties, measurements);
const baseData = new PageView(logger, name, url, duration, properties, measurements, id);
const data = new Data<PageView>(PageView.dataType, baseData);
return EnvelopeCreator.createEnvelope<PageView>(logger, PageView.envelopeType, telemetryItem, data);
}
}
export class PageViewPerformanceEnvelopeCreator extends EnvelopeCreator {
static PageViewPerformanceEnvelopeCreator = new PageViewPerformanceEnvelopeCreator();
Create(logger: IDiagnosticLogger, telemetryItem: ITelemetryItem): IEnvelope {
this._logger = logger;
if (CoreUtils.isNullOrUndefined(telemetryItem.baseData)) {
this._logger.throwInternal(
LoggingSeverity.CRITICAL,
_InternalMessageId.TelemetryEnvelopeInvalid, "telemetryItem.baseData cannot be null.");
}
const bd = telemetryItem.baseData as IPageViewPerformanceTelemetry;
const name = bd.name;
const url = bd.uri || (bd as any).url;
const properties = bd.properties || {};
const measurements = bd.measurements || {};
EnvelopeCreator.extractPropsAndMeasurements(telemetryItem.data, properties, measurements);
const baseData = new PageViewPerformance(logger, name, url, undefined, properties, measurements, bd);
const data = new Data<PageViewPerformance>(PageViewPerformance.dataType, baseData);
return EnvelopeCreator.createEnvelope<PageViewPerformance>(logger, PageViewPerformance.envelopeType, telemetryItem, data);
}
}
export class TraceEnvelopeCreator extends EnvelopeCreator {
static TraceEnvelopeCreator = new TraceEnvelopeCreator();
Create(logger: IDiagnosticLogger, telemetryItem: ITelemetryItem): IEnvelope {
this._logger = logger;
if (CoreUtils.isNullOrUndefined(telemetryItem.baseData)) {
this._logger.throwInternal(
LoggingSeverity.CRITICAL,
_InternalMessageId.TelemetryEnvelopeInvalid, "telemetryItem.baseData cannot be null.");
}
const message = telemetryItem.baseData.message;
const severityLevel = telemetryItem.baseData.severityLevel;
const props = telemetryItem.baseData.properties || {};
const measurements = telemetryItem.baseData.measurements || {};
EnvelopeCreator.extractPropsAndMeasurements(telemetryItem.data, props, measurements);
const baseData = new Trace(logger, message, severityLevel, props, measurements);
const data = new Data<Trace>(Trace.dataType, baseData);
return EnvelopeCreator.createEnvelope<Trace>(logger, Trace.envelopeType, telemetryItem, data);
}
}