-
Notifications
You must be signed in to change notification settings - Fork 0
Example Configs
github-actions[bot] edited this page Jun 13, 2026
·
3 revisions
Copy these from the configs/ directory in the repository.
| Config | Sink | Log format | Notes |
|---|---|---|---|
| example.yaml | Kafka | Tab-delimited | Full-featured starter |
| example-regex.yaml | Kafka | Regex | Generic regex parsing |
| example-file.yaml | File | Tab-delimited | JSONL to ./output/
|
| example-http-noauth.yaml | HTTP | Tab-delimited | POST to localhost ingest |
| Config | Sink | Notes |
|---|---|---|
| example-atc.yaml | File | Minimal ATC setup — metrics + registration; pair with log-forwarder-atc |
| example-spring-boot-kafka.yaml | Kafka | Spring Boot multiline + ATC enabled |
See Log Forwarder ATC.
| Config | Sink | Filter | Notes |
|---|---|---|---|
| example-vendor-filter-kafka.yaml | Kafka | INFO, WARN, ERROR | Third-party DEBUG-heavy appliance — see Filtering Vendor Noise |
| example-filter.yaml | File | WARN, ERROR | Integration-tested; local file sink |
| Config | Sink | Notes |
|---|---|---|
| example-spring-boot-kafka.yaml | Kafka | Multiline + regex; ATC registration enabled — see Log Forwarder ATC |
| example-spring-boot-file.yaml | File | JSONL to ./output/
|
| example-spring-boot-http-noauth.yaml | HTTP | POST to localhost ingest |
All three share multiline parser + Spring Boot regex. See Spring Boot Logs.
Under examples/kafka/:
| File | Protocol |
|---|---|
| plaintext.yaml | PLAINTEXT (dev only) |
| ssl-server-auth.yaml | SSL |
| ssl-mtls.yaml | mTLS |
| sasl-plaintext-plain.yaml | SASL_PLAINTEXT + PLAIN |
| sasl-ssl-plain.yaml | SASL_SSL + PLAIN |
| sasl-ssl-scram-sha-256.yaml | SASL_SSL + SCRAM-SHA-256 |
| sasl-ssl-scram-sha-512.yaml | SASL_SSL + SCRAM-SHA-512 |
| sasl-ssl-oauthbearer.yaml | SASL_SSL + OAUTHBEARER |
| sasl-ssl-gssapi.yaml | SASL_SSL + GSSAPI (reference; not fully implemented) |
- Copy the closest example to
/etc/log-forwarder/config.yaml - Update
watch.sourcespaths and patterns to your log directories - Choose
sinktype and destination settings - Set
enrichersstatic fields (application_id,environment, …) - Set a dedicated
watch.state.pathfor this process - Run:
./bin/log-forwarder -config /etc/log-forwarder/config.yaml
User guide
- Home
- Installation and First Run
- How It Works
- Filtering Vendor Noise
- Log Forwarder ATC
- Configuration Guide
- Configuration-Reference
- Config-Catalog
- Choosing a Sink
- Spring Boot Logs
- Watermarks and Restarts
- Built-in-Components
- Custom-Extensions
- Monitoring
- Testing
- Docker
- Deployment
- Example Configs
- Troubleshooting
Contributors