@salesforce/b2c-tooling-sdk / operations/mrt / TailMrtLogsOptions

Interface: TailMrtLogsOptions

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

Options for tailing MRT logs.

Properties

environmentSlug

environmentSlug: string

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

MRT environment slug.

---

onClose()?

optional onClose: (code, reason) => void

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

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

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

Called for each parsed log entry.

Parameters

entry

MrtLogEntry

Returns

void

---

onError()?

optional onError: (error) => void

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

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

MRT API origin URL.

---

projectSlug

projectSlug: string

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

MRT project slug.

---

user?

optional user: string

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

User email for the WebSocket connection.