Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update documentation to clarify the default format for logs #4953

Merged
merged 3 commits into from
Jun 26, 2019
Merged

Update documentation to clarify the default format for logs #4953

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a548b6a
update accesslog documentation to clarify the default clf format valu…
dduportal Jun 12, 2019
c599e5b
Apply suggestions from code review
dduportal Jun 24, 2019
baa8d4c
Apply suggestions from code review
dduportal Jun 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 9 additions & 14 deletions docs/configuration/logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ logLevel = "INFO"

For more information about the CLI, see the documentation about [Traefik command](/basics/#traefik).

```shell
```bash
--logLevel="DEBUG"
--traefikLog.filePath="/path/to/traefik.log"
--traefikLog.format="json"
Expand All @@ -54,7 +54,6 @@ For more information about the CLI, see the documentation about [Traefik command
--accessLog.fields.headers.names="User-Agent=redact Authorization=drop Content-Type=keep"
```


## Traefik Logs

By default the Traefik log is written to stdout in text format.
Expand All @@ -66,15 +65,14 @@ To write the logs into a log file specify the `filePath`:
filePath = "/path/to/traefik.log"
```

To write JSON format logs, specify `json` as the format:
To switch to JSON format instead of standard format (`common`), specify `json` as the format:

```toml
[traefikLog]
filePath = "/path/to/traefik.log"
format = "json"
```


Deprecated way (before 1.4):

!!! danger "DEPRECATED"
Expand Down Expand Up @@ -105,11 +103,10 @@ To customize the log level:
logLevel = "ERROR"
```


## Access Logs

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)](#clf-common-log-format), extended with additional fields.

To enable access logs using the default settings just add the `[accessLog]` entry:

Expand All @@ -124,12 +121,12 @@ To write the logs into a log file specify the `filePath`:
filePath = "/path/to/access.log"
```

To write JSON format logs, specify `json` as the format:
To switch to JSON format instead of [Common Log Format (CLF)](#clf-common-log-format), specify `json` as the format:

```toml
[accessLog]
filePath = "/path/to/access.log"
format = "json"
format = "json" # Default: "common"
```

To write the logs in async, specify `bufferingSize` as the format (must be >0):
Expand All @@ -152,7 +149,7 @@ To filter logs you can specify a set of filters which are logically "OR-connecte
```toml
[accessLog]
filePath = "/path/to/access.log"
format = "json"
format = "json" # Default: "common"

[accessLog.filters]

Expand All @@ -178,12 +175,12 @@ format = "json"
minDuration = "10ms"
```

To customize logs format:
To customize logs format, you must switch to the JSON format:

```toml
[accessLog]
filePath = "/path/to/access.log"
format = "json"
format = "json" # Default: "common"

[accessLog.filters]

Expand Down Expand Up @@ -227,7 +224,6 @@ format = "json"
# ...
```


### List of all available fields

| Field | Description |
Expand Down Expand Up @@ -281,10 +277,9 @@ accessLogsFile = "log/access.log"
By default, Traefik 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
<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

Traefik will close and reopen its log files, assuming they're configured, on receipt of a USR1 signal.
Expand Down