https://github.com/ageagainstthemachine/circuitpython-usyslog

Simple remote syslog client for CircuitPython
https://github.com/ageagainstthemachine/circuitpython-usyslog

circuitpython circuitpython-library syslog syslog-client

Last synced: 3 months ago
JSON representation

Simple remote syslog client for CircuitPython

• Host: GitHub
• URL: https://github.com/ageagainstthemachine/circuitpython-usyslog
• Owner: ageagainstthemachine
• License: mit
• Fork: true (kfricke/micropython-usyslog)
• Created: 2023-09-16T22:36:46.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-09-17T19:55:16.000Z (over 1 year ago)
• Last Synced: 2024-09-20T11:12:26.975Z (3 months ago)
• Topics: circuitpython, circuitpython-library, syslog, syslog-client
• Language: Python
• Homepage:
• Size: 4.88 KB
• Stars: 0
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/kfricke/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](https://docs.circuitpython.org/en/latest/shared-bindings/socketpool/index.html) 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.