|
1 | 1 | ---
|
2 |
| -title: Azure Application Insights Telemetry Data Model - Telemetry Context | Microsoft Docs |
3 |
| -description: Application Insights telemetry context data model |
| 2 | +title: 'Application Insights telemetry data model: Telemetry context | Microsoft Docs' |
| 3 | +description: Learn about the Application Insights telemetry context data model. |
4 | 4 | ms.topic: conceptual
|
5 | 5 | ms.date: 05/15/2017
|
6 | 6 | ms.reviewer: osrosado
|
7 | 7 | ---
|
8 | 8 |
|
9 | 9 | # Telemetry context: Application Insights data model
|
10 | 10 |
|
11 |
| -Every telemetry item may have a strongly typed context field. Every field enables a specific monitoring scenario. Use the custom properties collection to store custom or application-specific contextual information. |
12 |
| - |
| 11 | +Every telemetry item might have a strongly typed context field. Every field enables a specific monitoring scenario. Use the custom properties collection to store custom or application-specific contextual information. |
13 | 12 |
|
14 | 13 | ## Application version
|
15 | 14 |
|
16 |
| -Information in the application context fields is always about the application that is sending the telemetry. Application version is used to analyze trend changes in the application behavior and its correlation to the deployments. |
17 |
| - |
18 |
| -Max length: 1024 |
| 15 | +Information in the application context fields is always about the application that's sending the telemetry. The application version is used to analyze trend changes in the application behavior and its correlation to the deployments. |
19 | 16 |
|
| 17 | +Maximum length: 1,024 |
20 | 18 |
|
21 | 19 | ## Client IP address
|
22 | 20 |
|
23 |
| -The IP address of the client device. IPv4 and IPv6 are supported. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service. Application Insights extract the geo-location information from the client IP and then truncate it. So client IP by itself can't be used as end-user identifiable information. |
24 |
| - |
25 |
| -Max length: 46 |
| 21 | +This field is the IP address of the client device. IPv4 and IPv6 are supported. When telemetry is sent from a service, the location context is about the user that initiated the operation in the service. Application Insights extract the geo-location information from the client IP and then truncate it. The client IP by itself can't be used as user identifiable information. |
26 | 22 |
|
| 23 | +Maximum length: 46 |
27 | 24 |
|
28 | 25 | ## Device type
|
29 | 26 |
|
30 |
| -Originally this field was used to indicate the type of the device the end user of the application is using. Today used primarily to distinguish JavaScript telemetry with the device type 'Browser' from server-side telemetry with the device type 'PC'. |
31 |
| - |
32 |
| -Max length: 64 |
| 27 | +Originally, this field was used to indicate the type of the device the user of the application is using. Today it's used primarily to distinguish JavaScript telemetry with the device type `Browser` from server-side telemetry with the device type `PC`. |
33 | 28 |
|
| 29 | +Maximum length: 64 |
34 | 30 |
|
35 | 31 | ## Operation ID
|
36 | 32 |
|
37 |
| -A unique identifier of the root operation. This identifier allows grouping telemetry across multiple components. See [telemetry correlation](./correlation.md) for details. The operation ID is created by either a request or a page view. All other telemetry sets this field to the value for the containing request or page view. |
38 |
| - |
39 |
| -Max length: 128 |
| 33 | +This field is the unique identifier of the root operation. This identifier allows grouping telemetry across multiple components. For more information, see [Telemetry correlation](./correlation.md). The operation ID is created by either a request or a page view. All other telemetry sets this field to the value for the containing request or page view. |
40 | 34 |
|
| 35 | +Maximum length: 128 |
41 | 36 |
|
42 | 37 | ## Parent operation ID
|
43 | 38 |
|
44 |
| -The unique identifier of the telemetry item's immediate parent. See [telemetry correlation](./correlation.md) for details. |
45 |
| - |
46 |
| -Max length: 128 |
| 39 | +This field is the unique identifier of the telemetry item's immediate parent. For more information, see [Telemetry correlation](./correlation.md). |
47 | 40 |
|
| 41 | +Maximum length: 128 |
48 | 42 |
|
49 | 43 | ## Operation name
|
50 | 44 |
|
51 |
| -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 field 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 (for example 'GET Home/Index'). This context property is used to answer questions like "what are the typical exceptions thrown on this page." |
52 |
| - |
53 |
| -Max length: 1024 |
| 45 | +This field is 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 field to the value for the containing request or page view. The operation name is used for finding all the telemetry items for a group of operations (for example, `GET Home/Index`). This context property is used to answer questions like What are the typical exceptions thrown on this page? |
54 | 46 |
|
| 47 | +Maximum length: 1,024 |
55 | 48 |
|
56 | 49 | ## Synthetic source of the operation
|
57 | 50 |
|
58 |
| -Name of synthetic source. Some telemetry from the application may represent synthetic traffic. It may be web crawler indexing the web site, site availability tests, or traces from diagnostic libraries like Application Insights SDK itself. |
59 |
| - |
60 |
| -Max length: 1024 |
| 51 | +This field is the name of the synthetic source. Some telemetry from the application might represent synthetic traffic. It might be the web crawler indexing the website, site availability tests, or traces from diagnostic libraries like the Application Insights SDK itself. |
61 | 52 |
|
| 53 | +Maximum length: 1,024 |
62 | 54 |
|
63 | 55 | ## Session ID
|
64 | 56 |
|
65 |
| -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. |
66 |
| - |
67 |
| -Max length: 64 |
| 57 | +Session ID is the instance of the user's interaction with the app. Information in the session context fields is always about the user. When telemetry is sent from a service, the session context is about the user who initiated the operation in the service. |
68 | 58 |
|
| 59 | +Maximum length: 64 |
69 | 60 |
|
70 | 61 | ## Anonymous user ID
|
71 | 62 |
|
72 |
| -Anonymous user ID. (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. |
| 63 | +Anonymous user ID (User.Id) represents the user of the application. When telemetry is sent from a service, the user context is about the user who initiated the operation in the service. |
73 | 64 |
|
74 |
| -[Sampling](./sampling.md) is one of the techniques to minimize the amount of collected telemetry. Sampling algorithm attempts to either sample in or out all the correlated telemetry. Anonymous user ID is used for sampling score generation. So anonymous user ID should be a random enough value. |
| 65 | +[Sampling](./sampling.md) is one of the techniques to minimize the amount of collected telemetry. A sampling algorithm attempts to either sample in or out all the correlated telemetry. An anonymous user ID is used for sampling score generation, so an anonymous user ID should be a random enough value. |
75 | 66 |
|
76 | 67 | > [!NOTE]
|
77 |
| -> The count of anonymous user IDs is not the same as the number of unique application users. The count of anonymous user IDs is typically higher because each time the user opens your app on a different device or browser, or cleans up browser cookies, a new unique anonymous user id is allocated. This calculation may result in counting the same physical users multiple times. |
| 68 | +> The count of anonymous user IDs isn't the same as the number of unique application users. The count of anonymous user IDs is typically higher because each time the user opens your app on a different device or browser, or cleans up browser cookies, a new unique anonymous user ID is allocated. This calculation might result in counting the same physical users multiple times. |
78 | 69 |
|
79 | 70 | User IDs can be cross referenced with session IDs to provide unique telemetry dimensions and establish user activity over a session duration.
|
80 | 71 |
|
81 |
| -Using anonymous user ID to store user name is a misuse of the field. Use Authenticated user ID. |
82 |
| - |
83 |
| -Max length: 128 |
| 72 | +Using an anonymous user ID to store a username is a misuse of the field. Use an authenticated user ID. |
84 | 73 |
|
| 74 | +Maximum length: 128 |
85 | 75 |
|
86 | 76 | ## Authenticated user ID
|
87 | 77 |
|
88 |
| -Authenticated user ID. The opposite of anonymous user ID, this field represents the user with a friendly name. This ID is only collected by default with the ASP.NET Framework SDK's [`AuthenticatedUserIdTelemetryInitializer`](https://github.com/microsoft/ApplicationInsights-dotnet/blob/develop/WEB/Src/Web/Web/AuthenticatedUserIdTelemetryInitializer.cs). |
| 78 | +An authenticated user ID is the opposite of an anonymous user ID. This field represents the user with a friendly name. This ID is only collected by default with the ASP.NET Framework SDK's [`AuthenticatedUserIdTelemetryInitializer`](https://github.com/microsoft/ApplicationInsights-dotnet/blob/develop/WEB/Src/Web/Web/AuthenticatedUserIdTelemetryInitializer.cs). |
89 | 79 |
|
90 |
| -Use the Application Insights SDK to initialize the Authenticated User ID with a value identifying the user persistently across browsers and devices. In this way, all telemetry items are attributed to that unique ID. This ID enables querying for all telemetry collected for a specific user (subject to [sampling configurations](./sampling.md) and [telemetry filtering](./api-filtering-sampling.md)). |
| 80 | +Use the Application Insights SDK to initialize the authenticated user ID with a value that identifies the user persistently across browsers and devices. In this way, all telemetry items are attributed to that unique ID. This ID enables querying for all telemetry collected for a specific user (subject to [sampling configurations](./sampling.md) and [telemetry filtering](./api-filtering-sampling.md)). |
91 | 81 |
|
92 | 82 | User IDs can be cross referenced with session IDs to provide unique telemetry dimensions and establish user activity over a session duration.
|
93 | 83 |
|
94 |
| -Max length: 1024 |
95 |
| - |
| 84 | +Maximum length: 1,024 |
96 | 85 |
|
97 | 86 | ## Account ID
|
98 | 87 |
|
99 |
| -The account ID, in multi-tenant applications, is the tenant account ID or name that the user is acting with. It's used for more user segmentation when user ID and authenticated user ID aren't sufficient. For example, a subscription ID for Azure portal or the blog name for a blogging platform. |
100 |
| - |
101 |
| -Max length: 1024 |
| 88 | +The account ID, in multi-tenant applications, is the tenant account ID or name that the user is acting with. It's used for more user segmentation when a user ID and an authenticated user ID aren't sufficient. Examples might be a subscription ID for Azure portal or the blog name for a blogging platform. |
102 | 89 |
|
| 90 | +Maximum length: 1,024 |
103 | 91 |
|
104 | 92 | ## Cloud role
|
105 | 93 |
|
106 |
| -Name of the role the application is a part of. Maps directly to the role name in Azure. Can also be used to distinguish micro services, which are part of a single application. |
107 |
| - |
108 |
| -Max length: 256 |
| 94 | +This field is the name of the role of which the application is a part. It maps directly to the role name in Azure. It can also be used to distinguish micro services, which are part of a single application. |
109 | 95 |
|
| 96 | +Maximum length: 256 |
110 | 97 |
|
111 | 98 | ## Cloud role instance
|
112 | 99 |
|
113 |
| -Name of the instance where the application is running. Computer name for on-premises, instance name for Azure. |
114 |
| - |
115 |
| -Max length: 256 |
| 100 | +This field is the name of the instance where the application is running. For example, it's the computer name for on-premises or the instance name for Azure. |
116 | 101 |
|
| 102 | +Maximum length: 256 |
117 | 103 |
|
118 | 104 | ## Internal: SDK version
|
119 | 105 |
|
120 |
| -SDK version. See [this article](https://github.com/MohanGsk/ApplicationInsights-Home/blob/master/EndpointSpecs/SDK-VERSIONS.md) for information. |
121 |
| - |
122 |
| -Max length: 64 |
| 106 | +For more information, see this [SDK version article](https://github.com/MohanGsk/ApplicationInsights-Home/blob/master/EndpointSpecs/SDK-VERSIONS.md). |
123 | 107 |
|
| 108 | +Maximum length: 64 |
124 | 109 |
|
125 | 110 | ## Internal: Node name
|
126 | 111 |
|
127 | 112 | This field represents the node name used for billing purposes. Use it to override the standard detection of nodes.
|
128 | 113 |
|
129 |
| -Max length: 256 |
130 |
| - |
| 114 | +Maximum length: 256 |
131 | 115 |
|
132 | 116 | ## Next steps
|
133 | 117 |
|
134 | 118 | - Learn how to [extend and filter telemetry](./api-filtering-sampling.md).
|
135 |
| -- See [data model](data-model.md) for Application Insights types and data model. |
136 |
| -- Check out standard context properties collection [configuration](./configuration-with-applicationinsights-config.md#telemetry-initializers-aspnet). |
137 |
| - |
| 119 | +- See [Application Insights telemetry data model](data-model.md) for Application Insights types and data model. |
| 120 | +- Check out standard context properties collection [configuration](./configuration-with-applicationinsights-config.md#telemetry-initializers-aspnet). |
0 commit comments