update logging related information

Author: sbSteveK

documents/FAQ.md

@@ -16,8 +16,12 @@
 If you are just getting started make sure you [install this sdk](https://github.com/aws/aws-iot-device-sdk-python-v2#installation) and then build and run the [basic PubSub](https://github.com/aws/aws-iot-device-sdk-python-v2/tree/main/samples#pubsub)
 
 ### How do I enable logging?
+To enable logging you must import `io` from `awscrt` and initialize it with `init_logging`.
 
+`LogLevel` can be set to `Fatal`, `Error`, `Warn`, `Info`, `Debug`, or `Trace`. `stderr` and `stdout` can be used to print logs while any other string will be assumed to be a file path. 
 ``` python
+from awscrt import io
+# This sets the logger to print any Error level logs to stderr
 io.init_logging(io.LogLevel.Error, 'stderr')
 ```
 You can also enable [CloudWatch logging](https://docs.aws.amazon.com/iot/latest/developerguide/cloud-watch-logs.html) for IoT which will provide you with additional information that is not available on the client side sdk.

samples/README.md

@@ -6,9 +6,9 @@ This directory contains sample applications for [aws-iot-device-sdk-python-v2](.
     * [MQTT5 Client Samples](#mqtt5-client-samples)
     * [Service Client Samples](#service-client-samples)
     * [Greengrass Samples](#greengrass-samples)
-* [Build Instructions](#build-instructions)
+* [Instructions](#instructions)
 * [Sample Help](#sample-help)
-* [Enable Logging in Samples](#enable-logging-in-samples)
+* [Enable Logging](#enable-logging)
 
 
 ## Samples
@@ -39,9 +39,9 @@ This directory contains sample applications for [aws-iot-device-sdk-python-v2](.
 | [Greengrass Discovery](./greengrass//basic_discovery.md) | Discover and connect to a local Greengrass core. |
 | [Greengrass IPC](./greengrass//ipc_greengrass.md) | Demonstrates Inter-Process Communication (IPC) with Greengrass components. |
 
-### Build Instructions
+### Instructions
 
-First, install the `aws-iot-devices-sdk-python-v2` with following the [Installation Instructions](../README.md#Installation).
+First, install `aws-iot-devices-sdk-python-v2`. Installation instructions for the SDK are [Provided Here](../README.md#Installation).
 
 Each sample's README contains prerequisites, arguments, and detailed instructions. For example, the [MQTT5 X509 Sample README](./mqtt/mqtt5_x509.md) is `mqtt5_x509.md` and the sample can be run with the following command:
 
@@ -80,6 +80,6 @@ optional arguments:
 
 The sample will not run without the required arguments and will notify you of missing arguments.
 
-### Enable logging in samples
+### Enable Logging
 
-To enable logging in the samples, you can follow the instructions provided in the [FAQ](../documents/FAQ.md) related to [enabling logs](../documents/FAQ.md#how-do-i-enable-logging).
+Instructions to enable logging are available in the [FAQ](../documents/FAQ.md) under [How do I enable logging](../documents/FAQ.md#how-do-i-enable-logging).

samples/mqtt/mqtt5_x509.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0.
 
 from awsiot import mqtt5_client_builder
-from awscrt import mqtt5
+from awscrt import mqtt5, io
 import threading, time
 
 # --------------------------------- ARGUMENT PARSING -----------------------------------------
@@ -38,7 +38,7 @@
 # args contains all the parsed commandline arguments used by the sample
 args = parser.parse_args()
 # --------------------------------- ARGUMENT PARSING END -----------------------------------------
-
+io.init_logging(io.LogLevel.Debug, 'stdout')
 TIMEOUT = 100
 message_count = args.input_count
 message_topic = args.input_topic