From 2ebec0364d5185a93cf6ff3e0c77003bee865dd7 Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Sun, 26 Nov 2023 10:55:09 +0100 Subject: [PATCH] adjust log-on-startup docs (#815) * adjust log-on-startup docs * update message --- docs/src/main/paradox/logging.md | 3 ++- docs/src/main/paradox/typed/logging.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/src/main/paradox/logging.md b/docs/src/main/paradox/logging.md index 09946bbd864..b2dbd4d18a3 100644 --- a/docs/src/main/paradox/logging.md +++ b/docs/src/main/paradox/logging.md @@ -119,11 +119,12 @@ pekko { } ``` -This config option is very good if you want to know what config settings are loaded by Pekko: +This config option is useful if you want to know what config settings are loaded by Pekko: ```ruby pekko { # Log the complete configuration at INFO level when the actor system is started. + # We do not recommend using this logging in production environments as it can include sensitive values. # This is useful when you are uncertain of what configuration is used. log-config-on-start = on } diff --git a/docs/src/main/paradox/typed/logging.md b/docs/src/main/paradox/typed/logging.md index 47a791aed98..44e04be4125 100644 --- a/docs/src/main/paradox/typed/logging.md +++ b/docs/src/main/paradox/typed/logging.md @@ -337,11 +337,12 @@ pekko { } ``` -This config option is very good if you want to know what config settings are loaded by Pekko: +This config option is useful if you want to know what config settings are loaded by Pekko: ``` pekko { # Log the complete configuration at INFO level when the actor system is started. + # We do not recommend using this logging in production environments as it can include sensitive values. # This is useful when you are uncertain of what configuration is used. log-config-on-start = on }