Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

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

Function: tailMrtLogs()

tailMrtLogs(options, auth): Promise<TailMrtLogsResult>

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

Streams application logs from an MRT environment via WebSocket.

Parameters

options

TailMrtLogsOptions

Tail options

auth

AuthStrategy

Authentication strategy (ApiKeyStrategy)

Returns

Promise<TailMrtLogsResult>

Object with stop() to end streaming and done promise

Example

typescript
import { ApiKeyStrategy } from '@salesforce/b2c-tooling-sdk/auth';
import { tailMrtLogs } from '@salesforce/b2c-tooling-sdk/operations/mrt';

const auth = new ApiKeyStrategy(process.env.MRT_API_KEY!, 'Authorization');

const { stop, done } = await tailMrtLogs({
  projectSlug: 'my-storefront',
  environmentSlug: 'staging',
  onEntry: (entry) => console.log(entry.message),
  onConnect: () => console.log('Connected'),
}, auth);

// Later: stop()

Released under the Apache-2.0 License.