Skip to content

Commit 7213302

Browse files
committed
edits from my review
1 parent 11d764f commit 7213302

File tree

6 files changed

+58
-41
lines changed

6 files changed

+58
-41
lines changed

articles/container-apps/alerts.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: cebundy
66
ms.service: container-apps
77
ms.custom: event-tier1-build-2022
88
ms.topic: how-to
9-
ms.date: 07/29/2022
9+
ms.date: 08/30/2022
1010
ms.author: v-bcatherine
1111
---
1212

@@ -19,9 +19,9 @@ Azure Monitor alerts notify you so that you can respond quickly to critical issu
1919

2020
You can create alert rules from metric charts in the metric explorer and from queries in Log Analytics. You can also define and manage alerts from the **Monitor>Alerts** page. To learn more about alerts, refer to [Overview of alerts in Microsoft Azure](../azure-monitor/alerts/alerts-overview.md).
2121

22-
The **Alerts** page in the **Monitoring** section on your container app page displays all of your app's alerts. You can filter the list by alert type, resource, time and severity. You can also modify and create new alerts from this page.
22+
The **Alerts** page in the **Monitoring** section on your container app page displays all of your app's alerts. You can filter the list by alert type, resource, time and severity. You can also modify and create new alert rules from this page.
2323

24-
### Create metric alert rules
24+
## Create metric alert rules
2525

2626
When you create alerts rules based on a metric chart in the metrics explorer, alerts are triggered when the metric data matches alert rule conditions. For more information about creating metrics charts, see [Using metrics explorer](metrics.md#using-metrics-explorer)
2727

@@ -41,7 +41,7 @@ After creating a metric chart, you can create a new alert rule.
4141
:::image type="content" source="media/observability/screenshot-alert-details-dialog.png" alt-text="Screen shot of the alert details configuration page.":::
4242

4343

44-
#### Add conditions to an alert rule
44+
### Add conditions to an alert rule
4545

4646
To add more conditions to your alert rule:
4747

@@ -61,7 +61,7 @@ Example of selecting a dimension to split an alert.
6161

6262
To learn more about configuring alerts, visit [Create a metric alert for an Azure resource](../azure-monitor/alerts/tutorial-metric-alert.md)
6363

64-
### Create log alert rules
64+
## Create log alert rules
6565

6666
You can create log alerts from queries in Log Analytics. When you create an alert rule from a query, the query is run at set intervals triggering alerts when the log data matches the alert rule conditions. To learn more about creating log alert rules, see [Manage log alerts](../azure-monitor/alerts/alerts-log.md).
6767

@@ -84,5 +84,5 @@ To create an alert rule:
8484
1. Select **Review + create**.
8585
1. Select **Create**.
8686

87-
[!div class="nextstepaction"]
87+
> [!div class="nextstepaction"]
8888
> [View log streams from the Azure portal](log-streaming.md)

articles/container-apps/container-console.md

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: cebundy
66
ms.service: container-apps
77
ms.custom: event-tier1-build-2022
88
ms.topic: how-to
9-
ms.date: 08/25/2022
9+
ms.date: 08/30/2022
1010
ms.author: v-bcatherine
1111
---
1212

@@ -17,19 +17,19 @@ Connecting to a container's console is useful when you want to troubleshoot your
1717

1818
## Azure portal
1919

20-
Select **Console** in the **Monitoring** menu group from your container app page in the Azure portal.
20+
To connect to a container's console in the Azure portal, follow these steps.
2121

22-
* Select the revision, replica and container you want to connect to.
23-
24-
* You can choose to access your console via bash, sh, or a custom executable. If you choose a custom executable, it must be available in the container.
22+
1. Select **Console** in the **Monitoring** menu group from your container app page in the Azure portal.
23+
1. Select the revision, replica and container you want to connect to.
24+
1. Choose to access your console via bash, sh, or a custom executable. If you choose a custom executable, it must be available in the container.
2525

2626
:::image type="content" source="media/observability/console-ss.png" alt-text="Screenshot of Azure Container Apps Console page.":::
2727

2828
## Azure CLI
2929

3030
Use the `az containerapp exec` command to connect to a container console. Select **Ctrl-D** to exit the console.
3131

32-
For example, connect to a container console in a container app with a single revision, replica, and container using the following command. Replace the \<placeholders\> with your container app's values.
32+
For example, connect to a container console in a container app with a single container using the following command. Replace the \<placeholders\> with your container app's values.
3333

3434
# [Bash](#tab/bash)
3535

@@ -49,7 +49,13 @@ az containerapp exec `
4949

5050
---
5151

52-
To connect to a container console in a container app with multiple revisions, replicas, and containers include the `--revision`, `--replica`, and `--container` arguments with the `az containerapp exec` command.
52+
To connect to a container console in a container app with multiple revisions, replicas, and containers include the following parameters in the `az containerapp exec` command.
53+
54+
| Argument | Description |
55+
|----------|-------------|
56+
| `--revision` | The revision name of the container connect to. |
57+
| `--replica` | The replica name of the container o connect to. |
58+
| `--container` | The container name of the container to connect to. |
5359

5460
You can get the revision names with the `az containerapp revision list` command. Replace the \<placeholders\> with your container app's values.
5561

@@ -97,28 +103,28 @@ az containerapp replica list `
97103

98104
---
99105

100-
Connect to the container console using the names from the `az containerapp revision list` command.
106+
Connect to the container console with the `az containerapp exec` command. Replace the \<placeholders\> with your container app's values.
101107

102108
# [Bash](#tab/bash)
103109

104110
```azurecli
105111
az containerapp exec \
106-
--name album-api \
107-
--resource-group album-api-rg \
108-
--revision album-api--v2 \
109-
--replica album-api--v2-5fdd5b4ff5-6mblw \
110-
--container album-api-container
112+
--name <ContainerAppName> \
113+
--resource-group <ResourceGroup> \
114+
--revision <RevisionName> \
115+
--replica <ReplicaName> \
116+
--container <ContainerName>
111117
```
112118

113119
# [PowerShell](#tab/powershell)
114120

115121
```azurecli
116122
az containerapp exec `
117-
--name album-api `
118-
--resource-group album-api-rg `
119-
--revision album-api--v2 `
120-
--replica album-api--v2-5fdd5b4ff5-6mblw `
121-
--container album-api-container
123+
--name <ContainerAppName> `
124+
--resource-group <ResourceGroup> `
125+
--revision <RevisionName> `
126+
--replica <ReplicaName> `
127+
--container <ContainerName>
122128
```
123129

124130
---

articles/container-apps/log-monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: cebundy
66
ms.service: container-apps
77
ms.custom: event-tier1-build-2022
88
ms.topic: how-to
9-
ms.date: 07/29/2022
9+
ms.date: 08/30/2022
1010
ms.author: v-bcatherine
1111
---
1212

articles/container-apps/log-streaming.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: cebundy
66
ms.service: container-apps
77
ms.custom: event-tier1-build-2022
88
ms.topic: how-to
9-
ms.date: 08/29/2022
9+
ms.date: 08/30/2022
1010
ms.author: v-bcatherine
1111
---
1212

@@ -59,7 +59,13 @@ az containerapp logs show `
5959

6060
---
6161

62-
When your app has multiple active revisions, replicas, and containers, you need to specify the container by including the `--revision`, `--replica`, and `--container` arguments in the `az containerapp logs show` command.
62+
To connect to a container console in a container app with multiple revisions, replicas, and containers include the following parameters in the `az containerapp logs show` command.
63+
64+
| Argument | Description |
65+
|----------|-------------|
66+
| `--revision` | The revision name of the container connect to. |
67+
| `--replica` | The replica name of the container o connect to. |
68+
| `--container` | The container name of the container to connect to. |
6369

6470
You can get the revision names with the `az containerapp revision list` command. Replace the \<placeholders\> with your container app's values.
6571

@@ -107,7 +113,7 @@ az containerapp replica list `
107113

108114
---
109115

110-
Run the `az container app show` command using the names from the `az containerapp revision list ` command output. Replace the \<placeholders\> with your container app's values.
116+
Stream the container logs with the `az container app show` command. Replace the \<placeholders\> with your container app's values.
111117

112118

113119
# [Bash](#tab/bash)

articles/container-apps/metrics.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ author: cebundy
66
ms.service: container-apps
77
ms.custom: event-tier1-build-2022
88
ms.topic: how-to
9-
ms.date: 07/29/2022
9+
ms.date: 08/30/2022
1010
ms.author: v-bcatherine
1111
---
1212

1313
# Monitor Azure Container Apps metrics
1414

15-
Azure Monitor collects metric data from your container app at regular intervals. These metrics help you gain insights into the performance and health of your container app. You can use the metrics explorer in the Azure portal to monitor and analyze the metric data. You can also retrieve metric data through the [Azure CLI](/cli/azure/monitor/metrics) and Azure [PowerShell cmdlets](/powershell/module/az.monitor/get-azmetric).
15+
Azure Monitor collects metric data from your container app at regular interval to help you gain insights into the performance and health of your container app.
16+
17+
The metrics explorer in the Azure portal allows you to visualize the data. You can also retrieve raw metric data through the [Azure CLI](/cli/azure/monitor/metrics) and Azure [PowerShell cmdlets](/powershell/module/az.monitor/get-azmetric).
1618

1719
## Available metrics
1820

@@ -32,7 +34,7 @@ The metrics namespace is `microsoft.app/containerapps`.
3234

3335
## Metrics snapshots
3436

35-
On your container app **Overview** page in the Azure portal, select the **Monitoring** tab to display charts showing your container app's current CPU, memory, and network utilization.
37+
Select the **Monitoring** tab on your app's **Overview** page to display charts showing your container app's current CPU, memory, and network utilization.
3638

3739
:::image type="content" source="media/observability/metrics-in-overview-page.png" alt-text="Screenshot of the Monitoring section in the container app overview page.":::
3840

@@ -42,14 +44,14 @@ From this view, you can pin one or more charts to your dashboard or select a cha
4244

4345
The Azure Monitor metrics explorer lets you create charts from metric data to help you analyze your container app's resource and network usage over time. You can pin charts to a dashboard or in a shared workbook.
4446

45-
1. Open the metrics explorer in the Azure portal by selecting **Metrics** from the sidebar menu on your container app page. To learn more about metrics explorer, go to [Getting started with metrics explorer](../azure-monitor/essentials/metrics-getting-started.md).
47+
1. Open the metrics explorer in the Azure portal by selecting **Metrics** from the sidebar menu on your container app's page. To learn more about metrics explorer, go to [Getting started with metrics explorer](../azure-monitor/essentials/metrics-getting-started.md).
4648

4749
1. Create a chart by selecting **Metric**. You can modify the chart by changing aggregation, adding more metrics, changing time ranges and intervals, adding filters, and applying splitting.
4850
:::image type="content" source="media/observability/metrics-main-page.png" alt-text="Screenshot of the metrics explorer from the container app resource page.":::
4951

5052
### Add filters
5153

52-
Optionally, you can create filters based on revisions and replicas. To create a filter:
54+
Optionally, you can create filters to limit the data shown based on revisions and replicas. To create a filter:
5355
1. Select **Add filter**.
5456
1. Select a revision or replica from the **Property** list.
5557
1. Select values from the **Value** list.
@@ -59,15 +61,18 @@ Optionally, you can create filters based on revisions and replicas. To create a
5961

6062
When your chart contains a single metric, you can choose to split the metric information by revision or replica with the exceptions:
6163

62-
* The Replica count metric can only split by revision.
63-
* The requests metric can also be split by status code and status code category.
64+
* The *Replica count* metric can only split by revision.
65+
* The *Requests* metric can also be split by status code and status code category.
6466

65-
To split by revision:
67+
To split by revision or replica:
6668

6769
1. Select **Apply splitting**
68-
1. Select **Revision** from the **Values** drop-down list.
70+
1. Select **Revision** or **Replica** from the **Values** drop-down list.
71+
1. You can set the limit of the number of revisions or replicas to display in the chart. The default is 10.
72+
1. You can set Sort order to **Ascending** or **Descending**. The default is **Descending**.
73+
74+
:::image type="content" source="media/observability/metrics-splitting.png" alt-text="Screenshot of the metrics explorer showing the chart splitting options.":::
6975

70-
:::image type="content" source="media/observability/metrics-apply-splitting.png" alt-text="Screenshot of the metrics explorer that shows a chart with metrics split by revision.":::
7176

7277
### Add scopes
7378

articles/container-apps/observability.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,20 +39,20 @@ During the development and test phase, real-time access to your containers' appl
3939

4040
### Deployment
4141

42-
Once you deploy your container app, it's essential to monitor your app. Upon deployment, continuous monitoring helps you quickly identify problems that may occur around error rates, performance, or metrics.
42+
Once you deploy your container app, continuous monitoring helps you quickly identify problems that may occur around error rates, performance, and resource consumption.
4343

4444
Azure Monitor gives you the ability to track your app with the following features:
4545

4646
- [Azure Monitor metrics](metrics.md): Monitor and analyze key metrics.
47-
- [Azure Monitor alerts](alerts.md): Send alerts for critical conditions.
47+
- [Azure Monitor alerts](alerts.md): Recieve alerts for critical conditions.
4848
- [Azure Monitor Log Analytics](log-monitoring.md): View and analyze application logs.
4949

5050
### Maintenance
5151

5252
Container Apps manages updates to your container app by creating [revisions](revisions.md). You can run multiple revisions concurrently in blue green deployments or to perform A/B testing. These observability features will help you monitor your app across revisions:
5353

5454
- [Azure Monitor metrics](metrics.md): Monitor and compare key metrics for multiple revisions.
55-
- [Azure Monitor alerts](alerts.md): Send alerts individual alerts per revision.
55+
- [Azure Monitor alerts](alerts.md): Receive individual alerts per revision.
5656
- [Azure Monitor Log Analytics](log-monitoring.md): View, analyze and compare log data for multiple revisions.
5757

5858
## Next steps

0 commit comments

Comments
 (0)