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

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

# Interface: TailLogsOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:77](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L77)

Options for tailing logs.

## Extends

- [`TailLogsCallbacks`](TailLogsCallbacks.md)

## Properties

### lastEntries?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:93](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L93)

Number of recent entries to show per file on startup.
Set to 0 to skip initial entries and only show new ones.

#### Default

```ts
1
```

***

### maxEntries?

> `optional` **maxEntries**: `number`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:99](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L99)

Maximum number of entries to collect before stopping.
When set, the tail operation will automatically stop after collecting
this many entries. Useful for programmatic access.

***

### onEntry()?

> `optional` **onEntry**: (`entry`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:65](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L65)

Called for each new log entry

#### Parameters

##### entry

[`LogEntry`](LogEntry.md)

#### Returns

`void`

#### Inherited from

[`TailLogsCallbacks`](TailLogsCallbacks.md).[`onEntry`](TailLogsCallbacks.md#onentry)

***

### onError()?

> `optional` **onError**: (`error`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:67](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L67)

Called when an error occurs

#### Parameters

##### error

`Error`

#### Returns

`void`

#### Inherited from

[`TailLogsCallbacks`](TailLogsCallbacks.md).[`onError`](TailLogsCallbacks.md#onerror)

***

### onFileDiscovered()?

> `optional` **onFileDiscovered**: (`file`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:69](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L69)

Called when a new log file is discovered

#### Parameters

##### file

[`LogFile`](LogFile.md)

#### Returns

`void`

#### Inherited from

[`TailLogsCallbacks`](TailLogsCallbacks.md).[`onFileDiscovered`](TailLogsCallbacks.md#onfilediscovered)

***

### onFileRotated()?

> `optional` **onFileRotated**: (`file`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:71](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L71)

Called when file rotation is detected (file size decreased)

#### Parameters

##### file

[`LogFile`](LogFile.md)

#### Returns

`void`

#### Inherited from

[`TailLogsCallbacks`](TailLogsCallbacks.md).[`onFileRotated`](TailLogsCallbacks.md#onfilerotated)

***

### pathNormalizer()?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:104](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L104)

Path normalizer function to convert remote paths to local paths.
Called on each log message to make paths clickable in IDEs.

#### Parameters

##### message

`string`

#### Returns

`string`

***

### pollInterval?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:87](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L87)

Polling interval in milliseconds.

#### Default

```ts
3000
```

***

### prefixes?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/logs/types.ts:82](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/logs/types.ts#L82)

Filter by log prefixes (e.g., ["error", "customerror"]).

#### Default

```ts
["error", "customerror"]
```