Skip to content

Commit a8f66db

Browse files
committed
Acrolinx
1 parent cf690e7 commit a8f66db

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

articles/iot-edge/troubleshoot-common-errors.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Troubleshoot - Azure IoT Edge | Microsoft Docs
3-
description: Use this article to learn standard diagnostic skills for Azure IoT Edge, like retrieving component status and logs, and resolve common issues
2+
title: Common errors - Azure IoT Edge | Microsoft Docs
3+
description: Use this article to resolve common issues encountered when deploying an IoT Edge solution
44
author: kgremban
55
manager: philmea
66
ms.author: kgremban
@@ -13,7 +13,7 @@ ms.custom: [amqp, mqtt]
1313

1414
# Common issues and resolutions for Azure IoT Edge
1515

16-
Use this article to find steps to resolve common issues encountered when deploying IoT Edge solutions. If you need to learn how to find logs and errors from your IoT Edge device, see [Troubleshoot your IoT Edge device](troubleshoot.md).
16+
Use this article to find steps to resolve common issues that you may experience when deploying IoT Edge solutions. If you need to learn how to find logs and errors from your IoT Edge device, see [Troubleshoot your IoT Edge device](troubleshoot.md).
1717

1818
## IoT Edge agent stops after about a minute
1919

@@ -76,7 +76,7 @@ Specify the DNS server for your environment in the container engine settings, wh
7676
}
7777
```
7878

79-
The above example sets the DNS server to a publicly accessible DNS service. If the edge device cannot access this IP from its environment, replace it with DNS server address that is accessible.
79+
The above example sets the DNS server to a publicly accessible DNS service. If the edge device can't access this IP from its environment, replace it with DNS server address that is accessible.
8080

8181
Place `daemon.json` in the right location for your platform:
8282

@@ -92,7 +92,7 @@ Restart the container engine for the updates to take effect.
9292
| Platform | Command |
9393
| --------- | -------- |
9494
| Linux | `sudo systemctl restart docker` |
95-
| Windows (Admin Powershell) | `Restart-Service iotedge-moby -Force` |
95+
| Windows (Admin PowerShell) | `Restart-Service iotedge-moby -Force` |
9696

9797
**Option 2: Set DNS server in IoT Edge deployment per module**
9898

@@ -140,7 +140,7 @@ Some other process on the host machine has bound a port that the edgeHub module
140140

141141
You can resolve this issue two ways:
142142

143-
If the IoT Edge device is functioning as a gateway device, then you need to find and stop the process that is using port 443, 5671, or 8883. If the error specifies port 443, then the other process is usually a web server.
143+
If the IoT Edge device is functioning as a gateway device, then you need to find and stop the process that is using port 443, 5671, or 8883. An error for port 443 usually means that the other process is a web server.
144144

145145
If you don't need to use the IoT Edge device as a gateway, then you can remove the port bindings from edgeHub's module create options. You can change the create options in the Azure portal or directly in the deployment.json file.
146146

@@ -257,7 +257,7 @@ Windows Registry Editor Version 5.00
257257

258258
**Observed behavior:**
259259

260-
You may encounter stability problems on resource constrained devices like the Raspberry Pi, especially when used as a gateway. Symptoms include out of memory exceptions in the IoT Edge hub module, downstream devices failing to connect, or the device failing to send telemetry messages after a few hours.
260+
You may experience stability problems on resource constrained devices like the Raspberry Pi, especially when used as a gateway. Symptoms include out of memory exceptions in the IoT Edge hub module, downstream devices failing to connect, or the device failing to send telemetry messages after a few hours.
261261

262262
**Root cause:**
263263

@@ -269,7 +269,7 @@ For the IoT Edge hub, set an environment variable **OptimizeForPerformance** to
269269

270270
In the Azure portal:
271271

272-
In your IoT Hub, select your IoT Edge device and from the device details page and select **Set Modules** > **Runtime Settings**. Create an environment variable for the Edge Hub module called *OptimizeForPerformance* that is set to *false*.
272+
In your IoT Hub, select your IoT Edge device and from the device details page and select **Set Modules** > **Runtime Settings**. Create an environment variable for the IoT Edge hub module called *OptimizeForPerformance* that is set to *false*.
273273

274274
![OptimizeForPerformance set to false](./media/troubleshoot/optimizeforperformance-false.png)
275275

@@ -307,21 +307,21 @@ The IoT Edge daemon enforces process identification for all modules connecting t
307307
308308
As of version 1.0.7, all module processes are authorized to connect. For more information, see the [1.0.7 release changelog](https://github.com/Azure/iotedge/blob/master/CHANGELOG.md#iotedged-1).
309309
310-
If upgrading to 1.0.7 isn't possible, complete the following steps. Make sure that the same process ID is always used by the custom IoT Edge module to send messages to the edgeHub. For instance, make sure to `ENTRYPOINT` instead of `CMD` command in your Docker file, since `CMD` will lead to one process ID for the module and another process ID for the bash command running the main program whereas `ENTRYPOINT` will lead to a single process ID.
310+
If upgrading to 1.0.7 isn't possible, complete the following steps. Make sure that the same process ID is always used by the custom IoT Edge module to send messages to the edgeHub. For instance, make sure to `ENTRYPOINT` instead of `CMD` command in your Docker file. The `CMD` command leads to one process ID for the module and another process ID for the bash command running the main program, but `ENTRYPOINT` leads to a single process ID.
311311
312312
## IoT Edge module deploys successfully then disappears from device
313313
314314
**Observed behavior:**
315315
316-
After setting modules for an IoT Edge device, the modules are deployed successfully but after a few minutes they disappear from the device and from the device details in the Azure portal. Perhaps other modules than the ones defined appear on the device.
316+
After setting modules for an IoT Edge device, the modules are deployed successfully but after a few minutes they disappear from the device and from the device details in the Azure portal. Other modules than the ones defined might also appear on the device.
317317
318318
**Root cause:**
319319
320320
If an automatic deployment targets a device, it takes priority over manually setting the modules for a single device. The **Set modules** functionality in Azure portal or **Create deployment for single device** functionality in Visual Studio Code will take effect for a moment. You see the modules that you defined start on the device. Then the automatic deployment's priority kicks in and overwrites the device's desired properties.
321321
322322
**Resolution:**
323323
324-
Only use one type of deployment mechanism per device, either an automatic deployment or individual device deployments. If you have multiple automatic deployments targeting a device, you can change priority or target descriptions to make sure the correct one applies to a given device. If the automatic deployment targets tags in the device twin, you can update the device twin to no longer match the target description.
324+
Only use one type of deployment mechanism per device, either an automatic deployment or individual device deployments. If you have multiple automatic deployments targeting a device, you can change priority or target descriptions to make sure the correct one applies to a given device. You can also update the device twin to no longer match the target description of the automatic deployment.
325325
326326
For more information, see [Understand IoT Edge automatic deployments for single devices or at scale](module-deployment-monitoring.md).
327327

articles/iot-edge/troubleshoot.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Troubleshoot - Azure IoT Edge | Microsoft Docs
3-
description: Use this article to learn standard diagnostic skills for Azure IoT Edge, like retrieving component status and logs, and resolve common issues
3+
description: Use this article to learn standard diagnostic skills for Azure IoT Edge, like retrieving component status and logs
44
author: kgremban
55
manager: philmea
66
ms.author: kgremban
@@ -14,7 +14,7 @@ services: iot-edge
1414

1515
If you experience issues running Azure IoT Edge in your environment, use this article as a guide for troubleshooting and diagnostics.
1616

17-
## Run the iotedge 'check' command
17+
## Run the 'check' command
1818

1919
Your first step when troubleshooting IoT Edge should be to use the `check` command, which runs a collection of configuration and connectivity tests for common issues. The `check` command is available in [release 1.0.7](https://github.com/Azure/azure-iotedge/releases/tag/1.0.7) and later.
2020

@@ -32,19 +32,19 @@ On Windows:
3232
iotedge check
3333
```
3434

35-
The troubleshooting tool runs many checks that are sorted into the these three categories:
35+
The troubleshooting tool runs many checks that are sorted into these three categories:
3636

37-
* Configuration checks: Examines details that could prevent Edge devices from connecting to the cloud, including issues with *config.yaml* and the container engine.
37+
* Configuration checks: Examines details that could prevent IoT Edge devices from connecting to the cloud, including issues with *config.yaml* and the container engine.
3838
* Connection checks: Verifies the IoT Edge runtime can access ports on the host device and all the IoT Edge components can connect to the IoT Hub.
3939
* Production readiness checks: Looks for recommended production best practices, such as the state of device certificate authority (CA) certificates and module log file configuration.
4040

4141
For information about each of the diagnostic checks this tool runs, including what to do if you get an error or warning, see [IoT Edge troubleshoot checks](https://github.com/Azure/iotedge/blob/master/doc/troubleshoot-checks.md).
4242

43-
## Gather debug information with iotedge 'support-bundle' command
43+
## Gather debug information with 'support-bundle' command
4444

45-
When you need to gather logs from an IoT Edge device, the most convenient way is to use the `support-bundle` command. By default, this command collects module, IoT Edge Security Manager and container engine logs, 'iotedge check' JSON output and other useful debug information. It compresses them into a single file for easy sharing. The `support-bundle` command is available in [release 1.0.9](https://github.com/Azure/azure-iotedge/releases/tag/1.0.9) and later.
45+
When you need to gather logs from an IoT Edge device, the most convenient way is to use the `support-bundle` command. By default, this command collects module, IoT Edge security manager and container engine logs, `iotedge check` JSON output, and other useful debug information. It compresses them into a single file for easy sharing. The `support-bundle` command is available in [release 1.0.9](https://github.com/Azure/azure-iotedge/releases/tag/1.0.9) and later.
4646

47-
Run the `support-bundle` command with the `--since` flag to specify how long from the past you want to get logs. For example `6h` will get logs since the last 6 hours, `6d` since the last 6 days, `6m` since the last 6 minutes and so on. Include the `--help` flag to see a complete list of options.
47+
Run the `support-bundle` command with the `--since` flag to specify how long from the past you want to get logs. For example `6h` will get logs since the last six hours, `6d` since the last six days, `6m` since the last six minutes and so on. Include the `--help` flag to see a complete list of options.
4848

4949
On Linux:
5050

@@ -69,7 +69,7 @@ For instructions on how to update your device, see [Update the IoT Edge security
6969

7070
## Check the status of the IoT Edge security manager and its logs
7171

72-
The [IoT Edge security manager](iot-edge-security-manager.md) is responsible for operations like initializing the iotedge system at startup and provisioning devices. If IoT Edge isn't starting, the security manager logs may provide useful information.
72+
The [IoT Edge security manager](iot-edge-security-manager.md) is responsible for operations like initializing the IoT Edge system at startup and provisioning devices. If IoT Edge isn't starting, the security manager logs may provide useful information.
7373

7474
On Linux:
7575

@@ -87,7 +87,7 @@ On Linux:
8787

8888
* View more detailed logs of the IoT Edge security manager:
8989

90-
* Edit the iotedge daemon settings:
90+
* Edit the IoT Edge daemon settings:
9191

9292
```bash
9393
sudo systemctl edit iotedge.service

0 commit comments

Comments
 (0)