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
|
/**
* Copyright (C) 2018 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.
*/
#pragma once
#include "mongo/db/curop.h"
#include "mongo/rpc/metadata/client_metadata.h"
#include "mongo/rpc/metadata/client_metadata_ismaster.h"
namespace mongo {
/**
* Tracks metrics for a single multi-document transaction.
*/
class SingleTransactionStats {
public:
/**
* Stores information about the last client to run a transaction operation.
*/
struct LastClientInfo {
std::string clientHostAndPort;
long long connectionId;
BSONObj clientMetadata;
std::string appName;
void update(Client* client) {
if (client->hasRemote()) {
clientHostAndPort = client->getRemote().toString();
}
connectionId = client->getConnectionId();
if (const auto& metadata =
ClientMetadataIsMasterState::get(client).getClientMetadata()) {
clientMetadata = metadata.get().getDocument();
appName = metadata.get().getApplicationName().toString();
}
}
};
SingleTransactionStats() : _txnNumber(kUninitializedTxnNumber){};
SingleTransactionStats(TxnNumber txnNumber) : _txnNumber(txnNumber){};
/**
* Returns the start time of the transaction in microseconds.
*
* This method cannot be called until setStartTime() has been called.
*/
unsigned long long getStartTime() const;
/**
* Sets the transaction's start time, only if it hasn't already been set.
*
* This method must only be called once.
*/
void setStartTime(unsigned long long time);
/**
* If the transaction is currently in progress, this method returns the duration
* the transaction has been running for in microseconds, given the current time value.
*
* For a completed transaction, this method returns the total duration of the
* transaction in microseconds.
*
* This method cannot be called until setStartTime() has been called.
*/
unsigned long long getDuration(unsigned long long curTime) const;
/**
* Sets the transaction's end time, only if the start time has already been set.
*
* This method cannot be called until setStartTime() has been called.
*/
void setEndTime(unsigned long long time);
/**
* Returns the total active time of the transaction, given the current time value. A transaction
* is active when there is a running operation that is part of the transaction.
*/
Microseconds getTimeActiveMicros(unsigned long long curTime) const;
/**
* Returns the total inactive time of the transaction, given the current time value. A
* transaction is inactive when it is idly waiting for a new operation to occur.
*/
Microseconds getTimeInactiveMicros(unsigned long long curTime) const;
/**
* Marks the transaction as active and sets the start of the transaction's active time.
*
* This method cannot be called if the transaction is currently active. A call to setActive()
* must be followed by a call to setInactive() before calling setActive() again.
*/
void setActive(unsigned long long time);
/**
* Marks the transaction as inactive and sets the total active time of the transaction. The
* total active time will only be set if the transaction was active prior to this call.
*
* This method cannot be called if the transaction is currently not active.
*/
void setInactive(unsigned long long time);
/**
* Returns whether or not the transaction is currently active.
*/
bool isActive() const {
return _lastTimeActiveStart != 0;
}
/**
* Returns whether or not the transaction has ended (aborted or committed).
*/
bool isEnded() const {
return _endTime != 0;
}
/**
* Returns whether these stats are for a multi-document transaction.
*/
bool isForMultiDocumentTransaction() const {
return _autoCommit != boost::none;
}
/**
* Returns the OpDebug object stored in this SingleTransactionStats instance.
*/
OpDebug* getOpDebug() {
return &_opDebug;
}
/**
* Returns the LastClientInfo object stored in this SingleTransactionStats instance.
*/
const LastClientInfo& getLastClientInfo() const {
return _lastClientInfo;
}
/**
* Updates the LastClientInfo object stored in this SingleTransactionStats instance with the
* given Client's information.
*/
void updateLastClientInfo(Client* client) {
_lastClientInfo.update(client);
}
/**
* Set the autoCommit field. If this field is unset, this is not a transaction but a
* retryable write and other values will not be meaningful.
*/
void setAutoCommit(boost::optional<bool> autoCommit) {
_autoCommit = autoCommit;
}
/**
* Set the transaction expiration date.
*/
void setExpireDate(Date_t expireDate) {
_expireDate = expireDate;
}
/**
* Set the transaction storage read timestamp.
*/
void setReadTimestamp(Timestamp readTimestamp) {
_readTimestamp = readTimestamp;
}
/**
* Append the stats to the builder.
*/
void report(BSONObjBuilder* builder, const repl::ReadConcernArgs& readConcernArgs) const;
private:
// The transaction number of the transaction.
TxnNumber _txnNumber;
// Unset for retryable write, 'false' for multi-document transaction. Value 'true' is
// for future use.
boost::optional<bool> _autoCommit;
// The start time of the transaction in microseconds.
unsigned long long _startTime{0};
// The end time of the transaction in microseconds.
unsigned long long _endTime{0};
// The total amount of active time spent by the transaction.
Microseconds _timeActiveMicros = Microseconds{0};
// The time at which the transaction was last marked as active in microseconds. The transaction
// is considered active if this value is not equal to 0.
unsigned long long _lastTimeActiveStart{0};
// The expiration date of the transaction.
Date_t _expireDate = Date_t::max();
// The storage read timestamp of the transaction.
Timestamp _readTimestamp;
// Tracks and accumulates stats from all operations that run inside the transaction.
OpDebug _opDebug;
// Holds information about the last client to run a transaction operation.
LastClientInfo _lastClientInfo;
};
} // namespace mongo
|
