Class SplunkStore

constructor

• new SplunkStore(options?: SplunkStoreOptions): SplunkStore

  Parameters

  • options: SplunkStoreOptions = {}

  Returns SplunkStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): SplunkHttpClient

  Returns the underlying (internal or injected) HTTP client.

  Returns SplunkHttpClient

getSdk

• getSdk(): any

  Returns the lazily-required splunk-sdk module, or null if not installed.

  Returns any

push

• push(meta: SplunkEventMeta, events: unknown[]): Promise<any>

  Sends a batch of events to the HTTP Event Collector via POST /services/collector/event. Each event is wrapped in a HEC envelope carrying the shared meta (index/sourcetype/source/host); the envelopes are newline-concatenated as HEC expects.

  Parameters

  • meta: SplunkEventMeta
  • events: unknown[]

  Returns Promise<any>

query

• query(spl: string, options?: SplunkSearchOptions): Promise<any>

  Dispatches an SPL search via POST /services/search/jobs. The search string is normalized to start with search when it isn't already a generating command. Returns the parsed response (job SID or, for a oneshot search, the results).

  Parameters

  • spl: string
  • options: SplunkSearchOptions = {}

  Returns Promise<any>

labels

• labels(): Promise<any>

  Lists the configured source types via GET /services/data/sourcetypes.

  Returns Promise<any>

streams

• streams(): Promise<any>

  Lists the configured indexes via GET /services/data/indexes.

  Returns Promise<any>