@PublicEvolving public class FlinkKafkaProducer<IN> extends org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>
FlinkKafkaProducer.Semantic.AT_LEAST_ONCE semantic.
Before using FlinkKafkaProducer.Semantic.EXACTLY_ONCE please refer to Flink's
Kafka connector documentation.| Modifier and Type | Class and Description |
|---|---|
static class |
FlinkKafkaProducer.ContextStateSerializer
TypeSerializer for
FlinkKafkaProducer.KafkaTransactionContext. |
static class |
FlinkKafkaProducer.KafkaTransactionContext
Context associated to this instance of the
FlinkKafkaProducer. |
static class |
FlinkKafkaProducer.NextTransactionalIdHint
Keep information required to deduce next safe to use transactional id.
|
static class |
FlinkKafkaProducer.Semantic
Semantics that can be chosen.
|
static class |
FlinkKafkaProducer.TransactionStateSerializer
TypeSerializer for
FlinkKafkaProducer.KafkaTransactionState. |
org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction.State<TXN,CONTEXT>, org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction.StateSerializer<TXN,CONTEXT>, org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction.StateSerializerConfigSnapshot<TXN,CONTEXT>, org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction.TransactionHolder<TXN>| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_KAFKA_PRODUCERS_POOL_SIZE
Default number of KafkaProducers in the pool.
|
static org.apache.flink.api.common.time.Time |
DEFAULT_KAFKA_TRANSACTION_TIMEOUT
Default value for kafka transaction timeout.
|
static String |
KEY_DISABLE_METRICS
Configuration key for disabling the metrics reporting.
|
protected Properties |
producerConfig
User defined properties for the Producer.
|
static int |
SAFE_SCALE_DOWN_FACTOR
This coefficient determines what is the safe scale down factor.
|
protected FlinkKafkaProducer.Semantic |
semantic
Semantic chosen for this instance.
|
| Constructor and Description |
|---|
FlinkKafkaProducer(String topicId,
org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema,
Properties producerConfig)
Creates a FlinkKafkaProducer for a given topic.
|
FlinkKafkaProducer(String topicId,
org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema,
Properties producerConfig,
FlinkKafkaProducer.Semantic semantic)
Creates a FlinkKafkaProducer for a given topic.
|
FlinkKafkaProducer(String defaultTopicId,
org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema,
Properties producerConfig,
Optional<org.apache.flink.streaming.connectors.kafka.partitioner.FlinkKafkaPartitioner<IN>> customPartitioner)
Creates a FlinkKafkaProducer for a given topic.
|
FlinkKafkaProducer(String defaultTopicId,
org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema,
Properties producerConfig,
Optional<org.apache.flink.streaming.connectors.kafka.partitioner.FlinkKafkaPartitioner<IN>> customPartitioner,
FlinkKafkaProducer.Semantic semantic,
int kafkaProducersPoolSize)
Creates a FlinkKafkaProducer for a given topic.
|
FlinkKafkaProducer(String topicId,
org.apache.flink.api.common.serialization.SerializationSchema<IN> serializationSchema,
Properties producerConfig)
Creates a FlinkKafkaProducer for a given topic.
|
FlinkKafkaProducer(String topicId,
org.apache.flink.api.common.serialization.SerializationSchema<IN> serializationSchema,
Properties producerConfig,
Optional<org.apache.flink.streaming.connectors.kafka.partitioner.FlinkKafkaPartitioner<IN>> customPartitioner)
Creates a FlinkKafkaProducer for a given topic.
|
FlinkKafkaProducer(String brokerList,
String topicId,
org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema)
Creates a FlinkKafkaProducer for a given topic.
|
FlinkKafkaProducer(String brokerList,
String topicId,
org.apache.flink.api.common.serialization.SerializationSchema<IN> serializationSchema)
Creates a FlinkKafkaProducer for a given topic.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
abort(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction) |
protected org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState |
beginTransaction() |
void |
close() |
protected void |
commit(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction) |
protected FlinkKafkaInternalProducer<byte[],byte[]> |
createProducer() |
protected void |
finishRecoveringContext() |
FlinkKafkaProducer<IN> |
ignoreFailuresAfterTransactionTimeout()
Disables the propagation of exceptions thrown when committing presumably timed out Kafka
transactions during recovery of the job.
|
void |
initializeState(org.apache.flink.runtime.state.FunctionInitializationContext context) |
protected Optional<FlinkKafkaProducer.KafkaTransactionContext> |
initializeUserContext() |
void |
invoke(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction,
IN next,
org.apache.flink.streaming.api.functions.sink.SinkFunction.Context context) |
void |
open(org.apache.flink.configuration.Configuration configuration)
Initializes the connection to Kafka.
|
protected void |
preCommit(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction) |
protected void |
recoverAndAbort(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction) |
protected void |
recoverAndCommit(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction) |
void |
setLogFailuresOnly(boolean logFailuresOnly)
Defines whether the producer should fail on errors, or only log them.
|
void |
setWriteTimestampToKafka(boolean writeTimestampToKafka)
If set to true, Flink will write the (event time) timestamp attached to each record into Kafka.
|
void |
snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context) |
currentTransaction, enableTransactionTimeoutWarnings, getUserContext, invoke, invoke, notifyCheckpointComplete, pendingTransactions, setTransactionTimeoutpublic static final int SAFE_SCALE_DOWN_FACTOR
If the Flink application previously failed before first checkpoint completed or we are starting new batch
of FlinkKafkaProducer from scratch without clean shutdown of the previous one,
FlinkKafkaProducer doesn't know what was the set of previously used Kafka's transactionalId's. In
that case, it will try to play safe and abort all of the possible transactionalIds from the range of:
[0, getNumberOfParallelSubtasks() * kafkaProducersPoolSize * SAFE_SCALE_DOWN_FACTOR)
The range of available to use transactional ids is:
[0, getNumberOfParallelSubtasks() * kafkaProducersPoolSize)
This means that if we decrease getNumberOfParallelSubtasks() by a factor larger then
SAFE_SCALE_DOWN_FACTOR we can have a left some lingering transaction.
public static final int DEFAULT_KAFKA_PRODUCERS_POOL_SIZE
FlinkKafkaProducer.Semantic.EXACTLY_ONCE.public static final org.apache.flink.api.common.time.Time DEFAULT_KAFKA_TRANSACTION_TIMEOUT
public static final String KEY_DISABLE_METRICS
protected final Properties producerConfig
protected FlinkKafkaProducer.Semantic semantic
public FlinkKafkaProducer(String brokerList, String topicId, org.apache.flink.api.common.serialization.SerializationSchema<IN> serializationSchema)
brokerList - Comma separated addresses of the brokerstopicId - ID of the Kafka topic.serializationSchema - User defined (keyless) serialization schema.public FlinkKafkaProducer(String topicId, org.apache.flink.api.common.serialization.SerializationSchema<IN> serializationSchema, Properties producerConfig)
Using this constructor, the default FlinkFixedPartitioner will be used as
the partitioner. This default partitioner maps each sink subtask to a single Kafka
partition (i.e. all records received by a sink subtask will end up in the same
Kafka partition).
To use a custom partitioner, please use
FlinkKafkaProducer(String, SerializationSchema, Properties, Optional) instead.
topicId - ID of the Kafka topic.serializationSchema - User defined key-less serialization schema.producerConfig - Properties with the producer configuration.public FlinkKafkaProducer(String topicId, org.apache.flink.api.common.serialization.SerializationSchema<IN> serializationSchema, Properties producerConfig, Optional<org.apache.flink.streaming.connectors.kafka.partitioner.FlinkKafkaPartitioner<IN>> customPartitioner)
SerializationSchema and possibly a custom FlinkKafkaPartitioner.
Since a key-less SerializationSchema is used, all records sent to Kafka will not have an
attached key. Therefore, if a partitioner is also not provided, records will be distributed to Kafka
partitions in a round-robin fashion.
topicId - The topic to write data toserializationSchema - A key-less serializable serialization schema for turning user objects into a kafka-consumable byte[]producerConfig - Configuration properties for the KafkaProducer. 'bootstrap.servers.' is the only required argument.customPartitioner - A serializable partitioner for assigning messages to Kafka partitions.
If a partitioner is not provided, records will be distributed to Kafka partitions
in a round-robin fashion.public FlinkKafkaProducer(String brokerList, String topicId, org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema)
Using this constructor, the default FlinkFixedPartitioner will be used as
the partitioner. This default partitioner maps each sink subtask to a single Kafka
partition (i.e. all records received by a sink subtask will end up in the same
Kafka partition).
To use a custom partitioner, please use
FlinkKafkaProducer(String, KeyedSerializationSchema, Properties, Optional) instead.
brokerList - Comma separated addresses of the brokerstopicId - ID of the Kafka topic.serializationSchema - User defined serialization schema supporting key/value messagespublic FlinkKafkaProducer(String topicId, org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema, Properties producerConfig)
Using this constructor, the default FlinkFixedPartitioner will be used as
the partitioner. This default partitioner maps each sink subtask to a single Kafka
partition (i.e. all records received by a sink subtask will end up in the same
Kafka partition).
To use a custom partitioner, please use
FlinkKafkaProducer(String, KeyedSerializationSchema, Properties, Optional) instead.
topicId - ID of the Kafka topic.serializationSchema - User defined serialization schema supporting key/value messagesproducerConfig - Properties with the producer configuration.public FlinkKafkaProducer(String topicId, org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema, Properties producerConfig, FlinkKafkaProducer.Semantic semantic)
Using this constructor, the default FlinkFixedPartitioner will be used as
the partitioner. This default partitioner maps each sink subtask to a single Kafka
partition (i.e. all records received by a sink subtask will end up in the same
Kafka partition).
To use a custom partitioner, please use
FlinkKafkaProducer(String, KeyedSerializationSchema, Properties, Optional, FlinkKafkaProducer.Semantic, int) instead.
topicId - ID of the Kafka topic.serializationSchema - User defined serialization schema supporting key/value messagesproducerConfig - Properties with the producer configuration.semantic - Defines semantic that will be used by this producer (see FlinkKafkaProducer.Semantic).public FlinkKafkaProducer(String defaultTopicId, org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema, Properties producerConfig, Optional<org.apache.flink.streaming.connectors.kafka.partitioner.FlinkKafkaPartitioner<IN>> customPartitioner)
KeyedSerializationSchema and possibly a custom FlinkKafkaPartitioner.
If a partitioner is not provided, written records will be partitioned by the attached key of each
record (as determined by KeyedSerializationSchema.serializeKey(Object)). If written records do not
have a key (i.e., KeyedSerializationSchema.serializeKey(Object) returns null), they
will be distributed to Kafka partitions in a round-robin fashion.
defaultTopicId - The default topic to write data toserializationSchema - A serializable serialization schema for turning user objects into a kafka-consumable byte[] supporting key/value messagesproducerConfig - Configuration properties for the KafkaProducer. 'bootstrap.servers.' is the only required argument.customPartitioner - A serializable partitioner for assigning messages to Kafka partitions.
If a partitioner is not provided, records will be partitioned by the key of each record
(determined by KeyedSerializationSchema.serializeKey(Object)). If the keys
are null, then records will be distributed to Kafka partitions in a
round-robin fashion.public FlinkKafkaProducer(String defaultTopicId, org.apache.flink.streaming.util.serialization.KeyedSerializationSchema<IN> serializationSchema, Properties producerConfig, Optional<org.apache.flink.streaming.connectors.kafka.partitioner.FlinkKafkaPartitioner<IN>> customPartitioner, FlinkKafkaProducer.Semantic semantic, int kafkaProducersPoolSize)
KeyedSerializationSchema and possibly a custom FlinkKafkaPartitioner.
If a partitioner is not provided, written records will be partitioned by the attached key of each
record (as determined by KeyedSerializationSchema.serializeKey(Object)). If written records do not
have a key (i.e., KeyedSerializationSchema.serializeKey(Object) returns null), they
will be distributed to Kafka partitions in a round-robin fashion.
defaultTopicId - The default topic to write data toserializationSchema - A serializable serialization schema for turning user objects into a kafka-consumable byte[] supporting key/value messagesproducerConfig - Configuration properties for the KafkaProducer. 'bootstrap.servers.' is the only required argument.customPartitioner - A serializable partitioner for assigning messages to Kafka partitions.
If a partitioner is not provided, records will be partitioned by the key of each record
(determined by KeyedSerializationSchema.serializeKey(Object)). If the keys
are null, then records will be distributed to Kafka partitions in a
round-robin fashion.semantic - Defines semantic that will be used by this producer (see FlinkKafkaProducer.Semantic).kafkaProducersPoolSize - Overwrite default KafkaProducers pool size (see FlinkKafkaProducer.Semantic.EXACTLY_ONCE).public void setWriteTimestampToKafka(boolean writeTimestampToKafka)
writeTimestampToKafka - Flag indicating if Flink's internal timestamps are written to Kafka.public void setLogFailuresOnly(boolean logFailuresOnly)
logFailuresOnly - The flag to indicate logging-only on exceptions.public FlinkKafkaProducer<IN> ignoreFailuresAfterTransactionTimeout()
Note that we use System.currentTimeMillis() to track the age of a transaction.
Moreover, only exceptions thrown during the recovery are caught, i.e., the producer will
attempt at least one commit of the transaction before giving up.
ignoreFailuresAfterTransactionTimeout in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>public void open(org.apache.flink.configuration.Configuration configuration)
throws Exception
open in interface org.apache.flink.api.common.functions.RichFunctionopen in class org.apache.flink.api.common.functions.AbstractRichFunctionExceptionpublic void invoke(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction,
IN next,
org.apache.flink.streaming.api.functions.sink.SinkFunction.Context context)
throws FlinkKafkaException
invoke in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>FlinkKafkaExceptionpublic void close()
throws FlinkKafkaException
close in interface org.apache.flink.api.common.functions.RichFunctionclose in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>FlinkKafkaExceptionprotected org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState beginTransaction()
throws FlinkKafkaException
beginTransaction in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>FlinkKafkaExceptionprotected void preCommit(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction)
throws FlinkKafkaException
preCommit in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>FlinkKafkaExceptionprotected void commit(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction)
commit in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>protected void recoverAndCommit(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction)
recoverAndCommit in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>protected void abort(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction)
abort in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>protected void recoverAndAbort(org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState transaction)
recoverAndAbort in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>public void snapshotState(org.apache.flink.runtime.state.FunctionSnapshotContext context)
throws Exception
snapshotState in interface org.apache.flink.streaming.api.checkpoint.CheckpointedFunctionsnapshotState in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>Exceptionpublic void initializeState(org.apache.flink.runtime.state.FunctionInitializationContext context)
throws Exception
initializeState in interface org.apache.flink.streaming.api.checkpoint.CheckpointedFunctioninitializeState in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>Exceptionprotected Optional<FlinkKafkaProducer.KafkaTransactionContext> initializeUserContext()
initializeUserContext in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>protected void finishRecoveringContext()
finishRecoveringContext in class org.apache.flink.streaming.api.functions.sink.TwoPhaseCommitSinkFunction<IN,org.apache.flink.streaming.connectors.kafka.FlinkKafkaProducer.KafkaTransactionState,FlinkKafkaProducer.KafkaTransactionContext>protected FlinkKafkaInternalProducer<byte[],byte[]> createProducer()
Copyright © 2014–2019 The Apache Software Foundation. All rights reserved.