blob: 0930ce81d228c36504988d45ef3bd4cb505ead66 (
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
|
/**
* Copyright (C) 2022-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 <boost/optional.hpp>
#include "mongo/util/clock_source.h"
#include "mongo/util/duration.h"
#include "mongo/util/time_support.h"
#include "mongo/util/timer.h"
namespace mongo {
/**
* A class to record the metrics for various phases of connection establishment.
*
* This class expects a clock source to measure the duration of each phase of the connection
* establishment. The clock source must always outlive instances of this class.
*
* The methods that record the individual phases must be called in the following order:
* - onConnectionStarted()
* - onDNSResolved()
* - onTCPConnectionEstablished()
* - onTLSHandshakeFinished()
* - onAuthFinished()
* - onConnectionHookFinished()
* The calls for TLS handshake and post-auth hook can be skipped. All other calls are mandatory.
*/
class ConnectionMetrics {
public:
ConnectionMetrics(ClockSource* clkSource) : _clkSource(clkSource) {}
const boost::optional<Milliseconds>& dnsResolution() const {
return _dnsResolution;
}
const boost::optional<Milliseconds>& tcpConnection() const {
return _tcpConnection;
}
const boost::optional<Milliseconds>& tlsHandshake() const {
return _tlsHandshake;
}
const boost::optional<Milliseconds>& auth() const {
return _auth;
}
const boost::optional<Milliseconds>& connectionHook() const {
return _connectionHook;
}
Milliseconds total() const {
return _total;
}
void onConnectionStarted() {
invariant(!_stopWatch);
_stopWatch.emplace(_clkSource->makeStopWatch());
}
void onDNSResolved() {
invariant(_stopWatch);
invariant(!_dnsResolution);
_dnsResolution = _finishPhase();
}
void onTCPConnectionEstablished() {
invariant(_dnsResolution);
invariant(!_tcpConnection);
_tcpConnection = _finishPhase();
}
void onTLSHandshakeFinished() {
invariant(_tcpConnection);
invariant(!_tlsHandshake);
invariant(!_auth);
_tlsHandshake = _finishPhase();
}
void onAuthFinished() {
invariant(_tcpConnection);
invariant(!_auth);
_auth = _finishPhase();
}
void onConnectionHookFinished() {
invariant(_auth);
invariant(!_connectionHook);
_connectionHook = _finishPhase();
}
void startConnAcquiredTimer() {
_fromConnAcquiredTimer.reset();
}
Timer* getConnAcquiredTimer() {
return &_fromConnAcquiredTimer;
}
private:
Milliseconds _finishPhase() {
auto elapsed = _stopWatch->elapsed();
_stopWatch->restart();
_total += elapsed;
return elapsed;
}
ClockSource* const _clkSource;
boost::optional<ClockSource::StopWatch> _stopWatch;
boost::optional<Milliseconds> _dnsResolution;
boost::optional<Milliseconds> _tcpConnection;
boost::optional<Milliseconds> _tlsHandshake;
boost::optional<Milliseconds> _auth;
boost::optional<Milliseconds> _connectionHook;
// A timer that is initialized from when an egress connection is acquired from the connection
// pool.
Timer _fromConnAcquiredTimer;
Milliseconds _total{0};
};
} // namespace mongo
|
