logpipe 0.3.0

Lightweight log monitoring framework.

sendlog

sendlog is a lightweight, extensible log monitoring framework with rule-based alerting. View the full documentation at sendlog.samcole.net.

NOTE: Sendlog is in alpha. In its current state, it may be unstable and is subject to significant changes in future releases.

Quick Start Guide

Installation

This quick start installation guide is designed for Linux distributions running systemd.

1. Clone the repository. You can put it anywhere you want—/opt is recommended. Example:

   sudo git clone https://github.com/samcole8/sendlog.git /opt/sendlog
   

2. Configure a virtual environment and install Python dependencies

   python3 -m venv /opt/sendlog/venv
   source /opt/sendlog/venv/bin/activate
   pip install -r /opt/sendlog/requirements.txt
   

3. Copy the systemd service script into your systemd service directory, e.g.:

   sudo cp /opt/sendlog/pkg/sendlog.service /etc/systemd/system/sendlog.service
   

Configuring alerts

Configuration examples are available in examples/. For more information on configuring sendlog, see the Configuration File documentation.

Writing Plugins

You can write plugins to integrate sendlog with custom log structures or endpoints. For more information on writing plugins, see the Plugin DSL documentation.

Starting the service

1. Start/enable the service:

   sudo systemctl enable --now sendlog
   

2. Check if the system is operational:

   sudo systemctl status sendlog
   

3. If the configuration file changes, restart the service:

   sudo systemctl restart sendlog