|
1 | 1 | ---
|
2 | 2 | title: Configure Application Insights Profiler | Microsoft Docs
|
3 |
| -description: Use the Azure Application Insights Profiler settings pane to see Profiler status and start profiling sessions |
| 3 | +description: Use the Application Insights Profiler settings pane to see Profiler status and start profiling sessions |
4 | 4 | ms.contributor: Charles.Weininger
|
5 | 5 | ms.topic: conceptual
|
6 | 6 | ms.date: 08/09/2022
|
7 | 7 | ---
|
8 | 8 |
|
9 | 9 | # Configure Application Insights Profiler
|
10 | 10 |
|
11 |
| -Once you've enabled the Application Insights Profiler, you can: |
| 11 | +After you enable Application Insights Profiler, you can: |
12 | 12 |
|
13 |
| -- Start a new profiling session |
14 |
| -- Configure Profiler triggers |
15 |
| -- View recent profiling sessions |
| 13 | +- Start a new profiling session. |
| 14 | +- Configure Profiler triggers. |
| 15 | +- View recent profiling sessions. |
16 | 16 |
|
17 |
| -To open the Azure Application Insights Profiler settings pane, select **Performance** from the pane on the left within your Application Insights page. |
| 17 | +To open the Application Insights Profiler settings pane, select **Performance** on the left pane on your Application Insights page. |
18 | 18 |
|
19 |
| -:::image type="content" source="./media/profiler-settings/performance-blade-inline.png" alt-text="Screenshot of the link to open performance pane." lightbox="media/profiler-settings/performance-blade.png"::: |
| 19 | +:::image type="content" source="./media/profiler-settings/performance-blade-inline.png" alt-text="Screenshot that shows the link to open the Performance pane." lightbox="media/profiler-settings/performance-blade.png"::: |
20 | 20 |
|
21 |
| -View profiler traces across your Azure resources via two methods: |
| 21 | +You can view Profiler traces across your Azure resources via two methods: |
22 | 22 |
|
23 |
| -**Profiler button** |
| 23 | +- By the **Profiler** button: |
24 | 24 |
|
25 |
| -Select the **Profiler** button from the top menu. |
| 25 | + Select **Profiler**. |
26 | 26 |
|
27 |
| -:::image type="content" source="./media/profiler-overview/profiler-button-inline.png" alt-text="Screenshot of the Profiler button from the Performance pane." lightbox="media/profiler-settings/profiler-button.png"::: |
| 27 | + :::image type="content" source="./media/profiler-overview/profiler-button-inline.png" alt-text="Screenshot that shows the Profiler button on the Performance pane." lightbox="media/profiler-settings/profiler-button.png"::: |
28 | 28 |
|
29 |
| -**By operation** |
| 29 | +- By operation: |
30 | 30 |
|
31 |
| -1. Select an operation from the **Operation name** list ("Overall" is highlighted by default). |
32 |
| -1. Select the **Profiler traces** button. |
| 31 | + 1. Select an operation from the **Operation name** list. **Overall** is highlighted by default. |
| 32 | + 1. Select **Profiler traces**. |
33 | 33 |
|
34 |
| - :::image type="content" source="./media/profiler-settings/operation-entry-inline.png" alt-text="Screenshot of selecting operation and Profiler traces to view all profiler traces." lightbox="media/profiler-settings/operation-entry.png"::: |
| 34 | + :::image type="content" source="./media/profiler-settings/operation-entry-inline.png" alt-text="Screenshot that shows selecting operation and Profiler traces to view all Profiler traces." lightbox="media/profiler-settings/operation-entry.png"::: |
35 | 35 |
|
36 |
| -1. Select one of the requests from the list to the left. |
37 |
| -1. Select **Configure Profiler**. |
| 36 | + 1. Select one of the requests from the list on the left. |
| 37 | + 1. Select **Configure Profiler**. |
38 | 38 |
|
39 |
| - :::image type="content" source="./media/profiler-settings/configure-profiler-inline.png" alt-text="Screenshot of the overall selection and clicking Profiler traces to view all profiler traces." lightbox="media/profiler-settings/configure-profiler.png"::: |
| 39 | + :::image type="content" source="./media/profiler-settings/configure-profiler-inline.png" alt-text="Screenshot that shows the overall selection and clicking Profiler traces to view all profiler traces." lightbox="media/profiler-settings/configure-profiler.png"::: |
40 | 40 |
|
41 |
| -Once within the Profiler, you can configure and view the Profiler. The **Application Insights Profiler** page has these features: |
| 41 | +Within Profiler, you can configure and view Profiler. The **Application Insights Profiler** page has the following features. |
42 | 42 |
|
43 |
| -:::image type="content" source="./media/profiler-settings/configure-blade-inline.png" alt-text="Screenshot of profiler page features and settings." lightbox="media/profiler-settings/configure-blade.png"::: |
| 43 | +:::image type="content" source="./media/profiler-settings/configure-blade-inline.png" alt-text="Screenshot that shows Profiler page features and settings." lightbox="media/profiler-settings/configure-blade.png"::: |
44 | 44 |
|
45 | 45 | | Feature | Description |
|
46 | 46 | |-|-|
|
47 |
| -Profile Now | Starts profiling sessions for all apps that are linked to this instance of Application Insights. |
48 |
| -Triggers | Allows you to configure triggers that cause the profiler to run. |
49 |
| -Recent profiling sessions | Displays information about past profiling sessions, which you can sort using the filters at the top of the page. |
| 47 | +**Profile now** | Starts profiling sessions for all apps that are linked to this instance of Application Insights. |
| 48 | +**Triggers** | Allows you to configure triggers that cause Profiler to run. |
| 49 | +**Recent profiling sessions** | Displays information about past profiling sessions, which you can sort by using the filters at the top of the page. |
50 | 50 |
|
51 |
| -## Profile Now |
52 |
| -Select **Profile Now** to start a profiling session on demand. When you click this link, all profiler agents that are sending data to this Application Insights instance will start to capture a profile. After 5 to 10 minutes, the profile session will show in the list below. |
| 51 | +## Profile now |
| 52 | +Select **Profile now** to start a profiling session on demand. When you select this link, all Profiler agents that are sending data to this Application Insights instance start to capture a profile. After 5 to 10 minutes, the profile session is shown in the list. |
53 | 53 |
|
54 |
| -To manually trigger a profiler session, you'll need, at minimum, *write* access on your role for the Application Insights component. In most cases, you get write access automatically. If you're having issues, you'll need the "Application Insights Component Contributor" subscription scope role added. [See more about role access control with Azure Monitoring](../app/resources-roles-access-control.md). |
| 54 | +To manually trigger a Profiler session, you need, at minimum, *write* access on your role for the Application Insights component. In most cases, you get write access automatically. If you're having issues, you need the **Application Insights Component Contributor** subscription scope role added. For more information, see [Resources, roles, and access control in Application Insights](../app/resources-roles-access-control.md). |
55 | 55 |
|
56 |
| -## Trigger Settings |
| 56 | +## Trigger settings |
57 | 57 |
|
58 |
| -Select the Triggers button on the menu bar to open the CPU, Memory, and Sampling trigger settings pane. |
| 58 | +Select **Triggers** to open the **Trigger Settings** pane that has the **CPU**, **Memory**, and **Sampling** trigger tabs. |
59 | 59 |
|
60 |
| -**CPU or Memory triggers** |
| 60 | +### CPU or Memory triggers |
61 | 61 |
|
62 |
| -You can set up a trigger to start profiling when the percentage of CPU or Memory use hits the level you set. |
| 62 | +You can set up a trigger to start profiling when the percentage of CPU or memory use hits the level you set. |
63 | 63 |
|
64 |
| -:::image type="content" source="./media/profiler-settings/cpu-memory-trigger-settings.png" alt-text="Screenshot of trigger settings pane for C P U and Memory triggers."::: |
| 64 | +:::image type="content" source="./media/profiler-settings/cpu-memory-trigger-settings.png" alt-text="Screenshot that shows the Trigger Settings pane for C P U and Memory triggers."::: |
65 | 65 |
|
66 | 66 | | Setting | Description |
|
67 | 67 | |-|-|
|
68 |
| -On / Off Button | On: profiler can be started by this trigger; Off: profiler won't be started by this trigger. |
69 |
| -Memory threshold | When this percentage of memory is in use, the profiler will be started. |
70 |
| -Duration | Sets the length of time the profiler will run when triggered. |
71 |
| -Cooldown | Sets the length of time the profiler will wait before checking for the memory or CPU usage again after it's triggered. |
| 68 | +On/Off button | On: Starts Profiler. Off: Doesn't start Profiler. |
| 69 | +Memory threshold | When this percentage of memory is in use, Profiler is started. |
| 70 | +Duration | Sets the length of time Profiler runs when triggered. |
| 71 | +Cooldown | Sets the length of time Profiler waits before checking for the memory or CPU usage again after it's triggered. |
72 | 72 |
|
73 |
| -**Sampling trigger** |
| 73 | +### Sampling trigger |
74 | 74 |
|
75 |
| -Unlike CPU or memory triggers, the Sampling trigger isn't triggered by an event. Instead, it's triggered randomly to get a truly random sample of your application's performance. You can: |
| 75 | +Unlike CPU or Memory triggers, an event doesn't trigger the Sampling trigger. Instead, it's triggered randomly to get a truly random sample of your application's performance. |
| 76 | +You can: |
76 | 77 | - Turn this trigger off to disable random sampling.
|
77 |
| -- Set how often profiling will occur and the duration of the profiling session. |
| 78 | +- Set how often profiling occurs and the duration of the profiling session. |
78 | 79 |
|
79 |
| -:::image type="content" source="./media/profiler-settings/sampling-trigger-settings.png" alt-text="Screenshot of trigger settings pane for Sampling trigger."::: |
| 80 | +:::image type="content" source="./media/profiler-settings/sampling-trigger-settings.png" alt-text="Screenshot that shows the Trigger Settings pane for Sampling trigger."::: |
80 | 81 |
|
81 | 82 | | Setting | Description |
|
82 | 83 | |-|-|
|
83 |
| -On / Off Button | On: profiler can be started by this trigger; Off: profiler won't be started by this trigger. |
84 |
| -Sample rate | The rate at which the profiler can occur. </br> <ul><li>The **Normal** setting collects data 5% of the time, which is about 2 minutes per hour.</li><li>The **High** setting profiles 50% of the time.</li><li>The **Maximum** setting profiles 75% of the time.</li></ul> </br> Normal is recommended for production environments. |
85 |
| -Duration | Sets the length of time the profiler will run when triggered. |
| 84 | +On/Off button | On: Starts Profiler. Off: Doesn't start Profiler. |
| 85 | +Sample rate | The rate at which Profiler can occur. </br> <ul><li>The **Normal** setting collects data 5% of the time, which is about 2 minutes per hour.</li><li>The **High** setting profiles 50% of the time.</li><li>The **Maximum** setting profiles 75% of the time.</li></ul> </br> We recommend the **Normal** setting for production environments. |
| 86 | +Duration | Sets the length of time Profiler runs when triggered. |
86 | 87 |
|
87 |
| -## Recent Profiling Sessions |
88 |
| -This section of the Profiler page displays recent profiling session information. A profiling session represents the time taken by the profiler agent while profiling one of the machines hosting your application. Open the profiles from a session by clicking on one of the rows. For each session, we show: |
| 88 | +## Recent profiling sessions |
| 89 | +This section of the **Profiler** page displays recent profiling session information. A profiling session represents the time taken by the Profiler agent while profiling one of the machines that hosts your application. Open the profiles from a session by selecting one of the rows. For each session, we show the following settings. |
89 | 90 |
|
90 | 91 | | Setting | Description |
|
91 | 92 | |-|-|
|
92 |
| -Triggered by | How the session was started, either by a trigger, Profile Now, or default sampling. |
| 93 | +Triggered by | How the session was started, either by a trigger, Profile now, or default sampling. |
93 | 94 | App Name | Name of the application that was profiled.
|
94 |
| -Machine Instance | Name of the machine the profiler agent ran on. |
| 95 | +Machine Instance | Name of the machine the Profiler agent ran on. |
95 | 96 | Timestamp | Time when the profile was captured.
|
96 |
| -CPU % | Percentage of CPU that was being used while the profiler was running. |
97 |
| -Memory % | Percentage of memory that was being used while the profiler was running. |
| 97 | +CPU % | Percentage of CPU used while Profiler was running. |
| 98 | +Memory % | Percentage of memory used while Profiler was running. |
98 | 99 |
|
99 | 100 | ## Next steps
|
100 | 101 | [Enable Profiler and view traces](profiler-overview.md?toc=/azure/azure-monitor/toc.json)
|
|
0 commit comments