feat(mcl-processor): Update mcl processor hooks #11134
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| package com.linkedin.metadata.kafka; | ||
|
|
||
| import com.codahale.metrics.Histogram; | ||
| import com.codahale.metrics.MetricRegistry; | ||
| import com.codahale.metrics.Timer; | ||
| import com.linkedin.metadata.EventUtils; | ||
| import com.linkedin.metadata.kafka.hook.MetadataChangeLogHook; | ||
| import com.linkedin.metadata.utils.metrics.MetricUtils; | ||
| import com.linkedin.mxe.MetadataChangeLog; | ||
| import io.datahubproject.metadata.context.OperationContext; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.apache.avro.generic.GenericRecord; | ||
| import org.apache.kafka.clients.consumer.ConsumerRecord; | ||
|
|
||
| @Slf4j | ||
| public class MCLKafkaListener { | ||
| private static final Histogram kafkaLagStats = | ||
| MetricUtils.get() | ||
| .histogram( | ||
| MetricRegistry.name( | ||
| "com.linkedin.metadata.kafka.MetadataChangeLogProcessor", "kafkaLag")); | ||
|
|
||
| private final String consumerGroupId; | ||
| private final List<MetadataChangeLogHook> hooks; | ||
|
|
||
| public MCLKafkaListener( | ||
| OperationContext systemOperationContext, | ||
| String consumerGroup, | ||
| List<MetadataChangeLogHook> hooks) { | ||
| this.consumerGroupId = consumerGroup; | ||
| this.hooks = hooks; | ||
| this.hooks.forEach(hook -> hook.init(systemOperationContext)); | ||
|
|
||
| log.info( | ||
| "Enabled MCL Hooks - Group: {} Hooks: {}", | ||
| consumerGroup, | ||
| hooks.stream().map(hook -> hook.getClass().getSimpleName()).collect(Collectors.toList())); | ||
| } | ||
|
|
||
| public void consume(final ConsumerRecord<String, GenericRecord> consumerRecord) { | ||
| try (Timer.Context i = MetricUtils.timer(this.getClass(), "consume").time()) { | ||
| kafkaLagStats.update(System.currentTimeMillis() - consumerRecord.timestamp()); | ||
| final GenericRecord record = consumerRecord.value(); | ||
| log.debug( | ||
| "Got MCL event consumer: {} key: {}, topic: {}, partition: {}, offset: {}, value size: {}, timestamp: {}", | ||
| consumerGroupId, | ||
| consumerRecord.key(), | ||
| consumerRecord.topic(), | ||
| consumerRecord.partition(), | ||
| consumerRecord.offset(), | ||
| consumerRecord.serializedValueSize(), | ||
| consumerRecord.timestamp()); | ||
| MetricUtils.counter(this.getClass(), consumerGroupId + "_received_mcl_count").inc(); | ||
|
|
||
| MetadataChangeLog event; | ||
| try { | ||
| event = EventUtils.avroToPegasusMCL(record); | ||
| } catch (Exception e) { | ||
| MetricUtils.counter( | ||
| this.getClass(), consumerGroupId + "_avro_to_pegasus_conversion_failure") | ||
| .inc(); | ||
| log.error("Error deserializing message due to: ", e); | ||
| log.error("Message: {}", record.toString()); | ||
| return; | ||
| } | ||
|
|
||
| log.info( | ||
| "Invoking MCL hooks for consumer: {} urn: {}, aspect name: {}, entity type: {}, change type: {}", | ||
| consumerGroupId, | ||
| event.getEntityUrn(), | ||
| event.hasAspectName() ? event.getAspectName() : null, | ||
| event.hasEntityType() ? event.getEntityType() : null, | ||
| event.hasChangeType() ? event.getChangeType() : null); | ||
|
|
||
| // Here - plug in additional "custom processor hooks" | ||
| for (MetadataChangeLogHook hook : this.hooks) { | ||
| log.info( | ||
| "Invoking MCL hook {} for urn: {}", | ||
| hook.getClass().getSimpleName(), | ||
| event.getEntityUrn()); | ||
| try (Timer.Context ignored = | ||
| MetricUtils.timer(this.getClass(), hook.getClass().getSimpleName() + "_latency") | ||
| .time()) { | ||
| hook.invoke(event); | ||
| } catch (Exception e) { | ||
| // Just skip this hook and continue. - Note that this represents "at most once"// | ||
| // processing. | ||
| MetricUtils.counter(this.getClass(), hook.getClass().getSimpleName() + "_failure").inc(); | ||
| log.error( | ||
| "Failed to execute MCL hook with name {}", hook.getClass().getCanonicalName(), e); | ||
| } | ||
| } | ||
| // TODO: Manually commit kafka offsets after full processing. | ||
| MetricUtils.counter(this.getClass(), consumerGroupId + "_consumed_mcl_count").inc(); | ||
| log.info( | ||
| "Successfully completed MCL hooks for consumer: {} urn: {}", | ||
| consumerGroupId, | ||
| event.getEntityUrn()); | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| package com.linkedin.metadata.kafka; | ||
|
|
||
| import com.linkedin.metadata.kafka.config.MetadataChangeLogProcessorCondition; | ||
| import com.linkedin.metadata.kafka.hook.MetadataChangeLogHook; | ||
| import com.linkedin.mxe.Topics; | ||
| import io.datahubproject.metadata.context.OperationContext; | ||
| import java.util.Comparator; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.stream.Collectors; | ||
| import javax.annotation.Nonnull; | ||
| import lombok.SneakyThrows; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.apache.avro.generic.GenericRecord; | ||
| import org.apache.kafka.clients.consumer.ConsumerRecord; | ||
| import org.springframework.beans.factory.InitializingBean; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.beans.factory.annotation.Qualifier; | ||
| import org.springframework.beans.factory.annotation.Value; | ||
| import org.springframework.context.annotation.Conditional; | ||
| import org.springframework.kafka.annotation.EnableKafka; | ||
| import org.springframework.kafka.config.KafkaListenerContainerFactory; | ||
| import org.springframework.kafka.config.KafkaListenerEndpoint; | ||
| import org.springframework.kafka.config.KafkaListenerEndpointRegistry; | ||
| import org.springframework.kafka.config.MethodKafkaListenerEndpoint; | ||
| import org.springframework.messaging.handler.annotation.support.DefaultMessageHandlerMethodFactory; | ||
| import org.springframework.stereotype.Component; | ||
|
|
||
| @Slf4j | ||
| @EnableKafka | ||
| @Component | ||
| @Conditional(MetadataChangeLogProcessorCondition.class) | ||
| public class MCLKafkaListenerRegistrar implements InitializingBean { | ||
|
|
||
| @Autowired | ||
| @Qualifier("systemOperationContext") | ||
| private OperationContext systemOperationContext; | ||
|
|
||
| @Autowired private KafkaListenerEndpointRegistry kafkaListenerEndpointRegistry; | ||
|
|
||
| @Autowired | ||
| @Qualifier("kafkaEventConsumer") | ||
| private KafkaListenerContainerFactory<?> kafkaListenerContainerFactory; | ||
|
|
||
| @Value("${METADATA_CHANGE_LOG_KAFKA_CONSUMER_GROUP_ID:generic-mae-consumer-job-client}") | ||
| private String consumerGroupBase; | ||
|
|
||
| @Value("${METADATA_CHANGE_LOG_VERSIONED_TOPIC_NAME:" + Topics.METADATA_CHANGE_LOG_VERSIONED + "}") | ||
| private String mclVersionedTopicName; | ||
|
|
||
| @Value( | ||
| "${METADATA_CHANGE_LOG_TIMESERIES_TOPIC_NAME:" + Topics.METADATA_CHANGE_LOG_TIMESERIES + "}") | ||
| private String mclTimeseriesTopicName; | ||
|
|
||
| @Autowired private List<MetadataChangeLogHook> metadataChangeLogHooks; | ||
|
|
||
| @Override | ||
| public void afterPropertiesSet() { | ||
| Map<String, List<MetadataChangeLogHook>> hookGroups = | ||
| getMetadataChangeLogHooks().stream() | ||
| .collect(Collectors.groupingBy(MetadataChangeLogHook::getConsumerGroupSuffix)); | ||
|
|
||
| log.info( | ||
| "MetadataChangeLogProcessor Consumer Groups: {}", | ||
| hookGroups.keySet().stream().map(this::buildConsumerGroupName).collect(Collectors.toSet())); | ||
|
|
||
| hookGroups.forEach( | ||
| (key, hooks) -> { | ||
| KafkaListenerEndpoint kafkaListenerEndpoint = | ||
| createListenerEndpoint( | ||
| buildConsumerGroupName(key), | ||
| List.of(mclVersionedTopicName, mclTimeseriesTopicName), | ||
| hooks); | ||
| registerMCLKafkaListener(kafkaListenerEndpoint, true); | ||
| }); | ||
| } | ||
|
Comment on lines
+58
to
+76
There was a problem hiding this comment. Consider Error Handling for Hook Registration. The try {
registerMCLKafkaListener(kafkaListenerEndpoint, true);
} catch (Exception e) {
log.error("Failed to register Kafka listener for consumer group: {}", key, e);
} |
||
|
|
||
| public List<MetadataChangeLogHook> getMetadataChangeLogHooks() { | ||
| return metadataChangeLogHooks.stream() | ||
| .filter(MetadataChangeLogHook::isEnabled) | ||
| .sorted(Comparator.comparing(MetadataChangeLogHook::executionOrder)) | ||
| .toList(); | ||
| } | ||
|
|
||
| @SneakyThrows | ||
| public void registerMCLKafkaListener( | ||
| KafkaListenerEndpoint kafkaListenerEndpoint, boolean startImmediately) { | ||
| kafkaListenerEndpointRegistry.registerListenerContainer( | ||
| kafkaListenerEndpoint, kafkaListenerContainerFactory, startImmediately); | ||
| } | ||
|
|
||
| private KafkaListenerEndpoint createListenerEndpoint( | ||
| String consumerGroupId, List<String> topics, List<MetadataChangeLogHook> hooks) { | ||
| MethodKafkaListenerEndpoint<String, GenericRecord> kafkaListenerEndpoint = | ||
| new MethodKafkaListenerEndpoint<>(); | ||
| kafkaListenerEndpoint.setId(consumerGroupId); | ||
| kafkaListenerEndpoint.setGroupId(consumerGroupId); | ||
| kafkaListenerEndpoint.setAutoStartup(true); | ||
| kafkaListenerEndpoint.setTopics(topics.toArray(new String[topics.size()])); | ||
| kafkaListenerEndpoint.setMessageHandlerMethodFactory(new DefaultMessageHandlerMethodFactory()); | ||
| kafkaListenerEndpoint.setBean( | ||
| new MCLKafkaListener(systemOperationContext, consumerGroupId, hooks)); | ||
| try { | ||
| kafkaListenerEndpoint.setMethod( | ||
| MCLKafkaListener.class.getMethod("consume", ConsumerRecord.class)); | ||
| } catch (NoSuchMethodException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
|
|
||
| return kafkaListenerEndpoint; | ||
| } | ||
|
|
||
| private String buildConsumerGroupName(@Nonnull String suffix) { | ||
| if (suffix.isEmpty()) { | ||
| return consumerGroupBase; | ||
| } else { | ||
| return String.join("-", consumerGroupBase, suffix); | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Consider implementing manual offset commits.
The TODO comment suggests implementing manual offset commits after full processing. This can ensure that messages are only marked as processed after successful execution of all hooks, reducing the risk of message loss.
Would you like assistance in implementing manual offset commits?