Skip to main content

Class: LoggingClient

Client for performing logging through to REST endpoints.

Extends​

  • BaseRestClient

Implements​

  • ILoggingComponent

Constructors​

Constructor​

new LoggingClient(config): LoggingClient

Create a new instance of LoggingClient.

Parameters​

config​

IBaseRestClientConfig

The configuration for the client.

Returns​

LoggingClient

Overrides​

BaseRestClient.constructor

Properties​

CLASS_NAME​

readonly CLASS_NAME: string = LoggingClient._CLASS_NAME

Runtime name for the class.

Implementation of​

ILoggingComponent.CLASS_NAME

Methods​

log()​

log(logEntry): Promise<void>

Log an entry to the connector.

Parameters​

logEntry​

ILogEntry

The entry to log.

Returns​

Promise<void>

Nothing.

Implementation of​

ILoggingComponent.log

query()​

query(level?, source?, timeStart?, timeEnd?, cursor?, pageSize?): Promise<{ entities: ILogEntry[]; cursor?: string; }>

Query the log entries.

Parameters​

level?​

LogLevel

The level of the log entries.

source?​

string

The source of the log entries.

timeStart?​

number

The inclusive time as the start of the log entries.

timeEnd?​

number

The inclusive time as the end of the log entries.

cursor?​

string

The cursor to request the next page of entities.

pageSize?​

number

The maximum number of entities in a page.

Returns​

Promise<{ entities: ILogEntry[]; cursor?: string; }>

All the entities for the storage matching the conditions, and a cursor which can be used to request more entities.

Implementation of​

ILoggingComponent.query