@salesforce/b2c-tooling-sdk / operations/logs / WatchLogsOptions
Interface: WatchLogsOptions
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch.ts:21
Entry filters applied as entries arrive, before buffering.
Extends
Properties
bufferBytesCap?
optionalbufferBytesCap:number
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts:39
Maximum buffered bytes. Default: 50 MiB.
Inherited from
LogWatchBufferOptions.bufferBytesCap
bufferCap?
optionalbufferCap:number
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts:37
Maximum buffered entries. Default: 5000.
Inherited from
LogWatchBufferOptions.bufferCap
lastEntries?
optionallastEntries:number
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch.ts:27
Existing entries per file to buffer at startup. Default: 0.
level?
optionallevel:string[]
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts:30
Keep only these levels (case-insensitive). Entries without a level are dropped when set.
Inherited from
pathNormalizer()?
optionalpathNormalizer: (message) =>string
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch.ts:29
Converts remote paths in messages to local paths.
Parameters
message
string
Returns
string
pollInterval?
optionalpollInterval:number
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch.ts:25
WebDAV polling interval in milliseconds. Default: 3000.
prefixes?
optionalprefixes:string[]
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch.ts:23
Log prefixes. Default: ["error", "customerror"].
search?
optionalsearch:string
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts:32
Keep only entries whose message or raw line contains this text (case-insensitive).
Inherited from
tail()?
optionaltail: (instance,options) =>Promise<TailLogsResult>
Defined in: packages/b2c-tooling-sdk/src/operations/logs/watch.ts:31
Replaces tailLogs, for tests.
Parameters
instance
options
Returns
Promise<TailLogsResult>