Class VinylErrorLogger

constructor

• new VinylErrorLogger(): VinylErrorLogger

  Returns VinylErrorLogger

Readonly[toStringTag]

ReadonlylogPrefix

disposed

• get disposed(): boolean

  Returns boolean

options

• get options(): VinylErrorLoggingOptions

  Returns VinylErrorLoggingOptions

configure

• configure(
      newOptions: {
          authProvider?: null | VinylErrorLoggingAuthProvider;
          endpoint?: string;
          maxMessages?: number;
      },
  ): void

  Parameters

  • newOptions: {
        authProvider?: null | VinylErrorLoggingAuthProvider;
        endpoint?: string;
        maxMessages?: number;
    }

    • Optional ReadonlyauthProvider?: null | VinylErrorLoggingAuthProvider

      Provides the fields necessary to authorize a logging request.

    • Optional Readonlyendpoint?: string

      The url of the rest logger endpoint. If null, CloudWatch logging will be disabled.

    • Optional ReadonlymaxMessages?: number

      The maximum number of errors a single client may report. Limits 'spammy' clients.

  Returns void

dispose

• dispose(): void

  Returns void

log

• log<T>(data: JsonCompatible<T>): void

  Logs the given message to a service endpoint.

  Type Parameters

  • T

  Parameters

  • data: JsonCompatible<T>

    The message to log.

  Returns void