Skip to main content

Interface: FlushableLogger

Experimental

A logger that may opt-in to receive flush requests.

This is the interface expected by RuntimeOptions.logger. Unlike the Logger exposed by Workflow and Activity contexts, this interface supports an optional flush hook. If the the flush() method exists, then it may be called by the SDK in some situations where it may be desirable to immediately flush buffered log messages (e.g. when a Worker or Runtime terminates).

Extends​

Methods​

debug()​

debug(message, meta?): any

Experimental

Parameters​

message​

string

meta?​

LogMetadata

Returns​

any

Inherited from​

Logger.debug

error()​

error(message, meta?): any

Experimental

Parameters​

message​

string

meta?​

LogMetadata

Returns​

any

Inherited from​

Logger.error

flush()?​

optional flush(): void

Experimental

Flush buffered log entries synchronously.

This hook may be called repeatedly, including when there are no new entries. It must leave the logger usable.

Returns​

void

info()​

info(message, meta?): any

Experimental

Parameters​

message​

string

meta?​

LogMetadata

Returns​

any

Inherited from​

Logger.info

log()​

log(level, message, meta?): any

Experimental

Parameters​

level​

LogLevel

message​

string

meta?​

LogMetadata

Returns​

any

Inherited from​

Logger.log

trace()​

trace(message, meta?): any

Experimental

Parameters​

message​

string

meta?​

LogMetadata

Returns​

any

Inherited from​

Logger.trace

warn()​

warn(message, meta?): any

Experimental

Parameters​

message​

string

meta?​

LogMetadata

Returns​

any

Inherited from​

Logger.warn