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

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

# Interface: TailMrtLogsOptions

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts:52](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts#L52)

Options for tailing MRT logs.

## Properties

### environmentSlug

> **environmentSlug**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts:56](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts#L56)

MRT environment slug.

***

### onClose()?

> `optional` **onClose**: (`code`, `reason`) => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts:68](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts#L68)

Called when the WebSocket connection closes.

#### Parameters

##### code

`number`

##### reason

`string`

#### Returns

`void`

***

### onConnect()?

> `optional` **onConnect**: () => `void`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts:64](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts#L64)

Called when the WebSocket connection is established.

#### Returns

`void`

***

### onEntry()?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts:62](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts#L62)

Called for each parsed log entry.

#### Parameters

##### entry

[`MrtLogEntry`](MrtLogEntry.md)

#### Returns

`void`

***

### onError()?

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

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts:66](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts#L66)

Called on WebSocket error.

#### Parameters

##### error

`Error`

#### Returns

`void`

***

### origin?

> `optional` **origin**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts:58](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts#L58)

MRT API origin URL.

***

### projectSlug

> **projectSlug**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts:54](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts#L54)

MRT project slug.

***

### user?

> `optional` **user**: `string`

Defined in: [packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts:60](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/operations/mrt/tail-logs.ts#L60)

User email for the WebSocket connection.