@salesforce/b2c-tooling-sdk / operations/logs / tailLogs

Function: tailLogs()

tailLogs(instance, options): Promise<TailLogsResult>

Defined in: packages/b2c-tooling-sdk/src/operations/logs/tail.ts:191

Tails log files on a B2C Commerce instance.

Continuously polls for new log content using HTTP Range requests for efficiency. Calls the onEntry callback for each new log line.

Parameters

instance

B2CInstance

B2C instance to tail logs from

options

TailLogsOptions = {}

Tailing options (filters, callbacks, polling interval)

Returns

Promise<TailLogsResult>

Tail result with stop() control and done promise

Example

const result = await tailLogs(instance, {
  prefixes: ['error', 'customerror'],
  onEntry: (entry) => console.log(`[${entry.file}] ${entry.message}`),
  onError: (err) => console.error('Tail error:', err),
});

// Stop after 10 seconds
setTimeout(() => result.stop(), 10000);

// Wait for tailing to complete
await result.done;