Skip to content

Commit 97147a8

Browse files
committed
edit pass: app-articles-batch-20
1 parent 4a3b7f4 commit 97147a8

File tree

3 files changed

+75
-73
lines changed

3 files changed

+75
-73
lines changed
Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: Azure Application Insights Telemetry Data Model - Event Telemetry | Microsoft Docs
3-
description: Application Insights data model for event telemetry
2+
title: Application Insights telemetry data model - Event telemetry | Microsoft Docs
3+
description: Learn about the Application Insights data model for event telemetry.
44
ms.topic: conceptual
55
ms.date: 04/25/2017
66
ms.reviewer: mmcc
77
---
88

99
# Event telemetry: Application Insights data model
1010

11-
You can create event telemetry items (in [Application Insights](./app-insights-overview.md)) to represent an event that occurred in your application. Typically it is a user interaction such as button click or order checkout. It can also be an application life cycle event like initialization or configuration update.
11+
You can create event telemetry items (in [Application Insights](./app-insights-overview.md)) to represent an event that occurred in your application. Typically, it's a user interaction such as a button click or order checkout. It can also be an application lifecycle event like initialization or a configuration update.
1212

13-
Semantically, events may or may not be correlated to requests. However, if used properly, event telemetry is more important than requests or traces. Events represent business telemetry and should be a subject to separate, less aggressive [sampling](./api-filtering-sampling.md).
13+
Semantically, events may or may not be correlated to requests. However, if used properly, event telemetry is more important than requests or traces. Events represent business telemetry and should be subject to separate, less aggressive [sampling](./api-filtering-sampling.md).
1414

1515
## Name
1616

17-
Event name. To allow proper grouping and useful metrics, restrict your application so that it generates a small number of separate event names. For example, don't use a separate name for each generated instance of an event.
17+
Event name: To allow proper grouping and useful metrics, restrict your application so that it generates a few separate event names. For example, don't use a separate name for each generated instance of an event.
1818

19-
Max length: 512 characters
19+
**Maximum length:** 512 characters
2020

2121
## Custom properties
2222

@@ -28,7 +28,6 @@ Max length: 512 characters
2828

2929
## Next steps
3030

31-
- See [data model](data-model.md) for Application Insights types and data model.
32-
- [Write custom event telemetry](./api-custom-events-metrics.md#trackevent)
33-
- Check out [platforms](./app-insights-overview.md#supported-languages) supported by Application Insights.
34-
31+
- See [Data model](data-model.md) for Application Insights types and data models.
32+
- [Write custom event telemetry](./api-custom-events-metrics.md#trackevent).
33+
- Check out [platforms](./app-insights-overview.md#supported-languages) supported by Application Insights.

articles/azure-monitor/app/sharepoint.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
---
22
title: Monitor a SharePoint site with Application Insights
3-
description: Start monitoring a new application with a new instrumentation key
3+
description: Start monitoring a new application with a new instrumentation key.
44
ms.topic: conceptual
55
ms.date: 09/08/2020
66
ms.reviewer: newylie
77
---
88

99
# Monitor a SharePoint site with Application Insights
1010

11-
Azure Application Insights monitors the availability, performance and usage of your apps. Here you'll learn how to set it up for a SharePoint site.
11+
Application Insights monitors the availability, performance, and usage of your apps. This article shows you how to set it up for a SharePoint site.
1212

1313
> [!NOTE]
14-
> Due to security concerns, you can't directly add the script that's described in this article to your webpages in the SharePoint modern UX. As an alternative, you can use [SharePoint Framework (SPFx)](/sharepoint/dev/spfx/extensions/overview-extensions) to build a custom extension that you can use to install Application Insights on your SharePoint sites.
14+
> Because of security concerns, you can't directly add the script that's described in this article to your webpages in the SharePoint modern UX. As an alternative, you can use [SharePoint Framework (SPFx)](/sharepoint/dev/spfx/extensions/overview-extensions) to build a custom extension that you can use to install Application Insights on your SharePoint sites.
1515
1616
## Create an Application Insights resource
1717
In the [Azure portal](https://portal.azure.com), create a new Application Insights resource. Choose ASP.NET as the application type.
1818

19-
![Click Properties, select the key, and press ctrl+C](./media/sharepoint/001.png)
19+
![Screenshot that shows selecting Properties, selecting the key, and selecting Ctrl+C.](./media/sharepoint/001.png)
2020

21-
The window that opens is the place where you'll see performance and usage data about your app. To get back to it next time you sign in to Azure, you should find a tile for it on the start screen. Alternatively select Browse to find it.
21+
The window that opens is the place where you see performance and usage data about your app. The next time you sign in to Azure, a tile for it appears on the **Start** screen. Alternatively, select **Browse** to find it.
2222

23-
## Add the script to your web pages
23+
## Add the script to your webpages
2424

25-
The current Snippet (listed below) is version "5", the version is encoded in the snippet as sv:"#" and the [current version is also available on GitHub](https://go.microsoft.com/fwlink/?linkid=2156318).
25+
The following current snippet is version `"5"`. The version is encoded in the snippet as `sv:"#"`. The [current version is also available on GitHub](https://go.microsoft.com/fwlink/?linkid=2156318).
2626

2727
```HTML
2828
<!--
@@ -47,30 +47,33 @@ cfg: { // Application Insights Configuration
4747
```
4848

4949
> [!NOTE]
50-
> The Url for SharePoint uses a different module format "...\ai.2.gbl.min.js" (note the additional **.gbl.**) this alternate module format is required to avoid an issue caused by the order that scripts are loaded, which will cause the SDK to fail to initialize and will result in the loss of telemetry events.
50+
> The URL for SharePoint uses a different module format "...\ai.2.gbl.min.js" (note the additional **.gbl.**). This alternate module format is required to avoid an issue caused by the order that scripts are loaded, which will cause the SDK to fail to initialize and result in the loss of telemetry events.
5151
>
52-
> The issue is caused by requireJS being loaded and initialized before the SDK.
52+
> The issue is caused by `requireJS` being loaded and initialized before the SDK.
5353
54-
Insert the script just before the &lt;/head&gt; tag of every page you want to track. If your website has a master page, you can put the script there. For example, in an ASP.NET MVC project, you'd put it in View\Shared\_Layout.cshtml
54+
Insert the script before the &lt;/head&gt; tag of every page you want to track. If your website has a main page, you can put the script there. For example, in an ASP.NET MVC project, you'd put it in `View\Shared\_Layout.cshtml`.
5555

5656
The script contains the instrumentation key that directs the telemetry to your Application Insights resource.
5757

5858
### Add the code to your site pages
59-
#### On the master page
60-
If you can edit the site's master page, that will provide monitoring for every page in the site.
6159

62-
Check out the master page and edit it using SharePoint Designer or any other editor.
60+
You can add the code to your main page or individual pages.
6361

64-
![Screenshot that shows how to edit the master page using Sharepoing Designer or another editor.](./media/sharepoint/03-master.png)
62+
#### Main page
63+
If you can edit the site's main page, that will provide monitoring for every page in the site.
6564

66-
Add the code just before the </head> tag.
65+
Check out the main page and edit it by using SharePoint Designer or any other editor.
66+
67+
![Screenshot that shows how to edit the main page by using Sharepoint Designer or another editor.](./media/sharepoint/03-master.png)
68+
69+
Add the code before the </head> tag.
6770

6871
![Screenshot that shows where to add the code to your site page.](./media/sharepoint/04-code.png)
6972

7073
[!INCLUDE [azure-monitor-log-analytics-rebrand](../../../includes/azure-monitor-instrumentation-key-deprecation.md)]
7174

72-
#### Or on individual pages
73-
To monitor a limited set of pages, add the script separately to each page.
75+
#### Individual pages
76+
To monitor a limited set of pages, add the script separately to each page.
7477

7578
Insert a web part and embed the code snippet in it.
7679

@@ -81,21 +84,21 @@ Redeploy your app.
8184

8285
Return to your application pane in the [Azure portal](https://portal.azure.com).
8386

84-
The first events appear in Search.
87+
The first events appear in Search.
8588

8689
![Screenshot that shows the new data that you can view in the app.](./media/sharepoint/09-search.png)
8790

88-
Select Refresh after a few seconds if you're expecting more data.
91+
Select **Refresh** after a few seconds if you're expecting more data.
8992

90-
## Capturing User Id
91-
The standard web page code snippet doesn't capture the user ID from SharePoint, but you can do that with a small modification.
93+
## Capture user ID
94+
The standard webpage code snippet doesn't capture the user ID from SharePoint, but you can do that with a small modification.
9295

93-
1. Copy your app's instrumentation key from the Essentials drop-down in Application Insights.
96+
1. Copy your app's instrumentation key from the **Essentials** dropdown in Application Insights.
9497

9598
![Screenshot that shows copying the app's instrumentation from the Essentials dropdown in Application Insights.](./media/sharepoint/02-props.png)
9699

97-
1. Substitute the instrumentation key for 'XXXX' in the snippet below.
98-
2. Embed the script in your SharePoint app instead of the snippet you get from the portal.
100+
1. Substitute the instrumentation key for `XXXX` in the following snippet.
101+
1. Embed the script in your SharePoint app instead of the snippet you get from the portal.
99102

100103
```
101104
@@ -144,9 +147,7 @@ function onRequestFail(sender, args) {
144147
145148
```
146149

147-
148-
149-
## Next Steps
150+
## Next steps
150151
* [Availability overview](./availability-overview.md) to monitor the availability of your site.
151152
* [Application Insights](./app-insights-overview.md) for other types of app.
152153

articles/azure-monitor/app/source-map-support.md

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Source map support for JavaScript applications - Azure Monitor Application Insights
3-
description: Learn how to upload source maps to your own storage account Blob container using Application Insights.
3+
description: Learn how to upload source maps to your Azure Storage account blob container by using Application Insights.
44
ms.topic: conceptual
55
ms.date: 06/23/2020
66
ms.custom: devx-track-js
@@ -9,76 +9,78 @@ ms.reviewer: mmcc
99

1010
# Source map support for JavaScript applications
1111

12-
Application Insights supports the uploading of source maps to your own Storage Account Blob Container.
13-
Source maps can be used to unminify call stacks found on the end to end transaction details page. Any exception sent by the [JavaScript SDK][ApplicationInsights-JS] or the [Node.js SDK][ApplicationInsights-Node.js] can be unminified with source maps.
12+
Application Insights supports the uploading of source maps to your Azure Storage account blob container. You can use source maps to unminify call stacks found on the **End-to-end transaction details** page. You can also use source maps to unminify any exception sent by the [JavaScript SDK][ApplicationInsights-JS] or the [Node.js SDK][ApplicationInsights-Node.js].
1413

15-
![Unminify a Call Stack by linking with a Storage Account](./media/source-map-support/details-unminify.gif)
14+
![Screenshot that shows selecting the option to unminify a call stack by linking with a storage account.](./media/source-map-support/details-unminify.gif)
1615

17-
## Create a new storage account and Blob container
16+
## Create a new storage account and blob container
1817

1918
If you already have an existing storage account or blob container, you can skip this step.
2019

21-
1. [Create a new storage account][create storage account]
22-
2. [Create a blob container][create blob container] inside your storage account. Be sure to set the "Public access level" to `Private`, to ensure that your source maps are not publicly accessible.
20+
1. [Create a new storage account][create storage account].
21+
1. [Create a blob container][create blob container] inside your storage account. Set **Public access level** to **Private** to ensure that your source maps aren't publicly accessible.
2322

2423
> [!div class="mx-imgBorder"]
25-
>![Your container access level must be set to Private](./media/source-map-support/container-access-level.png)
24+
>![Screenshot that shows setting the container access level to Private.](./media/source-map-support/container-access-level.png)
2625
27-
## Push your source maps to your Blob container
26+
## Push your source maps to your blob container
2827

29-
You should integrate your continuous deployment pipeline with your storage account by configuring it to automatically upload your source maps to the configured Blob container.
28+
Integrate your continuous deployment pipeline with your storage account by configuring it to automatically upload your source maps to the configured blob container.
3029

31-
Source maps can be uploaded to your Blob Storage Container with the same folder structure they were compiled & deployed with. A common use case is to prefix a deployment folder with its version, e.g. `1.2.3/static/js/main.js`. When unminifying via an Azure Blob container called `sourcemaps`, it will try to fetch a source map located at `sourcemaps/1.2.3/static/js/main.js.map`.
30+
You can upload source maps to your Azure Blob Storage container with the same folder structure they were compiled and deployed with. A common use case is to prefix a deployment folder with its version, for example, `1.2.3/static/js/main.js`. When you unminify via an Azure blob container called `sourcemaps`, the pipeline tries to fetch a source map located at `sourcemaps/1.2.3/static/js/main.js.map`.
3231

3332
### Upload source maps via Azure Pipelines (recommended)
3433

35-
If you are using Azure Pipelines to continuously build and deploy your application, add an [Azure File Copy][azure file copy] task to your pipeline to automatically upload your source maps.
34+
If you're using Azure Pipelines to continuously build and deploy your application, add an [Azure file copy][azure file copy] task to your pipeline to automatically upload your source maps.
3635

3736
> [!div class="mx-imgBorder"]
38-
> ![Add an Azure File Copy task to your Pipeline to upload your source maps to Azure Blob Storage](./media/source-map-support/azure-file-copy.png)
37+
> ![Screenshot that shows adding an Azure file copy task to your pipeline to upload your source maps to Azure Blob Storage.](./media/source-map-support/azure-file-copy.png)
3938
40-
## Configure your Application Insights resource with a Source Map storage account
39+
## Configure your Application Insights resource with a source map storage account
4140

42-
### From the end-to-end transaction details page
41+
You have two options for configuring your Application Insights resource with a source map storage account.
4342

44-
From the end-to-end transaction details tab, you can click on *Unminify* and it will display a prompt to configure if your resource is unconfigured.
43+
### End-to-end transaction details tab
4544

46-
1. In the Portal, view the details of an exception that is minified.
47-
2. Select *Unminify*.
48-
3. If your resource has not been configured, a message will appear, prompting you to configure.
45+
From the **End-to-end transaction details** tab, select **Unminify**. Configure your resource if it's unconfigured.
4946

50-
### From the properties page
47+
1. In the Azure portal, view the details of an exception that's minified.
48+
1. Select **Unminify**.
49+
1. If your resource isn't configured, configure it.
5150

52-
If you would like to configure or change the storage account or Blob container that is linked to your Application Insights Resource, you can do it by viewing the Application Insights resource's *Properties* tab.
51+
### Properties tab
5352

54-
1. Navigate to the *Properties* tab of your Application Insights resource.
55-
2. Select *Change source map blob container*.
56-
3. Select a different Blob container as your source maps container.
57-
4. Select `Apply`.
53+
To configure or change the storage account or blob container that's linked to your Application Insights resource:
54+
55+
1. Go to the **Properties** tab of your Application Insights resource.
56+
1. Select **Change source map Blob Container**.
57+
1. Select a different blob container as your source map container.
58+
1. Select **Apply**.
5859

5960
> [!div class="mx-imgBorder"]
60-
> ![Reconfigure your selected Azure Blob Container by navigating to the Properties pane](./media/source-map-support/reconfigure.png)
61+
> ![Screenshot that shows reconfiguring your selected Azure blob container on the Properties pane.](./media/source-map-support/reconfigure.png)
6162
6263
## Troubleshooting
6364

64-
### Required Azure role-based access control (Azure RBAC) settings on your Blob container
65+
This section offers troubleshooting tips for common issues.
66+
67+
### Required Azure role-based access control settings on your blob container
6568

66-
Any user on the Portal using this feature must be at least assigned as a [Storage Blob Data Reader][storage blob data reader] to your Blob container. You must assign this role to anyone else that will be using the source maps through this feature.
69+
Any user on the portal who uses this feature must be assigned at least as a [Storage Blob Data Reader][storage blob data reader] to your blob container. Assign this role to anyone who might use the source maps through this feature.
6770

6871
> [!NOTE]
69-
> Depending on how the container was created, this may not have been automatically assigned to you or your team.
72+
> Depending on how the container was created, this role might not have been automatically assigned to you or your team.
7073
7174
### Source map not found
7275

73-
1. Verify that the corresponding source map is uploaded to the correct blob container
74-
2. Verify that the source map file is named after the JavaScript file it maps to, suffixed with `.map`.
75-
- For example, `/static/js/main.4e2ca5fa.chunk.js` will search for the blob named `main.4e2ca5fa.chunk.js.map`
76-
3. Check your browser's console to see if any errors are being logged. Include this in any support ticket.
77-
78-
## Next Steps
76+
1. Verify that the corresponding source map is uploaded to the correct blob container.
77+
1. Verify that the source map file is named after the JavaScript file it maps to and uses the suffix `.map`:
78+
- For example, `/static/js/main.4e2ca5fa.chunk.js` searches for the blob named `main.4e2ca5fa.chunk.js.map`.
79+
1. Check your browser's console to see if any errors were logged. Include this information in any support ticket.
7980

80-
* [Azure File Copy task](/azure/devops/pipelines/tasks/deploy/azure-file-copy)
81+
## Next steps
8182

83+
[Azure file copy task](/azure/devops/pipelines/tasks/deploy/azure-file-copy)
8284

8385
<!-- Remote URLs -->
8486
[create storage account]: ../../storage/common/storage-account-create.md?toc=%2Fazure%2Fstorage%2Fblobs%2Ftoc.json&tabs=azure-portal

0 commit comments

Comments
 (0)