Type alias LogEntriesOptions

LogEntriesOptions: {
    level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
    offset?: number;
    search?: string;
    size?: number;
    sort?: LogSortDirection;
    start?: number;
    upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
}

Options for retrieving log entries.

Type declaration

  • Optional level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>

    If set, only log entries with this log level will be returned.

  • Optional offset?: number

    If set, this many log entries will be skipped.

  • Optional search?: string

    If set, only log entries containing the specified text will be returned.

  • Optional size?: number

    If set, only this many entries will be returned.

  • Optional sort?: LogSortDirection

    If set to "desc", log entries will be returned in reverse chronological order.

    Default: "asc".

  • Optional start?: number

    If set, only log entries with an lid greater than or equal to this value will be returned.

  • Optional upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>

    Maximum log level of the entries to retrieve.

    Default: INFO.