The splunk component allows to publish or search for events in Splunk.
Name | Kind | Group | Required | Default | Type | Enum | Description |
---|---|---|---|---|---|---|---|
name | path | common | true | java.lang.String | Name has no purpose | ||
app | parameter | common | java.lang.String | Splunk app | |||
connectionTimeout | parameter | common | 5000 | int | Timeout in MS when connecting to Splunk server | ||
host | parameter | common | localhost | java.lang.String | Splunk host. | ||
owner | parameter | common | java.lang.String | Splunk owner | |||
password | parameter | common | java.lang.String | Password for Splunk | |||
port | parameter | common | 8089 | int | Splunk port | ||
scheme | parameter | common | https | java.lang.String | Splunk scheme | ||
sslProtocol | parameter | common | TLSv1.2 | com.splunk.SSLSecurityProtocol | TLSv1.2 TLSv1.1 TLSv1 SSLv3 |
Set the ssl protocol to use @param sslProtocol | |
username | parameter | common | java.lang.String | Username for Splunk | |||
useSunHttpsHandler | parameter | common | boolean | Use sun.net.www.protocol.https.Handler Https handler to establish the Splunk Connection. Can be useful when running in application servers to avoid app. server https handling. | |||
bridgeErrorHandler | parameter | consumer | boolean | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
count | parameter | consumer | int | A number that indicates the maximum number of entities to return. | |||
earliestTime | parameter | consumer | java.lang.String | Earliest time of the search time window. | |||
initEarliestTime | parameter | consumer | java.lang.String | Initial start offset of the first search | |||
latestTime | parameter | consumer | java.lang.String | Latest time of the search time window. | |||
savedSearch | parameter | consumer | java.lang.String | The name of the query saved in Splunk to run | |||
search | parameter | consumer | java.lang.String | The Splunk query to run | |||
sendEmptyMessageWhenIdle | parameter | consumer | boolean | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | |||
streaming | parameter | consumer | java.lang.Boolean | Sets streaming mode.
Streaming mode sends exchanges as they are received, rather than in a batch. |
|||
exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
pollStrategy | parameter | consumer (advanced) | org.apache.camel.spi.PollingConsumerPollStrategy | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | |||
eventHost | parameter | producer | java.lang.String | Override the default Splunk event host field | |||
index | parameter | producer | java.lang.String | Splunk index to write to | |||
raw | parameter | producer | false | boolean | Should the payload be inserted raw | ||
source | parameter | producer | java.lang.String | Splunk source argument | |||
sourceType | parameter | producer | java.lang.String | Splunk sourcetype argument | |||
tcpReceiverPort | parameter | producer | int | Splunk tcp receiver port | |||
exchangePattern | parameter | advanced | InOnly | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the default exchange pattern when creating an exchange | |
synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
backoffErrorThreshold | parameter | scheduler | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | |||
backoffIdleThreshold | parameter | scheduler | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | |||
backoffMultiplier | parameter | scheduler | int | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. | |||
delay | parameter | scheduler | 500 | long | Milliseconds before the next poll. | ||
greedy | parameter | scheduler | boolean | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | |||
initialDelay | parameter | scheduler | 1000 | long | Milliseconds before the first poll starts. | ||
runLoggingLevel | parameter | scheduler | TRACE | org.apache.camel.LoggingLevel | TRACE DEBUG INFO WARN ERROR OFF |
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | |
scheduledExecutorService | parameter | scheduler | java.util.concurrent.ScheduledExecutorService | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | |||
scheduler | parameter | scheduler | none | org.apache.camel.spi.ScheduledPollConsumerScheduler | none spring quartz2 |
To use a cron scheduler from either camel-spring or camel-quartz2 component | |
schedulerProperties | parameter | scheduler | java.util.Map |
To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. | |||
startScheduler | parameter | scheduler | true | boolean | Whether the scheduler should be auto started. | ||
timeUnit | parameter | scheduler | MILLISECONDS | java.util.concurrent.TimeUnit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
Time unit for initialDelay and delay options. | |
useFixedDelay | parameter | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |
The Splunk consumer.