/
ContextTagKeys.ts
273 lines (232 loc) · 11.4 KB
/
ContextTagKeys.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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// THIS FILE WAS AUTOGENERATED
export class ContextTagKeys {
/**
* Application version. Information in the application context fields is always about the application that is sending the telemetry.
*/
public applicationVersion: string;
/**
* Application build.
*/
public applicationBuild: string;
/**
* Application type id.
*/
public applicationTypeId: string;
/**
* Application id.
*/
public applicationId: string;
/**
* Application layer.
*/
public applicationLayer: string;
/**
* Unique client device id. Computer name in most cases.
*/
public deviceId: string;
public deviceIp: string;
public deviceLanguage: string;
/**
* Device locale using <language>-<REGION> pattern, following RFC 5646. Example 'en-US'.
*/
public deviceLocale: string;
/**
* Model of the device the end user of the application is using. Used for client scenarios. If this field is empty then it is derived from the user agent.
*/
public deviceModel: string;
public deviceFriendlyName: string;
public deviceNetwork: string;
public deviceNetworkName: string;
/**
* Client device OEM name taken from the browser.
*/
public deviceOEMName: string;
public deviceOS: string;
/**
* Operating system name and version of the device the end user of the application is using. If this field is empty then it is derived from the user agent. Example 'Windows 10 Pro 10.0.10586.0'
*/
public deviceOSVersion: string;
/**
* Name of the instance where application is running. Computer name for on-premisis, instance name for Azure.
*/
public deviceRoleInstance: string;
/**
* Name of the role application is part of. Maps directly to the role name in azure.
*/
public deviceRoleName: string;
public deviceScreenResolution: string;
/**
* The type of the device the end user of the application is using. Used primarily to distinguish JavaScript telemetry from server side telemetry. Examples: 'PC', 'Phone', 'Browser'. 'PC' is the default value.
*/
public deviceType: string;
public deviceMachineName: string;
public deviceVMName: string;
public deviceBrowser: string;
/**
* The browser name and version as reported by the browser.
*/
public deviceBrowserVersion: string;
/**
* The IP address of the client device. IPv4 and IPv6 are supported. Information in the location context fields is always about the end user. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service.
*/
public locationIp: string;
/**
* The country of the client device. If any of Country, Province, or City is specified, those values will be preferred over geolocation of the IP address field. Information in the location context fields is always about the end user. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service.
*/
public locationCountry: string;
/**
* The province/state of the client device. If any of Country, Province, or City is specified, those values will be preferred over geolocation of the IP address field. Information in the location context fields is always about the end user. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service.
*/
public locationProvince: string;
/**
* The city of the client device. If any of Country, Province, or City is specified, those values will be preferred over geolocation of the IP address field. Information in the location context fields is always about the end user. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service.
*/
public locationCity: string;
/**
* A unique identifier for the operation instance. The operation.id is created by either a request or a page view. All other telemetry sets this to the value for the containing request or page view. Operation.id is used for finding all the telemetry items for a specific operation instance.
*/
public operationId: string;
/**
* The name (group) of the operation. The operation.name is created by either a request or a page view. All other telemetry items set this to the value for the containing request or page view. Operation.name is used for finding all the telemetry items for a group of operations (i.e. 'GET Home/Index').
*/
public operationName: string;
/**
* The unique identifier of the telemetry item's immediate parent.
*/
public operationParentId: string;
public operationRootId: string;
/**
* Name of synthetic source. Some telemetry from the application may represent a synthetic traffic. It may be web crawler indexing the web site, site availability tests or traces from diagnostic libraries like Application Insights SDK itself.
*/
public operationSyntheticSource: string;
/**
* The correlation vector is a light weight vector clock which can be used to identify and order related events across clients and services.
*/
public operationCorrelationVector: string;
/**
* Session ID - the instance of the user's interaction with the app. Information in the session context fields is always about the end user. When telemetry is sent from a service, the session context is about the user that initiated the operation in the service.
*/
public sessionId: string;
/**
* Boolean value indicating whether the session identified by ai.session.id is first for the user or not.
*/
public sessionIsFirst: string;
public sessionIsNew: string;
public userAccountAcquisitionDate: string;
/**
* In multi-tenant applications this is the account ID or name which the user is acting with. Examples may be subscription ID for Azure portal or blog name blogging platform.
*/
public userAccountId: string;
/**
* The browser's user agent string as reported by the browser. This property will be used to extract informaiton regarding the customer's browser but will not be stored. Use custom properties to store the original user agent.
*/
public userAgent: string;
/**
* Anonymous user id. Represents the end user of the application. When telemetry is sent from a service, the user context is about the user that initiated the operation in the service.
*/
public userId: string;
/**
* Store region for UWP applications.
*/
public userStoreRegion: string;
/**
* Authenticated user id. The opposite of ai.user.id, this represents the user with a friendly name. Since it's PII information it is not collected by default by most SDKs.
*/
public userAuthUserId: string;
public userAnonymousUserAcquisitionDate: string;
public userAuthenticatedUserAcquisitionDate: string;
public cloudName: string;
/**
* Name of the role the application is a part of. Maps directly to the role name in azure.
*/
public cloudRole: string;
public cloudRoleVer: string;
/**
* Name of the instance where the application is running. Computer name for on-premisis, instance name for Azure.
*/
public cloudRoleInstance: string;
public cloudEnvironment: string;
public cloudLocation: string;
public cloudDeploymentUnit: string;
/**
* SDK version. See https://github.com/microsoft/ApplicationInsights-Home/blob/master/SDK-AUTHORING.md#sdk-version-specification for information.
*/
public internalSdkVersion: string;
/**
* Agent version. Used to indicate the version of StatusMonitor installed on the computer if it is used for data collection.
*/
public internalAgentVersion: string;
/**
* This is the node name used for billing purposes. Use it to override the standard detection of nodes.
*/
public internalNodeName: string;
/**
* This identifies the version of the snippet that was used to initialize the SDK
*/
public internalSnippet: string;
/**
* This identifies the source of the Sdk script (used to identify whether the SDK was loaded via the CDN)
*/
public internalSdkSrc: string;
constructor() {
this.applicationVersion = "ai.application.ver";
this.applicationBuild = "ai.application.build";
this.applicationTypeId = "ai.application.typeId";
this.applicationId = "ai.application.applicationId";
this.applicationLayer = "ai.application.layer";
this.deviceId = "ai.device.id";
this.deviceIp = "ai.device.ip";
this.deviceLanguage = "ai.device.language";
this.deviceLocale = "ai.device.locale";
this.deviceModel = "ai.device.model";
this.deviceFriendlyName = "ai.device.friendlyName";
this.deviceNetwork = "ai.device.network";
this.deviceNetworkName = "ai.device.networkName";
this.deviceOEMName = "ai.device.oemName";
this.deviceOS = "ai.device.os";
this.deviceOSVersion = "ai.device.osVersion";
this.deviceRoleInstance = "ai.device.roleInstance";
this.deviceRoleName = "ai.device.roleName";
this.deviceScreenResolution = "ai.device.screenResolution";
this.deviceType = "ai.device.type";
this.deviceMachineName = "ai.device.machineName";
this.deviceVMName = "ai.device.vmName";
this.deviceBrowser = "ai.device.browser";
this.deviceBrowserVersion = "ai.device.browserVersion";
this.locationIp = "ai.location.ip";
this.locationCountry = "ai.location.country";
this.locationProvince = "ai.location.province";
this.locationCity = "ai.location.city";
this.operationId = "ai.operation.id";
this.operationName = "ai.operation.name";
this.operationParentId = "ai.operation.parentId";
this.operationRootId = "ai.operation.rootId";
this.operationSyntheticSource = "ai.operation.syntheticSource";
this.operationCorrelationVector = "ai.operation.correlationVector";
this.sessionId = "ai.session.id";
this.sessionIsFirst = "ai.session.isFirst";
this.sessionIsNew = "ai.session.isNew";
this.userAccountAcquisitionDate = "ai.user.accountAcquisitionDate";
this.userAccountId = "ai.user.accountId";
this.userAgent = "ai.user.userAgent";
this.userId = "ai.user.id";
this.userStoreRegion = "ai.user.storeRegion";
this.userAuthUserId = "ai.user.authUserId";
this.userAnonymousUserAcquisitionDate = "ai.user.anonUserAcquisitionDate";
this.userAuthenticatedUserAcquisitionDate = "ai.user.authUserAcquisitionDate";
this.cloudName = "ai.cloud.name";
this.cloudRole = "ai.cloud.role";
this.cloudRoleVer = "ai.cloud.roleVer";
this.cloudRoleInstance = "ai.cloud.roleInstance";
this.cloudEnvironment = "ai.cloud.environment";
this.cloudLocation = "ai.cloud.location";
this.cloudDeploymentUnit = "ai.cloud.deploymentUnit";
this.internalNodeName = "ai.internal.nodeName";
this.internalSdkVersion = "ai.internal.sdkVersion";
this.internalAgentVersion = "ai.internal.agentVersion";
this.internalSnippet = "ai.internal.snippet";
this.internalSdkSrc = "ai.internal.sdkSrc";
}
}