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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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.
*/
#pragma once
#include <string>
#include "mongo/base/status.h"
#include "mongo/base/status_with.h"
#include "mongo/base/string_data.h"
#include "mongo/bson/bsonobj.h"
#include "mongo/bson/bsonobjbuilder.h"
namespace mongo {
class Client;
class OperationContext;
constexpr auto kMetadataDocumentName = "client"_sd;
/**
* The ClientMetadata class is responsible for parsing the client metadata document that is received
* in isMaster from clients. This class also provides static methods for client libraries to create
* a valid client metadata document.
*
* Example document of isMaster request with client metadata document:
* {
* "isMaster" : 1,
* "client" : {
* "application" : { // Optional
* "name" : "string" // Optional with caveats
* },
* "driver" : { // Required, Informational Only
* "name" : "string", // Required, Informational Only
* "version" : "string" // Required, Informational Only
* },
* "os" : { // Required, Informational Only
* "type" : "string", // Required, Informational Only, See note
* "name" : "string", // Optional, Informational Only
* "architecture" : "string", // Optional, Informational Only
* "version" : "string" // Optional, Informational Only
* }
* "mongos" : { // Optional, Informational Only
* "host" : "string", // Optional, Informational Only
* "client" : "string", // Optional, Informational Only
* "version" : "string" // Optional, Informational Only
* }
* }
* }
*
* For this classes' purposes, the client metadata document is the sub-document in "client". It is
* allowed to contain additional fields that are not listed in the example above. These additional
* fields are ignore by this class. The "os" document "type" field is required (defaults to
* "unknown" in Mongo Drivers). The "driver", and "os" documents while required, are for
* informational purposes only. The content is logged to disk but otherwise ignored.
*
* See Driver Specification: "MongoDB Handshake" for more information.
*/
class ClientMetadata {
ClientMetadata(const ClientMetadata&) = delete;
ClientMetadata& operator=(const ClientMetadata&) = delete;
public:
ClientMetadata(ClientMetadata&&) = default;
ClientMetadata& operator=(ClientMetadata&&) = default;
/**
* Parse and validate a client metadata document contained in an isMaster request.
*
* Empty or non-existent sub-documents are permitted. Non-empty documents are required to have
* the fields driver.name, driver.version, and os.type which must be strings.
*
* Returns an empty optional if element is empty.
*/
static StatusWith<boost::optional<ClientMetadata>> parse(const BSONElement& element);
/**
* Create a new client metadata document with os information from the ProcessInfo class.
*
* This method outputs the "client" field, and client metadata sub-document in the
* BSONObjBuilder:
*
* "client" : {
* "driver" : {
* "name" : "string",
* "version" : "string"
* },
* "os" : {
* "type" : "string",
* "name" : "string",
* "architecture" : "string",
* "version" : "string"
* }
* }
*/
static void serialize(StringData driverName, StringData driverVersion, BSONObjBuilder* builder);
/**
* Create a new client metadata document with os information from the ProcessInfo class.
*
* driverName - name of the driver, must not be empty
* driverVersion - a string for the driver version, must not be empty
*
* Notes: appName must be <= 128 bytes otherwise an error is returned. It may be empty in which
* case it is omitted from the output document.
*
* This method outputs the "client" field, and client metadata sub-document in the
* BSONObjBuilder:
*
* "client" : {
* "application" : {
* "name" : "string"
* },
* "driver" : {
* "name" : "string",
* "version" : "string"
* },
* "os" : {
* "type" : "string",
* "name" : "string",
* "architecture" : "string",
* "version" : "string"
* }
* }
*/
static Status serialize(StringData driverName,
StringData driverVersion,
StringData appName,
BSONObjBuilder* builder);
/**
* Modify the existing client metadata document to include a mongos section.
*
* hostAndPort is "host:port" of the running MongoS.
* monogsClient is "host:port" of the connected driver.
* version is the version string of MongoS.
*
* "mongos" : {
* "host" : "string",
* "client" : "string",
* "version" : "string"
* }
*/
void setMongoSMetadata(StringData hostAndPort, StringData mongosClient, StringData version);
/**
* Get the Application Name for the client metadata document.
*
* Used to log Application Name in slow operation reports, and into system.profile.
* Return: May be empty.
*/
StringData getApplicationName() const;
/**
* Get the BSON Document of the client metadata document. In the example above in the class
* comment, this is the document in the "client" field.
*
* Return: May be empty.
*/
const BSONObj& getDocument() const;
/**
* Log client and client metadata information to disk.
*/
void logClientMetadata(Client* client) const;
/**
* Field name for requests that contains client metadata.
*/
static StringData fieldName();
public:
/**
* Create a new client metadata document.
*
* Exposed for Unit Test purposes
*/
static void serializePrivate(StringData driverName,
StringData driverVersion,
StringData osType,
StringData osName,
StringData osArchitecture,
StringData osVersion,
BSONObjBuilder* builder);
/**
* Create a new client metadata document.
*
* driverName - name of the driver
* driverVersion - a string for the driver version
* osType - name of host operating system of client, i.e. uname -s
* osName - name of operating system distro, i.e. "Ubuntu..." or "Microsoft Windows 8"
* osArchitecture - architecture of host operating system, i.e. uname -p
* osVersion - operating system version, i.e. uname -v
*
* Notes: appName must be <= 128 bytes otherwise an error is returned. It may be empty in which
* case it is omitted from the output document. All other fields must not be empty.
*
* Exposed for Unit Test purposes
*/
static Status serializePrivate(StringData driverName,
StringData driverVersion,
StringData osType,
StringData osName,
StringData osArchitecture,
StringData osVersion,
StringData appName,
BSONObjBuilder* builder);
private:
ClientMetadata() = default;
Status parseClientMetadataDocument(const BSONObj& doc);
static Status validateDriverDocument(const BSONObj& doc);
static Status validateOperatingSystemDocument(const BSONObj& doc);
static StatusWith<StringData> parseApplicationDocument(const BSONObj& doc);
private:
// Parsed Client Metadata document
// May be empty
// Owned
BSONObj _document;
// Application Name extracted from the client metadata document.
// May be empty
StringData _appName;
};
} // namespace mongo
|
