Class PapertrailStore

constructor

• new PapertrailStore(options?: PapertrailStoreOptions): PapertrailStore

  Parameters

  • options: PapertrailStoreOptions = {}

  Returns PapertrailStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): PapertrailHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns PapertrailHttpClient

push

• push(lines: string | string[]): Promise<any>

  Ingests raw log lines by POSTing them (newline-delimited) to the configured HTTP log-destination ingestURL. Accepts a single string or an array of lines (joined with newlines).

  Parameters

  • lines: string | string[]

  Returns Promise<any>

query

• query(q: string, options?: PapertrailQueryOptions): Promise<any>

  Searches log events via GET /api/v1/events/search. Returns the parsed response ({ events, min_id, max_id, reached_beginning, ... }).

  Parameters

  • q: string
  • options: PapertrailQueryOptions = {}

  Returns Promise<any>

labels

• labels(): Promise<any>

  Lists the configured log groups via GET /api/v1/groups.

  Returns Promise<any>

streams

• streams(): Promise<any>

  Lists the configured systems (log senders) via GET /api/v1/systems.

  Returns Promise<any>