caddy/dist/init/freebsd/README.md
George Hartzell 580f7677ad Use syslog to manage caddy std{out,err} on FreeBSD (#2652)
* Use syslog to manage caddy std{out,err} on FreeBSD

There is no good way to rotate the logfile created by the previous
FreeBSD rc.d script (it's the result of redirecting std{out,err} and
is held open by the shell).

This solves the problem by sending caddy's std{out,err} stream to
syslog, using the daemon command's builtin functionality.

It replaces the old `caddy_logfile` rc.conf variable with
`caddy_syslog_facility` (which defaults to 'local7') and
`caddy_syslog_level` (which defaults to 'notice').

By default, these messages will end up in /var/log/messages but can
be redirected as documented in the script's comments.

* Add info about rotating log with newsyslog

If you create a caddy specific logfile in `/var/log`, you should
rotate it.

This adds a bit of info to the dist/init/freebsd/README.md about
rotating that log file with newsyslog.
2019-07-18 13:58:40 -06:00

44 lines
1.6 KiB
Markdown

# Logging the caddy process's output:
Caddy's FreeBSD `rc.d` script uses `daemon` to run `caddy`; by default
it sends the process's standard output and error to syslog with the
`caddy` tag, the `local7` facility and the `notice` level.
The stock FreeBSD `/etc/syslog.conf` has a line near the top that
captures nearly anything logged at the `notice` level or higher and
sends it to `/var/log/messages`. That line will send the caddy
process's output to `/var/log/messages`.
The simplest way to send `caddy` output to a separate file is:
- Arrange to log the messages at a lower level so that they slip past
that early rule, e.g. add an `/etc/rc.conf` entry like
``` shell
caddy_syslog_level="info"
```
- Add a rule that catches them, e.g. by creating a
`/usr/local/etc/syslog.d/caddy.conf` file that contains:
```
# Capture all messages tagged with "caddy" and send them to /var/log/caddy.log
!caddy
*.* /var/log/caddy.log
```
Heads up, if you specify a file that does not already exist, you'll
need to create it.
- Rotate `/var/log/caddy.log` with `newsyslog` by creating a
`/usr/local/etc/newsyslog.conf/caddy.conf` file that contains:
```
# See newsyslog.conf(5) for details. Logs written by syslog,
# no need for a pidfile or signal, the defaults workg.
# logfilename [owner:group] mode count size when flags [/pid_file] [sig_num]
/var/log/caddy.log www:www 664 7 * @T00 J
```
There are many other ways to do it, read the `syslogd.conf` and
`newsyslog.conf` man pages for additional information.