Skip to content

@oneplatform/plugin-sdk


@oneplatform/plugin-sdk / PluginLogger

Interface: PluginLogger

Defined in: packages/plugin-sdk/src/types/context.ts:128

Methods

debug()

debug(message, metadata?): void

Defined in: packages/plugin-sdk/src/types/context.ts:133

Log a debug-level message. Debug logs are suppressed by default in production tenants and are only visible with explicit debug mode enabled on the instance.

Parameters

message

string

metadata?

Record\<string, unknown>

Returns

void


error()

error(message, metadata?): void

Defined in: packages/plugin-sdk/src/types/context.ts:151

Log an error. Errors are surfaced in the plugin monitoring dashboard, increment the error counter, and trigger alerting if configured by the tenant admin.

IMPORTANT: Never pass credential values, access tokens, or PII in the metadata argument. The metadata object is persisted to the platform logging system.

Parameters

message

string

metadata?

Record\<string, unknown>

Returns

void


info()

info(message, metadata?): void

Defined in: packages/plugin-sdk/src/types/context.ts:136

Log an informational message. Appears in the plugin execution log view.

Parameters

message

string

metadata?

Record\<string, unknown>

Returns

void


warn()

warn(message, metadata?): void

Defined in: packages/plugin-sdk/src/types/context.ts:142

Log a warning. Warnings are surfaced in the plugin monitoring dashboard and increment the warning counter for this plugin instance.

Parameters

message

string

metadata?

Record\<string, unknown>

Returns

void