blob: d98aa4d282589d383a4f8ddfa44c0f93b27fbcae [file] [log] [blame]
// kafka-connector options: START
[[camel-splunk-kafka-connector-sink]]
= camel-splunk-kafka-connector sink configuration
When using camel-splunk-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-splunk-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-splunk sink connector supports 23 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.name* | Name has no purpose | null | ConfigDef.Importance.HIGH
| *camel.sink.endpoint.app* | Splunk app | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.connection Timeout* | Timeout in MS when connecting to Splunk server | 5000 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.host* | Splunk host. | "localhost" | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.owner* | Splunk owner | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.port* | Splunk port | 8089 | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.scheme* | Splunk scheme | "https" | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.eventHost* | Override the default Splunk event host field | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.index* | Splunk index to write to | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.lazyStart Producer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.raw* | Should the payload be inserted raw | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.source* | Splunk source argument | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.sourceType* | Splunk sourcetype argument | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.tcp ReceiverPort* | Splunk tcp receiver port | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.password* | Password for Splunk | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.ssl Protocol* | Set the ssl protocol to use One of: [TLSv1.2] [TLSv1.1] [TLSv1] [SSLv3] | "TLSv1.2" | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.username* | Username for Splunk | null | ConfigDef.Importance.MEDIUM
| *camel.sink.endpoint.useSun HttpsHandler* | 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. | false | ConfigDef.Importance.MEDIUM
| *camel.component.splunk.lazy StartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | ConfigDef.Importance.MEDIUM
| *camel.component.splunk.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.component.splunk.splunk ConfigurationFactory* | To use the SplunkConfigurationFactory | null | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END