diff options
author | Sara Golemon <sara.golemon@mongodb.com> | 2020-08-28 17:02:46 +0000 |
---|---|---|
committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2020-10-22 17:06:16 +0000 |
commit | cd8cce6dcb3d63bbf4bf882379540ed8b719dfc4 (patch) | |
tree | 2a4c78ef7ae4806bf46aba27b67470e941a5f25f | |
parent | 51caad0e005e1a6dc1bd529cb809ba0d7d5eef0d (diff) | |
download | mongo-cd8cce6dcb3d63bbf4bf882379540ed8b719dfc4.tar.gz |
SERVER-50605 Add logMessage test-only command
(cherry picked from commit cbdf4deaa4ef4352750893ab0b4b276b86e3026f)
-rw-r--r-- | jstests/core/escaped-logs.js | 18 | ||||
-rw-r--r-- | jstests/core/views/views_all_commands.js | 1 | ||||
-rw-r--r-- | jstests/replsets/db_reads_while_recovering_all_commands.js | 3 | ||||
-rw-r--r-- | jstests/sharding/safe_secondary_reads_drop_recreate.js | 1 | ||||
-rw-r--r-- | jstests/sharding/safe_secondary_reads_single_migration_suspend_range_deletion.js | 1 | ||||
-rw-r--r-- | jstests/sharding/safe_secondary_reads_single_migration_waitForDelete.js | 1 | ||||
-rw-r--r-- | src/mongo/db/commands/generic.cpp | 47 | ||||
-rw-r--r-- | src/mongo/db/initialize_server_global_state.cpp | 1 | ||||
-rw-r--r-- | src/mongo/logger/logstream_builder.cpp | 2 | ||||
-rw-r--r-- | src/mongo/logger/logstream_builder.h | 66 |
10 files changed, 128 insertions, 13 deletions
diff --git a/jstests/core/escaped-logs.js b/jstests/core/escaped-logs.js new file mode 100644 index 00000000000..223c003d22a --- /dev/null +++ b/jstests/core/escaped-logs.js @@ -0,0 +1,18 @@ +// Test escaping of user provided data in logs +// @tags: [requires_non_retryable_commands] + +(function() { + 'use strict'; + load('jstests/libs/check_log.js'); + + const mongo = db.getMongo(); + const admin = mongo.getDB('admin'); + + // Test a range of characters sent to the global log + for (let i = 1; i < 256; ++i) { + const msg = "Hello" + String.fromCharCode(i) + "World"; + assert.commandWorked(admin.runCommand({logMessage: msg})); + const escmsg = msg.replace("\r", "\\r").replace("\n", "\\n"); + checkLog.contains(mongo, "logMessage: " + escmsg); + } +})(); diff --git a/jstests/core/views/views_all_commands.js b/jstests/core/views/views_all_commands.js index 59d5d0be518..aae9d3e3d3a 100644 --- a/jstests/core/views/views_all_commands.js +++ b/jstests/core/views/views_all_commands.js @@ -355,6 +355,7 @@ listShards: {skip: isUnrelated}, lockInfo: {skip: isUnrelated}, logApplicationMessage: {skip: isUnrelated}, + logMessage: {skip: isUnrelated}, logRotate: {skip: isUnrelated}, logout: {skip: isUnrelated}, makeSnapshot: {skip: isAnInternalCommand}, diff --git a/jstests/replsets/db_reads_while_recovering_all_commands.js b/jstests/replsets/db_reads_while_recovering_all_commands.js index 06be14ffe96..c0b58d37eab 100644 --- a/jstests/replsets/db_reads_while_recovering_all_commands.js +++ b/jstests/replsets/db_reads_while_recovering_all_commands.js @@ -231,6 +231,7 @@ }, lockInfo: {skip: isPrimaryOnly}, logApplicationMessage: {skip: isNotAUserDataRead}, + logMessage: {skip: isNotAUserDataRead}, logRotate: {skip: isNotAUserDataRead}, logout: {skip: isNotAUserDataRead}, makeSnapshot: {skip: isNotAUserDataRead}, @@ -385,4 +386,4 @@ // Turn off maintenance mode and stop the test. assert.commandWorked(secondary.adminCommand({replSetMaintenance: 0})); rst.stopSet(); -})();
\ No newline at end of file +})(); diff --git a/jstests/sharding/safe_secondary_reads_drop_recreate.js b/jstests/sharding/safe_secondary_reads_drop_recreate.js index 24f104bfc03..a241cc09b33 100644 --- a/jstests/sharding/safe_secondary_reads_drop_recreate.js +++ b/jstests/sharding/safe_secondary_reads_drop_recreate.js @@ -248,6 +248,7 @@ listShards: {skip: "does not return user data"}, lockInfo: {skip: "primary only"}, logApplicationMessage: {skip: "primary only"}, + logMessage: {skip: "does not return user data"}, logRotate: {skip: "does not return user data"}, logout: {skip: "does not return user data"}, makeSnapshot: {skip: "does not return user data"}, diff --git a/jstests/sharding/safe_secondary_reads_single_migration_suspend_range_deletion.js b/jstests/sharding/safe_secondary_reads_single_migration_suspend_range_deletion.js index b65e7fabae4..602bd00af17 100644 --- a/jstests/sharding/safe_secondary_reads_single_migration_suspend_range_deletion.js +++ b/jstests/sharding/safe_secondary_reads_single_migration_suspend_range_deletion.js @@ -288,6 +288,7 @@ listShards: {skip: "does not return user data"}, lockInfo: {skip: "primary only"}, logApplicationMessage: {skip: "primary only"}, + logMessage: {skip: "does not return user data"}, logRotate: {skip: "does not return user data"}, logout: {skip: "does not return user data"}, makeSnapshot: {skip: "does not return user data"}, diff --git a/jstests/sharding/safe_secondary_reads_single_migration_waitForDelete.js b/jstests/sharding/safe_secondary_reads_single_migration_waitForDelete.js index 126ace906a9..f2d92e33d3d 100644 --- a/jstests/sharding/safe_secondary_reads_single_migration_waitForDelete.js +++ b/jstests/sharding/safe_secondary_reads_single_migration_waitForDelete.js @@ -252,6 +252,7 @@ listShards: {skip: "does not return user data"}, lockInfo: {skip: "primary only"}, logApplicationMessage: {skip: "primary only"}, + logMessage: {skip: "does not return user data"}, logRotate: {skip: "does not return user data"}, logout: {skip: "does not return user data"}, makeSnapshot: {skip: "does not return user data"}, diff --git a/src/mongo/db/commands/generic.cpp b/src/mongo/db/commands/generic.cpp index c1312768ee1..af647671660 100644 --- a/src/mongo/db/commands/generic.cpp +++ b/src/mongo/db/commands/generic.cpp @@ -500,6 +500,53 @@ public: MONGO_FP_DECLARE(crashOnShutdown); int* volatile illegalAddress; // NOLINT - used for fail point only +class CmdLogMessage : public BasicCommand { +public: + CmdLogMessage() : BasicCommand("logMessage") {} + + void help(stringstream& help) const final { + help << "Send a message to the server log"; + } + + bool supportsWriteConcern(const BSONObj& cmd) const final { + return false; + } + + bool slaveOk() const final { + return true; + } + + bool adminOnly() const final { + return true; + } + + void addRequiredPrivileges(const std::string& dbname, + const BSONObj& cmdObj, + std::vector<Privilege>* out) final { + out->push_back( + Privilege(ResourcePattern::forClusterResource(), ActionType::applicationMessage)); + } + + bool run(OperationContext* opCtx, + const std::string& ns, + const BSONObj& cmdObj, + BSONObjBuilder& result) final { + auto msgElem = cmdObj["logMessage"]; + uassert(ErrorCodes::BadValue, "logMessage must be a string", msgElem.type() == String); + + log() << "logMessage: " << msgElem.valueStringData(); + return true; + } +}; + +MONGO_INITIALIZER(RegisterCmdLogMessage)(InitializerContext* context) { + if (Command::testCommandsEnabled) { + // Leaked intentionally: a Command registers itself when constructed. + new CmdLogMessage(); + } + return Status::OK(); +} + } // namespace void CmdShutdown::addRequiredPrivileges(const std::string& dbname, diff --git a/src/mongo/db/initialize_server_global_state.cpp b/src/mongo/db/initialize_server_global_state.cpp index ac6e6580bed..56d9830f54d 100644 --- a/src/mongo/db/initialize_server_global_state.cpp +++ b/src/mongo/db/initialize_server_global_state.cpp @@ -316,6 +316,7 @@ MONGO_INITIALIZER_GENERAL( logger::globalLogDomain()->attachAppender( logger::MessageLogDomain::AppenderAutoPtr(new RamLogAppender(RamLog::get("global")))); + logger::LogstreamBuilder::setNewlineEscape(); return Status::OK(); } diff --git a/src/mongo/logger/logstream_builder.cpp b/src/mongo/logger/logstream_builder.cpp index 201130579e9..77ed984a9b3 100644 --- a/src/mongo/logger/logstream_builder.cpp +++ b/src/mongo/logger/logstream_builder.cpp @@ -71,6 +71,8 @@ struct ThreadOstreamCacheFinalizer { namespace logger { +bool LogstreamBuilder::newlineEscape = false; + LogstreamBuilder::LogstreamBuilder(MessageLogDomain* domain, StringData contextName, LogSeverity severity) diff --git a/src/mongo/logger/logstream_builder.h b/src/mongo/logger/logstream_builder.h index 2185ed1661d..62269a50783 100644 --- a/src/mongo/logger/logstream_builder.h +++ b/src/mongo/logger/logstream_builder.h @@ -124,24 +124,19 @@ public: } LogstreamBuilder& operator<<(const char* x) { - stream() << x; - return *this; + return appendEscapedString(x); } LogstreamBuilder& operator<<(const std::string& x) { - stream() << x; - return *this; + return appendEscapedString(x); } LogstreamBuilder& operator<<(StringData x) { - stream() << x; - return *this; + return appendEscapedString(x); } LogstreamBuilder& operator<<(char* x) { - stream() << x; - return *this; + return appendEscapedString(x); } LogstreamBuilder& operator<<(char x) { - stream() << x; - return *this; + return appendEscapedChar(x); } LogstreamBuilder& operator<<(int x) { stream() << x; @@ -210,8 +205,7 @@ public: template <typename T> LogstreamBuilder& operator<<(const T& x) { - stream() << x.toString(); - return *this; + return appendEscapedString(x.toString()); } LogstreamBuilder& operator<<(std::ostream& (*manip)(std::ostream&)) { @@ -229,9 +223,57 @@ public: */ void operator<<(Tee* tee); + /** + * Enable newilne escaping behavior. + */ + static void setNewlineEscape() { + newlineEscape = true; + } + private: + /** + * Global option to escape newlines. + */ + static bool newlineEscape; + void makeStream(); + // Append a string explicitly escaping \r and \n only. + LogstreamBuilder& appendEscapedString(StringData x) { + if (newlineEscape) { + auto idx = std::min(x.find('\r'), x.find('\n')); + while (idx != std::string::npos) { + if (idx > 0) { + stream() << x.substr(0, idx); + } + appendEscapedChar(x[idx]); + x = x.substr(idx + 1); + idx = std::min(x.find('\r'), x.find('\n')); + } + } + + stream() << x; + return *this; + } + + LogstreamBuilder& appendEscapedChar(char ch) { + if (newlineEscape) { + switch (ch) { + case '\n': + stream() << "\\n"; + break; + case '\r': + stream() << "\\r"; + break; + default: + stream() << ch; + } + } else { + stream() << ch; + } + return *this; + } + MessageLogDomain* _domain; std::string _contextName; LogSeverity _severity; |