@salesforce/b2c-tooling-sdk / operations/logs

operations/logs

Log operations for B2C Commerce instances.

This module provides functions for listing, tailing, and analyzing log files on B2C Commerce instances via WebDAV.

Examples

List log files:

import { listLogFiles } from '@salesforce/b2c-tooling-sdk/operations/logs';

const files = await listLogFiles(instance, {
  prefixes: ['error', 'customerror'],
  sortBy: 'date',
  sortOrder: 'desc'
});

for (const file of files) {
  console.log(`${file.name} (${file.size} bytes)`);
}

Tail logs in real-time:

import { tailLogs, createPathNormalizer } from '@salesforce/b2c-tooling-sdk/operations/logs';

const normalizer = createPathNormalizer({ cartridgePath: './cartridges' });

const { stop, done } = await tailLogs(instance, {
  prefixes: ['error', 'customerror'],
  pathNormalizer: normalizer,
  onEntry: (entry) => {
    console.log(`[${entry.file}] ${entry.level}: ${entry.message}`);
  },
  onError: (err) => console.error('Error:', err),
});

// Stop after 30 seconds
setTimeout(() => stop(), 30000);

await done;

Get recent logs (one-shot):

import { getRecentLogs } from '@salesforce/b2c-tooling-sdk/operations/logs';

const entries = await getRecentLogs(instance, {
  prefixes: ['error'],
  maxEntries: 50
});

for (const entry of entries) {
  console.log(`[${entry.timestamp}] ${entry.message}`);
}

Interfaces

• GetRecentLogsOptions
• ListLogsOptions
• LogEntry
• LogFile
• PathNormalizerOptions
• TailLogsCallbacks
• TailLogsOptions
• TailLogsResult

Functions

• aggregateLogEntries
• createPathNormalizer
• discoverAndCreateNormalizer
• extractPaths
• extractPrefix
• getRecentLogs
• listLogFiles
• parseLogEntry
• splitLines
• tailLogs