sv2000 commented on a change in pull request #3002: URL: https://github.com/apache/incubator-gobblin/pull/3002#discussion_r432729668
########## File path: gobblin-modules/gobblin-kafka-common/src/main/java/org/apache/gobblin/source/extractor/extract/kafka/KafkaIngestionHealthCheck.java ########## @@ -0,0 +1,164 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.gobblin.source.extractor.extract.kafka; + +import java.io.IOException; +import java.util.concurrent.TimeUnit; + +import com.google.common.collect.EvictingQueue; +import com.google.common.eventbus.EventBus; +import com.typesafe.config.Config; + +import lombok.extern.slf4j.Slf4j; + +import org.apache.gobblin.annotation.Alias; +import org.apache.gobblin.broker.SharedResourcesBrokerFactory; +import org.apache.gobblin.commit.CommitStep; +import org.apache.gobblin.util.ConfigUtils; +import org.apache.gobblin.util.event.ContainerHealthCheckFailureEvent; +import org.apache.gobblin.util.eventbus.EventBusFactory; + + +@Slf4j +@Alias(value = "KafkaIngestionHealthCheck") +public class KafkaIngestionHealthCheck implements CommitStep { + public static final String KAFKA_INGESTION_HEALTH_CHECK_PREFIX = "gobblin.kafka.healthCheck."; + public static final String KAFKA_INGESTION_HEALTH_CHECK_SLIDING_WINDOW_SIZE_KEY = KAFKA_INGESTION_HEALTH_CHECK_PREFIX + "slidingWindow.size"; + public static final String KAFKA_INGESTION_HEALTH_CHECK_LATENCY_THRESHOLD_MINUTES_KEY = KAFKA_INGESTION_HEALTH_CHECK_PREFIX + "ingestionLatency.minutes"; + public static final String KAFKA_INGESTION_HEALTH_CHECK_CONSUMPTION_RATE_DROPOFF_FRACTION_KEY = KAFKA_INGESTION_HEALTH_CHECK_PREFIX + "consumptionRate.dropOffFraction"; + public static final String KAFKA_INGESTION_HEALTH_CHECK_EXPECTED_CONSUMPTION_RATE_MBPS_KEY = KAFKA_INGESTION_HEALTH_CHECK_PREFIX + "expected.consumptionRateMbps"; + + public static final int DEFAULT_KAFKA_INGESTION_HEALTH_CHECK_SLIDING_WINDOW_SIZE = 3; + public static final long DEFAULT_KAFKA_INGESTION_HEALTH_CHECK_LATENCY_THRESHOLD_MINUTES= 15; + public static final double DEFAULT_KAFKA_INGESTION_HEALTH_CHECK_CONSUMPTION_RATE_DROPOFF_FRACTION = 0.7; + public static final double DEFAULT_KAFKA_INGESTION_HEALTH_CHECK_EXPECTED_CONSUMPTION_RATE_MBPS = 10.0; + + private final Config config; + private final EventBus eventBus; + private final KafkaExtractorStatsTracker statsTracker; + private final double expectedConsumptionRate; + private final double consumptionRateDropOffFraction; + private final long ingestionLatencyThresholdMinutes; + private final int slidingWindowSize; + private final EvictingQueue<Long> ingestionLatencies; + private final EvictingQueue<Double> consumptionRateMBps; + + public KafkaIngestionHealthCheck(Config config, KafkaExtractorStatsTracker statsTracker) { + this.config = config; + this.slidingWindowSize = ConfigUtils.getInt(config, KAFKA_INGESTION_HEALTH_CHECK_SLIDING_WINDOW_SIZE_KEY, DEFAULT_KAFKA_INGESTION_HEALTH_CHECK_SLIDING_WINDOW_SIZE); + this.ingestionLatencyThresholdMinutes = ConfigUtils.getLong(config, KAFKA_INGESTION_HEALTH_CHECK_LATENCY_THRESHOLD_MINUTES_KEY, DEFAULT_KAFKA_INGESTION_HEALTH_CHECK_LATENCY_THRESHOLD_MINUTES); + this.consumptionRateDropOffFraction = ConfigUtils.getDouble(config, KAFKA_INGESTION_HEALTH_CHECK_CONSUMPTION_RATE_DROPOFF_FRACTION_KEY, DEFAULT_KAFKA_INGESTION_HEALTH_CHECK_CONSUMPTION_RATE_DROPOFF_FRACTION); + this.expectedConsumptionRate = ConfigUtils.getDouble(config, KAFKA_INGESTION_HEALTH_CHECK_EXPECTED_CONSUMPTION_RATE_MBPS_KEY, DEFAULT_KAFKA_INGESTION_HEALTH_CHECK_EXPECTED_CONSUMPTION_RATE_MBPS); + this.ingestionLatencies = EvictingQueue.create(this.slidingWindowSize); + this.consumptionRateMBps = EvictingQueue.create(this.slidingWindowSize); + EventBus eventBus; + try { + eventBus = EventBusFactory.get(ContainerHealthCheckFailureEvent.CONTAINER_HEALTH_CHECK_EVENT_BUS_NAME, + SharedResourcesBrokerFactory.getImplicitBroker()); + } catch (IOException e) { + log.error("Could not find EventBus instance for container health check", e); + eventBus = null; + } + this.eventBus = eventBus; + this.statsTracker = statsTracker; + } + + /** + * + * @return true if ingestionLatency in the each of the recent epochs exceeds the threshold latency and the latency + * is increasing over these epochs. + */ + private boolean checkIngestionLatency() { + Long previousLatency = -1L; + for (Long ingestionLatency: ingestionLatencies) { + if (ingestionLatency < this.ingestionLatencyThresholdMinutes || previousLatency > ingestionLatency) { + return false; + } else { + previousLatency = ingestionLatency; + } + } + return true; + } + + /** + * Determine whether the commit step has been completed. + */ + @Override + public boolean isCompleted() Review comment: Set it to false both here and inside HelixParticipantCheck. In general, the isCompleted() check is not useful for streaming use cases, where a CommitStep is going to be called multiple times. Further, even for non-streaming use cases, the isCompeted() check is useful only if there is a side-effect due to a partial execution of a CommitStep (e.g. renaming a subset of files from a file list). ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
