/circuitpython-usyslog

Simple remote syslog client for CircuitPython

Primary LanguagePythonMIT LicenseMIT

circuitpython-usyslog

This CircuitPython module implements a simple syslog client for CircuitPython. Currently only UDP-based remote logging without timestamps is implemented. This is a fork of micropython-usyslog which has been updated to incorporate changes required for modern CircuitPython usage.

Background

An important part of creating IoT devices is the ability to gain observability through logging. One of the most widely-used methods of collecting logs from network devices is using syslog. This library can help when integrating logging capabilities in CircuitPython creations.

Dependencies

This module requires use of the socketpool library for CircuitPython.

Requirements

In order to use this module, a remote syslog server is also necessary to accept remote messages.

Disclaimer

This library is probably unstable and full of bugs. Like everything else on the internet, run/use at your own risk.