From 67e651e9c010570823e6c477db374bfdfa61733f Mon Sep 17 00:00:00 2001 From: Gem Lamont <106068376+gem-neo4j@users.noreply.github.com> Date: Tue, 1 Aug 2023 14:55:49 +0200 Subject: [PATCH] [NOID] Cherry pick logging doc updates (#3704) (#3707) --- .../ROOT/partials/usage/config/apoc.log.debug.adoc | 10 +++++----- .../ROOT/partials/usage/config/apoc.log.error.adoc | 10 +++++----- .../ROOT/partials/usage/config/apoc.log.info.adoc | 10 +++++----- .../ROOT/partials/usage/config/apoc.log.warn.adoc | 10 +++++----- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.debug.adoc b/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.debug.adoc index fea15d618c..2683ab7ace 100644 --- a/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.debug.adoc +++ b/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.debug.adoc @@ -1,4 +1,4 @@ -The procedure support the following properties in the APOC configuration file (`apoc.conf`): +This procedure supports the following properties in the APOC configuration file (`apoc.conf`): .Config parameters [opts=header, cols="1,1,1,3"] @@ -6,10 +6,10 @@ The procedure support the following properties in the APOC configuration file (` | name | type | default | description | apoc.user.log.type | String | `safe` a| Type of logging. -* `node`: disable the procedures -* `safe`: replace all `.` and whitespace (space and tab) with underscore and lowercase all characters -* `raw`: left the messages as-is +* `none`: disable logging +* `safe`: replace all period `.` and whitespace characters (space and tab) with an underscore. Set all characters to lowercase. +* `raw`: leave messages as-is -| apoc.user.log.window.ops | Long | 10 | Number of log messages permitted in a time-window. If this quota is exceeded, log messags will be skipped. +| apoc.user.log.window.ops | Long | 10 | Number of log messages permitted in a time-window. If this quota is exceeded, log messages will be skipped. | apoc.user.log.window.time | Long | 10000 | Length (in milliseconds) of the time-window. |=== \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.error.adoc b/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.error.adoc index fea15d618c..2683ab7ace 100644 --- a/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.error.adoc +++ b/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.error.adoc @@ -1,4 +1,4 @@ -The procedure support the following properties in the APOC configuration file (`apoc.conf`): +This procedure supports the following properties in the APOC configuration file (`apoc.conf`): .Config parameters [opts=header, cols="1,1,1,3"] @@ -6,10 +6,10 @@ The procedure support the following properties in the APOC configuration file (` | name | type | default | description | apoc.user.log.type | String | `safe` a| Type of logging. -* `node`: disable the procedures -* `safe`: replace all `.` and whitespace (space and tab) with underscore and lowercase all characters -* `raw`: left the messages as-is +* `none`: disable logging +* `safe`: replace all period `.` and whitespace characters (space and tab) with an underscore. Set all characters to lowercase. +* `raw`: leave messages as-is -| apoc.user.log.window.ops | Long | 10 | Number of log messages permitted in a time-window. If this quota is exceeded, log messags will be skipped. +| apoc.user.log.window.ops | Long | 10 | Number of log messages permitted in a time-window. If this quota is exceeded, log messages will be skipped. | apoc.user.log.window.time | Long | 10000 | Length (in milliseconds) of the time-window. |=== \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.info.adoc b/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.info.adoc index fea15d618c..2683ab7ace 100644 --- a/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.info.adoc +++ b/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.info.adoc @@ -1,4 +1,4 @@ -The procedure support the following properties in the APOC configuration file (`apoc.conf`): +This procedure supports the following properties in the APOC configuration file (`apoc.conf`): .Config parameters [opts=header, cols="1,1,1,3"] @@ -6,10 +6,10 @@ The procedure support the following properties in the APOC configuration file (` | name | type | default | description | apoc.user.log.type | String | `safe` a| Type of logging. -* `node`: disable the procedures -* `safe`: replace all `.` and whitespace (space and tab) with underscore and lowercase all characters -* `raw`: left the messages as-is +* `none`: disable logging +* `safe`: replace all period `.` and whitespace characters (space and tab) with an underscore. Set all characters to lowercase. +* `raw`: leave messages as-is -| apoc.user.log.window.ops | Long | 10 | Number of log messages permitted in a time-window. If this quota is exceeded, log messags will be skipped. +| apoc.user.log.window.ops | Long | 10 | Number of log messages permitted in a time-window. If this quota is exceeded, log messages will be skipped. | apoc.user.log.window.time | Long | 10000 | Length (in milliseconds) of the time-window. |=== \ No newline at end of file diff --git a/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.warn.adoc b/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.warn.adoc index fea15d618c..2683ab7ace 100644 --- a/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.warn.adoc +++ b/docs/asciidoc/modules/ROOT/partials/usage/config/apoc.log.warn.adoc @@ -1,4 +1,4 @@ -The procedure support the following properties in the APOC configuration file (`apoc.conf`): +This procedure supports the following properties in the APOC configuration file (`apoc.conf`): .Config parameters [opts=header, cols="1,1,1,3"] @@ -6,10 +6,10 @@ The procedure support the following properties in the APOC configuration file (` | name | type | default | description | apoc.user.log.type | String | `safe` a| Type of logging. -* `node`: disable the procedures -* `safe`: replace all `.` and whitespace (space and tab) with underscore and lowercase all characters -* `raw`: left the messages as-is +* `none`: disable logging +* `safe`: replace all period `.` and whitespace characters (space and tab) with an underscore. Set all characters to lowercase. +* `raw`: leave messages as-is -| apoc.user.log.window.ops | Long | 10 | Number of log messages permitted in a time-window. If this quota is exceeded, log messags will be skipped. +| apoc.user.log.window.ops | Long | 10 | Number of log messages permitted in a time-window. If this quota is exceeded, log messages will be skipped. | apoc.user.log.window.time | Long | 10000 | Length (in milliseconds) of the time-window. |=== \ No newline at end of file