iot-edge-logger

This package is a custom log formatter to standardize, collect and analyze logs from IoT Edge Devices in an Azure Log Analytics Workspace.

Official Documentation | Source code | Package PyPI

Table of Contents

• Versioning
• Getting Started
  • Prerequisites
  • Basic Examples

Versioning

This repository adheres to Semantic Versioning. It will be maintained through the CHANGELOG.md and in GitHub Releases. It's important to note that you must maintain the version with your releases in iot/edge/logger/_version.py, otherwise a new package version will fail to get published.

Getting Started

This section provides basic examples with the iot-edge-logger.

Prerequisites

• Python 3.7 or later is required to use this package.

Basic Examples

1. Install via pip:

   pip install iot-edge-logger
   

2. Import and say hello:

   from iot.edge.logger import __version__
   
   
   print(f"hello world from iot-edge-logger version: {__version__}")
   

3. Basic usage:

   from iot.edge.logger import init_logging
   
   # setup logging
   logger = init_logging(module_name="my_iot_module")
   
   
   logger.info("I am alive!")
   logger.warning("Plotting global takeover...")
   logger.error("Humans have become suspicious, shutting down")
   

4. Log output:

   <6> 2022-08-02 19:04:13,015 [INF] my_iot_module I am alive!
   <4> 2022-08-02 19:04:13,015 [WRN] my_iot_module Plotting global takeover...
   <3> 2022-08-02 19:04:13,015 [ERR] my_iot_module Humans have become suspicious, shutting down