[
https://issues.apache.org/jira/browse/GOBBLIN-1704?focusedWorklogId=810911&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-810911
]
ASF GitHub Bot logged work on GOBBLIN-1704:
-------------------------------------------
Author: ASF GitHub Bot
Created on: 21/Sep/22 17:51
Start Date: 21/Sep/22 17:51
Worklog Time Spent: 10m
Work Description: umustafi commented on code in PR #3561:
URL: https://github.com/apache/gobblin/pull/3561#discussion_r976824839
##########
gobblin-yarn/src/main/java/org/apache/gobblin/yarn/HelixInstancePurgerWithMetrics.java:
##########
@@ -0,0 +1,140 @@
+/*
+ * 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.yarn;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Stopwatch;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.gobblin.metrics.event.EventSubmitter;
+import org.apache.gobblin.metrics.event.GobblinEventBuilder;
+import org.apache.helix.HelixAdmin;
+
+
+@Slf4j
+@AllArgsConstructor
+public class HelixInstancePurgerWithMetrics {
+ private final EventSubmitter eventSubmitter;
+ private final long pollingRateMs;
+ private static final String PREFIX = "HelixOfflineInstancePurge.";
+ public static final String PURGE_FAILURE_EVENT = PREFIX + "Failure";
+ public static final String PURGE_LAGGING_EVENT = PREFIX + "Lagging";
+ public static final String PURGE_COMPLETED_EVENT = PREFIX + "Completed";
+
+
+ /**
+ * Blocking call for purging all offline helix instances. Provides boiler
plate code for providing periodic updates
+ * and sending a GTE if it's an unexpected amount of time.
+ *
+ * All previous helix instances should be purged on startup. Gobblin task
runners are stateless from helix
+ * perspective because all important state is persisted separately in
Workunit State Store or Watermark store.
+ */
+ public void purgeAllOfflineInstances(HelixAdmin admin, String clusterName,
long laggingThresholdMs, Map<String, String> gteMetadata) {
+ CompletableFuture<Void> purgeTask = CompletableFuture.supplyAsync(() -> {
+ long offlineDuration = 0; // 0 means all offline instance should be
purged.
+ admin.purgeOfflineInstances(clusterName, offlineDuration);
+ return null;
+ });
+
+ long timeToPurgeMs = waitForPurgeCompletion(purgeTask, laggingThresholdMs,
Stopwatch.createUnstarted(), gteMetadata);
+ log.info("Finished purging offline helix instances. It took
timeToPurgeMs={}", timeToPurgeMs);
+ }
+
+ @VisibleForTesting
+ long waitForPurgeCompletion(CompletableFuture<Void> purgeTask, long
laggingThresholdMs, Stopwatch watch,
+ Map<String, String> gteMetadata) {
+ watch.start();
+ try {
+ boolean haveSubmittedLaggingEvent = false; //
+ while (!purgeTask.isDone()) {
+ long elapsedTimeMs = watch.elapsed(TimeUnit.MILLISECONDS);
+ log.info("Waiting for helix to purge offline instances. Cannot proceed
with execution because purging is a "
Review Comment:
very helpful log message here!
##########
gobblin-yarn/src/main/java/org/apache/gobblin/yarn/HelixInstancePurgerWithMetrics.java:
##########
@@ -0,0 +1,140 @@
+/*
+ * 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.yarn;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Stopwatch;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.gobblin.metrics.event.EventSubmitter;
+import org.apache.gobblin.metrics.event.GobblinEventBuilder;
+import org.apache.helix.HelixAdmin;
+
+
+@Slf4j
+@AllArgsConstructor
+public class HelixInstancePurgerWithMetrics {
+ private final EventSubmitter eventSubmitter;
+ private final long pollingRateMs;
+ private static final String PREFIX = "HelixOfflineInstancePurge.";
+ public static final String PURGE_FAILURE_EVENT = PREFIX + "Failure";
+ public static final String PURGE_LAGGING_EVENT = PREFIX + "Lagging";
+ public static final String PURGE_COMPLETED_EVENT = PREFIX + "Completed";
+
+
+ /**
+ * Blocking call for purging all offline helix instances. Provides boiler
plate code for providing periodic updates
+ * and sending a GTE if it's an unexpected amount of time.
+ *
+ * All previous helix instances should be purged on startup. Gobblin task
runners are stateless from helix
+ * perspective because all important state is persisted separately in
Workunit State Store or Watermark store.
+ */
+ public void purgeAllOfflineInstances(HelixAdmin admin, String clusterName,
long laggingThresholdMs, Map<String, String> gteMetadata) {
+ CompletableFuture<Void> purgeTask = CompletableFuture.supplyAsync(() -> {
+ long offlineDuration = 0; // 0 means all offline instance should be
purged.
+ admin.purgeOfflineInstances(clusterName, offlineDuration);
+ return null;
+ });
+
+ long timeToPurgeMs = waitForPurgeCompletion(purgeTask, laggingThresholdMs,
Stopwatch.createUnstarted(), gteMetadata);
+ log.info("Finished purging offline helix instances. It took
timeToPurgeMs={}", timeToPurgeMs);
+ }
+
+ @VisibleForTesting
+ long waitForPurgeCompletion(CompletableFuture<Void> purgeTask, long
laggingThresholdMs, Stopwatch watch,
+ Map<String, String> gteMetadata) {
+ watch.start();
+ try {
+ boolean haveSubmittedLaggingEvent = false; //
+ while (!purgeTask.isDone()) {
+ long elapsedTimeMs = watch.elapsed(TimeUnit.MILLISECONDS);
+ log.info("Waiting for helix to purge offline instances. Cannot proceed
with execution because purging is a "
+ + "non-thread safe call. To disable purging offline instances
during startup, change the flag {} "
+ + "elapsedTimeMs={}, laggingThresholdMs={}",
+
GobblinYarnConfigurationKeys.HELIX_PURGE_OFFLINE_INSTANCES_ENABLED,
elapsedTimeMs, laggingThresholdMs);
+ if (!haveSubmittedLaggingEvent && elapsedTimeMs > laggingThresholdMs) {
+ submitLaggingEvent(elapsedTimeMs, laggingThresholdMs, gteMetadata);
+ haveSubmittedLaggingEvent = true;
+ }
+ Thread.sleep(this.pollingRateMs);
+ }
+
+ long timeToPurgeMs = watch.elapsed(TimeUnit.MILLISECONDS);
+ if (!haveSubmittedLaggingEvent && timeToPurgeMs > laggingThresholdMs) {
+ submitLaggingEvent(timeToPurgeMs, laggingThresholdMs, gteMetadata);
+ }
+
+ purgeTask.get(); // check for exceptions
+ submitCompletedEvent(timeToPurgeMs, gteMetadata);
+ return timeToPurgeMs;
+ } catch (ExecutionException | InterruptedException e) {
+ log.info("The call to purge offline helix instances failed. This is not
a fatal error because it is not mandatory to "
Review Comment:
nitpick can we make this a WARN type so it catches our attention more
##########
gobblin-yarn/src/main/java/org/apache/gobblin/yarn/HelixInstancePurgerWithMetrics.java:
##########
@@ -0,0 +1,140 @@
+/*
+ * 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.yarn;
+
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Stopwatch;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.gobblin.metrics.event.EventSubmitter;
+import org.apache.gobblin.metrics.event.GobblinEventBuilder;
+import org.apache.helix.HelixAdmin;
+
+
+@Slf4j
+@AllArgsConstructor
+public class HelixInstancePurgerWithMetrics {
+ private final EventSubmitter eventSubmitter;
+ private final long pollingRateMs;
+ private static final String PREFIX = "HelixOfflineInstancePurge.";
+ public static final String PURGE_FAILURE_EVENT = PREFIX + "Failure";
+ public static final String PURGE_LAGGING_EVENT = PREFIX + "Lagging";
+ public static final String PURGE_COMPLETED_EVENT = PREFIX + "Completed";
+
+
+ /**
+ * Blocking call for purging all offline helix instances. Provides boiler
plate code for providing periodic updates
+ * and sending a GTE if it's an unexpected amount of time.
+ *
+ * All previous helix instances should be purged on startup. Gobblin task
runners are stateless from helix
+ * perspective because all important state is persisted separately in
Workunit State Store or Watermark store.
+ */
+ public void purgeAllOfflineInstances(HelixAdmin admin, String clusterName,
long laggingThresholdMs, Map<String, String> gteMetadata) {
+ CompletableFuture<Void> purgeTask = CompletableFuture.supplyAsync(() -> {
+ long offlineDuration = 0; // 0 means all offline instance should be
purged.
+ admin.purgeOfflineInstances(clusterName, offlineDuration);
+ return null;
+ });
+
+ long timeToPurgeMs = waitForPurgeCompletion(purgeTask, laggingThresholdMs,
Stopwatch.createUnstarted(), gteMetadata);
+ log.info("Finished purging offline helix instances. It took
timeToPurgeMs={}", timeToPurgeMs);
+ }
+
+ @VisibleForTesting
+ long waitForPurgeCompletion(CompletableFuture<Void> purgeTask, long
laggingThresholdMs, Stopwatch watch,
+ Map<String, String> gteMetadata) {
+ watch.start();
+ try {
+ boolean haveSubmittedLaggingEvent = false; //
+ while (!purgeTask.isDone()) {
+ long elapsedTimeMs = watch.elapsed(TimeUnit.MILLISECONDS);
+ log.info("Waiting for helix to purge offline instances. Cannot proceed
with execution because purging is a "
+ + "non-thread safe call. To disable purging offline instances
during startup, change the flag {} "
+ + "elapsedTimeMs={}, laggingThresholdMs={}",
+
GobblinYarnConfigurationKeys.HELIX_PURGE_OFFLINE_INSTANCES_ENABLED,
elapsedTimeMs, laggingThresholdMs);
+ if (!haveSubmittedLaggingEvent && elapsedTimeMs > laggingThresholdMs) {
+ submitLaggingEvent(elapsedTimeMs, laggingThresholdMs, gteMetadata);
+ haveSubmittedLaggingEvent = true;
+ }
+ Thread.sleep(this.pollingRateMs);
+ }
+
+ long timeToPurgeMs = watch.elapsed(TimeUnit.MILLISECONDS);
+ if (!haveSubmittedLaggingEvent && timeToPurgeMs > laggingThresholdMs) {
+ submitLaggingEvent(timeToPurgeMs, laggingThresholdMs, gteMetadata);
+ }
+
+ purgeTask.get(); // check for exceptions
+ submitCompletedEvent(timeToPurgeMs, gteMetadata);
+ return timeToPurgeMs;
+ } catch (ExecutionException | InterruptedException e) {
+ log.info("The call to purge offline helix instances failed. This is not
a fatal error because it is not mandatory to "
+ + "clean up old helix instances. But repeated failure to purge
offline helix instances will cause an accumulation"
+ + "of offline helix instances which may cause large delays in future
helix calls.", e);
+ long timeToPurgeMs = watch.elapsed(TimeUnit.MILLISECONDS);
+ submitFailureEvent(timeToPurgeMs, gteMetadata);
+ return timeToPurgeMs;
+ }
+ }
+
+ private void submitFailureEvent(long elapsedTimeMs, Map<String, String>
additionalMetadata) {
+ if (eventSubmitter != null) {
+ GobblinEventBuilder eventBuilder = new
GobblinEventBuilder(PURGE_FAILURE_EVENT);
+ eventBuilder.addAdditionalMetadata(additionalMetadata);
+ eventBuilder.addMetadata("elapsedTimeMs", String.valueOf(elapsedTimeMs));
+
+ log.info("Submitting GTE because purging offline instances has failed to
complete. event={}", eventBuilder);
+ eventSubmitter.submit(eventBuilder);
+ } else {
+ log.info("Cannot submit {} GTE because eventSubmitter is null",
PURGE_FAILURE_EVENT);
+ }
+ }
+
+ private void submitCompletedEvent(long timeToPurgeMs, Map<String, String>
additionalMetadata) {
+ if (eventSubmitter != null) {
+ GobblinEventBuilder eventBuilder = new
GobblinEventBuilder(PURGE_COMPLETED_EVENT);
+ eventBuilder.addAdditionalMetadata(additionalMetadata);
+ eventBuilder.addMetadata("timeToPurgeMs", String.valueOf(timeToPurgeMs));
+
+ log.info("Submitting GTE because purging offline instances has completed
successfully. event={}", eventBuilder);
+ eventSubmitter.submit(eventBuilder);
+ } else {
+ log.info("Cannot submit {} GTE because eventSubmitter is null",
PURGE_COMPLETED_EVENT);
+ }
+ }
+
+ private void submitLaggingEvent(long elapsedTimeMs, long laggingThresholdMs,
Review Comment:
how do we track these events? are they processed somewhere or do we have any
automatic monitoring? or will we query them when there's an issue we're
noticing with helix?
Issue Time Tracking
-------------------
Worklog Id: (was: 810911)
Time Spent: 2h (was: 1h 50m)
> Purge offline helix instances during startup
> --------------------------------------------
>
> Key: GOBBLIN-1704
> URL: https://issues.apache.org/jira/browse/GOBBLIN-1704
> Project: Apache Gobblin
> Issue Type: New Feature
> Reporter: Matthew Ho
> Priority: Major
> Time Spent: 2h
> Remaining Estimate: 0h
>
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
