wneessen/logranger
1
1
Fork 0
mirror of https://github.com/wneessen/logranger.git synced 2024-11-22 21:00:50 +01:00
Code Issues Projects Releases Packages Wiki Activity
logranger/README.md

49 lines
2.3 KiB
Markdown
Raw Normal View History

Add SPDX license identifiers and update copyright year All source code files as well as README.md, .gitignore, and various configuration files have been updated with an SPDX license identifier, changing license from CC0-1.0 to MIT. The copyright year has been updated to 2023, and the copyright holder's email address has been corrected from 'winni@neessen.dev' to 'wn@neessen.dev'. An MIT license text file has been additionally added.
2023-12-15 16:35:41 +01:00
<!--
Update copyright year and hyperlink references in README.md The copyright year was updated to reflect changes in ownership duration and hyperlink references for badges were updated to match the new source location. This enhances accuracy and ensures that the links reflect the most current repository location.
2024-02-08 14:23:29 +01:00
SPDX-FileCopyrightText: 2023-2024 Winni Neessen <wn@neessen.dev>
Add SPDX license identifiers and update copyright year All source code files as well as README.md, .gitignore, and various configuration files have been updated with an SPDX license identifier, changing license from CC0-1.0 to MIT. The copyright year has been updated to 2023, and the copyright holder's email address has been corrected from 'winni@neessen.dev' to 'wn@neessen.dev'. An MIT license text file has been additionally added.
2023-12-15 16:35:41 +01:00
SPDX-License-Identifier: MIT
//-->
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.
2023-12-27 17:23:25 +01:00
# Logranger
Update project references to use GitHub repository All project references have been updated to point to the appropriate routes for the GitHub repository, replacing the previously used paths to src.neessen.cloud. This includes changes in README.md, Dockerfile, go mod packaging as well as in the source code where required.
2024-03-21 15:39:31 +01:00
[![GoDoc](https://godoc.org/github.com/wneessen/logranger?status.svg)](https://pkg.go.dev/github.com/wneessen/logranger)
[![Go Report Card](https://goreportcard.com/badge/github.com/wneessen/logranger)](https://goreportcard.com/report/github.com/wneessen/logranger)
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
[![#logranger on Discord](https://img.shields.io/badge/Discord-%23logranger-blue.svg)](https://discord.gg/ysQXkaccXk)
Update project references to use GitHub repository All project references have been updated to point to the appropriate routes for the GitHub repository, replacing the previously used paths to src.neessen.cloud. This includes changes in README.md, Dockerfile, go mod packaging as well as in the source code where required.
2024-03-21 15:39:31 +01:00
[![REUSE status](https://api.reuse.software/badge/github.com/wneessen/logranger)](https://api.reuse.software/info/github.com/wneessen/logranger)
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
<a href="https://ko-fi.com/D1D24V9IX"><img src="https://uploads-ssl.webflow.com/5c14e387dab576fe667689cf/5cbed8a4ae2b88347c06c923_BuyMeACoffee_blue.png" height="20" alt="buy ma a coffee"></a>
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.
2023-12-27 17:23:25 +01:00
*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
Update project references to use GitHub repository All project references have been updated to point to the appropriate routes for the GitHub repository, replacing the previously used paths to src.neessen.cloud. This includes changes in README.md, Dockerfile, go mod packaging as well as in the source code where required.
2024-03-21 15:39:31 +01:00
If you encounter any problems while using Logranger, please [create an issue](https://github.com/wneessen/logranger/issues) in this
repository. We appreciate any feedback or suggestions for improving Logranger.
Reference in a new issue Copy permalink