diff --git a/src/current/_includes/releases/v1.0/beta-20170105.md b/src/current/_includes/releases/v1.0/beta-20170105.md index 7b8a35af970..7483cc906c9 100644 --- a/src/current/_includes/releases/v1.0/beta-20170105.md +++ b/src/current/_includes/releases/v1.0/beta-20170105.md @@ -56,7 +56,7 @@ Raft traffic to that node is suspended until it becomes responsive again. [#1263 - Fixed a regression in `OUTER JOIN` operations with predicates. [#12350](https://github.com/cockroachdb/cockroach/pull/12350) - Fixed type checking in `window` definitions. [#12483](https://github.com/cockroachdb/cockroach/pull/12483) - Fixed a bug when adding columns with families to tables created by certain older beta versions of CockroachDB. [#12475](https://github.com/cockroachdb/cockroach/pull/12475) -- It is now possible to disable logging output to files with `--log-dir=""`. [#12662](https://github.com/cockroachdb/cockroach/pull/12662) +- It is now possible to disable logging output to files with `--log-dir=`. [#12662](https://github.com/cockroachdb/cockroach/pull/12662) - When logging to both `stderr` and files, all desired logging output is now properly emitted to files, not only to `stderr`. [#12662](https://github.com/cockroachdb/cockroach/pull/12662)

Internal Changes

@@ -88,4 +88,4 @@ This release includes 122 merged PRs by 25 authors. We would like to thank the f - Haines Chan - \ No newline at end of file + diff --git a/src/current/_includes/releases/v19.2/v19.2.6.md b/src/current/_includes/releases/v19.2/v19.2.6.md index a4da037c971..52c828cfdcd 100644 --- a/src/current/_includes/releases/v19.2/v19.2.6.md +++ b/src/current/_includes/releases/v19.2/v19.2.6.md @@ -71,7 +71,7 @@ $ docker pull cockroachdb/cockroach:v19.2.6 - Accesses to `/health` using a non-root authentication token no longer hang when a node is currently under load, or if a system range is unavailable. [#46477][#46477] - Fixed a race in the vectorized execution engine. [#46486][#46486] - The `cockroach debug zip` command now properly collects heap profiles. [#46482][#46482] -- The goroutine dump facility now functions properly when logging to files is disabled, e.g., via `--log-dir=""` or `--logtostderr`. [#46482][#46482] +- The goroutine dump facility now functions properly when logging to files is disabled, e.g., via `--log-dir=` or `--logtostderr`. [#46482][#46482] - Fixed a bug where the vectorized engine could sometimes give an incorrect result when reading from interleaved parents or children. [#46495][#46495] - Fixed an internal error that could occur when an aggregate inside the right-hand side of a `LATERAL` join was scoped at the level of the left-hand side. [#46544][#46544] - Fixed an error that incorrectly occurred when an aggregate was used inside the `WHERE` or `ON` clause of a [subquery](https://www.cockroachlabs.com/docs/v19.2/subqueries) but was scoped at an outer level of the query. [#46544][#46544] diff --git a/src/current/_includes/releases/v20.1/v20.1.0-rc.1.md b/src/current/_includes/releases/v20.1/v20.1.0-rc.1.md index c7ce5b04127..f75f28293a2 100644 --- a/src/current/_includes/releases/v20.1/v20.1.0-rc.1.md +++ b/src/current/_includes/releases/v20.1/v20.1.0-rc.1.md @@ -93,7 +93,7 @@ $ docker pull cockroachdb/cockroach-unstable:v20.1.0-rc.1 - Fixed incorrect query results in some corner cases involving variance/stddev/corr. [#46436][#46436] - Fixed an internal error or incorrect evaluation of check constraints in certain cases involving `UPSERT` and foreign key checks. [#46409][#46409] - `cockroach debug zip` now properly collects heap profiles. [#46469][#46469] -- The goroutine dump facility now functions properly when logging to files is disabled, e.g., via `--log-dir=""` or `--logtostderr`. [#46469][#46469] +- The goroutine dump facility now functions properly when logging to files is disabled, e.g., via `--log-dir=` or `--logtostderr`. [#46469][#46469] - Fixed an internal error that could occur during planning for some queries with a join and negative `LIMIT`. [#46440][#46440] - Fixed a bug where the vectorized engine could sometimes give an incorrect result when reading from interleaved parents or children. [#46456][#46456] - Fixed a bug where the vectorized engine would throw an internal error when executing a query that utilized an inverted index. [#46267][#46267] diff --git a/src/current/_includes/v1.0/misc/logging-flags.md b/src/current/_includes/v1.0/misc/logging-flags.md index fbcaa7cabe7..756d5f920cf 100644 --- a/src/current/_includes/v1.0/misc/logging-flags.md +++ b/src/current/_includes/v1.0/misc/logging-flags.md @@ -1,8 +1,8 @@ Flag | Description -----|------------ -`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-dir-max-size` | After the log directory reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-dir-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | Only writes messages to log files if they are at or above the specified [severity level](debug-and-error-logs.html#severity-levels), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` `--logtostderr` | Enable logging to `stderr` for messages at or above the specified [severity level](debug-and-error-logs.html#severity-levels), such as `--logtostderr=ERROR`

If you use this flag without specifying the severity level (e.g., `cockroach start --logtostderr`), it prints messages of *all* severities to `stderr`.

Setting `--logtostderr=NONE` disables logging to `stderr`. -`--no-color` | Do not colorize `stderr`. Possible values: `true` or `false`.

When set to `false`, messages logged to `stderr` are colorized based on [severity level](debug-and-error-logs.html#severity-levels).

**Default:** `false` \ No newline at end of file +`--no-color` | Do not colorize `stderr`. Possible values: `true` or `false`.

When set to `false`, messages logged to `stderr` are colorized based on [severity level](debug-and-error-logs.html#severity-levels).

**Default:** `false` diff --git a/src/current/_includes/v1.1/misc/logging-flags.md b/src/current/_includes/v1.1/misc/logging-flags.md index fbcaa7cabe7..756d5f920cf 100644 --- a/src/current/_includes/v1.1/misc/logging-flags.md +++ b/src/current/_includes/v1.1/misc/logging-flags.md @@ -1,8 +1,8 @@ Flag | Description -----|------------ -`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-dir-max-size` | After the log directory reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-dir-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | Only writes messages to log files if they are at or above the specified [severity level](debug-and-error-logs.html#severity-levels), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` `--logtostderr` | Enable logging to `stderr` for messages at or above the specified [severity level](debug-and-error-logs.html#severity-levels), such as `--logtostderr=ERROR`

If you use this flag without specifying the severity level (e.g., `cockroach start --logtostderr`), it prints messages of *all* severities to `stderr`.

Setting `--logtostderr=NONE` disables logging to `stderr`. -`--no-color` | Do not colorize `stderr`. Possible values: `true` or `false`.

When set to `false`, messages logged to `stderr` are colorized based on [severity level](debug-and-error-logs.html#severity-levels).

**Default:** `false` \ No newline at end of file +`--no-color` | Do not colorize `stderr`. Possible values: `true` or `false`.

When set to `false`, messages logged to `stderr` are colorized based on [severity level](debug-and-error-logs.html#severity-levels).

**Default:** `false` diff --git a/src/current/_includes/v19.1/misc/logging-flags.md b/src/current/_includes/v19.1/misc/logging-flags.md index 02a800a54bb..06af86228ee 100644 --- a/src/current/_includes/v19.1/misc/logging-flags.md +++ b/src/current/_includes/v19.1/misc/logging-flags.md @@ -1,6 +1,6 @@ Flag | Description -----|------------ -`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-dir-max-size` | After the log directory reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-dir-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | Only writes messages to log files if they are at or above the specified [severity level](debug-and-error-logs.html#severity-levels), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` diff --git a/src/current/_includes/v19.2/misc/logging-flags.md b/src/current/_includes/v19.2/misc/logging-flags.md index 2c717560d8c..67233c50834 100644 --- a/src/current/_includes/v19.2/misc/logging-flags.md +++ b/src/current/_includes/v19.2/misc/logging-flags.md @@ -1,6 +1,6 @@ Flag | Description -----|------------ -`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-dir-max-size` | After the log directory reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-dir-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | Only writes messages to log files if they are at or above the specified [severity level](debug-and-error-logs.html#severity-levels), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` diff --git a/src/current/_includes/v2.0/misc/logging-flags.md b/src/current/_includes/v2.0/misc/logging-flags.md index 02a800a54bb..06af86228ee 100644 --- a/src/current/_includes/v2.0/misc/logging-flags.md +++ b/src/current/_includes/v2.0/misc/logging-flags.md @@ -1,6 +1,6 @@ Flag | Description -----|------------ -`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-dir-max-size` | After the log directory reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-dir-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | Only writes messages to log files if they are at or above the specified [severity level](debug-and-error-logs.html#severity-levels), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` diff --git a/src/current/_includes/v2.1/misc/logging-flags.md b/src/current/_includes/v2.1/misc/logging-flags.md index 02a800a54bb..06af86228ee 100644 --- a/src/current/_includes/v2.1/misc/logging-flags.md +++ b/src/current/_includes/v2.1/misc/logging-flags.md @@ -1,6 +1,6 @@ Flag | Description -----|------------ -`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-dir-max-size` | After the log directory reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-dir-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | Only writes messages to log files if they are at or above the specified [severity level](debug-and-error-logs.html#severity-levels), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` diff --git a/src/current/_includes/v20.1/misc/logging-flags.md b/src/current/_includes/v20.1/misc/logging-flags.md index 2c717560d8c..67233c50834 100644 --- a/src/current/_includes/v20.1/misc/logging-flags.md +++ b/src/current/_includes/v20.1/misc/logging-flags.md @@ -1,6 +1,6 @@ Flag | Description -----|------------ -`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-dir-max-size` | After the log directory reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-dir-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | Only writes messages to log files if they are at or above the specified [severity level](debug-and-error-logs.html#severity-levels), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` diff --git a/src/current/_includes/v20.2/misc/logging-flags.md b/src/current/_includes/v20.2/misc/logging-flags.md index e4fdf161d1a..b9dcf2b025a 100644 --- a/src/current/_includes/v20.2/misc/logging-flags.md +++ b/src/current/_includes/v20.2/misc/logging-flags.md @@ -1,6 +1,6 @@ Flag | Description -----|------------ -`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | Enable logging to files and write logs to the specified directory.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-dir-max-size` | **Deprecated.** Use `--log-group-max-size`. `--log-group-max-size` | After the logging group (i.e., `cockroach`, `cockroach-sql-audit`, `cockroach-auth`, `cockroach-sql-exec`, `cockroach-pebble`, `cockroach-rocksdb`) reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-group-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB diff --git a/src/current/_includes/v21.1/misc/logging-flags.md b/src/current/_includes/v21.1/misc/logging-flags.md index 42dcfd57537..63c1aa396d8 100644 --- a/src/current/_includes/v21.1/misc/logging-flags.md +++ b/src/current/_includes/v21.1/misc/logging-flags.md @@ -2,7 +2,7 @@ Flag | Description -----|------------ `--log` | **New in v21.1:** Configure logging parameters by specifying a YAML payload. For details, see [Configure logs](configure-logs.html#flag). If a YAML configuration is not specified, the [default configuration](configure-logs.html#default-logging-configuration) is used.

`--log-config-file` can also be used.

**Note:** The deprecated logging flags below cannot be combined with `--log`, and can be defined instead in the YAML payload. `--log-config-file` | **New in v21.1:** Configure logging parameters by specifying a path to a YAML file. For details, see [Configure logs](configure-logs.html#flag). If a YAML configuration is not specified, the [default configuration](configure-logs.html#default-logging-configuration) is used.

`--log` can also be used.

**Note:** The deprecated logging flags below cannot be combined with `--log-config-file`, and can be defined instead in the YAML payload. -`--log-dir` | **Deprecated.** To enable logging to files and write logs to the specified directory, use [`--log`](configure-logs.html#flag) and set `dir` in the YAML configuration.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | **Deprecated.** To enable logging to files and write logs to the specified directory, use [`--log`](configure-logs.html#flag) and set `dir` in the YAML configuration.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-group-max-size` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. After the logging group (i.e., `cockroach`, `cockroach-sql-audit`, `cockroach-auth`, `cockroach-sql-exec`, `cockroach-pebble`) reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-group-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. Only writes messages to log files if they are at or above the specified [severity level](logging.html#logging-levels-severities), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` diff --git a/src/current/_includes/v21.2/misc/logging-flags.md b/src/current/_includes/v21.2/misc/logging-flags.md index a443423cfec..eaadb6c8ddb 100644 --- a/src/current/_includes/v21.2/misc/logging-flags.md +++ b/src/current/_includes/v21.2/misc/logging-flags.md @@ -2,7 +2,7 @@ Flag | Description -----|------------ `--log` | Configure logging parameters by specifying a YAML payload. For details, see [Configure logs](configure-logs.html#flag). If a YAML configuration is not specified, the [default configuration](configure-logs.html#default-logging-configuration) is used.

`--log-config-file` can also be used.

**Note:** The deprecated logging flags below cannot be combined with `--log`, and can be defined instead in the YAML payload. `--log-config-file` | Configure logging parameters by specifying a path to a YAML file. For details, see [Configure logs](configure-logs.html#flag). If a YAML configuration is not specified, the [default configuration](configure-logs.html#default-logging-configuration) is used.

`--log` can also be used.

**Note:** The deprecated logging flags below cannot be combined with `--log-config-file`, and can be defined instead in the YAML payload. -`--log-dir` | **Deprecated.** To enable logging to files and write logs to the specified directory, use [`--log`](configure-logs.html#flag) and set `dir` in the YAML configuration.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | **Deprecated.** To enable logging to files and write logs to the specified directory, use [`--log`](configure-logs.html#flag) and set `dir` in the YAML configuration.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-group-max-size` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. After the logging group (i.e., `cockroach`, `cockroach-sql-audit`, `cockroach-auth`, `cockroach-sql-exec`, `cockroach-pebble`) reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-group-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. Only writes messages to log files if they are at or above the specified [severity level](logging.html#logging-levels-severities), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` diff --git a/src/current/_includes/v22.1/misc/logging-flags.md b/src/current/_includes/v22.1/misc/logging-flags.md index a443423cfec..eaadb6c8ddb 100644 --- a/src/current/_includes/v22.1/misc/logging-flags.md +++ b/src/current/_includes/v22.1/misc/logging-flags.md @@ -2,7 +2,7 @@ Flag | Description -----|------------ `--log` | Configure logging parameters by specifying a YAML payload. For details, see [Configure logs](configure-logs.html#flag). If a YAML configuration is not specified, the [default configuration](configure-logs.html#default-logging-configuration) is used.

`--log-config-file` can also be used.

**Note:** The deprecated logging flags below cannot be combined with `--log`, and can be defined instead in the YAML payload. `--log-config-file` | Configure logging parameters by specifying a path to a YAML file. For details, see [Configure logs](configure-logs.html#flag). If a YAML configuration is not specified, the [default configuration](configure-logs.html#default-logging-configuration) is used.

`--log` can also be used.

**Note:** The deprecated logging flags below cannot be combined with `--log-config-file`, and can be defined instead in the YAML payload. -`--log-dir` | **Deprecated.** To enable logging to files and write logs to the specified directory, use [`--log`](configure-logs.html#flag) and set `dir` in the YAML configuration.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | **Deprecated.** To enable logging to files and write logs to the specified directory, use [`--log`](configure-logs.html#flag) and set `dir` in the YAML configuration.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-group-max-size` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. After the logging group (i.e., `cockroach`, `cockroach-sql-audit`, `cockroach-auth`, `cockroach-sql-exec`, `cockroach-pebble`) reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-group-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. Only writes messages to log files if they are at or above the specified [severity level](logging.html#logging-levels-severities), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` diff --git a/src/current/_includes/v22.2/misc/logging-flags.md b/src/current/_includes/v22.2/misc/logging-flags.md index a443423cfec..eaadb6c8ddb 100644 --- a/src/current/_includes/v22.2/misc/logging-flags.md +++ b/src/current/_includes/v22.2/misc/logging-flags.md @@ -2,7 +2,7 @@ Flag | Description -----|------------ `--log` | Configure logging parameters by specifying a YAML payload. For details, see [Configure logs](configure-logs.html#flag). If a YAML configuration is not specified, the [default configuration](configure-logs.html#default-logging-configuration) is used.

`--log-config-file` can also be used.

**Note:** The deprecated logging flags below cannot be combined with `--log`, and can be defined instead in the YAML payload. `--log-config-file` | Configure logging parameters by specifying a path to a YAML file. For details, see [Configure logs](configure-logs.html#flag). If a YAML configuration is not specified, the [default configuration](configure-logs.html#default-logging-configuration) is used.

`--log` can also be used.

**Note:** The deprecated logging flags below cannot be combined with `--log-config-file`, and can be defined instead in the YAML payload. -`--log-dir` | **Deprecated.** To enable logging to files and write logs to the specified directory, use [`--log`](configure-logs.html#flag) and set `dir` in the YAML configuration.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | **Deprecated.** To enable logging to files and write logs to the specified directory, use [`--log`](configure-logs.html#flag) and set `dir` in the YAML configuration.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-group-max-size` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. After the logging group (i.e., `cockroach`, `cockroach-sql-audit`, `cockroach-auth`, `cockroach-sql-exec`, `cockroach-pebble`) reaches the specified size, delete the oldest log file. The flag's argument takes standard file sizes, such as `--log-group-max-size=1GiB`.

**Default**: 100MiB `--log-file-max-size` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. After logs reach the specified size, begin writing logs to a new file. The flag's argument takes standard file sizes, such as `--log-file-max-size=2MiB`.

**Default**: 10MiB `--log-file-verbosity` | **Deprecated.** This is now configured with [`--log`](configure-logs.html#flag) or [`--log-config-file`](configure-logs.html#flag) and a YAML payload. Only writes messages to log files if they are at or above the specified [severity level](logging.html#logging-levels-severities), such as `--log-file-verbosity=WARNING`. **Requires** logging to files.

**Default**: `INFO` diff --git a/src/current/_includes/v23.1/misc/logging-flags.md b/src/current/_includes/v23.1/misc/logging-flags.md index acb18726756..68106413559 100644 --- a/src/current/_includes/v23.1/misc/logging-flags.md +++ b/src/current/_includes/v23.1/misc/logging-flags.md @@ -2,7 +2,7 @@ Flag | Description -----|------------ `--log` | Configure logging parameters by specifying a YAML payload. For details, see [Configure logs]({% link {{ page.version.version }}/configure-logs.md %}#flag). If a YAML configuration is not specified, the [default configuration]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration) is used.

`--log-config-file` can also be used.

**Note:** The logging flags below cannot be combined with `--log`, but can be defined instead in the YAML payload. `--log-config-file` | Configure logging parameters by specifying a path to a YAML file. For details, see [Configure logs]({% link {{ page.version.version }}/configure-logs.md %}#flag). If a YAML configuration is not specified, the [default configuration]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration) is used.

`--log` can also be used.

**Note:** The logging flags below cannot be combined with `--log-config-file`, but can be defined instead in the YAML file. -`--log-dir` | An alias for the [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag) flag, for configuring the log directory where log files are stored and written to. Specifically, `--log-dir=XXX` is an alias for `--log='file-defaults: {dir: XXX}'`.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | An alias for the [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag) flag, for configuring the log directory where log files are stored and written to. Specifically, `--log-dir=XXX` is an alias for `--log='file-defaults: {dir: XXX}'`.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-group-max-size` | An alias for the [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag) flag, for configuring the maximum size for a logging group (for example, `cockroach`, `cockroach-sql-audit`, `cockroach-auth`, `cockroach-sql-exec`, `cockroach-pebble`), after which the oldest log file is deleted. `--log-group-max-size=XXX` is an alias for `--log='file-defaults: {max-group-size: XXX}'`. Accepts a valid file size, such as `--log-group-max-size=1GiB`.

**Default:** `100MiB` `--log-file-max-size` | An alias for [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag), used to specify the maximum size that a log file can grow before a new log file is created. `--log-file-max-size=XXX` is an alias for `--log='file-defaults: {max-file-size: XXX}'`. Accepts a valid file size, such as `--log-file-max-size=2MiB`. **Requires** logging to files.

**Default:** `10MiB` `--log-file-verbosity` | An alias for [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag), used to specify the minimum [severity level]({% link {{ page.version.version }}/logging.md %}#logging-levels-severities) of messages that are logged. `--log-file-verbosity=XXX` is an alias for `--log='file-defaults: {filter: XXX}'`. When a severity is specified, such as `--log-file-verbosity=WARNING`, log messages that are below the specified severity level are not written to the target log file. **Requires** logging to files.

**Default:** `INFO` diff --git a/src/current/_includes/v23.2/misc/logging-flags.md b/src/current/_includes/v23.2/misc/logging-flags.md index acb18726756..68106413559 100644 --- a/src/current/_includes/v23.2/misc/logging-flags.md +++ b/src/current/_includes/v23.2/misc/logging-flags.md @@ -2,7 +2,7 @@ Flag | Description -----|------------ `--log` | Configure logging parameters by specifying a YAML payload. For details, see [Configure logs]({% link {{ page.version.version }}/configure-logs.md %}#flag). If a YAML configuration is not specified, the [default configuration]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration) is used.

`--log-config-file` can also be used.

**Note:** The logging flags below cannot be combined with `--log`, but can be defined instead in the YAML payload. `--log-config-file` | Configure logging parameters by specifying a path to a YAML file. For details, see [Configure logs]({% link {{ page.version.version }}/configure-logs.md %}#flag). If a YAML configuration is not specified, the [default configuration]({% link {{ page.version.version }}/configure-logs.md %}#default-logging-configuration) is used.

`--log` can also be used.

**Note:** The logging flags below cannot be combined with `--log-config-file`, but can be defined instead in the YAML file. -`--log-dir` | An alias for the [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag) flag, for configuring the log directory where log files are stored and written to. Specifically, `--log-dir=XXX` is an alias for `--log='file-defaults: {dir: XXX}'`.

Setting `--log-dir` to a blank directory (`--log-dir=""`) disables logging to files. +`--log-dir` | An alias for the [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag) flag, for configuring the log directory where log files are stored and written to. Specifically, `--log-dir=XXX` is an alias for `--log='file-defaults: {dir: XXX}'`.

Setting `--log-dir` to a blank directory (`--log-dir=`) disables logging to files. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. `--log-group-max-size` | An alias for the [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag) flag, for configuring the maximum size for a logging group (for example, `cockroach`, `cockroach-sql-audit`, `cockroach-auth`, `cockroach-sql-exec`, `cockroach-pebble`), after which the oldest log file is deleted. `--log-group-max-size=XXX` is an alias for `--log='file-defaults: {max-group-size: XXX}'`. Accepts a valid file size, such as `--log-group-max-size=1GiB`.

**Default:** `100MiB` `--log-file-max-size` | An alias for [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag), used to specify the maximum size that a log file can grow before a new log file is created. `--log-file-max-size=XXX` is an alias for `--log='file-defaults: {max-file-size: XXX}'`. Accepts a valid file size, such as `--log-file-max-size=2MiB`. **Requires** logging to files.

**Default:** `10MiB` `--log-file-verbosity` | An alias for [`--log`]({% link {{ page.version.version }}/configure-logs.md %}#flag), used to specify the minimum [severity level]({% link {{ page.version.version }}/logging.md %}#logging-levels-severities) of messages that are logged. `--log-file-verbosity=XXX` is an alias for `--log='file-defaults: {filter: XXX}'`. When a severity is specified, such as `--log-file-verbosity=WARNING`, log messages that are below the specified severity level are not written to the target log file. **Requires** logging to files.

**Default:** `INFO` diff --git a/src/current/v1.0/debug-and-error-logs.md b/src/current/v1.0/debug-and-error-logs.md index 46958e4d09f..ea88ea5caca 100644 --- a/src/current/v1.0/debug-and-error-logs.md +++ b/src/current/v1.0/debug-and-error-logs.md @@ -63,7 +63,7 @@ Default File Destination | `[first `[`store`](start-a-node.html#store)` dir]/log Change File Destination | `--log-dir=[destination]` | `--log-dir=[destination]` Default Severity Level Threshold | `INFO` | *N/A* Change Severity Threshold | `--log-file-verbosity=[severity level]` | `--log-file-verbosity=[severity level]` -Disabled by | `--log-dir=""`1 | Default +Disabled by | `--log-dir=`1 | Default {{site.data.alerts.callout_info}}1 If the cockroach process does not have access to on-disk storage, cockroach start does not write messages to log files; instead it prints all messages to stderr.{{site.data.alerts.end}} diff --git a/src/current/v1.1/debug-and-error-logs.md b/src/current/v1.1/debug-and-error-logs.md index abbd303f95d..66314a6b00c 100644 --- a/src/current/v1.1/debug-and-error-logs.md +++ b/src/current/v1.1/debug-and-error-logs.md @@ -69,7 +69,7 @@ Default File Destination | `[first `[`store`](start-a-node.html#store)` dir]/log Change File Destination | `--log-dir=[destination]` | `--log-dir=[destination]` Default Severity Level Threshold | `INFO` | *N/A* Change Severity Threshold | `--log-file-verbosity=[severity level]` | `--log-file-verbosity=[severity level]` -Disabled by | `--log-dir=""`1 | Default +Disabled by | `--log-dir=`1 | Default {{site.data.alerts.callout_info}}1 If the cockroach process does not have access to on-disk storage, cockroach start does not write messages to log files; instead it prints all messages to stderr.{{site.data.alerts.end}} diff --git a/src/current/v19.1/debug-and-error-logs.md b/src/current/v19.1/debug-and-error-logs.md index ed0f2d9e682..93ec0e6da10 100644 --- a/src/current/v19.1/debug-and-error-logs.md +++ b/src/current/v19.1/debug-and-error-logs.md @@ -73,7 +73,7 @@ Default File Destination | `[first `[`store`](start-a-node.html#store)` dir]/log Change File Destination | `--log-dir=[destination]` | `--log-dir=[destination]` Default Severity Level Threshold | `INFO` | *N/A* Change Severity Threshold | `--log-file-verbosity=[severity level]` | `--log-file-verbosity=[severity level]` -Disabled by | `--log-dir=""`1 | Default +Disabled by | `--log-dir=`1 | Default {{site.data.alerts.callout_info}}1 If the cockroach process does not have access to on-disk storage, cockroach start does not write messages to log files; instead it prints all messages to stderr.{{site.data.alerts.end}} diff --git a/src/current/v19.2/debug-and-error-logs.md b/src/current/v19.2/debug-and-error-logs.md index 18e8e85050c..7a7d28192c2 100644 --- a/src/current/v19.2/debug-and-error-logs.md +++ b/src/current/v19.2/debug-and-error-logs.md @@ -68,7 +68,7 @@ Default File Destination | `[first `[`store`](cockroach-start.html#store)` dir]/ Change File Destination | `--log-dir=[destination]` | `--log-dir=[destination]` Default Severity Level Threshold | `INFO` | *N/A* Change Severity Threshold | `--log-file-verbosity=[severity level]` | `--log-file-verbosity=[severity level]` -Disabled by | `--log-dir=""`1 | Default +Disabled by | `--log-dir=`1 | Default {{site.data.alerts.callout_info}}1 If the cockroach process does not have access to on-disk storage, cockroach start does not write messages to log files; instead it prints all messages to stderr.{{site.data.alerts.end}} diff --git a/src/current/v2.0/debug-and-error-logs.md b/src/current/v2.0/debug-and-error-logs.md index 65e5ef7de69..83c5c259b16 100644 --- a/src/current/v2.0/debug-and-error-logs.md +++ b/src/current/v2.0/debug-and-error-logs.md @@ -73,7 +73,7 @@ Default File Destination | `[first `[`store`](start-a-node.html#store)` dir]/log Change File Destination | `--log-dir=[destination]` | `--log-dir=[destination]` Default Severity Level Threshold | `INFO` | *N/A* Change Severity Threshold | `--log-file-verbosity=[severity level]` | `--log-file-verbosity=[severity level]` -Disabled by | `--log-dir=""`1 | Default +Disabled by | `--log-dir=`1 | Default {{site.data.alerts.callout_info}}1 If the cockroach process does not have access to on-disk storage, cockroach start does not write messages to log files; instead it prints all messages to stderr.{{site.data.alerts.end}} diff --git a/src/current/v2.1/debug-and-error-logs.md b/src/current/v2.1/debug-and-error-logs.md index ed0f2d9e682..93ec0e6da10 100644 --- a/src/current/v2.1/debug-and-error-logs.md +++ b/src/current/v2.1/debug-and-error-logs.md @@ -73,7 +73,7 @@ Default File Destination | `[first `[`store`](start-a-node.html#store)` dir]/log Change File Destination | `--log-dir=[destination]` | `--log-dir=[destination]` Default Severity Level Threshold | `INFO` | *N/A* Change Severity Threshold | `--log-file-verbosity=[severity level]` | `--log-file-verbosity=[severity level]` -Disabled by | `--log-dir=""`1 | Default +Disabled by | `--log-dir=`1 | Default {{site.data.alerts.callout_info}}1 If the cockroach process does not have access to on-disk storage, cockroach start does not write messages to log files; instead it prints all messages to stderr.{{site.data.alerts.end}} diff --git a/src/current/v20.1/debug-and-error-logs.md b/src/current/v20.1/debug-and-error-logs.md index 5beef97eb2d..969ad121837 100644 --- a/src/current/v20.1/debug-and-error-logs.md +++ b/src/current/v20.1/debug-and-error-logs.md @@ -77,7 +77,7 @@ Default File Destination | `[first `[`store`](cockroach-start.html#store)` dir]/ Change File Destination | `--log-dir=[destination]` | `--log-dir=[destination]` Default Severity Level Threshold | `INFO` | *N/A* Change Severity Threshold | `--log-file-verbosity=[severity level]` | `--log-file-verbosity=[severity level]` -Disabled by | `--log-dir=""`1 | Default +Disabled by | `--log-dir=`1 | Default {{site.data.alerts.callout_info}} 1 If the `cockroach` process does not have access to on-disk storage, `cockroach start` does not write messages to log files; instead it prints all messages to `stderr`. diff --git a/src/current/v20.2/debug-and-error-logs.md b/src/current/v20.2/debug-and-error-logs.md index 952482ef798..888542e02e5 100644 --- a/src/current/v20.2/debug-and-error-logs.md +++ b/src/current/v20.2/debug-and-error-logs.md @@ -77,7 +77,7 @@ Default File Destination | `[first `[`store`](cockroach-start.html#store)` dir]/ Change File Destination | `--log-dir=[destination]` | `--log-dir=[destination]` Default Severity Level Threshold | `INFO` | *N/A* Change Severity Threshold | `--log-file-verbosity=[severity level]` | `--log-file-verbosity=[severity level]` -Disabled by | `--log-dir=""`1 | Default +Disabled by | `--log-dir=`1 | Default {{site.data.alerts.callout_info}} 1 If the `cockroach` process does not have access to on-disk storage, `cockroach start` does not write messages to log files; instead it prints all messages to `stderr`. diff --git a/src/current/v22.1/configure-logs.md b/src/current/v22.1/configure-logs.md index 7658b998a3f..526b236eff9 100644 --- a/src/current/v22.1/configure-logs.md +++ b/src/current/v22.1/configure-logs.md @@ -21,6 +21,8 @@ To configure the logging behavior of a `cockroach` command, include one of these - `--log={yaml}`, where `{yaml}` is the [YAML payload](#yaml-payload) - `--log-config-file={yaml-file}`, where `{yaml-file}` is the path to a YAML file +To disable logging, set `--log-dir` to a blank directory (`--log-dir=`) instead of using one of the other logging flags. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. + {{site.data.alerts.callout_success}} All [`cockroach` commands](cockroach-commands.html) support logging and can be configured with `--log` or `--log-config-file`. However, note that most messages related to cluster operation are generated by [`cockroach start`](cockroach-start.html) or [`cockroach start-single-node`](cockroach-start-single-node.html). Other commands generate messages related to their own execution, which are mainly useful when troubleshooting the behaviors of those commands. {{site.data.alerts.end}} diff --git a/src/current/v22.2/configure-logs.md b/src/current/v22.2/configure-logs.md index acd09b98bba..1e30272258a 100644 --- a/src/current/v22.2/configure-logs.md +++ b/src/current/v22.2/configure-logs.md @@ -22,6 +22,8 @@ To configure the logging behavior of a `cockroach` command, include one of these - `--log={yaml}`, where `{yaml}` is the [YAML payload](#yaml-payload) - `--log-config-file={yaml-file}`, where `{yaml-file}` is the path to a YAML file +To disable logging, set `--log-dir` to a blank directory (`--log-dir=`) instead of using one of the other logging flags. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. + {{site.data.alerts.callout_success}} All [`cockroach` commands](cockroach-commands.html) support logging and can be configured with `--log` or `--log-config-file`. However, note that most messages related to cluster operation are generated by [`cockroach start`](cockroach-start.html) or [`cockroach start-single-node`](cockroach-start-single-node.html). Other commands generate messages related to their own execution, which are mainly useful when troubleshooting the behaviors of those commands. {{site.data.alerts.end}} diff --git a/src/current/v23.1/configure-logs.md b/src/current/v23.1/configure-logs.md index 90260646856..ac568571d5d 100644 --- a/src/current/v23.1/configure-logs.md +++ b/src/current/v23.1/configure-logs.md @@ -22,6 +22,8 @@ To configure the logging behavior of a `cockroach` command, include one of these - `--log={yaml}`, where `{yaml}` is the [YAML payload](#yaml-payload) - `--log-config-file={yaml-file}`, where `{yaml-file}` is the path to a YAML file +To disable logging, set `--log-dir` to a blank directory (`--log-dir=`) instead of using one of the other logging flags. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. + {{site.data.alerts.callout_success}} All [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands.md %}) support logging and can be configured with `--log` or `--log-config-file`. However, note that most messages related to cluster operation are generated by [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) or [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}). Other commands generate messages related to their own execution, which are mainly useful when troubleshooting the behaviors of those commands. {{site.data.alerts.end}} diff --git a/src/current/v23.2/configure-logs.md b/src/current/v23.2/configure-logs.md index 1bd99283dff..41e22e42ba2 100644 --- a/src/current/v23.2/configure-logs.md +++ b/src/current/v23.2/configure-logs.md @@ -22,6 +22,8 @@ To configure the logging behavior of a `cockroach` command, include one of these - `--log={yaml}`, where `{yaml}` is the [YAML payload](#yaml-payload) - `--log-config-file={yaml-file}`, where `{yaml-file}` is the path to a YAML file +To disable logging, set `--log-dir` to a blank directory (`--log-dir=`) instead of using one of the other logging flags. Do not use `--log-dir=""`; this creates a new directory named `""` and stores log files in that directory. + {{site.data.alerts.callout_success}} All [`cockroach` commands]({% link {{ page.version.version }}/cockroach-commands.md %}) support logging and can be configured with `--log` or `--log-config-file`. However, note that most messages related to cluster operation are generated by [`cockroach start`]({% link {{ page.version.version }}/cockroach-start.md %}) or [`cockroach start-single-node`]({% link {{ page.version.version }}/cockroach-start-single-node.md %}). Other commands generate messages related to their own execution, which are mainly useful when troubleshooting the behaviors of those commands. {{site.data.alerts.end}} @@ -486,7 +488,7 @@ sinks: ### Set timezone -{% include_cached new-in.html version="v23.2" %} Using the `format-options` sink parameter, you may set the timezone for a specified log format. +{% include_cached new-in.html version="v23.2" %} Using the `format-options` sink parameter, you may set the timezone for a specified log format. #### `timezone` for text formats