Configuration options for LogStream model instances.

These options specify the log stream identity and source location for connecting to specific log streams on KOS devices.

Example: Basic Log Stream Configuration

const options: LogStreamOptions = {
name: 'application-logs',
nodeId: 'primary'
};

const logStream = LogStream.instance('app-logger')
.options(options)
.build();

Example: Multiple Stream Types

// System logs from primary node
const systemLogs = LogStream.instance('system')
.options({ name: 'system-logs', nodeId: 'primary' })
.build();

// Error logs from secondary node
const errorLogs = LogStream.instance('errors')
.options({ name: 'error-logs', nodeId: 'secondary' })
.build();

// Debug logs from development node
const debugLogs = LogStream.instance('debug')
.options({ name: 'debug-logs', nodeId: 'dev-node' })
.build();
interface LogStreamOptions {
    name: string;
    nodeId: string;
}

Properties

Properties

name: string

Name of the log stream to connect to.

This should match the log stream name available on the target device. Common stream names include 'application-logs', 'system-logs', 'error-logs'.

nodeId: string

Node identifier where the log stream is located.

Specifies which KOS device node contains the target log stream. Typically 'primary' for main device logs, but can be any valid node ID.

Default

'primary'