diff --git a/README.md b/README.md index 6c5f730..d4d4c76 100644 --- a/README.md +++ b/README.md @@ -1,108 +1,3 @@ -# Syslog Director - -All received messages are written to *stdout* and/or forwarded to remote logging destinations. - -Supported incoming message formats are: -- Syslog RFC5424 - TCP and UDP -- Syslog RFC3164 (BSD) - TCP and UDP -- Graylog GELF - TCP and UDP (compressed & chunked) - -Supported remote logging destinations are: -- Syslog (RFC5424 over UDP) -- Graylog (GELF over UDP) -- Grafana Loki (HTTP over TCP). - -This software is free to use and is licensed under the [Apache 2.0 License](LICENSE). - -![architecture](doc/syslogd.png) - -Some of my other related projects are: - -- [hmci](https://git.data.coop/nellemann/hmci) for agent-less monitoring of IBM Power servers -- [svci](https://git.data.coop/nellemann/svci) for monitoring IBM Spectrum Virtualize (Flashsystems / Storwize / SVC) -- [sysmon](https://git.data.coop/nellemann/sysmon) for monitoring all types of servers with a small Java agent - -## Usage Instructions - -- Install the syslogd package (*.deb* or *.rpm*) from [packages](https://git.data.coop/nellemann/-/packages/generic/syslogd/) or build from source. - -```text -Usage: syslogd [-dhV] [--[no-]ansi] [--[no-]stdin] [--[no-]stdout] [--[no-]tcp] - [--[no-]udp] [-f=] [-p=] [--to-gelf=] - [--to-loki=] [--to-syslog=] - -d, --debug Enable debugging [default: 'false']. - -f, --format= Input format: RFC-5424, RFC-3164 or GELF [default: - RFC-3164]. - -h, --help Show this help message and exit. - --[no-]ansi Output in ANSI colors [default: true]. - --[no-]stdin Forward messages from stdin [default: true]. - --[no-]stdout Output messages to stdout [default: true]. - --[no-]tcp Listen on TCP [default: true]. - --[no-]udp Listen on UDP [default: true]. - -p, --port= Listening port [default: 1514]. - --to-gelf= Forward to Graylog . - --to-loki= Forward to Grafana Loki . - --to-syslog= Forward to Syslog (RFC-5424). - -V, --version Print version information and exit. -``` - -The default syslog port (514) requires you to run syslogd as root / administrator. -Any port number above 1024 does not require privileges and can be selected with the *-p* or *--port* option. - -### Examples - -Listening on the default syslog port: - -``` -java -jar /path/to/syslogd-x.y.z-all.jar --port 514 -``` - -or, if installed as a *deb* or *rpm* package: - -``` -/opt/syslogd/bin/syslogd --port 514 -``` - -Forwarding messages on to another log-system on a non-standard port. - -``` -java -jar /path/to/syslogd-x.y.z-all.jar --to-syslog udp://remotehost:514 -``` - -Forwarding messages to a Graylog server in GELF format. - -``` -java -jar /path/to/syslogd-x.y.z-all.jar --to-gelf udp://remotehost:12201 -``` - -Forwarding to a Grafana Loki server. - -``` -java -jar /path/to/syslogd-x.y.z-all.jar --to-loki http://remotehost:3100 -``` - -If you don't want any output locally (only forwarding), you can use the ```--no-stdout``` flag. - - -## Notes - -### IBM AIX and VIO Servers - -Syslog messages from AIX (and IBM Power Virtual I/O Servers) can be troublesome with some logging solutions. These can be received with -*syslogd* and then forwarded on to your preferred logging solution. - -### Forwarding to Grafana Loki - -Forwarding is currently done by making HTTP connections to the Loki API, which works fine for low volume messages, but might cause issues for large volume of messages. - -## Development Notes - -### Test Grafana Loki - -Run Loki and Grafana in local containers to test. - -```shell -docker run --rm -d --name=loki -p 3100:3100 grafana/loki -docker run --rm -d --name=grafana --link loki:loki -p 3000:3000 grafana/grafana:7.1.3 -``` +# Repository moved +Please visit [github.com/mnellemann/syslogd](https://github.com/mnellemann/syslogd) \ No newline at end of file