ui/server/src/health-1

Cockpit server, v0.8. Source: n/a.

Variables#

DEFAULT_MIN_FREE_MB#

const DEFAULT_MIN_FREE_MB: 500 = 500

Defined in: ui/server/src/health.mjs:16

---

HEALTH_CACHE_MS#

const HEALTH_CACHE_MS: 10000 = 10_000

Defined in: ui/server/src/health.mjs:17

Functions#

checkDir()#

checkDir(dir, minFreeBytes): object

Defined in: ui/server/src/health.mjs:51

{writable, error?, freeBytes, low} for one directory.

Parameters#

dir

any

minFreeBytes

any

Returns#

object

error?

optional error?: any = w.error

freeBytes

freeBytes: number

low

low: boolean

writable

writable: boolean = w.writable

---

createHealth()#

createHealth(deps): object

Defined in: ui/server/src/health.mjs:67

Parameters#

deps

cacheMs?

number = HEALTH_CACHE_MS

getStateDir

() => string

getWorkspaceRoot

() => string

gitStatus

() => object

minFreeBytes?

number = ...

nodeVersion?

string = process.version

now?

() => number = Date.now

Returns#

describeStartup()

describeStartup(): object[]

The same facts as {level, text} lines for the server's startup log (these MAY name paths: the log is local).

Returns

object[]

snapshot()

snapshot(__namedParameters?): any

The health document; cached for cacheMs unless fresh is asked for.

Parameters

__namedParameters?

fresh?

boolean = false

Returns

any

---

freeBytesOf()#

freeBytesOf(dir): number

Defined in: ui/server/src/health.mjs:41

Bytes available to this user on the filesystem holding dir, or null when it cannot be told.

Parameters#

dir

any

Returns#

number

---

probeWritable()#

probeWritable(dir): { error?: undefined; writable: boolean; } | { error: any; writable: boolean; }

Defined in: ui/server/src/health.mjs:27

A real write: create dir if missing, write one byte to a private file in it, remove the file.

Parameters#

dir

any

Returns#

{ error?: undefined; writable: boolean; } | { error: any; writable: boolean; }

---

resolveMinFreeBytes()#

resolveMinFreeBytes(env?): number

Defined in: ui/server/src/health.mjs:20

The low-space threshold in bytes: CONSTRUCT_HEALTH_MIN_FREE_MB (default 500).

Parameters#

env?

any = process.env

Returns#

number