summaryrefslogtreecommitdiff
path: root/src/mongo/db/server_transactions_metrics.h
blob: c6648bc2b0189da695a5efaaf9d8645bde5f7879 (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
/**
 *    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 <set>

#include "mongo/db/operation_context.h"
#include "mongo/db/repl/optime.h"
#include "mongo/db/service_context.h"
#include "mongo/db/transactions_stats_gen.h"
#include "mongo/util/concurrency/with_lock.h"

namespace mongo {

/**
 * Container for server-wide multi-document transaction statistics.
 */
class ServerTransactionsMetrics {
    MONGO_DISALLOW_COPYING(ServerTransactionsMetrics);

public:
    ServerTransactionsMetrics() = default;

    static ServerTransactionsMetrics* get(ServiceContext* service);
    static ServerTransactionsMetrics* get(OperationContext* opCtx);

    unsigned long long getCurrentActive() const;
    void decrementCurrentActive();
    void incrementCurrentActive();

    unsigned long long getCurrentInactive() const;
    void decrementCurrentInactive();
    void incrementCurrentInactive();

    unsigned long long getCurrentOpen() const;
    void decrementCurrentOpen();
    void incrementCurrentOpen();

    unsigned long long getTotalStarted() const;
    void incrementTotalStarted();

    unsigned long long getTotalAborted() const;
    void incrementTotalAborted();

    unsigned long long getTotalCommitted() const;
    void incrementTotalCommitted();

    unsigned long long getTotalPrepared() const;
    void incrementTotalPrepared();

    unsigned long long getTotalPreparedThenCommitted() const;
    void incrementTotalPreparedThenCommitted();

    unsigned long long getTotalPreparedThenAborted() const;
    void incrementTotalPreparedThenAborted();

    unsigned long long getCurrentPrepared() const;
    void incrementCurrentPrepared();
    void decrementCurrentPrepared();

    /**
     * Returns the OpTime of the oldest oplog entry written across all open transactions.
     * Returns boost::none if there are no transaction oplog entry OpTimes stored.
     */
    boost::optional<repl::OpTime> getOldestActiveOpTime() const;

    /**
     * Add the transaction's oplog entry OpTime to oldestActiveOplogEntryOpTimes, a set of OpTimes.
     * Also creates a pair with this OpTime and OpTime::max() as the corresponding commit/abort
     * oplog entry OpTime. Finally, adds this to oldestNonMajorityCommittedOpTimes.
     */
    void addActiveOpTime(repl::OpTime oldestOplogEntryOpTime);

    /**
     * Remove the corresponding transaction oplog entry OpTime if the transaction commits or
     * aborts. Also updates the pair in oldestNonMajorityCommittedOpTimes with the
     * oldestOplogEntryOpTime to have a valid finishOpTime instead of OpTime::max(). It's stored in
     * the format: < oldestOplogEntryOpTime, finishOpTime >.
     */
    void removeActiveOpTime(repl::OpTime oldestOplogEntryOpTime,
                            boost::optional<repl::OpTime> finishOpTime);

    /**
     * Returns the number of transaction oplog entry OpTimes currently stored.
     */
    unsigned int getTotalActiveOpTimes() const;

    /**
     * Returns the oldest oplog entry OpTime across transactions whose corresponding commit or
     * abort oplog entry has not been majority committed.
     */
    boost::optional<repl::OpTime> getOldestNonMajorityCommittedOpTime() const;

    /**
     * Remove the corresponding transaction oplog entry OpTime pair from
     * oldestNonMajorityCommittedOpTimes if the transaction is majority committed or aborted.
     * We determine this by checking if there are any pairs in the set whose
     * 'finishOpTime' <= 'committedOpTime'.
     */
    void removeOpTimesLessThanOrEqToCommittedOpTime(repl::OpTime committedOpTime);

    /**
     * Testing function that adds an OpTime pair to oldestNonMajorityCommittedOpTimes.
     */
    void addNonMajCommittedOpTimePair_forTest(std::pair<repl::OpTime, repl::OpTime> OpTimePair);

    /**
     * Testing function that returns the oldest non-majority committed OpTime pair in the form:
     * < oldestOplogEntryOpTime, finishOpTime >.
     */
    boost::optional<repl::OpTime> getFinishOpTimeOfOldestNonMajCommitted_forTest() const;

    /**
     * Appends the accumulated stats to a transactions stats object.
     */
    void updateStats(TransactionsStats* stats, OperationContext* opCtx);

    /**
     * Invalidates the in-memory state of prepared transactions during replication rollback by
     * clearing oldestActiveOplogEntryOpTime, oldestActiveOplogEntryOpTimes, and
     * oldestNonMajorityCommittedOpTimes. These variables/data structures should be properly
     * reconstructed during replication recovery.
     */
    void clearOpTimes();

private:
    /**
     * Returns the first and oldest optime in the ordered set of active oplog entry optimes.
     * Returns boost::none if there are no transaction oplog entry optimes stored.
     */
    boost::optional<repl::OpTime> _calculateOldestActiveOpTime(WithLock) const;

    /**
     * Returns the oldest read timestamp in use by any open unprepared transaction. This will
     * return a null timestamp if there is no oldest open unprepared read timestamp to be
     * returned.
     */
    static Timestamp _getOldestOpenUnpreparedReadTimestamp(OperationContext* opCtx);

    //
    // Member variables, excluding atomic variables, are labeled with the following code to
    // indicate the synchronization rules for accessing them.
    //
    // (M)  Reads and writes guarded by _mutex
    //
    mutable stdx::mutex _mutex;

    // The number of multi-document transactions currently active.
    AtomicWord<unsigned long long> _currentActive{0};

    // The number of multi-document transactions currently inactive.
    AtomicWord<unsigned long long> _currentInactive{0};

    // The total number of open transactions.
    AtomicWord<unsigned long long> _currentOpen{0};

    // The total number of multi-document transactions started since the last server startup.
    AtomicWord<unsigned long long> _totalStarted{0};

    // The total number of multi-document transaction aborts.
    AtomicWord<unsigned long long> _totalAborted{0};

    // The total number of multi-document transaction commits.
    AtomicWord<unsigned long long> _totalCommitted{0};

    // The total number of prepared transactions since the last server startup.
    AtomicWord<unsigned long long> _totalPrepared{0};

    // The total number of prepared transaction commits.
    AtomicWord<unsigned long long> _totalPreparedThenCommitted{0};

    // The total number of prepared transaction aborts.
    AtomicWord<unsigned long long> _totalPreparedThenAborted{0};

    // The current number of transactions in the prepared state.
    AtomicWord<unsigned long long> _currentPrepared{0};

    // The optime of the oldest oplog entry for any active transaction.
    boost::optional<repl::OpTime> _oldestActiveOplogEntryOpTime;  // (M)

    // Maintain the oldest oplog entry OpTime across all active transactions. Currently, we only
    // write an oplog entry for an ongoing transaction if it is in the `prepare` state. By
    // maintaining an ordered set of OpTimes, the OpTime at the beginning will be the oldest.
    std::set<repl::OpTime> _oldestActiveOplogEntryOpTimes;  // (M)

    // Maintain the oldest oplog entry OpTime across transactions whose corresponding abort/commit
    // oplog entries have not been majority committed. Since this is an ordered set, the first
    // pair's oldestOplogEntryOpTime represents the earliest OpTime that we should pin the stable
    // timestamp behind.
    // Each pair is structured as follows: <oldestOplogEntryOpTime, finishOpTime>
    // 'oldestOplogEntryOpTime': The first oplog entry OpTime written by a transaction.
    // 'finishOpTime': The commit/abort oplog entry OpTime.
    // Once the corresponding abort/commit entry has been majority committed, remove the pair from
    // this set.
    std::set<std::pair<repl::OpTime, repl::OpTime>> _oldestNonMajorityCommittedOpTimes;  // (M)
};

}  // namespace mongo