Skip to content

Add TunnelDuration metric #694

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jaomaloy wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add TunnelDuration metric #694

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/proxy-worker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,15 @@ class Tunnel extends nodeTunnel.Tunnel {
) {
this.logger.info(`connecting to ${host}:${port}`);
const socket = await super.connect(port, host, client, req);
const startTime = process.hrtime()[0];
metrics.inc(Metrics.ActiveTunnels);
metrics.inc(Metrics.TotalTunnels);
socket.on('close', (hadError) => {
metrics.dec(Metrics.ActiveTunnels);
metrics.histogram(
Metrics.TunnelDuration,
process.hrtime()[0] - startTime,
);
if (hadError) {
metrics.inc(Metrics.TunnelErrors);
}
Expand Down
36 changes: 21 additions & 15 deletions src/utils/metrics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,24 @@ export const enum Metrics {
ActiveTunnels = 'vpn_proxy_active_tunnels',
TotalTunnels = 'vpn_proxy_total_tunnels',
TunnelErrors = 'vpn_proxy_tunnel_errors',
TunnelDuration = 'vpn_proxy_tunnel_duration',
}

const min = 60;
const hour = 60 * min;
const day = 24 * hour;
const week = 7 * day;
const durationBuckets = [
1 * min,
5 * min,
15 * min,
1 * hour,
6 * hour,
12 * hour,
1 * day,
1 * week, // 1w - very stable long-running sessions, could be affected by deployment restarts, but still worth tracking
];

export const describeWorkerMetrics = () => {
metrics.describe.gauge(Metrics.OnlineDevices, 'vpn current online devices');
metrics.gauge(Metrics.OnlineDevices, 0);
Expand Down Expand Up @@ -52,6 +68,11 @@ export const describeWorkerMetrics = () => {
'number of tunnels failed due to transmission error',
);
metrics.counter(Metrics.TunnelErrors, 0);
metrics.describe.histogram(
Metrics.TunnelDuration,
'histogram showing duration of proxy tunnel sessions',
{ buckets: durationBuckets },
);
};
export const describePrimaryMetrics = () => {
const kb = 2 ** 10; // 1024
Expand Down Expand Up @@ -99,21 +120,6 @@ export const describePrimaryMetrics = () => {
'histogram of average tx rate per vpn client',
{ buckets: bitrateBuckets },
);
const min = 60;
const hour = 60 * min;
const day = 24 * hour;
const week = 7 * day;
const durationBuckets = [
1 * min,
5 * min,
15 * min,
1 * hour,
6 * hour,
12 * hour,
1 * day,
1 * week, // 1w - very stable long-running sessions, could be affected by deployment restarts, but still worth tracking
];

metrics.describe.histogram(
Metrics.SessionDuration,
'histogram showing duration of vpn sessions',
Expand Down
Loading