Skip to content

Commit

Permalink
Added a page in docs related to basic configuration of camel kafka co…
Browse files Browse the repository at this point in the history
…nnector
  • Loading branch information
oscerd committed Nov 2, 2020
1 parent 6837488 commit bdd884a
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/modules/ROOT/nav.adoc
@@ -1,5 +1,6 @@
* xref:about.adoc[What is it?]
** xref:basic-concepts.adoc[Basic concepts]
** xref:basic-configuration.adoc[Basic configuration]
** xref:aggregation.adoc[Aggregation]
* xref:archetypes.adoc[Archetypes]
** xref:archetype-connector.adoc[Extensible connector archetype]
Expand Down
44 changes: 44 additions & 0 deletions docs/modules/ROOT/pages/basic-configuration.adoc
@@ -0,0 +1,44 @@
[[BasicConfiguration-BasicConfiguration]]
= Basic Configuration

In this page we list the Camel Kafka Configuration which are not part of the camel-catalog material and are not part of the kafka connect framework. For the specific connector configuration you can have a look at the single documentation pages.

For a Sink connector the basic options are:

[width="100%",cols="2,5,^2,1",options="header"]
|===
| Name | Description | Default | Priority
| camel.sink.marshal | The camel dataformat name to use to marshal data to the destination | null | HIGH
| camel.sink.unmarshal | The camel dataformat name to use to unmarshal data from the topic | null | HIGH
| camel.sink.contentLogLevel | og level for the record's content. Valid values: TRACE, DEBUG, INFO, WARN, ERROR, OFF. | OFF | HIGH
| camel.beans.aggregate | A reference to an aggregate bean, in the form of #class: | null | MEDIUM
| camel.aggregation.size | The size of the aggregation, to be used in combination with camel.beans.aggregate | 10 | MEDIUM
| camel.aggregation.timeout | The timeout of the aggregation, to be used in combination with camel.beans.aggregate | 500L | MEDIUM
| camel.error.handler | The error handler to use: possible value are 'no' or 'default' | default | MEDIUM
| camel.error.handler.max.redeliveries | The maximum redeliveries to be use in case of Default Error Handler | 0 | MEDIUM
| camel.error.handler.redelivery.delay | The initial redelivery delay in milliseconds in case of Default Error Handler | 1000L | MEDIUM
|===

For a Source connector the basic options are:

[width="100%",cols="2,5,^2,1",options="header"]
|===
| Name | Description | Default | Priority
| camel.source.marshal | The camel dataformat name to use to marshal data to the destination | null | HIGH
| camel.source.unmarshal | The camel dataformat name to use to unmarshal data from the topic | null | HIGH
| camel.source.contentLogLevel | og level for the record's content. Valid values: TRACE, DEBUG, INFO, WARN, ERROR, OFF. | OFF | HIGH
| camel.source.maxBatchPollSize | The max number of messages retrieved in a single poll() | 1000L | MEDIUM
| camel.source.maxPollDuration | The maximum time in milliseconds spent in a single call to poll() | 1000L | MEDIUM
| camel.source.pollingConsumerQueueSize | The queue size for the internal hand-off queue between the polling consumer, and producers sending data into the queue. | 1000L | MEDIUM
| camel.source.pollingConsumerBlockTimeout | To use a timeout (in milliseconds) when the producer is blocked if the internal queue is full. If the value is 0 or negative then no timeout is in use. | 0L | MEDIUM
| camel.source.pollingConsumerBlockWhenFull | Whether to block any producer if the internal queue is full. | true | MEDIUM
| camel.source.camelMessageHeaderKey | The name of a camel message header containing an unique key that can be used as a Kafka message key. If this is not specified, then the Kafka message will not have a key. | null | MEDIUM
| camel.beans.aggregate | A reference to an aggregate bean, in the form of #class: | null | MEDIUM
| camel.aggregation.size | The size of the aggregation, to be used in combination with camel.beans.aggregate | 10 | MEDIUM
| camel.aggregation.timeout | The timeout of the aggregation, to be used in combination with camel.beans.aggregate | 500L | MEDIUM
| camel.error.handler | The error handler to use: possible value are 'no' or 'default' | default | MEDIUM
| camel.error.handler.max.redeliveries | The maximum redeliveries to be use in case of Default Error Handler | 0 | MEDIUM
| camel.error.handler.redelivery.delay | The initial redelivery delay in milliseconds in case of Default Error Handler | 1000L | MEDIUM
|===

For more options related to single connector you can have a look at xref:connectors.adoc[Connectors list].

0 comments on commit bdd884a

Please sign in to comment.