ui/server/src/logBuffer

A small, bounded, in-memory ring buffer of recent server/command output for the cockpit's Logs tab.

Cockpit server, v0.8. Source: ui/server/src/logBuffer.mjs.

Variables#

MAX_ENTRIES#

const MAX_ENTRIES: 500 = 500

Defined in: ui/server/src/logBuffer.mjs:5

---

MAX_TEXT#

const MAX_TEXT: 2000 = 2000

Defined in: ui/server/src/logBuffer.mjs:6

---

serverLog#

const serverLog: object

Defined in: ui/server/src/logBuffer.mjs:35

The process-wide buffer used by the server.

Type Declaration#

clear()

clear(): void

Returns

void

read()

read(since?): any[]

Entries with id greater than since (all when omitted), oldest first.

Parameters

since?

number = 0

Returns

any[]

record()

record(source, level, text, now?): object

Adds one line. Text is coerced to a string and truncated; unknown levels become 'info'.

Parameters

source

any

level

any

text

any

now?

number = ...

Returns

object

at

at: number = now

id

id: number

level

level: any

source

source: string

text

text: string = clipped

Functions#

createLogBuffer()#

createLogBuffer(max?): object

Defined in: ui/server/src/logBuffer.mjs:10

Parameters#

max?

number = MAX_ENTRIES

Returns#

clear()

clear(): void

Returns

void

read()

read(since?): any[]

Entries with id greater than since (all when omitted), oldest first.

Parameters

since?

number = 0

Returns

any[]

record()

record(source, level, text, now?): object

Adds one line. Text is coerced to a string and truncated; unknown levels become 'info'.

Parameters

source

any

level

any

text

any

now?

number = ...

Returns

object

at

at: number = now

id

id: number

level

level: any

source

source: string

text

text: string = clipped

---

handleLogs()#

handleLogs(query, __namedParameters): { body: { entries?: undefined; error: string; last?: undefined; ok: boolean; }; status: number; } | { body: { entries: any[]; error?: undefined; last: any; ok: boolean; }; status: number; }

Defined in: ui/server/src/logBuffer.mjs:38

GET /api/logs handler core: origin-guarded, returns { ok, entries, last }.

Parameters#

query

any

__namedParameters

clientOrigin

any

log?

{ clear: void; read: any[]; record: { at: number; id: number; level: any; source: string; text: string; }; } = serverLog

log.clear

log.read

log.record

origin

any

Returns#

{ body: { entries?: undefined; error: string; last?: undefined; ok: boolean; }; status: number; } | { body: { entries: any[]; error?: undefined; last: any; ok: boolean; }; status: number; }