From b1ac5ebc566886b4bb187db86a402da4e29da79d Mon Sep 17 00:00:00 2001 From: cpjulia Date: Mon, 20 Sep 2021 18:24:44 -0300 Subject: [PATCH 01/17] Added documentation for feature/escaping-unicode-control-chars --- 3.9/programs-arangod-log.md | 40 +++++++++++++++++------------ 3.9/release-notes-new-features39.md | 29 +++++++++++++++++++++ 2 files changed, 53 insertions(+), 16 deletions(-) diff --git a/3.9/programs-arangod-log.md b/3.9/programs-arangod-log.md index 7690d893bb..09026a8fb9 100644 --- a/3.9/programs-arangod-log.md +++ b/3.9/programs-arangod-log.md @@ -141,27 +141,35 @@ Format | Example | Description ## Escaping -`--log.escape value` - -This option toggles the escaping of log output. - -If set to `true`, the following characters in the log output are escaped: - -- the carriage return character (hex `0d`) -- the newline character (hex `0a`) -- the tabstop character (hex `09`) -- any other characters with an ordinal value less than hex `20` - -If the option is set to `false`, no characters are escaped. Characters with -an ordinal value less than hex `20` will not be printed in this mode but will -be replaced with a space character (hex `20`). +There are two flags for retaining or escaping control and unicode +characters in the log. The flag `log.escape` is deprecated and, instead, +the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` +should be used. + +- `--log.escape-control-chars`: this flag applies to the control characters, which have hex code below `\x20`, and also the character DEL, with hex code of `\x7f`. When its value is set to false, the control +character will be retained, and its actual value will be displayed when it +is a visible character, or a space ` ` character will be displayed if it is +not a visible character. The same will happen to `DEL` character (code `\xF7`), +even though it is not a control character, because it is not visible. For example, +control characer `\n` is visible, so a `\n` will be displayed in the log, and +control character `BEL` is not visible, so a space ` ` would be displayed. +When its value is set to true, the hex code for the character is displayed, for +example, `BEL` character would be displayed as its hex code, `\x07`. + The default value for this flag is `true` for compatibility with +previous versions. + +- `--log.escape-unicode-chars`: when its value is set to false, the unicode character +will be retained, and its actual value will be displayed. For example, `犬` will +be displayed as `犬`. When its value is set to true, the character is escaped, and +the hex code for the character is displayed. For example, `犬` would be displayed +as its hex code, `\u72AC`. + The default value for this flag is set to `false` for compatibility with +previous versions. A side effect of turning off the escaping is that it will reduce the CPU overhead for the logging. However, this will only be noticeable when logging is set to a very verbose level (e.g. debug or trace). -The default value for this option is `true`. - ## Maximum line length Introduced in: v3.7.9 diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index 2ea28fdb36..24834a5e4e 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -261,6 +261,35 @@ convention for both datacenters to avoid incompatibilities. Also see [Database Naming Conventions](data-modeling-naming-conventions-database-names.html). +### Logging + +The server now has two flags for retaining or escaping control and unicode +characters in the log. The flag `log.escape` is deprecated and, instead, +the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` +should be used. + +- `--log.escape-control-chars`: this flag applies to the control characters, which have hex code below `\x20`, and also the character DEL, with hex code of `\x7f`. When its value is set to false, the control +character will be retained, and its actual value will be displayed when it +is a visible character, or a space ` ` character will be displayed if it is +not a visible character. The same will happen to `DEL` character (code `\xF7`), +even though it is not a control character, because it is not visible. For example, +control characer `\n` is visible, so a `\n` will be displayed in the log, and +control character `BEL` is not visible, so a space ` ` would be displayed. +When its value is set to true, the hex code for the character is displayed, for +example, `BEL` character would be displayed as its hex code, `\x07`. + The default value for this flag is `true` for compatibility with +previous versions. + +- `--log.escape-unicode-chars`: when its value is set to false, the unicode character +will be retained, and its actual value will be displayed. For example, `犬` will +be displayed as `犬`. When its value is set to true, the character is escaped, and +the hex code for the character is displayed. For example, `犬` would be displayed +as its hex code, `\u72AC`. + The default value for this flag is set to `false` for compatibility with +previous versions. + +Also see [Logging](programs-arangod-log.html). + ### Version information The _arangod_ server now provides a command `--version-json` to print version From bc9fa86a56cedccd9b3c764ca2c6b93639ab9449 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Mon, 20 Sep 2021 19:10:55 -0300 Subject: [PATCH 02/17] Update 3.9/programs-arangod-log.md Co-authored-by: Jan --- 3.9/programs-arangod-log.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/3.9/programs-arangod-log.md b/3.9/programs-arangod-log.md index 09026a8fb9..2b6a15a0b2 100644 --- a/3.9/programs-arangod-log.md +++ b/3.9/programs-arangod-log.md @@ -142,7 +142,7 @@ Format | Example | Description ## Escaping There are two flags for retaining or escaping control and unicode -characters in the log. The flag `log.escape` is deprecated and, instead, +characters in the log. The flag `--log.escape` is deprecated since v3.9.0, and instead, the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` should be used. From e7990c61502f80df9a3d3519ca92f4806acd0e29 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 13:50:12 -0300 Subject: [PATCH 03/17] Update 3.9/programs-arangod-log.md Co-authored-by: Jan --- 3.9/programs-arangod-log.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/3.9/programs-arangod-log.md b/3.9/programs-arangod-log.md index 2b6a15a0b2..062fb5ccf1 100644 --- a/3.9/programs-arangod-log.md +++ b/3.9/programs-arangod-log.md @@ -146,7 +146,8 @@ characters in the log. The flag `--log.escape` is deprecated since v3.9.0, and i the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` should be used. -- `--log.escape-control-chars`: this flag applies to the control characters, which have hex code below `\x20`, and also the character DEL, with hex code of `\x7f`. When its value is set to false, the control +- `--log.escape-control-chars`: this flag applies to the control characters, which have hex codes below `\x20`, + and also the character DEL with hex code `\x7f`. When the flag value is set to `false`, control character will be retained, and its actual value will be displayed when it is a visible character, or a space ` ` character will be displayed if it is not a visible character. The same will happen to `DEL` character (code `\xF7`), From 08d0dcd417ca5da7a4d97abddefeda95ff37a266 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 13:50:34 -0300 Subject: [PATCH 04/17] Update 3.9/programs-arangod-log.md Co-authored-by: Jan --- 3.9/programs-arangod-log.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/3.9/programs-arangod-log.md b/3.9/programs-arangod-log.md index 062fb5ccf1..3256f8a5ab 100644 --- a/3.9/programs-arangod-log.md +++ b/3.9/programs-arangod-log.md @@ -148,15 +148,13 @@ should be used. - `--log.escape-control-chars`: this flag applies to the control characters, which have hex codes below `\x20`, and also the character DEL with hex code `\x7f`. When the flag value is set to `false`, control -character will be retained, and its actual value will be displayed when it -is a visible character, or a space ` ` character will be displayed if it is -not a visible character. The same will happen to `DEL` character (code `\xF7`), -even though it is not a control character, because it is not visible. For example, -control characer `\n` is visible, so a `\n` will be displayed in the log, and -control character `BEL` is not visible, so a space ` ` would be displayed. -When its value is set to true, the hex code for the character is displayed, for -example, `BEL` character would be displayed as its hex code, `\x07`. - The default value for this flag is `true` for compatibility with +characters will be retained when they have a visible representation, and replaced +with a space character in case they don't have a visible representation. For example, +the control characer `\n` is visible, so a `\n` will be displayed in the log. Contrary, +the control character `BEL` is not visible, so a space will be displayed instead. +When the flag value is set to `true`, the hex code for the character is displayed, for +example, the `BEL` character will be displayed as its hex code, `\x07`. +The default value for this flag is `true` to ensure compatibility with previous versions. - `--log.escape-unicode-chars`: when its value is set to false, the unicode character From c9571e6c01fd43b6889e8871901581222a126d0f Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 13:51:06 -0300 Subject: [PATCH 05/17] Update 3.9/programs-arangod-log.md Co-authored-by: Jan --- 3.9/programs-arangod-log.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/3.9/programs-arangod-log.md b/3.9/programs-arangod-log.md index 3256f8a5ab..23483b9671 100644 --- a/3.9/programs-arangod-log.md +++ b/3.9/programs-arangod-log.md @@ -158,11 +158,11 @@ The default value for this flag is `true` to ensure compatibility with previous versions. - `--log.escape-unicode-chars`: when its value is set to false, the unicode character -will be retained, and its actual value will be displayed. For example, `犬` will -be displayed as `犬`. When its value is set to true, the character is escaped, and -the hex code for the character is displayed. For example, `犬` would be displayed -as its hex code, `\u72AC`. - The default value for this flag is set to `false` for compatibility with +will be retained and written to the log as-is. For example, `犬` will +be logged as `犬`. When the flag value is set to `true`, any Unicode characters are +escaped, and the hex codes for all Unicode characters are logged instead. +For example, `犬` would be logged as its hex code, `\u72AC`. +The default value for this flag is set to `false` for compatibility with previous versions. A side effect of turning off the escaping is that it will reduce the CPU From 7b2864e9dbea99bddffc124fdf85b4f9dea17ae2 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 13:51:15 -0300 Subject: [PATCH 06/17] Update 3.9/release-notes-new-features39.md Co-authored-by: Jan --- 3.9/release-notes-new-features39.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index 24834a5e4e..24a847fe58 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -263,7 +263,7 @@ Also see [Database Naming Conventions](data-modeling-naming-conventions-database ### Logging -The server now has two flags for retaining or escaping control and unicode +The server now has two flags for retaining or escaping control and Unicode characters in the log. The flag `log.escape` is deprecated and, instead, the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` should be used. From c8f3636600b2f331505ca85590d8356b150af4b0 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 13:51:26 -0300 Subject: [PATCH 07/17] Update 3.9/release-notes-new-features39.md Co-authored-by: Jan --- 3.9/release-notes-new-features39.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index 24a847fe58..b18038ecd1 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -264,7 +264,7 @@ Also see [Database Naming Conventions](data-modeling-naming-conventions-database ### Logging The server now has two flags for retaining or escaping control and Unicode -characters in the log. The flag `log.escape` is deprecated and, instead, +characters in the log. The flag `--log.escape` is now deprecated and, instead, the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` should be used. From 9de888db958238a2693d4bb0f719c2d67a2d51a1 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 13:51:35 -0300 Subject: [PATCH 08/17] Update 3.9/release-notes-new-features39.md Co-authored-by: Jan --- 3.9/release-notes-new-features39.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index b18038ecd1..76853baaea 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -265,7 +265,7 @@ Also see [Database Naming Conventions](data-modeling-naming-conventions-database The server now has two flags for retaining or escaping control and Unicode characters in the log. The flag `--log.escape` is now deprecated and, instead, -the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` +the new flags `--log.escape-control-chars` and `--log.escape-unicode-chars` should be used. - `--log.escape-control-chars`: this flag applies to the control characters, which have hex code below `\x20`, and also the character DEL, with hex code of `\x7f`. When its value is set to false, the control From e8b54a5103b696726ab30a1799fe0f12fb4f9b73 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 13:51:51 -0300 Subject: [PATCH 09/17] Update 3.9/release-notes-new-features39.md Co-authored-by: Jan --- 3.9/release-notes-new-features39.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index 76853baaea..6b050b7dad 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -268,7 +268,8 @@ characters in the log. The flag `--log.escape` is now deprecated and, instead, the new flags `--log.escape-control-chars` and `--log.escape-unicode-chars` should be used. -- `--log.escape-control-chars`: this flag applies to the control characters, which have hex code below `\x20`, and also the character DEL, with hex code of `\x7f`. When its value is set to false, the control +- `--log.escape-control-chars`: this flag applies to control characters, which have hex codes below `\x20`, + and also the character DEL, with a hex code of `\x7f`. When the flag value is set to `false`, control character will be retained, and its actual value will be displayed when it is a visible character, or a space ` ` character will be displayed if it is not a visible character. The same will happen to `DEL` character (code `\xF7`), From c5816887bc8168c60c6e8282564994e734d914ee Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 13:52:01 -0300 Subject: [PATCH 10/17] Update 3.9/release-notes-new-features39.md Co-authored-by: Jan --- 3.9/release-notes-new-features39.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index 6b050b7dad..680c4db2d5 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -270,15 +270,14 @@ should be used. - `--log.escape-control-chars`: this flag applies to control characters, which have hex codes below `\x20`, and also the character DEL, with a hex code of `\x7f`. When the flag value is set to `false`, control -character will be retained, and its actual value will be displayed when it -is a visible character, or a space ` ` character will be displayed if it is -not a visible character. The same will happen to `DEL` character (code `\xF7`), -even though it is not a control character, because it is not visible. For example, -control characer `\n` is visible, so a `\n` will be displayed in the log, and -control character `BEL` is not visible, so a space ` ` would be displayed. -When its value is set to true, the hex code for the character is displayed, for -example, `BEL` character would be displayed as its hex code, `\x07`. - The default value for this flag is `true` for compatibility with +characters that have a visual representation will be retained and logged as-is. +Controls characters without a visual representation will be replaced by a space +character in the log. The same will happen to the `DEL` character (code `\x7f`), +For example, the control characer `\n` is visible, so a `\n` will be displayed in +the log, and the control character `BEL` is not visible, so a space will be displayed. +When the flag value is set to `true`, the hex code for the character is logged. For +example, the `BEL` character will be displayed as its hex code, `\x07`. +The default value for this flag is `true` for compatibility with previous versions. - `--log.escape-unicode-chars`: when its value is set to false, the unicode character From 9b8a20b1b60a1c0a712d2113c5ce39cddc012b1b Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 13:52:16 -0300 Subject: [PATCH 11/17] Update 3.9/release-notes-new-features39.md Co-authored-by: Jan --- 3.9/release-notes-new-features39.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index 680c4db2d5..90f7a0f82d 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -280,12 +280,12 @@ example, the `BEL` character will be displayed as its hex code, `\x07`. The default value for this flag is `true` for compatibility with previous versions. -- `--log.escape-unicode-chars`: when its value is set to false, the unicode character -will be retained, and its actual value will be displayed. For example, `犬` will -be displayed as `犬`. When its value is set to true, the character is escaped, and -the hex code for the character is displayed. For example, `犬` would be displayed -as its hex code, `\u72AC`. - The default value for this flag is set to `false` for compatibility with +- `--log.escape-unicode-chars`: when its value is set to `false`, Unicode characters +will be retained, and written to the log as-is. For example, `犬` will +be logged as `犬`. When the flag value is set to `true`, any Unicode characters are +escaped, and the hex codes for all Unicode characters are logged instead. +For example, `犬` would be logged as its hex code, `\u72AC`. +The default value for this flag is set to `false` for compatibility with previous versions. Also see [Logging](programs-arangod-log.html). From b7178eccaa5d6c1a021c39cd27da2518a3286542 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 23:11:51 -0300 Subject: [PATCH 12/17] Update 3.9/programs-arangod-log.md Co-authored-by: Jan --- 3.9/programs-arangod-log.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/3.9/programs-arangod-log.md b/3.9/programs-arangod-log.md index 23483b9671..14410d2739 100644 --- a/3.9/programs-arangod-log.md +++ b/3.9/programs-arangod-log.md @@ -157,7 +157,7 @@ example, the `BEL` character will be displayed as its hex code, `\x07`. The default value for this flag is `true` to ensure compatibility with previous versions. -- `--log.escape-unicode-chars`: when its value is set to false, the unicode character +- `--log.escape-unicode-chars`: when its value is set to `false`, Unicode characters will be retained and written to the log as-is. For example, `犬` will be logged as `犬`. When the flag value is set to `true`, any Unicode characters are escaped, and the hex codes for all Unicode characters are logged instead. From 2ca271a90ba7fd7622997e53e32959616115cb6a Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 23:12:18 -0300 Subject: [PATCH 13/17] Update 3.9/programs-arangod-log.md Co-authored-by: Jan --- 3.9/programs-arangod-log.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/3.9/programs-arangod-log.md b/3.9/programs-arangod-log.md index 14410d2739..2877cdb02e 100644 --- a/3.9/programs-arangod-log.md +++ b/3.9/programs-arangod-log.md @@ -148,14 +148,14 @@ should be used. - `--log.escape-control-chars`: this flag applies to the control characters, which have hex codes below `\x20`, and also the character DEL with hex code `\x7f`. When the flag value is set to `false`, control -characters will be retained when they have a visible representation, and replaced -with a space character in case they don't have a visible representation. For example, -the control characer `\n` is visible, so a `\n` will be displayed in the log. Contrary, -the control character `BEL` is not visible, so a space will be displayed instead. -When the flag value is set to `true`, the hex code for the character is displayed, for -example, the `BEL` character will be displayed as its hex code, `\x07`. -The default value for this flag is `true` to ensure compatibility with -previous versions. + characters will be retained when they have a visible representation, and replaced + with a space character in case they don't have a visible representation. For example, + the control characer `\n` is visible, so a `\n` will be displayed in the log. Contrary, + the control character `BEL` is not visible, so a space will be displayed instead. + When the flag value is set to `true`, the hex code for the character is displayed, for + example, the `BEL` character will be displayed as its hex code, `\x07`. + The default value for this flag is `true` to ensure compatibility with + previous versions. - `--log.escape-unicode-chars`: when its value is set to `false`, Unicode characters will be retained and written to the log as-is. For example, `犬` will From d547c6da9c4ee8461484f4adda927f4a16c7b194 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 23:12:26 -0300 Subject: [PATCH 14/17] Update 3.9/release-notes-new-features39.md Co-authored-by: Jan --- 3.9/release-notes-new-features39.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index 90f7a0f82d..c2c1c7a2ef 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -270,15 +270,15 @@ should be used. - `--log.escape-control-chars`: this flag applies to control characters, which have hex codes below `\x20`, and also the character DEL, with a hex code of `\x7f`. When the flag value is set to `false`, control -characters that have a visual representation will be retained and logged as-is. -Controls characters without a visual representation will be replaced by a space -character in the log. The same will happen to the `DEL` character (code `\x7f`), -For example, the control characer `\n` is visible, so a `\n` will be displayed in -the log, and the control character `BEL` is not visible, so a space will be displayed. -When the flag value is set to `true`, the hex code for the character is logged. For -example, the `BEL` character will be displayed as its hex code, `\x07`. -The default value for this flag is `true` for compatibility with -previous versions. + characters that have a visual representation will be retained and logged as-is. + Controls characters without a visual representation will be replaced by a space + character in the log. The same will happen to the `DEL` character (code `\x7f`), + For example, the control characer `\n` is visible, so a `\n` will be displayed in + the log, and the control character `BEL` is not visible, so a space will be displayed. + When the flag value is set to `true`, the hex code for the character is logged. For + example, the `BEL` character will be displayed as its hex code, `\x07`. + The default value for this flag is `true` for compatibility with + previous versions. - `--log.escape-unicode-chars`: when its value is set to `false`, Unicode characters will be retained, and written to the log as-is. For example, `犬` will From faa5f790f922a165a7f56a281ccf44eac8a46435 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 23:12:37 -0300 Subject: [PATCH 15/17] Update 3.9/programs-arangod-log.md Co-authored-by: Jan --- 3.9/programs-arangod-log.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/3.9/programs-arangod-log.md b/3.9/programs-arangod-log.md index 2877cdb02e..6ae19de731 100644 --- a/3.9/programs-arangod-log.md +++ b/3.9/programs-arangod-log.md @@ -159,11 +159,11 @@ should be used. - `--log.escape-unicode-chars`: when its value is set to `false`, Unicode characters will be retained and written to the log as-is. For example, `犬` will -be logged as `犬`. When the flag value is set to `true`, any Unicode characters are -escaped, and the hex codes for all Unicode characters are logged instead. -For example, `犬` would be logged as its hex code, `\u72AC`. -The default value for this flag is set to `false` for compatibility with -previous versions. + be logged as `犬`. When the flag value is set to `true`, any Unicode characters are + escaped, and the hex codes for all Unicode characters are logged instead. + For example, `犬` would be logged as its hex code, `\u72AC`. + The default value for this flag is set to `false` for compatibility with + previous versions. A side effect of turning off the escaping is that it will reduce the CPU overhead for the logging. However, this will only be noticeable when logging From e795b35986a0e6f982750842337961f7e267a9c5 Mon Sep 17 00:00:00 2001 From: cpjulia Date: Tue, 21 Sep 2021 23:12:46 -0300 Subject: [PATCH 16/17] Update 3.9/release-notes-new-features39.md Co-authored-by: Jan --- 3.9/release-notes-new-features39.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index c2c1c7a2ef..0e2ca8419d 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -281,12 +281,12 @@ should be used. previous versions. - `--log.escape-unicode-chars`: when its value is set to `false`, Unicode characters -will be retained, and written to the log as-is. For example, `犬` will -be logged as `犬`. When the flag value is set to `true`, any Unicode characters are -escaped, and the hex codes for all Unicode characters are logged instead. -For example, `犬` would be logged as its hex code, `\u72AC`. -The default value for this flag is set to `false` for compatibility with -previous versions. + will be retained, and written to the log as-is. For example, `犬` will + be logged as `犬`. When the flag value is set to `true`, any Unicode characters are + escaped, and the hex codes for all Unicode characters are logged instead. + For example, `犬` would be logged as its hex code, `\u72AC`. + The default value for this flag is set to `false` for compatibility with + previous versions. Also see [Logging](programs-arangod-log.html). From ba4c42131119973289f89ab9ee019878cbc06c6e Mon Sep 17 00:00:00 2001 From: Simran Spiller Date: Wed, 22 Sep 2021 11:26:12 +0200 Subject: [PATCH 17/17] Review --- 3.9/programs-arangod-log.md | 49 +++++++++++++++---------- 3.9/release-notes-new-features39.md | 56 +++++++++++++++++------------ 2 files changed, 63 insertions(+), 42 deletions(-) diff --git a/3.9/programs-arangod-log.md b/3.9/programs-arangod-log.md index 6ae19de731..13bcaaf427 100644 --- a/3.9/programs-arangod-log.md +++ b/3.9/programs-arangod-log.md @@ -141,28 +141,39 @@ Format | Example | Description ## Escaping -There are two flags for retaining or escaping control and unicode -characters in the log. The flag `--log.escape` is deprecated since v3.9.0, and instead, -the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` -should be used. - -- `--log.escape-control-chars`: this flag applies to the control characters, which have hex codes below `\x20`, - and also the character DEL with hex code `\x7f`. When the flag value is set to `false`, control - characters will be retained when they have a visible representation, and replaced - with a space character in case they don't have a visible representation. For example, - the control characer `\n` is visible, so a `\n` will be displayed in the log. Contrary, - the control character `BEL` is not visible, so a space will be displayed instead. - When the flag value is set to `true`, the hex code for the character is displayed, for - example, the `BEL` character will be displayed as its hex code, `\x07`. +There are two flags for retaining or escaping control and Unicode characters in +the log. The flag `--log.escape` is deprecated since v3.9.0, and instead, +the new flags `--log.escape-control-chars` and `log.escape-unicode-chars` +should be used. + +- `--log.escape-control-chars`: + + This flag applies to the control characters, that have hex codes below `\x20`, + and also the character `DEL` with hex code `\x7f`. + + When the flag value is set to `false`, control characters will be retained + when they have a visible representation, and replaced with a space character + in case they do not have a visible representation. For example, the control + character `\n` is visible, so a `\n` will be displayed in the log. Contrary, + the control character `BEL` is not visible, so a space will be displayed + instead. + + When the flag value is set to `true`, the hex code for the character is + displayed, for example, the `BEL` character will be displayed as its hex code, + `\x07`. + The default value for this flag is `true` to ensure compatibility with previous versions. -- `--log.escape-unicode-chars`: when its value is set to `false`, Unicode characters -will be retained and written to the log as-is. For example, `犬` will - be logged as `犬`. When the flag value is set to `true`, any Unicode characters are - escaped, and the hex codes for all Unicode characters are logged instead. - For example, `犬` would be logged as its hex code, `\u72AC`. - The default value for this flag is set to `false` for compatibility with +- `--log.escape-unicode-chars`: + + If its value is set to `false`, Unicode characters will be retained and + written to the log as-is. For example, `犬` will be logged as `犬`. If the + flag value is set to `true`, any Unicode characters are escaped, and the hex + codes for all Unicode characters are logged instead. For example, `犬` would + be logged as its hex code, `\u72AC`. + + The default value for this flag is set to `false` for compatibility with previous versions. A side effect of turning off the escaping is that it will reduce the CPU diff --git a/3.9/release-notes-new-features39.md b/3.9/release-notes-new-features39.md index 0e2ca8419d..1471e36c19 100644 --- a/3.9/release-notes-new-features39.md +++ b/3.9/release-notes-new-features39.md @@ -48,7 +48,7 @@ FOR v, e, p IN 10 OUTBOUND @start GRAPH "myGraph" The condition `v.isRelevant == true` is stored in the variable `pruneCondition`, and later used as a condition for `FILTER`. -See [Pruning](aql/graphs-traversals.html#pruning) +See [Pruning](aql/graphs-traversals.html#pruning). ### Decay Functions @@ -263,29 +263,39 @@ Also see [Database Naming Conventions](data-modeling-naming-conventions-database ### Logging -The server now has two flags for retaining or escaping control and Unicode -characters in the log. The flag `--log.escape` is now deprecated and, instead, -the new flags `--log.escape-control-chars` and `--log.escape-unicode-chars` -should be used. - -- `--log.escape-control-chars`: this flag applies to control characters, which have hex codes below `\x20`, - and also the character DEL, with a hex code of `\x7f`. When the flag value is set to `false`, control - characters that have a visual representation will be retained and logged as-is. - Controls characters without a visual representation will be replaced by a space - character in the log. The same will happen to the `DEL` character (code `\x7f`), - For example, the control characer `\n` is visible, so a `\n` will be displayed in - the log, and the control character `BEL` is not visible, so a space will be displayed. - When the flag value is set to `true`, the hex code for the character is logged. For - example, the `BEL` character will be displayed as its hex code, `\x07`. - The default value for this flag is `true` for compatibility with +The server now has two flags for retaining or escaping control and Unicode +characters in the log. The flag `--log.escape` is now deprecated and, instead, +the new flags `--log.escape-control-chars` and `--log.escape-unicode-chars` +should be used. + +- `--log.escape-control-chars`: + + This flag applies to the control characters, that have hex codes below `\x20`, + and also the character `DEL` with hex code `\x7f`. + + When the flag value is set to `false`, control characters will be retained + when they have a visible representation, and replaced with a space character + in case they do not have a visible representation. For example, the control + character `\n` is visible, so a `\n` will be displayed in the log. Contrary, + the control character `BEL` is not visible, so a space will be displayed + instead. + + When the flag value is set to `true`, the hex code for the character is + displayed, for example, the `BEL` character will be displayed as its hex code, + `\x07`. + + The default value for this flag is `true` to ensure compatibility with previous versions. -- `--log.escape-unicode-chars`: when its value is set to `false`, Unicode characters - will be retained, and written to the log as-is. For example, `犬` will - be logged as `犬`. When the flag value is set to `true`, any Unicode characters are - escaped, and the hex codes for all Unicode characters are logged instead. - For example, `犬` would be logged as its hex code, `\u72AC`. - The default value for this flag is set to `false` for compatibility with +- `--log.escape-unicode-chars`: + + If its value is set to `false`, Unicode characters will be retained and + written to the log as-is. For example, `犬` will be logged as `犬`. If the + flag value is set to `true`, any Unicode characters are escaped, and the hex + codes for all Unicode characters are logged instead. For example, `犬` would + be logged as its hex code, `\u72AC`. + + The default value for this flag is set to `false` for compatibility with previous versions. Also see [Logging](programs-arangod-log.html). @@ -402,7 +412,7 @@ This will turn the numeric-looking values in the `key` attribute into strings but treat the attributes `price` and `weight` as numbers. Finally, the values in attribute `fk` will be treated as strings again. -See [Overriding data types per attribute](programs-arangoimport-examples-csv.html#overriding-data-types-per-attribute) +See [Overriding data types per attribute](programs-arangoimport-examples-csv.html#overriding-data-types-per-attribute). ### arangobench