summaryrefslogtreecommitdiff
path: root/src/mongo/s/commands/cluster_current_op.cpp
blob: 50c5ad4390c63c88ed1fb8f8ed03adb7c1393411 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
/*
 *    Copyright (C) 2015 MongoDB Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the GNU Affero General Public License in all respects
 *    for all of the code used other than as permitted herein. If you modify
 *    file(s) with this exception, you may extend this exception to your
 *    version of the file(s), but you are not obligated to do so. If you do not
 *    wish to do so, delete this exception statement from your version. If you
 *    delete this exception statement from all source files in the program,
 *    then also delete it in the license file.
 */

#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kCommand

#include "mongo/platform/basic.h"

#include <vector>
#include <tuple>

#include "mongo/client/connpool.h"
#include "mongo/db/auth/action_type.h"
#include "mongo/db/auth/authorization_session.h"
#include "mongo/db/commands.h"
#include "mongo/db/jsobj.h"
#include "mongo/s/commands/run_on_all_shards_cmd.h"
#include "mongo/s/strategy.h"
#include "mongo/util/log.h"
#include "mongo/util/mongoutils/str.h"

namespace mongo {
namespace {

    const char kInprogFieldName[] = "inprog";
    const char kOpIdFieldName[] = "opid";
    const char kClientFieldName[] = "client";
    // awkward underscores used to make this visually distinct from kClientFieldName
    const char kClient_S_FieldName[] = "client_s";
    const char kLegacyInprogCollection[] = "$cmd.sys.inprog";

    const char kCommandName[] = "currentOp";

    class ClusterCurrentOpCommand : public RunOnAllShardsCommand {
    public:

        ClusterCurrentOpCommand() : RunOnAllShardsCommand(kCommandName) { }

        bool adminOnly() const final { return true; }

        Status checkAuthForCommand(ClientBasic* client,
                                   const std::string& dbname,
                                   const BSONObj& cmdObj) final {


            bool isAuthorized = client->getAuthorizationSession()->isAuthorizedForActionsOnResource(
                                    ResourcePattern::forClusterResource(),
                                    ActionType::inprog);

            return isAuthorized ? Status::OK() : Status(ErrorCodes::Unauthorized, "Unauthorized");
        }

        // TODO remove after 3.2
        BSONObj specialErrorHandler(const std::string& server,
                                    const std::string& db,
                                    const BSONObj& cmdObj,
                                    const BSONObj& originalResult) const final {

            // it is unfortunate that this logic needs to be duplicated from
            // DBClientWithCommands::runPseudoCommand
            // but I don't see a better way to do it without performing heart surgery on
            // Future/CommandResponse.

            auto status = getStatusFromCommandResult(originalResult);
            invariant(!status.isOK());

            uassert(28629,
                    str::stream() << "Received bad "
                                  << kCommandName
                                  << " response from server " << server
                                  << " got: " << originalResult,
                    status != ErrorCodes::CommandResultSchemaViolation);

            // getStatusFromCommandResult handles cooercing "no such command" into the right
            // Status type
            if (status == ErrorCodes::CommandNotFound) {
                // fall back to the old inprog pseudo-command
                NamespaceString pseudoCommandNss("admin", kLegacyInprogCollection);
                BSONObj legacyResult;

                BSONObjBuilder legacyCommandBob;

                // need to exclude {currentOp: 1}
                for (auto&& cmdElem : cmdObj) {
                    if (cmdElem.fieldNameStringData() != kCommandName) {
                        legacyCommandBob.append(cmdElem);
                    }
                }
                auto legacyCommand = legacyCommandBob.done();

                try {
                    ScopedDbConnection conn(server);
                    legacyResult =
                        conn->findOne(pseudoCommandNss.ns(), legacyCommand);

                }
                catch (const DBException& ex) {
                    // If there is a non-DBException exception the entire operation will be
                    // terminated, as that would be a programmer error.

                    // We convert the exception to a BSONObj so that the ordinary
                    // failure path for RunOnAllShardsCommand will handle the failure

                    // TODO: consider adding an exceptionToBSONObj utility?
                    BSONObjBuilder b;
                    b.append("errmsg", ex.toString());
                    b.append("code", ex.getCode());
                    return b.obj();
                }
                return legacyResult;
            }
            // if the command failed for another reason then we don't retry it.
            return originalResult;
        }

        void aggregateResults(const std::vector<ShardAndReply>& results,
                              BSONObjBuilder& output) final {
            // Each shard responds with a document containing an array of subdocuments.
            // Each subdocument represents an operation running on that shard.
            // We merge the responses into a single document containg an array
            // of the operations from all shards.

            // There are two modifications we make.
            // 1) we prepend the shardid (with a colon separator) to the opid of each operation.
            // This allows users to pass the value of the opid field directly to killOp.

            // 2) we change the field name of "client" to "client_s". This is because each
            // client is actually a mongos.

            // TODO: failpoint for a shard response being invalid.

            // Error handling - we maintain the same behavior as legacy currentOp/inprog
            // that is, if any shard replies with an invalid response (i.e. it does not
            // contain a field 'inprog' that is an array), we ignore it.
            //
            // If there is a lower level error (i.e. the command fails, network error, etc)
            // RunOnAllShardsCommand will handle returning an error to the user.
            BSONArrayBuilder aggregatedOpsBab(output.subarrayStart(kInprogFieldName));

            for (auto&& shardResponse : results) {

                StringData shardName;
                BSONObj shardResponseObj;
                std::tie(shardName, shardResponseObj) = shardResponse;

                auto shardOps = shardResponseObj[kInprogFieldName];

                // legacy behavior
                if (!shardOps.isABSONObj()) {
                    warning() << "invalid currentOp response from shard "
                              << shardName
                              << ", got: "
                              << shardOps;
                    continue;
                }

                for (auto&& shardOp : shardOps.Obj()) {
                    BSONObjBuilder modifiedShardOpBob;

                    // maintain legacy behavior
                    // but log it first
                    if (!shardOp.isABSONObj()) {
                        warning() << "invalid currentOp response from shard "
                                  << shardName
                                  << ", got: "
                                  << shardOp;
                        continue;
                    }

                    for (auto&& shardOpElement : shardOp.Obj()) {
                        auto fieldName = shardOpElement.fieldNameStringData();
                        if (fieldName == kOpIdFieldName) {
                            uassert(28630,
                                    str::stream() << "expected numeric opid from currentOp response"
                                                  << " from shard " << shardName
                                                  << ", got: " << shardOpElement,
                                    shardOpElement.isNumber());

                            modifiedShardOpBob.append(kOpIdFieldName,
                                                      str::stream() << shardName
                                                                    << ":"
                                                                    << shardOpElement.numberInt());
                        }
                        else if (fieldName == kClientFieldName) {
                            modifiedShardOpBob.appendAs(shardOpElement, kClient_S_FieldName);
                        }
                        else {
                            modifiedShardOpBob.append(shardOpElement);
                        }
                    }
                    modifiedShardOpBob.done();
                    // append the modified document to the output array
                    aggregatedOpsBab.append(modifiedShardOpBob.obj());
                }
            }
            aggregatedOpsBab.done();
        }

    } clusterCurrentOpCmd;

}  // namespace
}  // namespace mongo