Skip to content

Commit 21b2e2a

Browse files
committed
copy edits and Acroylinx fixes
1 parent a806e02 commit 21b2e2a

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

articles/iot-edge/how-to-deploy-at-scale.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@ To modify targeted devices for a deployment:
181181

182182
1. In your IoT hub, select **IoT Edge** from the left pane menu.
183183
1. Select the **IoT Edge deployments** tab and select the deployment you want to configure. Select the **Target Condition** tab.
184+
1. If needed, adjust the **Priority** for when deployments target the same device, the deployment with higher priority gets applied. If multiple deployments have the same priority, the deployment with the later creation date gets applied.
184185
1. Define a target condition, using the example syntax as a guide.
185186

186187
![Specify target conditions for a deployment](./media/how-to-deploy-monitor/target-devices.png)

articles/iot-edge/how-to-monitor-iot-edge-deployments.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ services: iot-edge
1212
---
1313
# Monitor IoT Edge deployments
1414

15-
Azure IoT Edge provides reporting that lets you monitor real-time information on the modules deployed to your IoT Edge devices. The IoT Hub service retrieves the status from the IoT Edge devices and makes them available to the operator. In addition to the need to monitor deployments made to individual devices, monitoring is important for [deployments made at scale](module-deployment-monitoring.md) that include automatic deployments and layered deployments.
15+
Azure IoT Edge provides reporting that lets you monitor real-time information on the modules deployed to your IoT Edge devices. The IoT Hub service retrieves the status from the devices and makes them available to the operator. Monitoring is also important for [deployments made at scale](module-deployment-monitoring.md) that include automatic deployments and layered deployments.
1616

1717
Successful deployments require monitoring the following information:
1818

@@ -22,21 +22,19 @@ Successful deployments require monitoring the following information:
2222

2323
* Status codes of the IoT Edge runtime modules.
2424

25-
* Versions of deployed modules.
25+
* Versions of the deployed modules.
2626

27-
Both devices and modules have similar data, such as connectivity, so values are obtained according the device ID or the module ID.
27+
Both devices and modules have similar data, such as connectivity, so values are obtained according to the device ID or the module ID.
2828

29-
The IoT Hub service collects the data reported by device and module twins and provides aggregated counts of the various states that devices may have. The IoT Hub service organizes this data into four groups of metrics:
29+
The IoT Hub service collects data reported by device and module twins and provides counts of the various states that devices may have. The IoT Hub service organizes this data into four groups of metrics:
3030

3131
| Type | Description |
3232
| --- | ---|
33-
| Targeted | Shows the IoT Edge devices that match the Deployment targeting condition. |
33+
| Targeted | Shows the IoT Edge devices that match the deployment targeting condition. |
3434
| Applied | Shows the targeted IoT Edge devices that are not targeted by another deployment of higher priority. |
3535
| Reporting Success | Shows the IoT Edge devices that have reported that the modules have been deployed successfully. |
3636
| Reporting Failure | Shows the IoT Edge devices that have reported that one or more modules haven't been deployed successfully. To further investigate the error, connect remotely to those devices and view the log files. |
3737

38-
You can also define your own custom metrics.
39-
4038
The IoT Hub service makes this data available for you to monitor in the Azure portal and in the Azure CLI.
4139

4240
## Monitor a deployment in the Azure portal
@@ -51,28 +49,28 @@ To view the details of a deployment and monitor the devices running it, use the
5149
| Column | Description |
5250
| --- | --- |
5351
| ID | The name of the deployment. |
54-
| Type | The type of deployment, either **Deployment** or **Layered Deployment** |
52+
| Type | The type of deployment, either **Deployment** or **Layered Deployment**. |
5553
| Target Condition | The tag used to define targeted devices. |
5654
| Priority | The priority number assigned to the deployment. |
57-
| System metrics | Specifies the number of device twins in IoT Hub that match the targeting condition, and **Applied** specifies the number of devices that have had the deployment content applied to their module twins in IoT Hub. |
58-
| Device Metrics | The number of IoT Edge devices in the deployment |reporting success or errors from the IoT Edge client runtime. |
59-
| Custom Metrics | The number of IoT Edge devices in the deployment |reporting data for any metrics that you defined for the deployment. |
55+
| System metrics | The number of device twins in IoT Hub that match the targeting condition. **Applied** specifies the number of devices that have had the deployment content applied to their module twins in IoT Hub. |
56+
| Device Metrics | The number of IoT Edge devices reporting success or errors from the IoT Edge client runtime. |
57+
| Custom Metrics | The number of IoT Edge devices reporting data for any metrics that you defined for the deployment. |
6058
| Creation Time | The timestamp from when the deployment was created. This timestamp is used to break ties when two deployments have the same priority. |
6159

6260
1. Select the deployment that you want to monitor.  
63-
1. On the **Deployment Details** page, scroll down to the bottom section and select the **Metrics** tab. Use the **Select Metric** drop-down to choose a specific metric. When a metric is selected, the **View** button appears that will list the IoT Edge devices that match the condition for the selected metric.
61+
1. On the **Deployment Details** page, scroll down to the bottom section and select the **Metrics** tab. Use the **Select Metric** drop-down to choose a specific metric. When a metric is selected, the **View** button appears that lists the IoT Edge devices that match the condition for the selected metric.
6462

6563
![View metrics for a selected deployment](./media/how-to-monitor-iot-edge-deployments/deployment-metrics-tab.png)
6664

67-
1. Select the **Edit Metrics** button to view and edit the criteria for each metric. In addition to the four default metrics, custom defined metrics will appear in this list.
65+
1. Select the **Edit Metrics** button to view and edit the criteria for each metric. Also the four default metrics, custom defined metrics will appear in this list.
6866

6967
![View IoT Edge deployment metric criteria](./media/how-to-monitor-iot-edge-deployments/metric-list.png)
7068

7169
To make changes to your deployment, see [Modify a deployment](how-to-deploy-at-scale.md#modify-a-deployment).
7270

7371
## Monitor a deployment with Azure CLI
7472

75-
Use the [az iot edge deployment show](https://docs.microsoft.com/cli/azure/ext/azure-cli-iot-ext/iot/edge/deployment?view=azure-cli-latest#ext-azure-cli-iot-ext-az-iot-edge-deployment-show) command to display the details of a single deployment:
73+
Use the [az IoT Edge deployment show](https://docs.microsoft.com/cli/azure/ext/azure-cli-iot-ext/iot/edge/deployment?view=azure-cli-latest#ext-azure-cli-iot-ext-az-iot-edge-deployment-show) command to display the details of a single deployment:
7674

7775
```cli
7876
az iot edge deployment show --deployment-id [deployment id] --hub-name [hub name]
@@ -90,7 +88,7 @@ Inspect the deployment in the command window. The **metrics** property lists a
9088
* **reportedSuccessfulCount** - A device metric that specifies the number of IoT Edge devices in the deployment reporting success from the IoT Edge client runtime.
9189
* **reportedFailedCount** - A device metric that specifies the number of IoT Edge devices in the deployment reporting failure from the IoT Edge client runtime.
9290

93-
You can show a list of device IDs or objects for each of the metrics by using the [az iot edge deployment show-metric](https://docs.microsoft.com/cli/azure/ext/azure-cli-iot-ext/iot/edge/deployment?view=azure-cli-latest#ext-azure-cli-iot-ext-az-iot-edge-deployment-show-metric) command:
91+
You can show a list of device IDs or objects for each of the metrics with the [az IoT Edge deployment show-metric](https://docs.microsoft.com/cli/azure/ext/azure-cli-iot-ext/iot/edge/deployment?view=azure-cli-latest#ext-azure-cli-iot-ext-az-iot-edge-deployment-show-metric) command:
9492

9593
```cli
9694
az iot edge deployment show-metric --deployment-id [deployment id] --metric-id [metric id] --hub-name [hub name]
@@ -102,6 +100,8 @@ The deployment show-metric command takes the following parameters:
102100
* **--metric-id** - The name of the metric for which you want to see the list of device IDs, for example `reportedFailedCount`.
103101
* **--hub-name** - Name of the IoT hub in which the deployment exists. The hub must be in the current subscription. Switch to the desired subscription with the command `az account set -s [subscription name]`.
104102

103+
To make changes to your deployment, see [Modify a deployment](how-to-deploy-cli-at-scale.md#modify-a-deployment).
104+
105105
## Next steps
106106

107-
Learn how [communicate with EdgeAgent using built-in direct methods](how-to-edgeagent-direct-method.md).
107+
Learn how to [communicate with EdgeAgent using built-in direct methods](how-to-edgeagent-direct-method.md).

0 commit comments

Comments
 (0)