From 7e542b660a5ff34cf662c9aa2669a7b8f15d5da8ffe401dc921f3f3ad7a1a43d Mon Sep 17 00:00:00 2001 From: Lixen Wraith Date: Fri, 10 Oct 2025 14:13:02 -0400 Subject: [PATCH] v0.7.2 minor doc and dependency update --- README.md | 58 +++++++++++++++++++++++++-------------------------- doc/README.md | 15 +++++++------ go.mod | 4 ++-- go.sum | 8 +++---- 4 files changed, 42 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 3678a9c..4f65510 100644 --- a/README.md +++ b/README.md @@ -21,45 +21,45 @@ A high-performance, pipeline-based log transport and processing system built in ## Features ### Core Capabilities -- **Pipeline Architecture**: Independent processing pipelines with source → filter → format → sink flow. -- **Multiple Input Sources**: Directory monitoring, stdin, HTTP, TCP. -- **Flexible Output Sinks**: Console, file, HTTP SSE, TCP streaming, HTTP/TCP forwarding. -- **Real-time Processing**: Sub-millisecond latency with configurable buffering. -- **Hot Configuration Reload**: Update pipelines without service restart. +- **Pipeline Architecture**: Independent processing pipelines with source(s) → filter → format → sink(s) flow +- **Multiple Input Sources**: Directory monitoring, stdin, HTTP, TCP +- **Flexible Output Sinks**: Console, file, HTTP SSE, TCP streaming, HTTP/TCP forwarding +- **Real-time Processing**: Sub-millisecond latency with configurable buffering +- **Hot Configuration Reload**: Update pipelines without service restart ### Data Processing -- **Pattern-based Filtering**: Chainable include/exclude filters with regex support. -- **Multiple Formatters**: Raw, JSON, and template-based text formatting. -- **Rate Limiting**: Pipeline rate control. +- **Pattern-based Filtering**: Chainable include/exclude filters with regex support +- **Multiple Formatters**: Raw, JSON, and template-based text formatting +- **Rate Limiting**: Pipeline rate control ### Security & Reliability -- **Authentication**: Basic, token, and mTLS support for HTTPS, and SCRAM for TCP. -- **TLS Encryption**: TLS 1.2/1.3 support for HTTP connections. -- **Access Control**: IP whitelisting/blacklisting, connection limits. -- **Automatic Reconnection**: Resilient client connections with exponential backoff. -- **File Rotation**: Size-based rotation with retention policies. +- **Authentication**: Basic, token, and mTLS support for HTTPS, and SCRAM for TCP +- **TLS Encryption**: TLS 1.2/1.3 support for HTTP connections +- **Access Control**: IP whitelisting/blacklisting, connection limits +- **Automatic Reconnection**: Resilient client connections with exponential backoff +- **File Rotation**: Size-based rotation with retention policies ### Operational Features -- **Status Monitoring**: Real-time statistics and health endpoints. -- **Signal Handling**: Graceful shutdown and configuration reload via signals. -- **Background Mode**: Daemon operation with proper signal handling. -- **Quiet Mode**: Silent operation for automated deployments. +- **Status Monitoring**: Real-time statistics and health endpoints +- **Signal Handling**: Graceful shutdown and configuration reload via signals +- **Background Mode**: Daemon operation with proper signal handling +- **Quiet Mode**: Silent operation for automated deployments ## Documentation Available in `doc/` directory. -- [Installation Guide](installation.md) - Platform setup and service configuration -- [Architecture Overview](architecture.md) - System design and component interaction -- [Configuration Reference](configuration.md) - TOML structure and configuration methods -- [Input Sources](sources.md) - Available source types and configurations -- [Output Sinks](sinks.md) - Sink types and output options -- [Filters](filters.md) - Pattern-based log filtering -- [Formatters](formatters.md) - Log formatting and transformation -- [Authentication](authentication.md) - Security configurations and auth methods -- [Networking](networking.md) - TLS, rate limiting, and network features -- [Command Line Interface](cli.md) - CLI flags and subcommands -- [Operations Guide](operations.md) - Running and maintaining LogWisp +- [Installation Guide](doc/installation.md) - Platform setup and service configuration +- [Architecture Overview](doc/architecture.md) - System design and component interaction +- [Configuration Reference](doc/configuration.md) - TOML structure and configuration methods +- [Input Sources](doc/sources.md) - Available source types and configurations +- [Output Sinks](doc/sinks.md) - Sink types and output options +- [Filters](doc/filters.md) - Pattern-based log filtering +- [Formatters](doc/formatters.md) - Log formatting and transformation +- [Authentication](doc/authentication.md) - Security configurations and auth methods +- [Networking](doc/networking.md) - TLS, rate limiting, and network features +- [Command Line Interface](doc/cli.md) - CLI flags and subcommands +- [Operations Guide](doc/operations.md) - Running and maintaining LogWisp ## Quick Start @@ -91,4 +91,4 @@ Run with: `logwisp -c config.toml` ## License -BSD 3-Clause License \ No newline at end of file +BSD 3-Clause License diff --git a/doc/README.md b/doc/README.md index d83c0f5..9f61228 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,21 +1,20 @@ # LogWisp -A high-performance, pipeline-based log transport and processing system built in Go. LogWisp provides flexible log collection, filtering, formatting, and distribution with enterprise-grade security and reliability features. +A high-performance, pipeline-based log transport and processing system built in Go. LogWisp provides flexible log collection, filtering, formatting, and distribution with security and reliability features. ## Features ### Core Capabilities -- **Pipeline Architecture**: Independent processing pipelines with source → filter → format → sink flow +- **Pipeline Architecture**: Independent processing pipelines with source(s) → filter → format → sink(s) flow - **Multiple Input Sources**: Directory monitoring, stdin, HTTP, TCP - **Flexible Output Sinks**: Console, file, HTTP SSE, TCP streaming, HTTP/TCP forwarding - **Real-time Processing**: Sub-millisecond latency with configurable buffering - **Hot Configuration Reload**: Update pipelines without service restart ### Data Processing -- **Pattern-based Filtering**: Include/exclude filters with regex support +- **Pattern-based Filtering**: Chainable include/exclude filters with regex support - **Multiple Formatters**: Raw, JSON, and template-based text formatting -- **Rate Limiting**: Pipeline and per-connection rate controls -- **Batch Processing**: Configurable batching for HTTP/TCP clients +- **Rate Limiting**: Pipeline rate controls ### Security & Reliability - **Authentication**: Basic, token, SCRAM, and mTLS support @@ -68,10 +67,10 @@ Run with: `logwisp -c config.toml` ## System Requirements -- **Operating Systems**: Linux (kernel 3.10+), FreeBSD (12.0+) +- **Operating Systems**: Linux (kernel 6.10+), FreeBSD (14.0+) - **Architecture**: amd64 -- **Go Version**: 1.24+ (for building from source) +- **Go Version**: 1.25+ (for building from source) ## License -BSD 3-Clause License \ No newline at end of file +BSD 3-Clause License diff --git a/go.mod b/go.mod index 0a53d0f..d4bb555 100644 --- a/go.mod +++ b/go.mod @@ -6,7 +6,7 @@ require ( github.com/lixenwraith/config v0.0.0-20251003140149-580459b815f6 github.com/lixenwraith/log v0.0.0-20251010094026-6a161eb2b686 github.com/panjf2000/gnet/v2 v2.9.4 - github.com/valyala/fasthttp v1.67.0 + github.com/valyala/fasthttp v1.68.0 golang.org/x/crypto v0.43.0 golang.org/x/term v0.36.0 ) @@ -15,7 +15,7 @@ require ( github.com/BurntSushi/toml v1.5.0 // indirect github.com/andybalholm/brotli v1.2.0 // indirect github.com/davecgh/go-spew v1.1.1 // indirect - github.com/klauspost/compress v1.18.0 // indirect + github.com/klauspost/compress v1.18.1 // indirect github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/panjf2000/ants/v2 v2.11.3 // indirect github.com/valyala/bytebufferpool v1.0.0 // indirect diff --git a/go.sum b/go.sum index 656b8c2..666ec0f 100644 --- a/go.sum +++ b/go.sum @@ -6,8 +6,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/go-viper/mapstructure v1.6.0 h1:0WdPOF2rmmQDN1xo8qIgxyugvLp71HrZSWyGLxofobw= github.com/go-viper/mapstructure v1.6.0/go.mod h1:FcbLReH7/cjaC0RVQR+LHFIrBhHF3s1e/ud1KMDoBVw= -github.com/klauspost/compress v1.18.0 h1:c/Cqfb0r+Yi+JtIEq73FWXVkRonBlf0CRNYc8Zttxdo= -github.com/klauspost/compress v1.18.0/go.mod h1:2Pp+KzxcywXVXMr50+X0Q/Lsb43OQHYWRCY2AiWywWQ= +github.com/klauspost/compress v1.18.1 h1:bcSGx7UbpBqMChDtsF28Lw6v/G94LPrrbMbdC3JH2co= +github.com/klauspost/compress v1.18.1/go.mod h1:ZQFFVG+MdnR0P+l6wpXgIL4NTtwiKIdBnrBd8Nrxr+0= github.com/lixenwraith/config v0.0.0-20251003140149-580459b815f6 h1:G9qP8biXBT6bwBOjEe1tZwjA0gPuB5DC+fLBRXDNXqo= github.com/lixenwraith/config v0.0.0-20251003140149-580459b815f6/go.mod h1:I7ddNPT8MouXXz/ae4DQfBKMq5EisxdDLRX0C7Dv4O0= github.com/lixenwraith/log v0.0.0-20251010094026-6a161eb2b686 h1:STgvFUpjvZquBF322PNLXaU67oEScewGDLy0aV+lIkY= @@ -22,8 +22,8 @@ github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOf github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw= github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= -github.com/valyala/fasthttp v1.67.0 h1:tqKlJMUP6iuNG8hGjK/s9J4kadH7HLV4ijEcPGsezac= -github.com/valyala/fasthttp v1.67.0/go.mod h1:qYSIpqt/0XNmShgo/8Aq8E3UYWVVwNS2QYmzd8WIEPM= +github.com/valyala/fasthttp v1.68.0 h1:v12Nx16iepr8r9ySOwqI+5RBJ/DqTxhOy1HrHoDFnok= +github.com/valyala/fasthttp v1.68.0/go.mod h1:5EXiRfYQAoiO/khu4oU9VISC/eVY6JqmSpPJoHCKsz4= github.com/xyproto/randomstring v1.0.5 h1:YtlWPoRdgMu3NZtP45drfy1GKoojuR7hmRcnhZqKjWU= github.com/xyproto/randomstring v1.0.5/go.mod h1:rgmS5DeNXLivK7YprL0pY+lTuhNQW3iGxZ18UQApw/E= go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=