Class DiagnosticLogger

DiagnosticLogger provides structured logging that is accessible through:

browser developer tools,
an in-page overlay,
a global window hook for ad-hoc inspection,
and a downloadable JSON snapshot.

Hierarchy

EventTarget
- DiagnosticLogger

Index

Constructors

Methods

debug info warning error getBufferedEntries downloadBufferedEntries

Constructors

constructor

new DiagnosticLogger(maximumBufferedLogEntryCount: number): DiagnosticLogger
Creates a structured logger with a bounded in-memory ring buffer.
Parameters
- maximumBufferedLogEntryCount: number
Returns DiagnosticLogger
Overrides EventTarget.constructor
- Defined in telemetry/DiagnosticLogger.ts:37

Methods

debug

debug(
    sourceSubsystem: string,
    message: string,
    details?: Record<string, unknown>,
): void
Records a debug message.
Parameters
- sourceSubsystem: string
- message: string
- Optionaldetails: Record<string, unknown>
Returns void
- Defined in telemetry/DiagnosticLogger.ts:45

info

info(
    sourceSubsystem: string,
    message: string,
    details?: Record<string, unknown>,
): void
Records an informational message.
Parameters
- sourceSubsystem: string
- message: string
- Optionaldetails: Record<string, unknown>
Returns void
- Defined in telemetry/DiagnosticLogger.ts:52

warning

warning(
    sourceSubsystem: string,
    message: string,
    details?: Record<string, unknown>,
): void
Records a warning message.
Parameters
- sourceSubsystem: string
- message: string
- Optionaldetails: Record<string, unknown>
Returns void
- Defined in telemetry/DiagnosticLogger.ts:59

error

error(
    sourceSubsystem: string,
    message: string,
    details?: Record<string, unknown>,
): void
Records an error message.
Parameters
- sourceSubsystem: string
- message: string
- Optionaldetails: Record<string, unknown>
Returns void
- Defined in telemetry/DiagnosticLogger.ts:70

getBufferedEntries

getBufferedEntries(): DiagnosticLogEntry[]
Returns a copy of the current in-memory buffer.

Returns DiagnosticLogEntry[]
- Defined in telemetry/DiagnosticLogger.ts:77

downloadBufferedEntries

downloadBufferedEntries(): void
Downloads the current buffer as a JSON file. This is useful when a user wants to attach logs to a bug report without having to manually copy messages from the browser console.

Returns void
- Defined in telemetry/DiagnosticLogger.ts:86