This is an automated email from the ASF dual-hosted git repository. davsclaus pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/master by this push: new 37a08d0 CAMEL-14932: Updated and polished 37a08d0 is described below commit 37a08d083cf175b19c165f704b2682d93a39b51c Author: Claus Ibsen <claus.ib...@gmail.com> AuthorDate: Thu Apr 23 07:28:21 2020 +0200 CAMEL-14932: Updated and polished --- .../splunkhec/SplunkHECComponentConfigurer.java | 5 - .../splunkhec/SplunkHECEndpointConfigurer.java | 23 +- .../camel/component/splunkhec/splunk-hec.json | 23 +- .../src/main/docs/splunk-hec-component.adoc | 29 +- .../component/splunkhec/SplunkHECComponent.java | 3 - .../splunkhec/SplunkHECConfiguration.java | 12 +- .../component/splunkhec/SplunkHECEndpoint.java | 34 +- .../component/splunkhec/SplunkHECProducer.java | 6 +- .../component/ComponentsBuilderFactory.java | 2 +- .../dsl/SplunkHecComponentBuilderFactory.java | 22 +- .../src/generated/resources/metadata.json | 4 +- .../dsl/SplunkHECEndpointBuilderFactory.java | 448 ++------------------- .../modules/ROOT/pages/splunk-hec-component.adoc | 31 +- 13 files changed, 110 insertions(+), 532 deletions(-) diff --git a/components/camel-splunk-hec/src/generated/java/org/apache/camel/component/splunkhec/SplunkHECComponentConfigurer.java b/components/camel-splunk-hec/src/generated/java/org/apache/camel/component/splunkhec/SplunkHECComponentConfigurer.java index a46cef4..ae001bb 100644 --- a/components/camel-splunk-hec/src/generated/java/org/apache/camel/component/splunkhec/SplunkHECComponentConfigurer.java +++ b/components/camel-splunk-hec/src/generated/java/org/apache/camel/component/splunkhec/SplunkHECComponentConfigurer.java @@ -21,8 +21,6 @@ public class SplunkHECComponentConfigurer extends PropertyConfigurerSupport impl switch (ignoreCase ? name.toLowerCase() : name) { case "basicpropertybinding": case "basicPropertyBinding": target.setBasicPropertyBinding(property(camelContext, boolean.class, value)); return true; - case "bridgeerrorhandler": - case "bridgeErrorHandler": target.setBridgeErrorHandler(property(camelContext, boolean.class, value)); return true; case "lazystartproducer": case "lazyStartProducer": target.setLazyStartProducer(property(camelContext, boolean.class, value)); return true; default: return false; @@ -33,7 +31,6 @@ public class SplunkHECComponentConfigurer extends PropertyConfigurerSupport impl public Map<String, Object> getAllOptions(Object target) { Map<String, Object> answer = new CaseInsensitiveMap(); answer.put("basicPropertyBinding", boolean.class); - answer.put("bridgeErrorHandler", boolean.class); answer.put("lazyStartProducer", boolean.class); return answer; } @@ -44,8 +41,6 @@ public class SplunkHECComponentConfigurer extends PropertyConfigurerSupport impl switch (ignoreCase ? name.toLowerCase() : name) { case "basicpropertybinding": case "basicPropertyBinding": return target.isBasicPropertyBinding(); - case "bridgeerrorhandler": - case "bridgeErrorHandler": return target.isBridgeErrorHandler(); case "lazystartproducer": case "lazyStartProducer": return target.isLazyStartProducer(); default: return null; diff --git a/components/camel-splunk-hec/src/generated/java/org/apache/camel/component/splunkhec/SplunkHECEndpointConfigurer.java b/components/camel-splunk-hec/src/generated/java/org/apache/camel/component/splunkhec/SplunkHECEndpointConfigurer.java index e05d045..e784928 100644 --- a/components/camel-splunk-hec/src/generated/java/org/apache/camel/component/splunkhec/SplunkHECEndpointConfigurer.java +++ b/components/camel-splunk-hec/src/generated/java/org/apache/camel/component/splunkhec/SplunkHECEndpointConfigurer.java @@ -21,18 +21,13 @@ public class SplunkHECEndpointConfigurer extends PropertyConfigurerSupport imple switch (ignoreCase ? name.toLowerCase() : name) { case "basicpropertybinding": case "basicPropertyBinding": target.setBasicPropertyBinding(property(camelContext, boolean.class, value)); return true; - case "bridgeerrorhandler": - case "bridgeErrorHandler": target.setBridgeErrorHandler(property(camelContext, boolean.class, value)); return true; - case "exceptionhandler": - case "exceptionHandler": target.setExceptionHandler(property(camelContext, org.apache.camel.spi.ExceptionHandler.class, value)); return true; - case "exchangepattern": - case "exchangePattern": target.setExchangePattern(property(camelContext, org.apache.camel.ExchangePattern.class, value)); return true; case "host": target.getConfiguration().setHost(property(camelContext, java.lang.String.class, value)); return true; case "https": target.getConfiguration().setHttps(property(camelContext, boolean.class, value)); return true; case "index": target.getConfiguration().setIndex(property(camelContext, java.lang.String.class, value)); return true; case "lazystartproducer": case "lazyStartProducer": target.setLazyStartProducer(property(camelContext, boolean.class, value)); return true; - case "skiptlsverify": target.getConfiguration().setSkiptlsverify(property(camelContext, boolean.class, value)); return true; + case "skiptlsverify": + case "skipTlsVerify": target.getConfiguration().setSkipTlsVerify(property(camelContext, boolean.class, value)); return true; case "source": target.getConfiguration().setSource(property(camelContext, java.lang.String.class, value)); return true; case "sourcetype": case "sourceType": target.getConfiguration().setSourceType(property(camelContext, java.lang.String.class, value)); return true; @@ -45,14 +40,11 @@ public class SplunkHECEndpointConfigurer extends PropertyConfigurerSupport imple public Map<String, Object> getAllOptions(Object target) { Map<String, Object> answer = new CaseInsensitiveMap(); answer.put("basicPropertyBinding", boolean.class); - answer.put("bridgeErrorHandler", boolean.class); - answer.put("exceptionHandler", org.apache.camel.spi.ExceptionHandler.class); - answer.put("exchangePattern", org.apache.camel.ExchangePattern.class); answer.put("host", java.lang.String.class); answer.put("https", boolean.class); answer.put("index", java.lang.String.class); answer.put("lazyStartProducer", boolean.class); - answer.put("skiptlsverify", boolean.class); + answer.put("skipTlsVerify", boolean.class); answer.put("source", java.lang.String.class); answer.put("sourceType", java.lang.String.class); answer.put("synchronous", boolean.class); @@ -65,18 +57,13 @@ public class SplunkHECEndpointConfigurer extends PropertyConfigurerSupport imple switch (ignoreCase ? name.toLowerCase() : name) { case "basicpropertybinding": case "basicPropertyBinding": return target.isBasicPropertyBinding(); - case "bridgeerrorhandler": - case "bridgeErrorHandler": return target.isBridgeErrorHandler(); - case "exceptionhandler": - case "exceptionHandler": return target.getExceptionHandler(); - case "exchangepattern": - case "exchangePattern": return target.getExchangePattern(); case "host": return target.getConfiguration().getHost(); case "https": return target.getConfiguration().isHttps(); case "index": return target.getConfiguration().getIndex(); case "lazystartproducer": case "lazyStartProducer": return target.isLazyStartProducer(); - case "skiptlsverify": return target.getConfiguration().isSkiptlsverify(); + case "skiptlsverify": + case "skipTlsVerify": return target.getConfiguration().isSkipTlsVerify(); case "source": return target.getConfiguration().getSource(); case "sourcetype": case "sourceType": return target.getConfiguration().getSourceType(); diff --git a/components/camel-splunk-hec/src/generated/resources/org/apache/camel/component/splunkhec/splunk-hec.json b/components/camel-splunk-hec/src/generated/resources/org/apache/camel/component/splunkhec/splunk-hec.json index fd7beff..6c8d0f6 100644 --- a/components/camel-splunk-hec/src/generated/resources/org/apache/camel/component/splunkhec/splunk-hec.json +++ b/components/camel-splunk-hec/src/generated/resources/org/apache/camel/component/splunkhec/splunk-hec.json @@ -14,30 +14,27 @@ "version": "3.3.0-SNAPSHOT", "scheme": "splunk-hec", "extendsScheme": "", - "syntax": "splunk-hec:endpoint\/token", + "syntax": "splunk-hec:splunkURL\/token", "async": false, "consumerOnly": false, - "producerOnly": false, + "producerOnly": true, "lenientProperties": false }, "componentProperties": { - "bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "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 [...] "lazyStartProducer": { "kind": "property", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "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 r [...] "basicPropertyBinding": { "kind": "property", "displayName": "Basic Property Binding", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities" } }, "properties": { - "endpointUri": { "kind": "path", "displayName": "Endpoint Uri", "group": "common", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "description": "Splunk host URI" }, - "bridgeErrorHandler": { "kind": "parameter", "displayName": "Bridge Error Handler", "group": "consumer", "label": "consumer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "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 b [...] - "exceptionHandler": { "kind": "parameter", "displayName": "Exception Handler", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.", "deprecated": false, "secret": false, "description": "To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with [...] - "exchangePattern": { "kind": "parameter", "displayName": "Exchange Pattern", "group": "consumer (advanced)", "label": "consumer,advanced", "required": false, "type": "object", "javaType": "org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut", "InOptionalOut" ], "deprecated": false, "secret": false, "description": "Sets the exchange pattern when the consumer creates an exchange." }, - "index": { "kind": "parameter", "displayName": "Index", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk index to write to" }, + "splunkURL": { "kind": "path", "displayName": "Splunk URL", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "secret": false, "description": "Splunk Host URL" }, + "token": { "kind": "path", "displayName": "Token", "group": "security", "label": "security", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "secret": false, "description": "Splunk authorization token" }, + "host": { "kind": "parameter", "displayName": "Host", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk host." }, + "index": { "kind": "parameter", "displayName": "Index", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "camel", "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk index to write to" }, "lazyStartProducer": { "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer", "label": "producer", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "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 [...] - "source": { "kind": "parameter", "displayName": "Source", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk source argument" }, - "sourceType": { "kind": "parameter", "displayName": "Source Type", "group": "producer", "label": "producer", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk sourcetype argument" }, + "source": { "kind": "parameter", "displayName": "Source", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "camel", "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk source argument" }, + "sourceType": { "kind": "parameter", "displayName": "Source Type", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "defaultValue": "camel", "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk sourcetype argument" }, "basicPropertyBinding": { "kind": "parameter", "displayName": "Basic Property Binding", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "description": "Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities" }, "synchronous": { "kind": "parameter", "displayName": "Synchronous", "group": "advanced", "label": "advanced", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": "false", "description": "Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported)." }, - "host": { "kind": "parameter", "displayName": "Host", "group": "host", "label": "host", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "secret": false, "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk host." }, - "https": { "kind": "parameter", "displayName": "Https", "group": "https", "label": "https", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Contact HEC over https." }, - "skiptlsverify": { "kind": "parameter", "displayName": "Skiptlsverify", "group": "skiptlsverify", "label": "skiptlsverify", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk HEC TLS verification." } + "https": { "kind": "parameter", "displayName": "Https", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": "true", "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Contact HEC over https." }, + "skipTlsVerify": { "kind": "parameter", "displayName": "Skip Tls Verify", "group": "security", "label": "security", "required": false, "type": "boolean", "javaType": "boolean", "deprecated": false, "secret": false, "defaultValue": false, "configurationClass": "org.apache.camel.component.splunkhec.SplunkHECConfiguration", "configurationField": "configuration", "description": "Splunk HEC TLS verification." } } } diff --git a/components/camel-splunk-hec/src/main/docs/splunk-hec-component.adoc b/components/camel-splunk-hec/src/main/docs/splunk-hec-component.adoc index 287a705..4f5f263 100644 --- a/components/camel-splunk-hec/src/main/docs/splunk-hec-component.adoc +++ b/components/camel-splunk-hec/src/main/docs/splunk-hec-component.adoc @@ -5,7 +5,7 @@ :description: The splunk component allows to publish events in Splunk using the HTTP Event Collector. :since: 3.3 :supportLevel: Stable -:component-header: Both producer and consumer are supported +:component-header: Only producer is supported *Since Camel {since}* @@ -35,14 +35,13 @@ for this component: // component options: START -The Splunk HEC component supports 3 options, which are listed below. +The Splunk HEC component supports 2 options, which are listed below. [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false | boolean | *lazyStartProducer* (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 [...] | *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean |=== @@ -54,39 +53,37 @@ The Splunk HEC component supports 3 options, which are listed below. The Splunk HEC endpoint is configured using URI syntax: ---- -splunk-hec:endpoint/token +splunk-hec:splunkURL/token ---- with the following path and query parameters: -=== Path Parameters (1 parameters): +=== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -| *endpointUri* | Splunk host URI | | String +| *splunkURL* | *Required* Splunk Host URL | | String +| *token* | *Required* Splunk authorization token | | String |=== -=== Query Parameters (12 parameters): +=== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false | boolean -| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern -| *index* (producer) | Splunk index to write to | | String +| *host* (producer) | Splunk host. | | String +| *index* (producer) | Splunk index to write to | camel | String | *lazyStartProducer* (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 [...] -| *source* (producer) | Splunk source argument | | String -| *sourceType* (producer) | Splunk sourcetype argument | | String +| *source* (producer) | Splunk source argument | camel | String +| *sourceType* (producer) | Splunk sourcetype argument | camel | String | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean | *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| *host* (host) | Splunk host. | | String -| *https* (https) | Contact HEC over https. | false | boolean -| *skiptlsverify* (skiptlsverify) | Splunk HEC TLS verification. | false | boolean +| *https* (security) | Contact HEC over https. | true | boolean +| *skipTlsVerify* (security) | Splunk HEC TLS verification. | false | boolean |=== // endpoint options: END diff --git a/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECComponent.java b/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECComponent.java index 4429906..c6a2da5 100644 --- a/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECComponent.java +++ b/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECComponent.java @@ -22,9 +22,6 @@ import org.apache.camel.Endpoint; import org.apache.camel.spi.annotations.Component; import org.apache.camel.support.DefaultComponent; -/** - * Represents the component that manages {@link SplunkHECEndpoint}. - */ @Component("splunk-hec") public class SplunkHECComponent extends DefaultComponent { diff --git a/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECConfiguration.java b/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECConfiguration.java index 7ddfdd6..b8de428 100644 --- a/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECConfiguration.java +++ b/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECConfiguration.java @@ -28,17 +28,17 @@ import org.slf4j.LoggerFactory; public class SplunkHECConfiguration { private static final transient Logger LOG = LoggerFactory.getLogger(SplunkHECConfiguration.class); - @UriParam(label = "producer") + @UriParam(defaultValue = "camel") private String index = "camel"; - @UriParam(label = "producer") + @UriParam(defaultValue = "camel") private String sourceType = "camel"; - @UriParam(label = "producer") + @UriParam(defaultValue = "camel") private String source = "camel"; - @UriParam(label = "producer") + @UriParam private String host; - @UriParam(label = "producer") + @UriParam(label = "security") private boolean skipTlsVerify; - @UriParam(label = "producer") + @UriParam(label = "security", defaultValue = "true") private boolean https = true; public String getSourceType() { diff --git a/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECEndpoint.java b/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECEndpoint.java index 1a941a1..240e72a 100644 --- a/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECEndpoint.java +++ b/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECEndpoint.java @@ -22,29 +22,25 @@ import java.util.regex.Pattern; import org.apache.camel.Consumer; import org.apache.camel.Processor; import org.apache.camel.Producer; +import org.apache.camel.spi.Metadata; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; import org.apache.camel.support.DefaultEndpoint; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; /** * The splunk component allows to publish events in Splunk using the HTTP Event Collector. */ -@UriEndpoint(firstVersion = "3.3.0", scheme = "splunk-hec", title = "Splunk HEC", syntax = "splunk-hec:endpoint/token", label = "log,monitoring") +@UriEndpoint(firstVersion = "3.3.0", scheme = "splunk-hec", title = "Splunk HEC", producerOnly = true, + syntax = "splunk-hec:splunkURL/token", label = "log,monitoring") public class SplunkHECEndpoint extends DefaultEndpoint { - private static final Logger LOG = LoggerFactory.getLogger(SplunkHECEndpoint.class); private static final Pattern URI_PARSER = Pattern.compile("splunk-hec\\:\\/?\\/?(\\w+):(\\d+)/(\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12})\\??.*"); - @UriPath - private String endpointUri; - + @UriPath @Metadata(required = true) private String splunkURL; - + @UriPath(label = "security") @Metadata(required = true) private String token; - @UriParam private SplunkHECConfiguration configuration; @@ -58,7 +54,7 @@ public class SplunkHECEndpoint extends DefaultEndpoint { if (!match.matches()) { throw new IllegalArgumentException("Invalid URI: " + uri); } - int port = Integer.valueOf(match.group(2)); + int port = Integer.parseInt(match.group(2)); if (port < 1 || port > 65535) { throw new IllegalArgumentException("Invalid port: " + port); } @@ -84,20 +80,22 @@ public class SplunkHECEndpoint extends DefaultEndpoint { return splunkURL; } + /** + * Splunk Host URL + */ + public void setSplunkURL(String splunkURL) { + this.splunkURL = splunkURL; + } + public String getToken() { return token; } /** - * Splunk host URI + * Splunk authorization token */ - @Override - public void setEndpointUri(String endpointUri) { - this.endpointUri = endpointUri; + public void setToken(String token) { + this.token = token; } - @Override - public String getEndpointUri() { - return endpointUri; - } } diff --git a/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECProducer.java b/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECProducer.java index 1abeca9..c4a6b06 100644 --- a/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECProducer.java +++ b/components/camel-splunk-hec/src/main/java/org/apache/camel/component/splunkhec/SplunkHECProducer.java @@ -16,7 +16,6 @@ */ package org.apache.camel.component.splunkhec; - import java.io.ByteArrayOutputStream; import java.nio.charset.StandardCharsets; import java.util.HashMap; @@ -45,7 +44,6 @@ public class SplunkHECProducer extends DefaultProducer { private SplunkHECEndpoint endpoint; private CloseableHttpClient httpClient; - public SplunkHECProducer(SplunkHECEndpoint endpoint) { super(endpoint); this.endpoint = endpoint; @@ -91,7 +89,9 @@ public class SplunkHECProducer extends DefaultProducer { @Override protected void doStop() throws Exception { super.doStop(); - httpClient.close(); + if (httpClient != null) { + httpClient.close(); + } } Map<String, Object> createPayload(Message message) { diff --git a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java index 833bcb1..a2f2871 100644 --- a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java +++ b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/ComponentsBuilderFactory.java @@ -3475,7 +3475,7 @@ public interface ComponentsBuilderFactory { * Event Collector. * * Category: log,monitoring - * Since: 3.2 + * Since: 3.3 * Maven coordinates: org.apache.camel:camel-splunk-hec */ static org.apache.camel.builder.component.dsl.SplunkHecComponentBuilderFactory.SplunkHecComponentBuilder splunkHec() { diff --git a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/SplunkHecComponentBuilderFactory.java b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/SplunkHecComponentBuilderFactory.java index af759fb..849f027 100644 --- a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/SplunkHecComponentBuilderFactory.java +++ b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/SplunkHecComponentBuilderFactory.java @@ -37,7 +37,7 @@ public interface SplunkHecComponentBuilderFactory { * Event Collector. * * Category: log,monitoring - * Since: 3.2 + * Since: 3.3 * Maven coordinates: org.apache.camel:camel-splunk-hec */ static SplunkHecComponentBuilder splunkHec() { @@ -51,25 +51,6 @@ public interface SplunkHecComponentBuilderFactory { extends ComponentBuilder<SplunkHECComponent> { /** - * 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 or ERROR level and - * ignored. - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: consumer - */ - default SplunkHecComponentBuilder bridgeErrorHandler( - boolean bridgeErrorHandler) { - doSetProperty("bridgeErrorHandler", bridgeErrorHandler); - return this; - } - /** * 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 @@ -121,7 +102,6 @@ public interface SplunkHecComponentBuilderFactory { String name, Object value) { switch (name) { - case "bridgeErrorHandler": ((SplunkHECComponent) component).setBridgeErrorHandler((boolean) value); return true; case "lazyStartProducer": ((SplunkHECComponent) component).setLazyStartProducer((boolean) value); return true; case "basicPropertyBinding": ((SplunkHECComponent) component).setBasicPropertyBinding((boolean) value); return true; default: return false; diff --git a/core/camel-componentdsl/src/generated/resources/metadata.json b/core/camel-componentdsl/src/generated/resources/metadata.json index 768e43c..ee56636 100644 --- a/core/camel-componentdsl/src/generated/resources/metadata.json +++ b/core/camel-componentdsl/src/generated/resources/metadata.json @@ -6628,10 +6628,10 @@ "version": "3.3.0-SNAPSHOT", "scheme": "splunk-hec", "extendsScheme": "", - "syntax": "splunk-hec:endpoint\/token", + "syntax": "splunk-hec:splunkURL\/token", "async": false, "consumerOnly": false, - "producerOnly": false, + "producerOnly": true, "lenientProperties": false }, "SpringBatchComponentBuilderFactory": { diff --git a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SplunkHECEndpointBuilderFactory.java b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SplunkHECEndpointBuilderFactory.java index fc0b069..4e9f0bb 100644 --- a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SplunkHECEndpointBuilderFactory.java +++ b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/SplunkHECEndpointBuilderFactory.java @@ -17,11 +17,9 @@ package org.apache.camel.builder.endpoint.dsl; import javax.annotation.Generated; -import org.apache.camel.ExchangePattern; import org.apache.camel.builder.EndpointConsumerBuilder; import org.apache.camel.builder.EndpointProducerBuilder; import org.apache.camel.builder.endpoint.AbstractEndpointBuilder; -import org.apache.camel.spi.ExceptionHandler; /** * The splunk component allows to publish events in Splunk using the HTTP Event @@ -34,256 +32,32 @@ public interface SplunkHECEndpointBuilderFactory { /** - * Builder for endpoint consumers for the Splunk HEC component. + * Builder for endpoint for the Splunk HEC component. */ - public interface SplunkHECEndpointConsumerBuilder - extends - EndpointConsumerBuilder { - default AdvancedSplunkHECEndpointConsumerBuilder advanced() { - return (AdvancedSplunkHECEndpointConsumerBuilder) this; - } - /** - * 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 or ERROR level and - * ignored. - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: consumer - */ - default SplunkHECEndpointConsumerBuilder bridgeErrorHandler( - boolean bridgeErrorHandler) { - doSetProperty("bridgeErrorHandler", bridgeErrorHandler); - return this; - } - /** - * 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 or ERROR level and - * ignored. - * - * The option will be converted to a <code>boolean</code> type. - * - * Default: false - * Group: consumer - */ - default SplunkHECEndpointConsumerBuilder bridgeErrorHandler( - String bridgeErrorHandler) { - doSetProperty("bridgeErrorHandler", bridgeErrorHandler); - return this; + public interface SplunkHECEndpointBuilder extends EndpointProducerBuilder { + default AdvancedSplunkHECEndpointBuilder advanced() { + return (AdvancedSplunkHECEndpointBuilder) this; } /** * Splunk host. * * The option is a: <code>java.lang.String</code> type. * - * Group: host + * Group: producer */ - default SplunkHECEndpointConsumerBuilder host(String host) { + default SplunkHECEndpointBuilder host(String host) { doSetProperty("host", host); return this; } /** - * Contact HEC over https. - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: https - */ - default SplunkHECEndpointConsumerBuilder https(boolean https) { - doSetProperty("https", https); - return this; - } - /** - * Contact HEC over https. - * - * The option will be converted to a <code>boolean</code> type. - * - * Default: false - * Group: https - */ - default SplunkHECEndpointConsumerBuilder https(String https) { - doSetProperty("https", https); - return this; - } - /** - * Splunk HEC TLS verification. - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: skiptlsverify - */ - default SplunkHECEndpointConsumerBuilder skiptlsverify( - boolean skiptlsverify) { - doSetProperty("skiptlsverify", skiptlsverify); - return this; - } - /** - * Splunk HEC TLS verification. - * - * The option will be converted to a <code>boolean</code> type. - * - * Default: false - * Group: skiptlsverify - */ - default SplunkHECEndpointConsumerBuilder skiptlsverify( - String skiptlsverify) { - doSetProperty("skiptlsverify", skiptlsverify); - return this; - } - } - - /** - * Advanced builder for endpoint consumers for the Splunk HEC component. - */ - public interface AdvancedSplunkHECEndpointConsumerBuilder - extends - EndpointConsumerBuilder { - default SplunkHECEndpointConsumerBuilder basic() { - return (SplunkHECEndpointConsumerBuilder) this; - } - /** - * To let the consumer use a custom ExceptionHandler. Notice if the - * option bridgeErrorHandler is enabled then this option is not in use. - * By default the consumer will deal with exceptions, that will be - * logged at WARN or ERROR level and ignored. - * - * The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> - * type. - * - * Group: consumer (advanced) - */ - default AdvancedSplunkHECEndpointConsumerBuilder exceptionHandler( - ExceptionHandler exceptionHandler) { - doSetProperty("exceptionHandler", exceptionHandler); - return this; - } - /** - * To let the consumer use a custom ExceptionHandler. Notice if the - * option bridgeErrorHandler is enabled then this option is not in use. - * By default the consumer will deal with exceptions, that will be - * logged at WARN or ERROR level and ignored. - * - * The option will be converted to a - * <code>org.apache.camel.spi.ExceptionHandler</code> type. - * - * Group: consumer (advanced) - */ - default AdvancedSplunkHECEndpointConsumerBuilder exceptionHandler( - String exceptionHandler) { - doSetProperty("exceptionHandler", exceptionHandler); - return this; - } - /** - * Sets the exchange pattern when the consumer creates an exchange. - * - * The option is a: <code>org.apache.camel.ExchangePattern</code> type. - * - * Group: consumer (advanced) - */ - default AdvancedSplunkHECEndpointConsumerBuilder exchangePattern( - ExchangePattern exchangePattern) { - doSetProperty("exchangePattern", exchangePattern); - return this; - } - /** - * Sets the exchange pattern when the consumer creates an exchange. - * - * The option will be converted to a - * <code>org.apache.camel.ExchangePattern</code> type. - * - * Group: consumer (advanced) - */ - default AdvancedSplunkHECEndpointConsumerBuilder exchangePattern( - String exchangePattern) { - doSetProperty("exchangePattern", exchangePattern); - return this; - } - /** - * Whether the endpoint should use basic property binding (Camel 2.x) or - * the newer property binding with additional capabilities. - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: advanced - */ - default AdvancedSplunkHECEndpointConsumerBuilder basicPropertyBinding( - boolean basicPropertyBinding) { - doSetProperty("basicPropertyBinding", basicPropertyBinding); - return this; - } - /** - * Whether the endpoint should use basic property binding (Camel 2.x) or - * the newer property binding with additional capabilities. - * - * The option will be converted to a <code>boolean</code> type. - * - * Default: false - * Group: advanced - */ - default AdvancedSplunkHECEndpointConsumerBuilder basicPropertyBinding( - String basicPropertyBinding) { - doSetProperty("basicPropertyBinding", basicPropertyBinding); - return this; - } - /** - * Sets whether synchronous processing should be strictly used, or Camel - * is allowed to use asynchronous processing (if supported). - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: advanced - */ - default AdvancedSplunkHECEndpointConsumerBuilder synchronous( - boolean synchronous) { - doSetProperty("synchronous", synchronous); - return this; - } - /** - * Sets whether synchronous processing should be strictly used, or Camel - * is allowed to use asynchronous processing (if supported). - * - * The option will be converted to a <code>boolean</code> type. - * - * Default: false - * Group: advanced - */ - default AdvancedSplunkHECEndpointConsumerBuilder synchronous( - String synchronous) { - doSetProperty("synchronous", synchronous); - return this; - } - } - - /** - * Builder for endpoint producers for the Splunk HEC component. - */ - public interface SplunkHECEndpointProducerBuilder - extends - EndpointProducerBuilder { - default AdvancedSplunkHECEndpointProducerBuilder advanced() { - return (AdvancedSplunkHECEndpointProducerBuilder) this; - } - /** * Splunk index to write to. * * The option is a: <code>java.lang.String</code> type. * + * Default: camel * Group: producer */ - default SplunkHECEndpointProducerBuilder index(String index) { + default SplunkHECEndpointBuilder index(String index) { doSetProperty("index", index); return this; } @@ -303,7 +77,7 @@ public interface SplunkHECEndpointBuilderFactory { * Default: false * Group: producer */ - default SplunkHECEndpointProducerBuilder lazyStartProducer( + default SplunkHECEndpointBuilder lazyStartProducer( boolean lazyStartProducer) { doSetProperty("lazyStartProducer", lazyStartProducer); return this; @@ -324,7 +98,7 @@ public interface SplunkHECEndpointBuilderFactory { * Default: false * Group: producer */ - default SplunkHECEndpointProducerBuilder lazyStartProducer( + default SplunkHECEndpointBuilder lazyStartProducer( String lazyStartProducer) { doSetProperty("lazyStartProducer", lazyStartProducer); return this; @@ -334,9 +108,10 @@ public interface SplunkHECEndpointBuilderFactory { * * The option is a: <code>java.lang.String</code> type. * + * Default: camel * Group: producer */ - default SplunkHECEndpointProducerBuilder source(String source) { + default SplunkHECEndpointBuilder source(String source) { doSetProperty("source", source); return this; } @@ -345,170 +120,20 @@ public interface SplunkHECEndpointBuilderFactory { * * The option is a: <code>java.lang.String</code> type. * + * Default: camel * Group: producer */ - default SplunkHECEndpointProducerBuilder sourceType(String sourceType) { + default SplunkHECEndpointBuilder sourceType(String sourceType) { doSetProperty("sourceType", sourceType); return this; } /** - * Splunk host. - * - * The option is a: <code>java.lang.String</code> type. - * - * Group: host - */ - default SplunkHECEndpointProducerBuilder host(String host) { - doSetProperty("host", host); - return this; - } - /** * Contact HEC over https. * * The option is a: <code>boolean</code> type. * - * Default: false - * Group: https - */ - default SplunkHECEndpointProducerBuilder https(boolean https) { - doSetProperty("https", https); - return this; - } - /** - * Contact HEC over https. - * - * The option will be converted to a <code>boolean</code> type. - * - * Default: false - * Group: https - */ - default SplunkHECEndpointProducerBuilder https(String https) { - doSetProperty("https", https); - return this; - } - /** - * Splunk HEC TLS verification. - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: skiptlsverify - */ - default SplunkHECEndpointProducerBuilder skiptlsverify( - boolean skiptlsverify) { - doSetProperty("skiptlsverify", skiptlsverify); - return this; - } - /** - * Splunk HEC TLS verification. - * - * The option will be converted to a <code>boolean</code> type. - * - * Default: false - * Group: skiptlsverify - */ - default SplunkHECEndpointProducerBuilder skiptlsverify( - String skiptlsverify) { - doSetProperty("skiptlsverify", skiptlsverify); - return this; - } - } - - /** - * Advanced builder for endpoint producers for the Splunk HEC component. - */ - public interface AdvancedSplunkHECEndpointProducerBuilder - extends - EndpointProducerBuilder { - default SplunkHECEndpointProducerBuilder basic() { - return (SplunkHECEndpointProducerBuilder) this; - } - /** - * Whether the endpoint should use basic property binding (Camel 2.x) or - * the newer property binding with additional capabilities. - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: advanced - */ - default AdvancedSplunkHECEndpointProducerBuilder basicPropertyBinding( - boolean basicPropertyBinding) { - doSetProperty("basicPropertyBinding", basicPropertyBinding); - return this; - } - /** - * Whether the endpoint should use basic property binding (Camel 2.x) or - * the newer property binding with additional capabilities. - * - * The option will be converted to a <code>boolean</code> type. - * - * Default: false - * Group: advanced - */ - default AdvancedSplunkHECEndpointProducerBuilder basicPropertyBinding( - String basicPropertyBinding) { - doSetProperty("basicPropertyBinding", basicPropertyBinding); - return this; - } - /** - * Sets whether synchronous processing should be strictly used, or Camel - * is allowed to use asynchronous processing (if supported). - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: advanced - */ - default AdvancedSplunkHECEndpointProducerBuilder synchronous( - boolean synchronous) { - doSetProperty("synchronous", synchronous); - return this; - } - /** - * Sets whether synchronous processing should be strictly used, or Camel - * is allowed to use asynchronous processing (if supported). - * - * The option will be converted to a <code>boolean</code> type. - * - * Default: false - * Group: advanced - */ - default AdvancedSplunkHECEndpointProducerBuilder synchronous( - String synchronous) { - doSetProperty("synchronous", synchronous); - return this; - } - } - - /** - * Builder for endpoint for the Splunk HEC component. - */ - public interface SplunkHECEndpointBuilder - extends - SplunkHECEndpointConsumerBuilder, - SplunkHECEndpointProducerBuilder { - default AdvancedSplunkHECEndpointBuilder advanced() { - return (AdvancedSplunkHECEndpointBuilder) this; - } - /** - * Splunk host. - * - * The option is a: <code>java.lang.String</code> type. - * - * Group: host - */ - default SplunkHECEndpointBuilder host(String host) { - doSetProperty("host", host); - return this; - } - /** - * Contact HEC over https. - * - * The option is a: <code>boolean</code> type. - * - * Default: false - * Group: https + * Default: true + * Group: security */ default SplunkHECEndpointBuilder https(boolean https) { doSetProperty("https", https); @@ -519,8 +144,8 @@ public interface SplunkHECEndpointBuilderFactory { * * The option will be converted to a <code>boolean</code> type. * - * Default: false - * Group: https + * Default: true + * Group: security */ default SplunkHECEndpointBuilder https(String https) { doSetProperty("https", https); @@ -532,10 +157,10 @@ public interface SplunkHECEndpointBuilderFactory { * The option is a: <code>boolean</code> type. * * Default: false - * Group: skiptlsverify + * Group: security */ - default SplunkHECEndpointBuilder skiptlsverify(boolean skiptlsverify) { - doSetProperty("skiptlsverify", skiptlsverify); + default SplunkHECEndpointBuilder skipTlsVerify(boolean skipTlsVerify) { + doSetProperty("skipTlsVerify", skipTlsVerify); return this; } /** @@ -544,10 +169,10 @@ public interface SplunkHECEndpointBuilderFactory { * The option will be converted to a <code>boolean</code> type. * * Default: false - * Group: skiptlsverify + * Group: security */ - default SplunkHECEndpointBuilder skiptlsverify(String skiptlsverify) { - doSetProperty("skiptlsverify", skiptlsverify); + default SplunkHECEndpointBuilder skipTlsVerify(String skipTlsVerify) { + doSetProperty("skipTlsVerify", skipTlsVerify); return this; } } @@ -557,8 +182,7 @@ public interface SplunkHECEndpointBuilderFactory { */ public interface AdvancedSplunkHECEndpointBuilder extends - AdvancedSplunkHECEndpointConsumerBuilder, - AdvancedSplunkHECEndpointProducerBuilder { + EndpointProducerBuilder { default SplunkHECEndpointBuilder basic() { return (SplunkHECEndpointBuilder) this; } @@ -625,13 +249,16 @@ public interface SplunkHECEndpointBuilderFactory { * HTTP Event Collector. * * Category: log,monitoring - * Since: 3.2 + * Since: 3.3 * Maven coordinates: org.apache.camel:camel-splunk-hec * - * Syntax: <code>splunk-hec:endpoint/token</code> + * Syntax: <code>splunk-hec:splunkURL/token</code> * - * Path parameter: endpointUri - * Splunk host URI + * Path parameter: splunkURL (required) + * Splunk Host URL + * + * Path parameter: token (required) + * Splunk authorization token */ default SplunkHECEndpointBuilder splunkHec(String path) { return SplunkHECEndpointBuilderFactory.splunkHec(path); @@ -643,13 +270,16 @@ public interface SplunkHECEndpointBuilderFactory { * Event Collector. * * Category: log,monitoring - * Since: 3.2 + * Since: 3.3 * Maven coordinates: org.apache.camel:camel-splunk-hec * - * Syntax: <code>splunk-hec:endpoint/token</code> + * Syntax: <code>splunk-hec:splunkURL/token</code> + * + * Path parameter: splunkURL (required) + * Splunk Host URL * - * Path parameter: endpointUri - * Splunk host URI + * Path parameter: token (required) + * Splunk authorization token */ static SplunkHECEndpointBuilder splunkHec(String path) { class SplunkHECEndpointBuilderImpl extends AbstractEndpointBuilder implements SplunkHECEndpointBuilder, AdvancedSplunkHECEndpointBuilder { diff --git a/docs/components/modules/ROOT/pages/splunk-hec-component.adoc b/docs/components/modules/ROOT/pages/splunk-hec-component.adoc index df45a2c..6dd7745 100644 --- a/docs/components/modules/ROOT/pages/splunk-hec-component.adoc +++ b/docs/components/modules/ROOT/pages/splunk-hec-component.adoc @@ -5,9 +5,9 @@ :docTitle: Splunk HEC :artifactId: camel-splunk-hec :description: The splunk component allows to publish events in Splunk using the HTTP Event Collector. -:since: 3.2 +:since: 3.3 :supportLevel: Stable -:component-header: Both producer and consumer are supported +:component-header: Only producer is supported *Since Camel {since}* @@ -37,14 +37,13 @@ for this component: // component options: START -The Splunk HEC component supports 3 options, which are listed below. +The Splunk HEC component supports 2 options, which are listed below. [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false | boolean | *lazyStartProducer* (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 [...] | *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean |=== @@ -56,39 +55,37 @@ The Splunk HEC component supports 3 options, which are listed below. The Splunk HEC endpoint is configured using URI syntax: ---- -splunk-hec:endpoint/token +splunk-hec:splunkURL/token ---- with the following path and query parameters: -=== Path Parameters (1 parameters): +=== Path Parameters (2 parameters): [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -| *endpointUri* | Splunk host URI | | String +| *splunkURL* | *Required* Splunk Host URL | | String +| *token* | *Required* Splunk authorization token | | String |=== -=== Query Parameters (12 parameters): +=== Query Parameters (9 parameters): [width="100%",cols="2,5,^1,2",options="header"] |=== | Name | Description | Default | Type -| *bridgeErrorHandler* (consumer) | 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 or ERROR level and ignored. | false | boolean -| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | | ExceptionHandler -| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut | | ExchangePattern -| *index* (producer) | Splunk index to write to | | String +| *host* (producer) | Splunk host. | | String +| *index* (producer) | Splunk index to write to | camel | String | *lazyStartProducer* (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 [...] -| *source* (producer) | Splunk source argument | | String -| *sourceType* (producer) | Splunk sourcetype argument | | String +| *source* (producer) | Splunk source argument | camel | String +| *sourceType* (producer) | Splunk sourcetype argument | camel | String | *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean | *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean -| *host* (host) | Splunk host. | | String -| *https* (https) | Contact HEC over https. | false | boolean -| *skiptlsverify* (skiptlsverify) | Splunk HEC TLS verification. | false | boolean +| *https* (security) | Contact HEC over https. | true | boolean +| *skipTlsVerify* (security) | Splunk HEC TLS verification. | false | boolean |=== // endpoint options: END