logranger/README.md
Winni Neessen 44473579de
Add badges to README for Logranger project
Appended project badges in the README file to provide quick project status checks and important links. These include badges for GoDoc, Go Report Card, Discord, REUSE status, and a Ko-fi donation button, fostering easy navigation and interaction for the project users and contributors.
2023-12-27 17:33:38 +01:00

2.3 KiB

Logranger

GoDoc Go Report Card #logranger on Discord REUSE status buy ma a coffee

Note: Logranger is still WIP

Introduction

Logranger is a powerful and intelligent log processing tool written in Go. Its main purpose is to efficiently process a large number of incoming syslog messages, enabling you filter for specific events and perform actions based on the received events.

Features

  • Efficient log processing: Logranger is based on the performand go-parsesyslog package and can handle and analyze large volumes of syslog messages without compromising on its speed or performance.
  • Powerful rule-based filtering: You can filter for log events based on a rules that specify regular expressions to match the events.
  • Customization: Logranger is easily customizable. Its easy to implement plugin interface allows you to write your own plugins to perform custom actions with your events.
  • Custom templates: Matched (or sub-matched) event log messages can be processed using Go's versatile templating language.

Plugins

By default Logranger ships with a varity of action plugins:

  • File action: Store the matched (or a sub-match) event log messages in a file. The file can be used in overwrite or append mode.

License

Logranger is released under the MIT License.

Support

If you encounter any problems while using Logranger, please create an issue in this repository. We appreciate any feedback or suggestions for improving Logranger.