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
|
/**
* Copyright (C) 2019-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 "mongo/db/s/server_transaction_coordinators_metrics.h"
#include "mongo/db/s/single_transaction_coordinator_stats.h"
#include "mongo/db/s/transaction_coordinator.h"
namespace mongo {
/**
* Updates transaction coordinator metrics (per- two-phase commit metrics and server-wide two-phase
* commit metrics) upon the appropriate event.
*/
class TransactionCoordinatorMetricsObserver {
public:
/**
* Updates relevant metrics when a transaction coordinator is created.
*/
void onCreate(ServerTransactionCoordinatorsMetrics* serverTransactionCoordinatorMetrics,
TickSource* tickSource,
Date_t curWallClockTime);
/**
* Called when the transaction coordinator has recovered and continues the commit.
*/
void onRecoveryFromFailover();
/**
* Updates relevant metrics when a transaction coordinator is about to write the participant
* list.
*/
void onStartWritingParticipantList(
ServerTransactionCoordinatorsMetrics* serverTransactionCoordinatorMetrics,
TickSource* tickSource,
Date_t curWallClockTime);
/**
* Updates relevant metrics when a transaction coordinator is about to send 'prepare' and start
* waiting for votes (i.e., 'prepare' responses).
*/
void onStartWaitingForVotes(
ServerTransactionCoordinatorsMetrics* serverTransactionCoordinatorMetrics,
TickSource* tickSource,
Date_t curWallClockTime);
/**
* Updates relevant metrics when a transaction coordinator is about to write the decision.
*/
void onStartWritingDecision(
ServerTransactionCoordinatorsMetrics* serverTransactionCoordinatorMetrics,
TickSource* tickSource,
Date_t curWallClockTime);
/**
* Updates relevant metrics when a transaction coordinator is about to send the decision to
* participants and start waiting for acknowledgements.
*/
void onStartWaitingForDecisionAcks(
ServerTransactionCoordinatorsMetrics* serverTransactionCoordinatorMetrics,
TickSource* tickSource,
Date_t curWallClockTime);
/**
* Updates relevant metrics when a transaction coordinator is about to delete its durable state.
*/
void onStartDeletingCoordinatorDoc(
ServerTransactionCoordinatorsMetrics* serverTransactionCoordinatorMetrics,
TickSource* tickSource,
Date_t curWallClockTime);
/**
* Updates relevant metrics when a transaction coordinator is destroyed.
*
* The 'lastStep' parameter is needed because, unlike for the other state transitions, the
* coordinator can transition to the end state from any other state, for example on stepdown.
*/
void onEnd(ServerTransactionCoordinatorsMetrics* serverTransactionCoordinatorMetrics,
TickSource* tickSource,
Date_t curWallClockTime,
TransactionCoordinator::Step lastStep,
const boost::optional<txn::CoordinatorCommitDecision>& decision);
/**
* Returns a read-only reference to the SingleTransactionCoordinatorStats object stored in this
* TransactionCoordinatorMetricsObserver instance.
*/
const SingleTransactionCoordinatorStats& getSingleTransactionCoordinatorStats() const {
return _singleTransactionCoordinatorStats;
}
/**
* Save information about the last client that interacted with this transaction.
*/
void updateLastClientInfo(Client* client);
private:
/**
* Decrements the current active in 'step'.
*/
void _decrementLastStep(ServerTransactionCoordinatorsMetrics*, TransactionCoordinator::Step);
// Tracks metrics for a single commit coordination.
SingleTransactionCoordinatorStats _singleTransactionCoordinatorStats;
};
} // namespace mongo
|
