Class LogAndSkipOnInvalidTimestamp
- All Implemented Interfaces:
TimestampExtractor
Embedded metadata timestamp was introduced in "KIP-32: Add timestamps to Kafka message" for the new 0.10+ Kafka message format.
Here, "embedded metadata" refers to the fact that compatible Kafka producer clients automatically and transparently embed such timestamps into message metadata they send to Kafka, which can then be retrieved via this timestamp extractor.
If the embedded metadata timestamp represents CreateTime (cf. Kafka broker setting
message.timestamp.type
and Kafka topic setting log.message.timestamp.type
),
this extractor effectively provides event-time semantics.
If LogAppendTime is used as broker/topic setting to define the embedded metadata timestamps,
using this extractor effectively provides ingestion-time semantics.
If you need processing-time semantics, use WallclockTimestampExtractor
.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionlong
extract
(ConsumerRecord<Object, Object> record, long partitionTime) Extracts the embedded metadata timestamp from the givenConsumerRecord
.long
onInvalidTimestamp
(ConsumerRecord<Object, Object> record, long recordTimestamp, long partitionTime) Writes a log WARN message when the extracted timestamp is invalid (negative) but returns the invalid timestamp as-is, which ultimately causes the record to be skipped and not to be processed.
-
Constructor Details
-
LogAndSkipOnInvalidTimestamp
public LogAndSkipOnInvalidTimestamp()
-
-
Method Details
-
onInvalidTimestamp
public long onInvalidTimestamp(ConsumerRecord<Object, Object> record, long recordTimestamp, long partitionTime) Writes a log WARN message when the extracted timestamp is invalid (negative) but returns the invalid timestamp as-is, which ultimately causes the record to be skipped and not to be processed.- Parameters:
record
- a data recordrecordTimestamp
- the timestamp extractor from the recordpartitionTime
- the highest extracted valid timestamp of the current record's partition˙ (could be -1 if unknown)- Returns:
- the originally extracted timestamp of the record
-
extract
Extracts the embedded metadata timestamp from the givenConsumerRecord
.- Specified by:
extract
in interfaceTimestampExtractor
- Parameters:
record
- a data recordpartitionTime
- the highest extracted valid timestamp of the current record's partition˙ (could be -1 if unknown)- Returns:
- the embedded metadata timestamp of the given
ConsumerRecord
-