From 6d2d66784747b6aaf1f8ba546f72c5ed88f698b4 Mon Sep 17 00:00:00 2001 From: Aaron Taylor Date: Fri, 19 Mar 2021 11:46:40 -0400 Subject: [PATCH] caddyfile: add documentation for new global log option This corresponds with the changes in this PR: https://github.com/caddyserver/caddy/pull/4028 --- src/docs/markdown/caddyfile/options.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/docs/markdown/caddyfile/options.md b/src/docs/markdown/caddyfile/options.md index ba3bd99..f5f74e9 100644 --- a/src/docs/markdown/caddyfile/options.md +++ b/src/docs/markdown/caddyfile/options.md @@ -32,6 +32,13 @@ Possible options are: origins enforce_origin } + log [name] { + output ... + format ... + level + include + exclude + } # TLS Options auto_https off|disable_redirects @@ -96,6 +103,14 @@ Customizes the [admin API endpoint](/docs/api). If `off`, then the admin endpoin - **enforce_origin** enables enforcement of the Origin header. (This is different from enforcing origins generally, which is always done.) +##### `log` +Customizes the named logger. The name can be passed to indicate a specific logger to customize the behavior for. If no name is specified, the behavior of the default logger is modified. This option can be specified multiple times to configure different loggers. You can read more about the default logger and other logging behaviors in the [logging documentation](/docs/logging/). + +- **output** configures where to write the logs. See the [log directive](/docs/caddyfile/directives/log#output-modules) documentation for more information, which has the same structure. +- **format** describes how to encode, or format, the logs. See the [log directive](/docs/caddyfile/directives/log#format-modules) documentation for more information, which has the same structure. +- **level** is the minimum entry level to log. Default: `INFO` +- **include** identifies the loggers that are included in this log configuration. See the [JSON documentation](/docs/json/logging/logs/include/) for more information. +- **exclude** identifies the loggers that are excluded from this log configuration. See the [JSON documentation](/docs/json/logging/logs/exclude/) for more information. ## TLS Options