You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-monitor/app/availability.md
+16-18Lines changed: 16 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ There are four types of availability tests:
48
48
49
49
1. Select **Add Standard test** from the top navigation bar.
50
50
51
-
:::image type="content" source="media/availability/add-standard-test.png" alt-text="Screenshot that shows the Availability experience with the Add Standard test tab open." lightbox="media/availability/add-standard-test.png":::
51
+
:::image type="content" source="media/availability/add-standard-test.png" alt-text="Screenshot showing the Availability experience with the Add Standard test tab open." lightbox="media/availability/add-standard-test.png":::
52
52
53
53
1. Input your test name, URL, and other settings described in the following table, then select **Create**.
54
54
@@ -78,16 +78,16 @@ There are four types of availability tests:
78
78
>
79
79
> *Standard tests should always be used if possible*, as they require little investment, no maintenance, and have few prerequisites.
80
80
81
+
This example is designed only to show you the mechanics of how the `TrackAvailability()` API call works within an Azure Functions app. It doesn't show how to write the underlying HTTP test code or business logic required to turn this example into a fully functional availability test.
> * Access to the source code of an [Azure Functions app](../../azure-functions/functions-how-to-use-azure-function-app-settings.md)
86
88
> * Developer expertise to author [custom code](#basic-code-sample) for [TrackAvailability()](/dotnet/api/microsoft.applicationinsights.telemetryclient.trackavailability), tailored to your specific business needs
87
89
88
-
### Basic code sample
89
-
90
-
This example is designed only to show you the mechanics of how the `TrackAvailability()` API call works within an Azure Functions app. It doesn't show how to write the underlying HTTP test code or business logic required to turn this example into a fully functional availability test.
90
+
### Get started
91
91
92
92
> [!NOTE]
93
93
> To follow these instructions, you must use either the [App Service](../../azure-functions/dedicated-plan.md) plan or Functions Premium plan to allow editing code in App Service Editor.
@@ -102,7 +102,7 @@ This example is designed only to show you the mechanics of how the `TrackAvailab
102
102
103
103
***If you already have an Application Insights resource,** go to the **Monitoring** tab while creating the Azure Functions app, and select or enter the name of your existing resource in the Application Insights dropdown:
104
104
105
-
:::image type="content" source="media/availability/create-application-insights.png" alt-text="Screenshot that shows selecting your existing Application Insights resource on the Monitoring tab.":::
105
+
:::image type="content" source="media/availability/create-application-insights.png" alt-text="Screenshot showing selecting your existing Application Insights resource on the Monitoring tab.":::
106
106
107
107
1. Follow the instructions to [create a timer triggered function](../../azure-functions/functions-create-scheduled-function.md#create-a-timer-triggered-function).
108
108
@@ -125,7 +125,7 @@ To create a new file, right-click under your timer trigger function (for example
125
125
</Project>
126
126
```
127
127
128
-
:::image type="content" source="media/availability/function-proj.png" alt-text=" Screenshot that shows function.proj in the App Service Editor." lightbox="media/availability/function-proj.png":::
128
+
:::image type="content" source="media/availability/function-proj.png" alt-text=" Screenshot showing function.proj in the App Service Editor." lightbox="media/availability/function-proj.png":::
129
129
130
130
1. Create a new file called **runAvailabilityTest.csx** and paste the following code:
131
131
@@ -291,11 +291,11 @@ You can use the following population tags for the geo-location attribute when yo
291
291
292
292
1. After you save the availability test, open the context menu by the test you made, then select **Open Rules (Alerts) page**.
293
293
294
-
:::image type="content" source="media/availability/edit-alert.png" alt-text="Screenshot that shows the Availability experience for an Application Insights resource in the Azure portal and the Open Rules (Alerts) page menu option." lightbox="media/availability/edit-alert.png":::
294
+
:::image type="content" source="media/availability/open-rules-page.png" alt-text="Screenshot showing the Availability experience for an Application Insights resource in the Azure portal and the Open Rules (Alerts) page menu option." lightbox="media/availability/open-rules-page.png":::
295
295
296
296
1. On the **Alert rules** page, open your alert, then select **Edit** in the top navigation bar. Here you can set the severity level, rule description, and action group that have the notification preferences you want to use for this alert rule.
297
297
298
-
:::image type="content" source="media/availability/metric-alert-rule.png" alt-text="Screenshot that shows an alert rule page in the Azure portal with Edit highlighted." lightbox="media/availability/metric-alert-rule.png":::
298
+
:::image type="content" source="media/availability/edit-alert.png" alt-text="Screenshot showing an alert rule page in the Azure portal with Edit highlighted." lightbox="media/availability/edit-alert.png":::
299
299
300
300
### Alert criteria
301
301
@@ -312,7 +312,7 @@ You might not want to receive notifications when your website is down for only a
312
312
313
313
To make changes to the location threshold, aggregation period, and test frequency, go to the **Edit alert rule** page (see step 2 under [Enable alerts](#enable-alerts)), then select the condition to open the **Configure signal logic** window.
314
314
315
-
:::image type="content" source="media/availability/configure-signal-logic.png" alt-text="Screenshot that shows a highlighted alert condition and the Configure signal logic window." lightbox="media/availability/configure-signal-logic.png":::
315
+
:::image type="content" source="media/availability/configure-signal-logic.png" alt-text="Screenshot showing a highlighted alert condition and the Configure signal logic window." lightbox="media/availability/configure-signal-logic.png":::
316
316
317
317
### Create a custom alert rule
318
318
@@ -344,20 +344,18 @@ This section explains how to review availability test results in the Azure porta
344
344
345
345
Start by reviewing the graph in the **Availability** experience in the Azure portal.
346
346
347
-
:::image type="content" source="media/availability/graph-and-tests.png" alt-text="Screenshot that shows the Availability experience with two different tests listed.":::
347
+
:::image type="content" source="media/availability/availability-test-list.png" alt-text="Screenshot showing the Availability experience with two different tests listed.":::
348
348
349
349
> [!NOTE]
350
350
> Tests created with `TrackAvailability()` will appear with **CUSTOM** next to the test name.
351
351
352
352
By default, the Availability experience shows a line graph. Change the view to **Scatter Plot** (toggle above the graph) to see samples of the test results that have diagnostic test-step detail in them. The test engine stores diagnostic detail for tests that have failures. For successful tests, diagnostic details are stored for a subset of the executions. To see the test, test name, and location, hover over any of the green dots or red crosses.
353
353
354
-
:::image type="content" source="media/availability/scatter-plot.png" alt-text="Screenshot that shows the Scatter Plot view in the Availability experience.":::
355
-
356
354
Select a particular test or location. Or you can reduce the time period to see more results around the time period of interest. Use Search Explorer to see results from all executions. Or you can use Log Analytics queries to run custom reports on this data.
357
355
358
356
To see the end-to-end transaction details, under **Drill into**, select **Successful** or **Failed**. Then select a sample. You can also get to the end-to-end transaction details by selecting a data point on the graph.
359
357
360
-
:::image type="content" source="media/availability/sample-availability-test.png" alt-text="Screenshot that shows selecting a sample availability test.":::
358
+
:::image type="content" source="media/availability/sample-availability-test.png" alt-text="Screenshot showing selecting a sample availability test.":::
361
359
362
360
### Inspect and edit tests
363
361
@@ -370,7 +368,7 @@ To edit, temporarily disable, or delete a test, open the context menu (ellipsis)
370
368
371
369
Open the **End-to-end transaction details** view by selecting a red cross on the Scatter Plot.
372
370
373
-
:::image type="content" source="media/availability/end-to-end-transaction-details.png" alt-text="Screenshot that shows the End-to-end transaction details tab." lightbox="media/availability/end-to-end-transaction-details.png":::
@@ -384,7 +382,7 @@ To learn more about the end-to-end transaction diagnostics experience, see the [
384
382
385
383
Select the exception row to see the details of the server-side exception that caused the synthetic availability test to fail. You can also get the [debug snapshot](./snapshot-debugger.md) for richer code-level diagnostics.
386
384
387
-
:::image type="content" source="media/availability/end-to-end-open-debug-snapshot.png" alt-text="Screenshot that shows the Server-side diagnostics." lightbox="media/availability/end-to-end-open-debug-snapshot.png":::
385
+
:::image type="content" source="media/availability/end-to-end-open-debug-snapshot.png" alt-text="Screenshot showing the Server-side diagnostics." lightbox="media/availability/end-to-end-open-debug-snapshot.png":::
388
386
389
387
In addition to the raw results, you can also view two key availability metrics in [metrics explorer](../essentials/metrics-getting-started.md):
390
388
@@ -395,7 +393,7 @@ In addition to the raw results, you can also view two key availability metrics i
395
393
396
394
You can use Log Analytics to view your availability results (`availabilityResults`), dependencies (`dependencies`), and more. To learn more about Log Analytics, see [Log query overview](../logs/log-query-overview.md).
397
395
398
-
:::image type="content" source="media/availability/availability-test-results.png" alt-text="Screenshot that shows availability results." lightbox="media/availability/availability-test-results.png":::
396
+
:::image type="content" source="media/availability/availability-results.png" alt-text="Screenshot showing availability results in Logs." lightbox="media/availability/availability-results.png":::
399
397
400
398
## Migrate classic URL ping tests to standard tests
401
399
@@ -486,7 +484,7 @@ Set custom headers in [standard availability tests](availability-standard-tests.
486
484
487
485
1. Add the custom header *X-Customer-InstanceId* with the value `ApplicationInsightsAvailability:<your availability test string identifier>` under the **Standard test info** section when creating or updating your availability tests.
488
486
489
-
:::image type="content" source="media/availability/custom-header.png" alt-text="Screenshot that shows custom validation header.":::
* `Subscriptions`, `App Insights Resources`, and `Web Test`: These parameters determine your high-level resource options. They're based on Log Analytics queries and are used in every report query.
571
569
* `Failure Threshold` and `Outage Window`: You can use these parameters to determine your own criteria for a service outage. An example is the criteria for an Application Insights availability alert based on a failed location counter over a chosen period. The typical threshold is three locations over a five-minute window.
0 commit comments