mirror of
https://github.com/wneessen/logranger.git
synced 2024-11-22 21:00:50 +01:00
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.
This commit is contained in:
parent
dbe0c6fe3b
commit
97bfbbfddd
1 changed files with 37 additions and 2 deletions
39
README.md
39
README.md
|
@ -4,5 +4,40 @@ SPDX-FileCopyrightText: 2023 Winni Neessen <wn@neessen.dev>
|
||||||
SPDX-License-Identifier: MIT
|
SPDX-License-Identifier: MIT
|
||||||
//-->
|
//-->
|
||||||
|
|
||||||
# logranger
|
# Logranger
|
||||||
Perform actions on rule-based incoming syslog messages
|
|
||||||
|
*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.
|
Loading…
Reference in a new issue