mirror of https://github.com/docker/docs.git
chore: tier 1 freshness: content/config/containers/logging/syslog.md
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson
parent
ec07c18734
commit
6f717a0ff6
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
description: Describes how to use the syslog logging driver.
|
||||
description: Learn how to use the syslog logging driver with Docker Engine
|
||||
keywords: syslog, docker, logging, driver
|
||||
title: Syslog logging driver
|
||||
aliases:
|
||||
- /engine/reference/logging/syslog/
|
||||
- /engine/admin/logging/syslog/
|
||||
- /engine/reference/logging/syslog/
|
||||
- /engine/admin/logging/syslog/
|
||||
---
|
||||
|
||||
The `syslog` logging driver routes logs to a `syslog` server. The `syslog` protocol uses
|
||||
|
|
@ -12,11 +12,11 @@ a raw string as the log message and supports a limited set of metadata. The sysl
|
|||
message must be formatted in a specific way to be valid. From a valid message, the
|
||||
receiver can extract the following information:
|
||||
|
||||
- **priority**: the logging level, such as `debug`, `warning`, `error`, `info`.
|
||||
- **timestamp**: when the event occurred.
|
||||
- **hostname**: where the event happened.
|
||||
- **facility**: which subsystem logged the message, such as `mail` or `kernel`.
|
||||
- **process name** and **process ID (PID)**: The name and ID of the process that generated the log.
|
||||
- Priority: the logging level, such as `debug`, `warning`, `error`, `info`.
|
||||
- Timestamp: when the event occurred.
|
||||
- Hostname: where the event happened.
|
||||
- Facility: which subsystem logged the message, such as `mail` or `kernel`.
|
||||
- Process name and process ID (PID): The name and ID of the process that generated the log.
|
||||
|
||||
The format is defined in [RFC 5424](https://tools.ietf.org/html/rfc5424) and Docker's syslog driver implements the
|
||||
[ABNF reference](https://tools.ietf.org/html/rfc5424#section-6) in the following way:
|
||||
|
|
@ -58,7 +58,7 @@ Restart Docker for the changes to take effect.
|
|||
> **Note**
|
||||
>
|
||||
> `log-opts` configuration options in the `daemon.json` configuration file must
|
||||
> be provided as strings. Numeric and boolean values (such as the value for
|
||||
> be provided as strings. Numeric and Boolean values (such as the value for
|
||||
> `syslog-tls-skip-verify`) must therefore be enclosed in quotes (`"`).
|
||||
|
||||
You can set the logging driver for a specific container by using the
|
||||
|
|
@ -79,16 +79,16 @@ container by adding a `--log-opt <key>=<value>` flag for each option when
|
|||
starting the container.
|
||||
|
||||
| Option | Description | Example value |
|
||||
|:-------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------|
|
||||
| `syslog-address` | The address of an external `syslog` server. The URI specifier may be `[tcp|udp|tcp+tls]://host:port`, `unix://path`, or `unixgram://path`. If the transport is `tcp`, `udp`, or `tcp+tls`, the default port is `514`. | `--log-opt syslog-address=tcp+tls://192.168.1.3:514`, `--log-opt syslog-address=unix:///tmp/syslog.sock` |
|
||||
| :----------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------- |
|
||||
| `syslog-address` | The address of an external `syslog` server. The URI specifier may be `[tcp\|udp\|tcp+tls]://host:port`, `unix://path`, or `unixgram://path`. If the transport is `tcp`, `udp`, or `tcp+tls`, the default port is `514`. | `--log-opt syslog-address=tcp+tls://192.168.1.3:514`, `--log-opt syslog-address=unix:///tmp/syslog.sock` |
|
||||
| `syslog-facility` | The `syslog` facility to use. Can be the number or name for any valid `syslog` facility. See the [syslog documentation](https://tools.ietf.org/html/rfc5424#section-6.2.1). | `--log-opt syslog-facility=daemon` |
|
||||
| `syslog-tls-ca-cert` | The absolute path to the trust certificates signed by the CA. **Ignored if the address protocol is not `tcp+tls`.** | `--log-opt syslog-tls-ca-cert=/etc/ca-certificates/custom/ca.pem` |
|
||||
| `syslog-tls-cert` | The absolute path to the TLS certificate file. **Ignored if the address protocol is not `tcp+tls`**. | `--log-opt syslog-tls-cert=/etc/ca-certificates/custom/cert.pem` |
|
||||
| `syslog-tls-key` | The absolute path to the TLS key file. **Ignored if the address protocol is not `tcp+tls`.** | `--log-opt syslog-tls-key=/etc/ca-certificates/custom/key.pem` |
|
||||
| `syslog-tls-skip-verify` | If set to `true`, TLS verification is skipped when connecting to the `syslog` daemon. Defaults to `false`. **Ignored if the address protocol is not `tcp+tls`.** | `--log-opt syslog-tls-skip-verify=true` |
|
||||
| `tag` | A string that is appended to the `APP-NAME` in the `syslog` message. By default, Docker uses the first 12 characters of the container ID to tag log messages. Refer to the [log tag option documentation](log_tags.md) for customizing the log tag format. | `--log-opt tag=mailer` |
|
||||
| `syslog-format` | The `syslog` message format to use. If not specified the local UNIX syslog format is used, without a specified hostname. Specify `rfc3164` for the RFC-3164 compatible format, `rfc5424` for RFC-5424 compatible format, or `rfc5424micro` for RFC-5424 compatible format with microsecond timestamp resolution. | `--log-opt syslog-format=rfc5424micro` |
|
||||
| `syslog-tls-ca-cert` | The absolute path to the trust certificates signed by the CA. Ignored if the address protocol isn't `tcp+tls`. | `--log-opt syslog-tls-ca-cert=/etc/ca-certificates/custom/ca.pem` |
|
||||
| `syslog-tls-cert` | The absolute path to the TLS certificate file. Ignored if the address protocol isn't `tcp+tls`. | `--log-opt syslog-tls-cert=/etc/ca-certificates/custom/cert.pem` |
|
||||
| `syslog-tls-key` | The absolute path to the TLS key file. Ignored if the address protocol isn't `tcp+tls`. | `--log-opt syslog-tls-key=/etc/ca-certificates/custom/key.pem` |
|
||||
| `syslog-tls-skip-verify` | If set to `true`, TLS verification is skipped when connecting to the `syslog` daemon. Defaults to `false`. Ignored if the address protocol isn't `tcp+tls`. | `--log-opt syslog-tls-skip-verify=true` |
|
||||
| `tag` | A string that's appended to the `APP-NAME` in the `syslog` message. By default, Docker uses the first 12 characters of the container ID to tag log messages. Refer to the [log tag option documentation](log_tags.md) for customizing the log tag format. | `--log-opt tag=mailer` |
|
||||
| `syslog-format` | The `syslog` message format to use. If not specified the local Unix syslog format is used, without a specified hostname. Specify `rfc3164` for the RFC-3164 compatible format, `rfc5424` for RFC-5424 compatible format, or `rfc5424micro` for RFC-5424 compatible format with microsecond timestamp resolution. | `--log-opt syslog-format=rfc5424micro` |
|
||||
| `labels` | Applies when starting the Docker daemon. A comma-separated list of logging-related labels this daemon accepts. Used for advanced [log tag options](log_tags.md). | `--log-opt labels=production_status,geo` |
|
||||
| `labels-regex` | Applies when starting the Docker daemon. Similar to and compatible with `labels`. A regular expression to match logging-related labels. Used for advanced [log tag options](log_tags.md). | `--log-opt labels-regex=^(production_status\|geo)` |
|
||||
| `env` | Applies when starting the Docker daemon. A comma-separated list of logging-related environment variables this daemon accepts. Used for advanced [log tag options](log_tags.md). | `--log-opt env=os,customer` |
|
||||
| `env-regex` | Applies when starting the Docker daemon. Similar to and compatible with `env`. A regular expression to match logging-related environment variables. Used for advanced [log tag options](log_tags.md). | `--log-opt env-regex=^(os\|customer)` |
|
||||
| `env-regex` | Applies when starting the Docker daemon. Similar to and compatible with `env`. A regular expression to match logging-related environment variables. Used for advanced [log tag options](log_tags.md). | `--log-opt env-regex=^(os\|customer)` |
|
||||
|
|
|
|||
Loading…
Reference in New Issue