Class GraylogStore

constructor

• new GraylogStore(options?: GraylogStoreOptions): GraylogStore

  Parameters

  • options: GraylogStoreOptions = {}

  Returns GraylogStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): GraylogHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns GraylogHttpClient

push

• push(host: string, entries: GraylogEntry[]): Promise<any>

  Ingests one or more log entries as GELF messages via POST /gelf. Each entry is completed into a GELF 1.1 message with the shared host, and messages are newline-delimited (the GELF HTTP input accepts one JSON message per line).

  Parameters

  • host: string
  • entries: GraylogEntry[]

  Returns Promise<any>

query

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

  Runs a relative universal search via GET /api/search/universal/relative. Returns the parsed response ({ messages, total_results, fields, ... }).

  Parameters

  • q: string
  • options: GraylogQueryOptions = {}

  Returns Promise<any>

labels

• labels(): Promise<any>

  Lists the known message field names via GET /api/system/fields.

  Returns Promise<any>

streams

• streams(): Promise<any>

  Lists the configured streams via GET /api/streams.

  Returns Promise<any>