phet commented on code in PR #3890: URL: https://github.com/apache/gobblin/pull/3890#discussion_r1525748746
########## gobblin-service/src/main/java/org/apache/gobblin/service/modules/orchestration/InstrumentedLeaseArbiter.java: ########## @@ -0,0 +1,104 @@ +/* + * 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 com.typesafe.config.Config; + +import lombok.Getter; +import lombok.extern.slf4j.Slf4j; + +import org.apache.gobblin.instrumented.Instrumented; +import org.apache.gobblin.metrics.ContextAwareCounter; +import org.apache.gobblin.metrics.ContextAwareMeter; +import org.apache.gobblin.metrics.MetricContext; +import org.apache.gobblin.metrics.ServiceMetricNames; +import org.apache.gobblin.runtime.api.DagActionStore; +import org.apache.gobblin.runtime.api.MultiActiveLeaseArbiter; +import org.apache.gobblin.util.ConfigUtils; + + +/* + A generic lease arbitration decorator built upon the {@link MultiActiveLeaseArbiter} which encapsulates common + functionality desired by lease arbiter users to track metrics on all lease attempts made by the arbiter. The metrics + can be used to compare relative performance among arbitration participants. + */ +@Slf4j +public class InstrumentedLeaseArbiter implements MultiActiveLeaseArbiter { + protected MultiActiveLeaseArbiter decoratedMultiActiveLeaseArbiter; + @Getter + protected MetricContext metricContext; + private ContextAwareCounter leaseObtainedCount; + + private ContextAwareCounter leasedToAnotherStatusCount; + + private ContextAwareCounter noLongerLeasingStatusCount; + private ContextAwareMeter leasesObtainedDueToReminderCount; + + public InstrumentedLeaseArbiter(Config config, MultiActiveLeaseArbiter leaseDeterminationStore, + String metricsPrefix) { + this.decoratedMultiActiveLeaseArbiter = leaseDeterminationStore; + this.metricContext = Instrumented.getMetricContext(new org.apache.gobblin.configuration.State(ConfigUtils.configToProperties(config)), + this.getClass()); + initializeMetrics(metricsPrefix); + } + + private void initializeMetrics(String metricsPrefix) { + // If a valid metrics prefix is provided then add a delimiter after it + if (!metricsPrefix.equals("")) { + metricsPrefix += "."; + } + this.leaseObtainedCount = this.metricContext.contextAwareCounter(metricsPrefix + ServiceMetricNames.FLOW_TRIGGER_HANDLER_LEASE_OBTAINED_COUNT); + this.leasedToAnotherStatusCount = this.metricContext.contextAwareCounter(metricsPrefix + ServiceMetricNames.FLOW_TRIGGER_HANDLER_LEASED_TO_ANOTHER_COUNT); + this.noLongerLeasingStatusCount = this.metricContext.contextAwareCounter(metricsPrefix + ServiceMetricNames.FLOW_TRIGGER_HANDLER_NO_LONGER_LEASING_COUNT); + this.leasesObtainedDueToReminderCount = this.metricContext.contextAwareMeter(metricsPrefix + ServiceMetricNames.FLOW_TRIGGER_HANDLER_LEASES_OBTAINED_DUE_TO_REMINDER_COUNT); + } + + @Override + public MultiActiveLeaseArbiter.LeaseAttemptStatus tryAcquireLease(DagActionStore.DagAction flowAction, long eventTimeMillis, + boolean isReminderEvent, boolean skipFlowExecutionIdReplacement) throws IOException { + + MultiActiveLeaseArbiter.LeaseAttemptStatus leaseAttemptStatus = + decoratedMultiActiveLeaseArbiter.tryAcquireLease(flowAction, eventTimeMillis, isReminderEvent, + skipFlowExecutionIdReplacement); + log.info("Multi-active scheduler lease attempt for dagAction: {} received type of leaseAttemptStatus: [{}, " + + "eventTimestamp: {}] ", flowAction, leaseAttemptStatus.getClass().getName(), eventTimeMillis); + if (leaseAttemptStatus instanceof MultiActiveLeaseArbiter.LeaseObtainedStatus) { + if (isReminderEvent) { + this.leasesObtainedDueToReminderCount.mark(); + } + this.leaseObtainedCount.inc(); + return leaseAttemptStatus; + } else if (leaseAttemptStatus instanceof MultiActiveLeaseArbiter.LeasedToAnotherStatus) { + this.leasedToAnotherStatusCount.inc(); + return leaseAttemptStatus; + } else if (leaseAttemptStatus instanceof MultiActiveLeaseArbiter.NoLongerLeasingStatus) { + this.noLongerLeasingStatusCount.inc(); + return leaseAttemptStatus; + } + throw new RuntimeException(String.format("Received type of leaseAttemptStatus: %s not handled by this method", + leaseAttemptStatus.getClass().getName())); + } + + @Override + public boolean recordLeaseSuccess(LeaseObtainedStatus status) + throws IOException { + return this.decoratedMultiActiveLeaseArbiter.recordLeaseSuccess(status); Review Comment: shall we measure how many times true vs false? -- 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]
