https://github.com/fuchs-fabian/simbashlog-example-notifier
Template for a simbashlog-notifier
https://github.com/fuchs-fabian/simbashlog-example-notifier
linux logging logging-framework notifier simbashlog simbashlog-notifier template-repository
Last synced: 11 months ago
JSON representation
Template for a simbashlog-notifier
- Host: GitHub
- URL: https://github.com/fuchs-fabian/simbashlog-example-notifier
- Owner: fuchs-fabian
- License: gpl-3.0
- Created: 2024-09-29T15:09:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-24T14:38:59.000Z (about 1 year ago)
- Last Synced: 2025-01-28T03:17:19.049Z (about 1 year ago)
- Topics: linux, logging, logging-framework, notifier, simbashlog, simbashlog-notifier, template-repository
- Language: Python
- Homepage: https://github.com/fuchs-fabian/simbashlog/wiki
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `simbashlog-example-notifier`: Template for a `simbashlog`-notifier
## Description
This is a template for creating a Python notifier for `simbashlog`.
## Getting Started
> It is possible that `pip` is not yet installed. If this is not the case, you will be prompted to install it. Confirm the installation.
### Installation with `pip` (GitHub)
```bash
pip install git+https://github.com/fuchs-fabian/simbashlog-example-notifier
```
### Installation with `pip` (Local)
Download the repository and navigate to the directory containing the [`setup.py`](setup.py) file.
```bash
pip install .
```
### Check Installation
```bash
pip list
```
```bash
pip show simbashlog-example-notifier
```
### Configuration
After installation, you will find the configuration file under:
```plain
~/.config/simbashlog-notifier/simbashlog-example-notifier/config.json
```
This configuration file is used by default if no other custom configuration file is specified.
It looks as follows:
```json
{
"min_required_log_level": "6",
"show_in_console_sent_message": "true",
"show_in_header_pid": "false",
"show_in_body_log_file_result": "false",
"show_in_body_log_file_content": "false",
"show_in_body_summary_for_pid": "false",
"show_in_body_summary_for_log_file": "false",
"show_in_footer_log_file_names": "false",
"show_in_footer_host": "false",
"show_in_footer_notifier_name": "true",
"example_key": "example_value"
}
```
### Usage
```plain
usage: simbashlog-example-notifier [-h] [--config CONFIG] [--pid PID] [--log-level LOG_LEVEL] [--message MESSAGE]
[--log-file LOG_FILE] [--json-log-file JSON_LOG_FILE]
Notifier for simbashlog.
options:
-h, --help show this help message and exit
--config CONFIG Path to a custom config file.
--pid PID The used process ID.
--log-level LOG_LEVEL
The used log level (sourced simbashlog) / severity number (simbashlog called with arguments).
--message MESSAGE The logged message (simbashlog called with arguments).
--log-file LOG_FILE The created *.log file.
--json-log-file JSON_LOG_FILE
The created *_log.json file.
```
### Uninstallation
```bash
pip uninstall simbashlog-example-notifier
```
## Bugs, Suggestions, Feedback, and Needed Support
> If you have any bugs, suggestions or feedback, feel free to create an issue or create a pull request with your changes.
## Support `simbashlog`
If you like `simbashlog`'s ecosystem, you think it is useful and saves you a lot of work and nerves and lets you sleep better, please give it a star and consider donating.
---
> This script is a component of [`simbashlog`](https://github.com/fuchs-fabian/simbashlog) ([LICENSE](https://github.com/fuchs-fabian/simbashlog/blob/main/LICENSE)).
>
> The core of this notifier is [`simbashlog-notify-helper-py`](https://github.com/fuchs-fabian/simbashlog-notify-helper-py) ([LICENSE](https://github.com/fuchs-fabian/simbashlog-notify-helper-py/blob/main/LICENSE)).
>
> *Copyright (C) 2024 Fabian Fuchs*