Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Endpoint

Description

normal

Performs normal search and requires a search query in the search option.

realtime

Performs realtime search in Splunk and requires a search query in the search option.

savedsearch

Performs search based on a search query saved in splunk and requires the name of the query in the savedSearch option.

...

Name

Default Value

Context

Description

host

localhost

Both

Splunk host.

port

8089

Both

Splunk port

username

null

Both

Username for Splunk

password

null

Both

Password for Splunk

connectionTimeout

5000

Both

Timeout in MS when connecting to Splunk server

useSunHttpsHandler

false

Both

Use sun.net.www.protocol.https.Handler Https hanlder to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling.

index

null

Producer

Splunk index to write to

sourceType

null

Producer

Splunk SourceType sourcetype arguement

source

null

Producer

Splunk Source source arguement

tcpReceiverPort

0

Producer

Splunk tcp reciever receiver port when using tcp producer endpoint.

initEarliestTime

null

Consumer

Initial start offset of the first search. Required

earliestTime

null

Consumer

Earliest time of the search time window.

latestTime

null

Consumer

Latest time of the search time window.

count

0

Consumer

A number that indicates the maximum number of entities to return. Note this is not the same as maxMessagesPerPoll which currently is unsupported

search

null

Consumer

The Splunk query to run

savedSearch

null

Consumer

The name of the query saved in Splunk to run

...

Splunk comes with a variety of options for leveraging machine generated data with prebuild prebuilt apps for analyzing and displaying this.
For example the jmx app. could be used to publish jmx attributes, eg. route and jvm metrics to Splunk, and displaying this on a dashboard.