logwisp/doc/quickstart.md

Quick Start Guide

Get LogWisp up and running in 5 minutes with the new pipeline architecture!

Installation

From Source

git clone https://github.com/lixenwraith/logwisp.git
cd logwisp
make install

Using Go Install

go install github.com/lixenwraith/logwisp/src/cmd/logwisp@latest

Basic Usage

1. Monitor Current Directory

Start LogWisp with defaults (monitors *.log files in current directory):

logwisp

2. Stream Logs

Connect to the log stream:

# SSE stream
curl -N http://localhost:8080/stream

# Check status
curl http://localhost:8080/status | jq .

3. Generate Test Logs

echo "[ERROR] Something went wrong!" >> test.log
echo "[INFO] Application started" >> test.log
echo "[WARN] Low memory warning" >> test.log

Common Scenarios

Monitor Specific Directory

Create ~/.config/logwisp.toml:

[[pipelines]]
name = "myapp"

[[pipelines.sources]]
type = "directory"
options = { path = "/var/log/myapp", pattern = "*.log" }

[[pipelines.sinks]]
type = "http"
options = { port = 8080 }

Filter Only Errors

[[pipelines]]
name = "errors"

[[pipelines.sources]]
type = "directory"
options = { path = "./", pattern = "*.log" }

[[pipelines.filters]]
type = "include"
patterns = ["ERROR", "WARN", "CRITICAL"]

[[pipelines.sinks]]
type = "http"
options = { port = 8080 }

Multiple Outputs

Send logs to both HTTP stream and file:

[[pipelines]]
name = "multi-output"

[[pipelines.sources]]
type = "directory"
options = { path = "/var/log/app", pattern = "*.log" }

# HTTP streaming
[[pipelines.sinks]]
type = "http"
options = { port = 8080 }

# File archival
[[pipelines.sinks]]
type = "file"
options = { directory = "/var/log/archive", name = "app" }

TCP Streaming

For high-performance streaming:

[[pipelines]]
name = "highperf"

[[pipelines.sources]]
type = "directory"
options = { path = "/var/log/app", pattern = "*.log" }

[[pipelines.sinks]]
type = "tcp"
options = { port = 9090, buffer_size = 5000 }

Connect with netcat:

nc localhost 9090

Router Mode

Run multiple pipelines on shared ports:

logwisp --router

# Access pipelines at:
# http://localhost:8080/myapp/stream
# http://localhost:8080/errors/stream
# http://localhost:8080/status (global)

Quick Tips

Enable Debug Logging

logwisp --log-level debug --log-output stderr

Rate Limiting

[[pipelines.sinks]]
type = "http"
options = {
    port = 8080,
    rate_limit = {
        enabled = true,
        requests_per_second = 10.0,
        burst_size = 20
    }
}

Console Output

[[pipelines.sinks]]
type = "stdout"  # or "stderr"
options = {}