- feat: new config directive include_dest_ports ([]int) in correlation section - feat: if non-empty, only events with a matching dst_port are correlated - feat: filtered events are silently ignored (not correlated, not emitted as orphan) - feat: new metric failed_dest_port_filtered tracked in ProcessEvent - feat: DEBUG log 'event excluded by dest port filter: source=A dst_port=22' - test: TestCorrelationService_IncludeDestPorts_AllowedPort - test: TestCorrelationService_IncludeDestPorts_FilteredPort - test: TestCorrelationService_IncludeDestPorts_EmptyAllowsAll - docs(readme): full rewrite to match current code (v1.1.12) - docs(readme): add include_dest_ports section, fix version refs, clean outdated sections - docs(arch): add dest_port_filtering section, failed_dest_port_filtered metric, debug log example - fix(config.example): remove obsolete stdout.level field - chore: bump version to 1.1.12 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
94 lines
2.7 KiB
YAML
94 lines
2.7 KiB
YAML
# logcorrelator configuration file
|
|
# Format: YAML
|
|
|
|
# Logging configuration
|
|
log:
|
|
level: INFO # DEBUG, INFO, WARN, ERROR
|
|
|
|
inputs:
|
|
unix_sockets:
|
|
- name: http
|
|
source_type: A
|
|
path: /var/run/logcorrelator/http.socket
|
|
format: json
|
|
socket_permissions: "0666" # world read/write
|
|
- name: network
|
|
source_type: B
|
|
path: /var/run/logcorrelator/network.socket
|
|
format: json
|
|
socket_permissions: "0666"
|
|
|
|
outputs:
|
|
file:
|
|
enabled: true
|
|
path: /var/log/logcorrelator/correlated.log
|
|
|
|
clickhouse:
|
|
enabled: false
|
|
dsn: clickhouse://user:pass@localhost:9000/db
|
|
table: correlated_logs_http_network
|
|
batch_size: 500
|
|
flush_interval_ms: 200
|
|
max_buffer_size: 5000
|
|
drop_on_overflow: true
|
|
async_insert: true
|
|
timeout_ms: 1000
|
|
|
|
stdout:
|
|
enabled: false
|
|
|
|
correlation:
|
|
# Time window for correlation (A and B must be within this window)
|
|
# Increased to 10s to support HTTP Keep-Alive scenarios
|
|
time_window:
|
|
value: 10
|
|
unit: s
|
|
|
|
# Orphan policy: what to do when no match is found
|
|
orphan_policy:
|
|
apache_always_emit: true # Always emit A events, even without B match
|
|
apache_emit_delay_ms: 500 # Wait 500ms before emitting as orphan (allows B to arrive)
|
|
network_emit: false # Never emit B events alone
|
|
|
|
# Matching mode: one_to_one or one_to_many (Keep-Alive)
|
|
matching:
|
|
mode: one_to_many
|
|
|
|
# Buffer limits (max events in memory)
|
|
buffers:
|
|
max_http_items: 10000
|
|
max_network_items: 20000
|
|
|
|
# TTL for network events (source B)
|
|
# Increased to 120s to support long-lived HTTP Keep-Alive sessions
|
|
ttl:
|
|
network_ttl_s: 120
|
|
|
|
# Exclude specific source IPs or CIDR ranges from correlation
|
|
# Events from these IPs will be silently dropped (not correlated, not emitted)
|
|
# Useful for excluding health checks, internal traffic, or known bad actors
|
|
exclude_source_ips:
|
|
- 10.0.0.1 # Single IP
|
|
- 192.168.1.100 # Another single IP
|
|
- 172.16.0.0/12 # CIDR range (private network)
|
|
- 10.10.10.0/24 # Another CIDR range
|
|
|
|
# Restrict correlation to specific destination ports (optional)
|
|
# If non-empty, only events whose dst_port matches one of these values will be correlated
|
|
# Events on other ports are silently ignored (not correlated, not emitted as orphans)
|
|
# Useful to focus on HTTP/HTTPS traffic only and ignore unrelated connections
|
|
# include_dest_ports:
|
|
# - 80 # HTTP
|
|
# - 443 # HTTPS
|
|
# - 8080 # HTTP alt
|
|
# - 8443 # HTTPS alt
|
|
|
|
# Metrics server configuration (optional, for debugging/monitoring)
|
|
metrics:
|
|
enabled: false
|
|
addr: ":8080" # Address to listen on (e.g., ":8080", "localhost:8080")
|
|
# Endpoints:
|
|
# GET /metrics - Returns correlation metrics as JSON
|
|
# GET /health - Health check endpoint
|
|
|