logwisp/doc/sinks.md

Output Sinks

LogWisp sinks deliver processed log entries to various destinations.

Sink Types

Console Sink

Output to stdout/stderr.

[[pipelines.plugin_sinks]]
id = "console_out"
type = "console"
[pipelines.plugin_sinks.config]
target = "stdout"  # stdout|stderr|split
buffer_size = 1000

Configuration Options:

Option	Type	Default	Description
target	string	"stdout"	Output target (stdout/stderr/split)
buffer_size	int	1000	Internal buffer size

Target Modes:

• stdout: All output to standard output
• stderr: All output to standard error
• split: INFO/DEBUG to stdout, WARN/ERROR to stderr

File Sink

Write logs to rotating files.

[[pipelines.plugin_sinks]]
id = "file_out"
type = "file"
[pipelines.plugin_sinks.config]
directory = "./logs"
name = "output"
max_size_mb = 100
max_total_size_mb = 1000
min_disk_free_mb = 500
retention_hours = 168.0
buffer_size = 1000
flush_interval_ms = 1000

Configuration Options:

Option	Type	Default	Description
directory	string	Required	Output directory
name	string	Required	Base filename
max_size_mb	int	100	Rotation threshold
max_total_size_mb	int	1000	Total size limit
min_disk_free_mb	int	500	Minimum free disk space
retention_hours	float	168	Delete files older than
buffer_size	int	1000	Internal buffer size
flush_interval_ms	int	1000	Force flush interval

Features:

• Automatic rotation on size
• Retention management
• Disk space monitoring
• Periodic flushing

HTTP Sink

SSE (Server-Sent Events) streaming server.

[[pipelines.plugin_sinks]]
id = "http_out"
type = "http"
[pipelines.plugin_sinks.config]
host = "0.0.0.0"
port = 8080
stream_path = "/stream"
status_path = "/status"
buffer_size = 1000
client_buffer_size = 256
write_timeout_ms = 0
max_connections = 0

Configuration Options:

Option	Type	Default	Description
host	string	"0.0.0.0"	Bind address
port	int	Required	Listen port
stream_path	string	"/stream"	SSE stream endpoint
status_path	string	"/status"	Status endpoint
buffer_size	int	1000	Sink input queue size
client_buffer_size	int	256	Per-client send queue size
write_timeout_ms	int	0	Write deadline per event (0 = none)
max_connections	int	0	Concurrent connection cap (0 = unlimited)

TCP Sink

TCP streaming server for debugging and raw client forwarding.

[[pipelines.plugin_sinks]]
id = "tcp_out"
type = "tcp"
[pipelines.plugin_sinks.config]
host = "0.0.0.0"
port = 9090
buffer_size = 1000
client_buffer_size = 256
write_timeout_ms = 5000
keep_alive = true
keep_alive_period_ms = 30000
max_connections = 0

Configuration Options:

Option	Type	Default	Description
host	string	"0.0.0.0"	Bind address
port	int	Required	Listen port
buffer_size	int	1000	Sink input queue size
client_buffer_size	int	256	Per-client send queue size
write_timeout_ms	int	5000	Write timeout
keep_alive	bool	true	Enable TCP keep-alive
keep_alive_period_ms	int	30000	Keep-alive interval
max_connections	int	0	Concurrent connection cap (0 = unlimited)

### Null Sink

```toml
[[pipelines.plugin_sinks]]
id = "null_out"
type = "null"

Buffer Management

• Full input buffer: entry dropped for that sink only (counted per pipeline as total_dropped_by_sink)"

Sink Statistics

All sinks track:

• Total entries processed
• Active connections
• Failed sends
• Retry attempts
• Last processed timestamp