connectors/camel-splunk-hec-kafka-connector/src/main/docs/camel-splunk-hec-kafka-sink-connector.adoc

// kafka-connector options: START
[[camel-splunk-hec-kafka-connector-sink]]
= camel-splunk-hec-kafka-connector sink configuration

Connector Description: The splunk component allows to publish events in Splunk using the HTTP Event Collector.

When using camel-splunk-hec-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-hec-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>
----

To use this Sink connector in Kafka connect you'll need to set the following connector.class

[source,java]
----
connector.class=org.apache.camel.kafkaconnector.splunkhec.CamelSplunkhecSinkConnector
----


The camel-splunk-hec sink connector supports 14 options, which are listed below.



[width="100%",cols="2,5,^1,1,1",options="header"]
|===
| Name | Description | Default | Required | Priority
| *camel.sink.path.splunkURL* | Splunk Host URL | null | true | HIGH
| *camel.sink.path.token* | Splunk authorization token | null | true | HIGH
| *camel.sink.endpoint.bodyOnly* | Send only the message body | false | false | MEDIUM
| *camel.sink.endpoint.headersOnly* | Send only message headers | false | false | MEDIUM
| *camel.sink.endpoint.host* | Splunk host. | null | false | MEDIUM
| *camel.sink.endpoint.index* | Splunk index to write to | "camel" | false | MEDIUM
| *camel.sink.endpoint.lazyStartProducer* | 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 | false | MEDIUM
| *camel.sink.endpoint.source* | Splunk source argument | "camel" | false | MEDIUM
| *camel.sink.endpoint.sourceType* | Splunk sourcetype argument | "camel" | false | MEDIUM
| *camel.sink.endpoint.time* | Time this even occurred. By default, the time will be when this event hits the splunk server. | null | false | MEDIUM
| *camel.sink.endpoint.https* | Contact HEC over https. | true | false | MEDIUM
| *camel.sink.endpoint.skipTlsVerify* | Splunk HEC TLS verification. | false | false | MEDIUM
| *camel.component.splunk-hec.lazyStartProducer* | 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 | false | MEDIUM
| *camel.component.splunk-hec.autowiredEnabled* | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | false | MEDIUM
|===



The camel-splunk-hec sink connector has no converters out of the box.





The camel-splunk-hec sink connector has no transforms out of the box.





The camel-splunk-hec sink connector has no aggregation strategies out of the box.
// kafka-connector options: END