umustafi commented on code in PR #3700: URL: https://github.com/apache/gobblin/pull/3700#discussion_r1227286463
########## gobblin-service/src/main/java/org/apache/gobblin/service/modules/orchestration/SchedulerLeaseAlgoHandler.java: ########## @@ -0,0 +1,179 @@ +/* + * 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.service.modules.orchestration; + +import java.io.IOException; +import java.sql.SQLException; +import java.time.LocalDateTime; +import java.time.ZoneId; +import java.time.format.DateTimeFormatter; +import java.time.temporal.ChronoUnit; +import java.util.Locale; +import java.util.Properties; +import java.util.Random; + +import org.quartz.JobKey; +import org.quartz.SchedulerException; +import org.quartz.Trigger; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.typesafe.config.Config; + +import javax.inject.Inject; + +import org.apache.gobblin.configuration.ConfigurationKeys; +import org.apache.gobblin.instrumented.Instrumented; +import org.apache.gobblin.metrics.ContextAwareMeter; +import org.apache.gobblin.metrics.MetricContext; +import org.apache.gobblin.runtime.api.DagActionStore; +import org.apache.gobblin.runtime.api.LeaseAttemptStatus; +import org.apache.gobblin.runtime.api.MultiActiveLeaseArbiter; +import org.apache.gobblin.runtime.metrics.RuntimeMetrics; +import org.apache.gobblin.scheduler.JobScheduler; +import org.apache.gobblin.scheduler.SchedulerService; +import org.apache.gobblin.util.ConfigUtils; +import org.apache.gobblin.runtime.api.LeaseObtainedStatus; +import org.apache.gobblin.runtime.api.LeasedToAnotherStatus; + + +/** + * Handler used to coordinate multiple hosts with enabled schedulers to respond to flow action events. It uses the + * {@link org.apache.gobblin.runtime.api.MySQLMultiActiveLeaseArbiter} to determine a single lease owner at a given time + * for a flow action event. After acquiring the lease, it persists the flow action event to the {@link DagActionStore} + * to be eventually acted upon by the host with the active DagManager. Once it has completed this action, it will mark + * the lease as completed by calling the + * {@link org.apache.gobblin.runtime.api.MySQLMultiActiveLeaseArbiter.completeLeaseUse} method. Hosts that do not gain + * the lease for the event, instead schedule a reminder using the {@link SchedulerService} to check back in on the + * previous lease owner's completion status after the lease should expire to ensure the event is handled in failure + * cases. + */ +public class SchedulerLeaseAlgoHandler { + private static final Logger LOG = LoggerFactory.getLogger(SchedulerLeaseAlgoHandler.class); + private final int staggerUpperBoundSec; + private static Random random = new Random(); + protected MultiActiveLeaseArbiter multiActiveLeaseArbiter; + protected JobScheduler jobScheduler; + protected SchedulerService schedulerService; + protected DagActionStore dagActionStore; + private MetricContext metricContext; + private ContextAwareMeter numLeasesCompleted; + @Inject + public SchedulerLeaseAlgoHandler(Config config, MultiActiveLeaseArbiter leaseDeterminationStore, + JobScheduler jobScheduler, SchedulerService schedulerService, DagActionStore dagActionStore) { + this.staggerUpperBoundSec = ConfigUtils.getInt(config, + ConfigurationKeys.SCHEDULER_STAGGERING_UPPER_BOUND_SEC_KEY, + ConfigurationKeys.DEFAULT_SCHEDULER_STAGGERING_UPPER_BOUND_SEC); + this.multiActiveLeaseArbiter = leaseDeterminationStore; + this.jobScheduler = jobScheduler; + this.schedulerService = schedulerService; + this.dagActionStore = dagActionStore; + this.metricContext = Instrumented.getMetricContext(new org.apache.gobblin.configuration.State(ConfigUtils.configToProperties(config)), + this.getClass()); + this.numLeasesCompleted = metricContext.contextAwareMeter(RuntimeMetrics.GOBBLIN_SCHEDULER_LEASE_ALGO_HANDLER_NUM_LEASES_COMPLETED); + } + + /** + * This method is used in the multi-active scheduler case for one or more hosts to respond to a flow action event + * by attempting a lease for the flow event and processing the result depending on the status of the attempt. + * @param jobProps + * @param flowAction + * @param eventTimeMillis + * @throws IOException + */ + public void handleNewSchedulerEvent(Properties jobProps, DagActionStore.DagAction flowAction, long eventTimeMillis) + throws IOException { + LeaseAttemptStatus leaseAttemptStatus = + multiActiveLeaseArbiter.tryAcquireLease(flowAction, eventTimeMillis); + // TODO: add a log event or metric for each of these cases + switch (leaseAttemptStatus.getClass().getSimpleName()) { + case "LeaseObtainedStatus": + finalizeLease((LeaseObtainedStatus) leaseAttemptStatus, flowAction); + break; + case "LeasedToAnotherStatus": + scheduleReminderForEvent(jobProps, (LeasedToAnotherStatus) leaseAttemptStatus, flowAction, eventTimeMillis); + break; + case "NoLongerLeasingStatus": + break; + default: + } + } + + // Called after obtaining a lease to persist the flow action to {@link DagActionStore} and mark the lease as done + private boolean finalizeLease(LeaseObtainedStatus status, DagActionStore.DagAction flowAction) { Review Comment: this could be a variety of actions including launch, retry, trigger, etc... which is hard to encapsulate with launchFlow. I changed to `persistFlowAction` -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
