-
Notifications
You must be signed in to change notification settings - Fork 8.2k
/
status.ts
167 lines (155 loc) · 4.96 KB
/
status.ts
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
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
import { Observable, combineLatest, ReplaySubject } from 'rxjs';
import { first } from 'rxjs/operators';
import { schema } from '@kbn/config-schema';
import { IRouter } from '../../http';
import { MetricsServiceSetup } from '../../metrics';
import { ServiceStatus, CoreStatus, ServiceStatusLevels } from '../types';
import { PluginName } from '../../plugins';
import { calculateLegacyStatus, LegacyStatusInfo } from '../legacy_status';
import { PackageInfo } from '../../config';
const SNAPSHOT_POSTFIX = /-SNAPSHOT$/;
interface Deps {
router: IRouter;
config: {
allowAnonymous: boolean;
packageInfo: PackageInfo;
serverName: string;
uuid: string;
};
metrics: MetricsServiceSetup;
status: {
overall$: Observable<ServiceStatus>;
core$: Observable<CoreStatus>;
plugins$: Observable<Record<PluginName, ServiceStatus>>;
};
}
interface StatusInfo {
overall: ServiceStatus;
core: CoreStatus;
plugins: Record<string, ServiceStatus>;
}
interface StatusHttpBody {
name: string;
uuid: string;
version: {
number: string;
build_hash: string;
build_number: number;
build_snapshot: boolean;
};
status: StatusInfo | LegacyStatusInfo;
metrics: {
/** ISO-8601 date string w/o timezone */
last_updated: string;
collection_interval_in_millis: number;
process: {
memory: {
heap: {
total_in_bytes: number;
used_in_bytes: number;
size_limit: number;
};
resident_set_size_in_bytes: number;
};
event_loop_delay: number;
pid: number;
uptime_in_millis: number;
};
os: {
load: Record<string, number>;
memory: {
total_in_bytes: number;
used_in_bytes: number;
free_in_bytes: number;
};
uptime_in_millis: number;
platform: string;
platformRelease: string;
};
response_times: {
max_in_millis: number;
};
requests: {
total: number;
disconnects: number;
statusCodes: Record<number, number>;
status_codes: Record<number, number>;
};
concurrent_connections: number;
};
}
export const registerStatusRoute = ({ router, config, metrics, status }: Deps) => {
// Since the status.plugins$ observable is not subscribed to elsewhere, we need to subscribe it here to eagerly load
// the plugins status when Kibana starts up so this endpoint responds quickly on first boot.
const combinedStatus$ = new ReplaySubject<
[ServiceStatus<unknown>, CoreStatus, Record<string, ServiceStatus<unknown>>]
>(1);
combineLatest([status.overall$, status.core$, status.plugins$]).subscribe(combinedStatus$);
router.get(
{
path: '/api/status',
options: {
authRequired: !config.allowAnonymous,
tags: ['api'], // ensures that unauthenticated calls receive a 401 rather than a 302 redirect to login page
},
validate: {
query: schema.object({
v8format: schema.boolean({ defaultValue: false }),
}),
},
},
async (context, req, res) => {
const { version, buildSha, buildNum } = config.packageInfo;
const versionWithoutSnapshot = version.replace(SNAPSHOT_POSTFIX, '');
const [overall, core, plugins] = await combinedStatus$.pipe(first()).toPromise();
let statusInfo: StatusInfo | LegacyStatusInfo;
if (req.query?.v8format) {
statusInfo = {
overall,
core,
plugins,
};
} else {
statusInfo = calculateLegacyStatus({
overall,
core,
plugins,
versionWithoutSnapshot,
});
}
const lastMetrics = await metrics.getOpsMetrics$().pipe(first()).toPromise();
const body: StatusHttpBody = {
name: config.serverName,
uuid: config.uuid,
version: {
number: versionWithoutSnapshot,
build_hash: buildSha,
build_number: buildNum,
build_snapshot: SNAPSHOT_POSTFIX.test(version),
},
status: statusInfo,
metrics: {
last_updated: lastMetrics.collected_at.toISOString(),
collection_interval_in_millis: metrics.collectionInterval,
os: lastMetrics.os,
process: lastMetrics.process,
response_times: lastMetrics.response_times,
concurrent_connections: lastMetrics.concurrent_connections,
requests: {
...lastMetrics.requests,
status_codes: lastMetrics.requests.statusCodes,
},
},
};
const statusCode = overall.level >= ServiceStatusLevels.unavailable ? 503 : 200;
return res.custom({ body, statusCode, bypassErrorFormat: true });
}
);
};