File tree Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Expand file tree Collapse file tree 1 file changed +15
-0
lines changed Original file line number Diff line number Diff line change 19
19
- [ How does code-server decide what workspace or folder to open?] ( #how-does-code-server-decide-what-workspace-or-folder-to-open )
20
20
- [ How do I debug issues with code-server?] ( #how-do-i-debug-issues-with-code-server )
21
21
- [ Heartbeat File] ( #heartbeat-file )
22
+ - [ Healthz endpoint] ( #healthz-endpoint )
22
23
- [ How does the config file work?] ( #how-does-the-config-file-work )
23
24
- [ Blank screen on iPad?] ( #blank-screen-on-ipad )
24
25
- [ Isn't an install script piped into sh insecure?] ( #isnt-an-install-script-piped-into-sh-insecure )
@@ -240,6 +241,20 @@ If you want to shutdown `code-server` if there hasn't been an active connection
240
241
you can do so by continuously checking the last modified time on the heartbeat file and if it is
241
242
older than X minutes, kill ` code-server ` .
242
243
244
+ ## Healthz endpoint
245
+
246
+ ` code-server ` exposes an endpoint at ` /healthz ` which can be used to check
247
+ whether ` code-server ` is up without triggering a heartbeat. The response will
248
+ include a status (` alive ` or ` expired ` ) and a timestamp for the last heartbeat
249
+ (defaults to ` 0 ` ).
250
+
251
+ ``` json
252
+ {
253
+ "status" : " alive" ,
254
+ "lastHeartbeat" : 1599166210566 ,
255
+ }
256
+ ```
257
+
243
258
[ #1636 ] ( https://github.com/cdr/code-server/issues/1636 ) will make the experience here better.
244
259
245
260
## How does the config file work?
You can’t perform that action at this time.
0 commit comments