baalajimaestro/traefik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Document the default accessLog format

Browse source
This commit is contained in:
Dan Fredell 2018-10-01 11:54:04 -05:00 committed by Traefiker Bot
parent 61e1836472
commit f74526a36e
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/configuration/logs.md
View file

@ -60,12 +60,14 @@ For more information about the CLI, see the documentation about [Traefik command
By default the Traefik log is written to stdout in text format. By default the Traefik log is written to stdout in text format.
To write the logs into a log file specify the `filePath`: To write the logs into a log file specify the `filePath`:
```toml ```toml
[traefikLog] [traefikLog]
filePath = "/path/to/traefik.log" filePath = "/path/to/traefik.log"
``` ```
To write JSON format logs, specify `json` as the format: To write JSON format logs, specify `json` as the format:
```toml ```toml
[traefikLog] [traefikLog]
filePath = "/path/to/traefik.log" filePath = "/path/to/traefik.log"
@ -90,6 +92,7 @@ traefikLogsFile = "log/traefik.log"
``` ```
To customize the log level: To customize the log level:
```toml ```toml
# Log level # Log level
# #
@ -109,17 +112,20 @@ Access logs are written when `[accessLog]` is defined.
By default it will write to stdout and produce logs in the textual Common Log Format (CLF), extended with additional fields. By default it will write to stdout and produce logs in the textual Common Log Format (CLF), extended with additional fields.
To enable access logs using the default settings just add the `[accessLog]` entry: To enable access logs using the default settings just add the `[accessLog]` entry:
```toml ```toml
[accessLog] [accessLog]
``` ```
To write the logs into a log file specify the `filePath`: To write the logs into a log file specify the `filePath`:
```toml ```toml
[accessLog] [accessLog]
filePath = "/path/to/access.log" filePath = "/path/to/access.log"
``` ```
To write JSON format logs, specify `json` as the format: To write JSON format logs, specify `json` as the format:
```toml ```toml
[accessLog] [accessLog]
filePath = "/path/to/access.log" filePath = "/path/to/access.log"
@ -127,6 +133,7 @@ format = "json"
``` ```
To write the logs in async, specify `bufferingSize` as the format (must be >0): To write the logs in async, specify `bufferingSize` as the format (must be >0):
```toml ```toml
[accessLog] [accessLog]
filePath = "/path/to/access.log" filePath = "/path/to/access.log"
@ -141,6 +148,7 @@ bufferingSize = 100
``` ```
To filter logs you can specify a set of filters which are logically "OR-connected". Thus, specifying multiple filters will keep more access logs than specifying only one: To filter logs you can specify a set of filters which are logically "OR-connected". Thus, specifying multiple filters will keep more access logs than specifying only one:
```toml ```toml
[accessLog] [accessLog]
filePath = "/path/to/access.log" filePath = "/path/to/access.log"
@ -171,6 +179,7 @@ format = "json"
``` ```
To customize logs format: To customize logs format:
```toml ```toml
[accessLog] [accessLog]
filePath = "/path/to/access.log" filePath = "/path/to/access.log"
@ -218,7 +227,8 @@ format = "json"
# ... # ...
``` ```
#### List of all available fields
### List of all available fields
```ini ```ini
StartUTC StartUTC
@ -266,6 +276,15 @@ Deprecated way (before 1.4):
accessLogsFile = "log/access.log" accessLogsFile = "log/access.log"
``` ```
### CLF - Common Log Format
By default, Træfik use the CLF (`common`) as access log format.
```html
<remote_IP_address> - <client_user_name_if_available> [<timestamp>] "<request_method> <request_path> <request_protocol>" <origin_server_HTTP_status> <origin_server_content_size> "<request_referrer>" "<request_user_agent>" <number_of_requests_received_since_Traefik_started> "<Traefik_frontend_name>" "<Traefik_backend_URL>" <request_duration_in_ms>ms
```
## Log Rotation ## Log Rotation
Traefik will close and reopen its log files, assuming they're configured, on receipt of a USR1 signal. Traefik will close and reopen its log files, assuming they're configured, on receipt of a USR1 signal.