From 97bfbbfddd3540e0471466513d508e9cc437ec29 Mon Sep 17 00:00:00 2001 From: Winni Neessen Date: Wed, 27 Dec 2023 17:23:25 +0100 Subject: [PATCH] Update and enrich README for Logranger project Expanded the README file to include a detailed description of Logranger project's purpose, features, available plugins and support. This provides a comprehensive overview of the project for new or prospective users and contributors, offering insights on its functionality, customization features, efficient log processing, and rule-based filtering capabilities. --- README.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8e93607..919c1aa 100644 --- a/README.md +++ b/README.md @@ -4,5 +4,40 @@ SPDX-FileCopyrightText: 2023 Winni Neessen SPDX-License-Identifier: MIT //--> -# logranger -Perform actions on rule-based incoming syslog messages +# Logranger + +*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](https://github.com/wneessen/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](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. \ No newline at end of file