From: Sage Weil <sage@redhat.com>
Date: Tue, 9 Jan 2018 14:24:54 +0000 (-0600)
Subject: common/options: long description for log_stderr_prefix
X-Git-Tag: v13.0.2~582^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F19869%2Fhead;p=ceph.git

common/options: long description for log_stderr_prefix

Signed-off-by: Sage Weil <sage@redhat.com>
---

diff --git a/src/common/options.cc b/src/common/options.cc
index 19e88a10f0a..e0288c77fa2 100644
--- a/src/common/options.cc
+++ b/src/common/options.cc
@@ -346,7 +346,9 @@ std::vector<Option> get_global_options() {
     .set_description("send critical error log lines to stderr"),
 
     Option("log_stderr_prefix", Option::TYPE_STR, Option::LEVEL_ADVANCED)
-    .set_description("String to prefix log messages with when sent to stderr"),
+    .set_description("String to prefix log messages with when sent to stderr")
+    .set_long_description("This is useful in container environments when combined with mon_cluster_log_to_stderr.  The mon log prefixes each line with the channel name (e.g., 'default', 'audit'), while log_stderr_prefix can be set to 'debug '.")
+    .add_see_also("mon_cluster_log_to_stderr"),
 
     Option("log_to_syslog", Option::TYPE_BOOL, Option::LEVEL_BASIC)
     .set_default(false)
@@ -432,7 +434,8 @@ std::vector<Option> get_global_options() {
 
     Option("mon_cluster_log_to_stderr", Option::TYPE_BOOL, Option::LEVEL_ADVANCED)
     .set_default(false)
-    .set_description("Send cluster log messages to stderr (prefixed by channel)"),
+    .set_description("Send cluster log messages to stderr (prefixed by channel)")
+    .add_see_also("log_stderr_prefix"),
 
     Option("mon_cluster_log_to_syslog", Option::TYPE_STR, Option::LEVEL_ADVANCED)
     .set_default("default=false")