The tap-kafka extractor pulls data from Apache Kafka that can then be sent to a destination using a loader.
Alternate Implementations
-
Airbyte
🥈
-
Gadget
🥈
-
isabella232
-
Peter Kosztolanyi
-
Peter Begle
-
Stitch Data
🥉
-
Steve Hanna
- Wise (default)🥈
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-kafka extractor to your
project using
:meltano add -
Configure the tap-kafka
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-kafkameltano config tap-kafka set --interactivemeltano config tap-kafka testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-kafka
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- discover
- properties
- state
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-kafka settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
bootstrap_serverscommit_interval_msconsumer_timeout_msgroup_idheartbeat_interval_msinitial_start_timemax_poll_interval_msmax_poll_recordsmax_runtime_msmessage_formatprimary_keysproto_classes_dirproto_schemasession_timeout_mstopicuse_message_key
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-kafka list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Bootstrap Servers (bootstrap_servers)
-
Environment variable:
TAP_KAFKA_BOOTSTRAP_SERVERS
host[:port] string (or list of comma separated host[:port] strings) that the consumer should contact to bootstrap initial cluster metadata.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set bootstrap_servers [value]Commit Internal (ms) (commit_interval_ms)
-
Environment variable:
TAP_KAFKA_COMMIT_INTERVAL_MS
(Default 5000) Number of milliseconds between two commits. This is different than the kafka auto commit feature. Tap-kafka sends commit messages automatically but only when the data consumed successfully and persisted to local store.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set commit_interval_ms [value]Consumer Timeout (ms) (consumer_timeout_ms)
-
Environment variable:
TAP_KAFKA_CONSUMER_TIMEOUT_MS
(Default 10000) KafkaConsumer setting. Number of milliseconds to block during message iteration before raising StopIteration
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set consumer_timeout_ms [value]Group ID (group_id)
-
Environment variable:
TAP_KAFKA_GROUP_ID
The name of the consumer group to join for dynamic partition assignment (if enabled), and to use for fetching and committing offsets.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set group_id [value]Heartbeat Interval (ms) (heartbeat_interval_ms)
-
Environment variable:
TAP_KAFKA_HEARTBEAT_INTERVAL_MS
(Default 10000) KafkaConsumer setting. The expected time in milliseconds between heartbeats to the consumer coordinator when using Kafka’s group management facilities.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set heartbeat_interval_ms [value]Initial Start Time (initial_start_time)
-
Environment variable:
TAP_KAFKA_INITIAL_START_TIME
(Default latest) Start time reference of the message consumption if no bookmarked position in state.sjon. One of - latest, earliest or an ISO-8601 formatted timestamp string.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set initial_start_time [value]Max Poll Interval (ms) (max_poll_interval_ms)
-
Environment variable:
TAP_KAFKA_MAX_POLL_INTERVAL_MS
(Default 300000) KafkaConsumer setting. The maximum delay between invocations of poll() when using consumer group management.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set max_poll_interval_ms [value]Max Poll Records (max_poll_records)
-
Environment variable:
TAP_KAFKA_MAX_POLL_RECORDS
(Default 500) KafkaConsumer setting. Maximum number of records to poll.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set max_poll_records [value]Max Runtime (ms) (max_runtime_ms)
-
Environment variable:
TAP_KAFKA_MAX_RUNTIME_MS
(Default 300000) The maximum time for the tap to collect new messages from Kafka topic. If this time exceeds it will flush the batch and close kafka connection.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set max_runtime_ms [value]Message Format (message_format)
-
Environment variable:
TAP_KAFKA_MESSAGE_FORMAT
(Default json) Supported message formats are json and protobuf.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set message_format [value]Primary Keys (primary_keys)
-
Environment variable:
TAP_KAFKA_PRIMARY_KEYS
Optionally you can define primary key for the consumed messages. It requires a column name and /slashed/paths ala xpath selector to extract the value from the kafka messages. The extracted column will be added to every output singer message.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set primary_keys [value]Protobuf Classes Directory (proto_classes_dir)
-
Environment variable:
TAP_KAFKA_PROTO_CLASSES_DIR
(Default current working dir)
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set proto_classes_dir [value]Protobuf Schema (proto_schema)
-
Environment variable:
TAP_KAFKA_PROTO_SCHEMA
Protobuf message format in .proto syntax. Required if the message_format is protobuf.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set proto_schema [value]Session Timeout (ms) (session_timeout_ms)
-
Environment variable:
TAP_KAFKA_SESSION_TIMEOUT_MS
(Default 30000) KafkaConsumer setting. The timeout used to detect failures when using Kafka’s group management facilities.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set session_timeout_ms [value]Topic (topic)
-
Environment variable:
TAP_KAFKA_TOPIC
Name of kafka topics to subscribe to
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set topic [value]Use Message Key (use_message_key)
-
Environment variable:
TAP_KAFKA_USE_MESSAGE_KEY
(Default true) Defines whether to use Kafka message key as a primary key for the record. Note - custom primary key(s) takes precedence if such defined and use_message_key is set to true.
Configure this setting directly using the following Meltano command:
meltano config tap-kafka set use_message_key [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-4-c0c0c4){kind=icon}
