Merge pull request #195531 from bishal41/patch-3

Configure "local logging driver" during Moby installation

Author: denrea

articles/iot-edge/production-checklist.md

@@ -246,7 +246,7 @@ If your devices are going to be deployed on a network that uses a proxy server,
 
 * **Helpful**
   * Set up logs and diagnostics
-  * Place limits on log size
+  * Set up default logging driver
   * Consider tests and CI/CD pipelines
 
 ### Set up logs and diagnostics
@@ -285,17 +285,24 @@ Starting with version 1.2, IoT Edge relies on multiple daemons. While each daemo
 
 When you're testing an IoT Edge deployment, you can usually access your devices to retrieve logs and troubleshoot. In a deployment scenario, you may not have that option. Consider how you're going to gather information about your devices in production. One option is to use a logging module that collects information from the other modules and sends it to the cloud. One example of a logging module is [logspout-loganalytics](https://github.com/veyalla/logspout-loganalytics), or you can design your own.
 
-### Place limits on log size
+### Set up default logging driver
 
-By default the Moby container engine does not set container log size limits. Over time this can lead to the device filling up with logs and running out of disk space. Consider the following options to prevent this:
+By default, the Moby container engine does not set container log size limits. Over time, this can lead to the device filling up with logs and running out of disk space. Configure your container engine to use the [`local` logging driver](https://docs.docker.com/config/containers/logging/local/) as your logging mechanism. `Local` logging driver offers a default log size limit, performs log-rotation by default, and uses a more efficient file format which helps to prevent disk space exhaustion. You may also choose to use different [logging drivers](https://docs.docker.com/config/containers/logging/configure/) and set different size limits based on your need.
 
-#### Option: Set global limits that apply to all container modules
+#### Option: Configure the default logging driver for all container modules
 
-You can limit the size of all container logfiles in the container engine log options. The following example sets the log driver to `json-file` (recommended) with limits on size and number of files:
+You can configure your container engine to use a specific logging driver by setting the value of `log driver` to the name of the log driver in the `daemon.json`. The following example sets the default logging driver to the `local` log driver (recommended).
 
 ```JSON
 {
-    "log-driver": "json-file",
+    "log-driver": "local"
+}
+```
+You can also configure your `log-opts` keys to use appropriate values in the `daemon.json` file. The following example sets the log driver to `local` and sets the `max-size` and `max-file` options.  
+
+```JSON
+{
+    "log-driver": "local",
     "log-opts": {
         "max-size": "10m",
         "max-file": "3"
@@ -332,7 +339,7 @@ You can do so in the **createOptions** of each module. For example:
 "createOptions": {
     "HostConfig": {
         "LogConfig": {
-            "Type": "json-file",
+            "Type": "local",
             "Config": {
                 "max-size": "10m",
                 "max-file": "3"

articles/iot-edge/troubleshoot.md

@@ -54,7 +54,7 @@ sudo iotedge check
 
 The troubleshooting tool runs many checks that are sorted into these three categories:
 
-* *Configuration checks* examines details that could prevent IoT Edge devices from connecting to the cloud, including issues with the config file and the container engine.
+* *Configuration checks* examine details that could prevent IoT Edge devices from connecting to the cloud, including issues with the config file and the container engine.
 * *Connection checks* verify that the IoT Edge runtime can access ports on the host device and that all the IoT Edge components can connect to the IoT Hub. This set of checks returns errors if the IoT Edge device is behind a proxy.
 * *Production readiness checks* look for recommended production best practices, such as the state of device certificate authority (CA) certificates and module log file configuration.
 
@@ -293,7 +293,7 @@ If you're still troubleshooting, wait until after you've inspected the container
 docker rm --force <container name>
 ```
 
-For ongoing logs maintenance and production scenarios, [place limits on log size](production-checklist.md#place-limits-on-log-size).
+For ongoing logs maintenance and production scenarios, [Set up default logging driver](production-checklist.md#set-up-default-logging-driver).
 
 ## View the messages going through the IoT Edge hub
 

includes/iot-edge-install-linux.md

@@ -73,8 +73,18 @@ Install the Moby engine.
    sudo apt-get update; \
      sudo apt-get install moby-engine
    ```
-
 ---
+Once the Moby engine is successfully installed, configure it to use [`local` logging driver](https://docs.docker.com/config/containers/logging/local/) as the logging mechanism. To learn more about logging configuration, see [Production Deployment Checklist](../articles/iot-edge/production-checklist.md#set-up-default-logging-driver).
+
+* Create or open the Docker daemon's config file at `/etc/docker/daemon.json`.
+* Set the default logging driver to the `local` logging driver as shown in the example below.   
+   
+    ```JSON
+       {
+          "log-driver": "local"
+       }
+    ```
+* Restart the container engine for the changes to take effect.
 
    > [!TIP]
    > If you get errors when you install the Moby container engine, verify your Linux kernel for Moby compatibility. Some embedded device manufacturers ship device images that contain custom Linux kernels without the features required for container engine compatibility. Run the following command, which uses the [check-config script](https://github.com/moby/moby/blob/master/contrib/check-config.sh) provided by Moby, to check your kernel configuration: