Skip to content

Commit

Permalink
README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Troy Davis committed Nov 4, 2011
1 parent dcf41cb commit af981a1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Expand Up @@ -27,7 +27,7 @@ Install the gem, which includes a binary called "remote_syslog":
$ [sudo] gem install remote_syslog $ [sudo] gem install remote_syslog


Optionally, create a log_files.yml with the log file paths to read and the Optionally, create a log_files.yml with the log file paths to read and the
host/port to log to (see [examples/log_files.yml.example]). These can also be host/port to log to (see examples/[log_files.yml.example][sample config]). These can also be
specified as command-line arguments (below). specified as command-line arguments (below).




Expand Down Expand Up @@ -115,16 +115,17 @@ Provide `--hostname somehostname` or use the `hostname` configuration option:


hostname: somehostname hostname: somehostname


## Run multiple instances ### Multiple instances


Run multiple instances to support more than one message-specific file format Run multiple instances to support more than one message-specific file format
(concurrently) or to specify distinct syslog hostnames. To do so, provide or to specify unique syslog hostnames.
an alternative PID filename as a command-line option to additional
instance(s), such as: To do that, provide an alternate PID filename as a command-line option
to the additional instance(s). For example:


--pid-file remote_syslog_2.pid --pid-file remote_syslog_2.pid


### Parse fields from messages ### Parse fields from log messages


Rarely needed. Usually only used when remote_syslog is watching files Rarely needed. Usually only used when remote_syslog is watching files
generated by syslogd (rather than by apps), like ``/var/log/messages``. generated by syslogd (rather than by apps), like ``/var/log/messages``.
Expand Down Expand Up @@ -161,8 +162,8 @@ doesn't provide a value. For example, given the log message:
something-meaningless The log message something-meaningless The log message


One could use a regex to ignore "something-meaningless" (and not to extract One could use a regex to ignore "something-meaningless" (and not to extract
a program or hostname). To ignore the first word and return 3 empty values a program or hostname). To ignore that prefix and return 3 empty values
then the log message, use this custom regex: then the log message, use parse_fields with this regex:


parse_fields: "something-meaningless ()()()(.*)" parse_fields: "something-meaningless ()()()(.*)"


Expand All @@ -187,9 +188,8 @@ Once you've made your great commits:
5. Create a Pull Request or an [Issue][is] with a link to your branch 5. Create a Pull Request or an [Issue][is] with a link to your branch
6. That's it! 6. That's it!


[examples/log_files.example]: https://github.com/papertrail/remote_syslog/blob/master/examples/log_files.yml.example
[remote_syslog.init.d]: https://github.com/papertrail/remote_syslog/blob/master/examples/remote_syslog.init.d
[sample config]: https://github.com/papertrail/remote_syslog/blob/master/examples/log_files.yml.example [sample config]: https://github.com/papertrail/remote_syslog/blob/master/examples/log_files.yml.example
[remote_syslog.init.d]: https://github.com/papertrail/remote_syslog/blob/master/examples/remote_syslog.init.d
[advanced config]: https://github.com/papertrail/remote_syslog/blob/master/examples/log_files.yml.example.advanced [advanced config]: https://github.com/papertrail/remote_syslog/blob/master/examples/log_files.yml.example.advanced
[fk]: http://help.github.com/forking/ [fk]: http://help.github.com/forking/
[is]: https://github.com/papertrail/remote_syslog/issues/ [is]: https://github.com/papertrail/remote_syslog/issues/
Expand Down
File renamed without changes.

0 comments on commit af981a1

Please sign in to comment.