-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathssh.ts
More file actions
187 lines (170 loc) · 5.18 KB
/
Copy pathssh.ts
File metadata and controls
187 lines (170 loc) · 5.18 KB
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
import type { NetworkInfo } from "../remote/sshProcess";
import type { TelemetryReporter } from "../telemetry/reporter";
const NETWORK_SAMPLE_INTERVAL_MS = 60_000;
const NETWORK_CHANGE_COOLDOWN_MS = 15_000;
const NETWORK_LATENCY_CHANGE_RATIO = 0.2;
const NETWORK_LATENCY_MIN_ABSOLUTE_CHANGE_MS = 25;
export type ProcessLossCause = "stale_network_info" | "missing_network_info";
interface NetworkSample {
readonly emittedAtMs: number;
readonly p2p: boolean;
readonly preferredDerp: string;
readonly latencyMs: number;
}
interface ProcessDiscoveryResult {
readonly pid: number | undefined;
readonly attempts: number;
}
export class SshTelemetry {
readonly #telemetry: TelemetryReporter;
#processStartedAtMs: number | undefined;
#processLostAtMs: number | undefined;
#lastNetworkSample: NetworkSample | undefined;
public constructor(telemetry: TelemetryReporter) {
this.#telemetry = telemetry;
}
public traceProcessDiscovery(
fn: () => Promise<ProcessDiscoveryResult>,
): Promise<number | undefined> {
return this.#telemetry.trace("ssh.process.discovered", async (span) => {
const { pid, attempts } = await fn();
span.setProperty("found", pid !== undefined);
span.setMeasurement("attempts", attempts);
return pid;
});
}
public processStarted(): void {
this.#processStartedAtMs = performance.now();
this.#processLostAtMs = undefined;
}
public processLost(cause: ProcessLossCause): void {
if (
this.#processStartedAtMs === undefined ||
this.#processLostAtMs !== undefined
) {
return;
}
const now = performance.now();
this.#processLostAtMs = now;
this.#telemetry.log(
"ssh.process.lost",
{ cause },
{ uptime_ms: now - this.#processStartedAtMs },
);
}
public processRecovered(): void {
if (this.#processLostAtMs === undefined) {
return;
}
this.#telemetry.log(
"ssh.process.recovered",
{},
{ recovery_duration_ms: performance.now() - this.#processLostAtMs },
);
this.#processLostAtMs = undefined;
}
/** Handover to a different SSH process. Always emits `ssh.process.replaced`,
* even when the prior process was already lost (replacement is operationally
* distinct from recovery). */
public processReplaced(): void {
const now = performance.now();
if (this.#processStartedAtMs !== undefined) {
const measurements: Record<string, number> = {
previous_uptime_ms: now - this.#processStartedAtMs,
};
if (this.#processLostAtMs !== undefined) {
measurements.lost_duration_ms = now - this.#processLostAtMs;
}
this.#telemetry.log(
"ssh.process.replaced",
{ was_lost: this.#processLostAtMs !== undefined },
measurements,
);
}
this.#processStartedAtMs = now;
this.#processLostAtMs = undefined;
this.#lastNetworkSample = undefined;
}
/** Terminal teardown signal. Emits regardless of prior lost state so
* consumers always see a session-ending event. */
public disposed(): void {
if (this.#processStartedAtMs === undefined) {
return;
}
const now = performance.now();
this.#telemetry.log(
"ssh.process.disposed",
{ was_lost: this.#processLostAtMs !== undefined },
{ uptime_ms: now - this.#processStartedAtMs },
);
this.#processStartedAtMs = undefined;
this.#processLostAtMs = undefined;
this.#lastNetworkSample = undefined;
}
public networkSampled(network: NetworkInfo): void {
const now = performance.now();
const previous = this.#lastNetworkSample;
if (previous && !shouldEmitSample(previous, network, now)) {
return;
}
this.#lastNetworkSample = {
emittedAtMs: now,
p2p: network.p2p,
preferredDerp: network.preferred_derp,
latencyMs: network.latency,
};
this.#telemetry.log(
"ssh.network.sampled",
{
p2p: network.p2p,
preferred_derp: network.preferred_derp,
},
{
latency_ms: network.latency,
download_mbits: bytesPerSecondToMbits(network.download_bytes_sec),
upload_mbits: bytesPerSecondToMbits(network.upload_bytes_sec),
},
);
}
}
/** Emit on the heartbeat interval, or on a p2p flip, DERP change, or large
* latency swing once the change cooldown has elapsed. Suppression leaves the
* last emitted sample in place, so a change that persists through the
* cooldown is emitted when it expires rather than lost. */
function shouldEmitSample(
previous: NetworkSample,
current: NetworkInfo,
now: number,
): boolean {
const sinceLastEmit = now - previous.emittedAtMs;
if (sinceLastEmit >= NETWORK_SAMPLE_INTERVAL_MS) {
return true;
}
if (sinceLastEmit < NETWORK_CHANGE_COOLDOWN_MS) {
return false;
}
if (current.p2p !== previous.p2p) {
return true;
}
if (current.preferred_derp !== previous.preferredDerp) {
return true;
}
return hasMeaningfulLatencyChange(current.latency, previous.latencyMs);
}
function hasMeaningfulLatencyChange(
current: number,
previous: number,
): boolean {
if (previous === 0) {
return current !== 0;
}
const absoluteChange = Math.abs(current - previous);
// The absolute floor mutes fast-link jitter; the ratio mutes slow-link noise.
return (
absoluteChange >= NETWORK_LATENCY_MIN_ABSOLUTE_CHANGE_MS &&
absoluteChange / Math.abs(previous) >= NETWORK_LATENCY_CHANGE_RATIO
);
}
function bytesPerSecondToMbits(bytesPerSecond: number): number {
return (bytesPerSecond * 8) / 1_000_000;
}