---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../../modules.md) / [operations/logs](../index.md) / WatchLogsOptions

# Interface: WatchLogsOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch.ts:21](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch.ts#L21)

Entry filters applied as entries arrive, before buffering.

## Extends

- [`LogWatchBufferOptions`](LogWatchBufferOptions.md)

## Properties

### bufferBytesCap?

> `optional` **bufferBytesCap**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts:39](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts#L39)

Maximum buffered bytes. Default: 50 MiB.

#### Inherited from

[`LogWatchBufferOptions`](LogWatchBufferOptions.md).[`bufferBytesCap`](LogWatchBufferOptions.md#bufferbytescap)

***

### bufferCap?

> `optional` **bufferCap**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts:37](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts#L37)

Maximum buffered entries. Default: 5000.

#### Inherited from

[`LogWatchBufferOptions`](LogWatchBufferOptions.md).[`bufferCap`](LogWatchBufferOptions.md#buffercap)

***

### lastEntries?

> `optional` **lastEntries**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch.ts:27](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch.ts#L27)

Existing entries per file to buffer at startup. Default: 0.

***

### level?

> `optional` **level**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts:30](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts#L30)

Keep only these levels (case-insensitive). Entries without a level are dropped when set.

#### Inherited from

[`LogWatchBufferOptions`](LogWatchBufferOptions.md).[`level`](LogWatchBufferOptions.md#level)

***

### pathNormalizer()?

> `optional` **pathNormalizer**: (`message`) => `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch.ts:29](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch.ts#L29)

Converts remote paths in messages to local paths.

#### Parameters

##### message

`string`

#### Returns

`string`

***

### pollInterval?

> `optional` **pollInterval**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch.ts:25](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch.ts#L25)

WebDAV polling interval in milliseconds. Default: 3000.

***

### prefixes?

> `optional` **prefixes**: `string`[]

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch.ts:23](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch.ts#L23)

Log prefixes. Default: `["error", "customerror"]`.

***

### search?

> `optional` **search**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts:32](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch-buffer.ts#L32)

Keep only entries whose message or raw line contains this text (case-insensitive).

#### Inherited from

[`LogWatchBufferOptions`](LogWatchBufferOptions.md).[`search`](LogWatchBufferOptions.md#search)

***

### tail()?

> `optional` **tail**: (`instance`, `options`) => `Promise`\<[`TailLogsResult`](TailLogsResult.md)\>

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/watch.ts:31](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/operations/logs/watch.ts#L31)

Replaces [tailLogs](../functions/tailLogs.md), for tests.

#### Parameters

##### instance

[`B2CInstance`](../../../instance/classes/B2CInstance.md)

##### options

[`TailLogsOptions`](TailLogsOptions.md)

#### Returns

`Promise`\<[`TailLogsResult`](TailLogsResult.md)\>
