majin1102 commented on code in PR #4045: URL: https://github.com/apache/amoro/pull/4045#discussion_r2745017717
########## amoro-common/src/main/java/org/apache/amoro/maintainer/MaintainerOperationTemplate.java: ########## @@ -0,0 +1,151 @@ +/* + * 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.amoro.maintainer; + +/** + * Template for executing maintainer operations with consistent metrics recording. + * + * <p>This template ensures that all maintainer operations record metrics in a consistent way: + * + * <ul> + * <li>Record operation start + * <li>Execute the operation + * <li>Record operation success/failure with duration + * </ul> + * + * <p>Usage example: + * + * <pre>{@code + * MaintainerOperationTemplate template = new MaintainerOperationTemplate(metrics); + * template.execute( + * MaintainerOperationType.ORPHAN_FILES_CLEANING, + * () -> { + * // Operation logic here + * cleanOrphanFiles(); + * } + * ); + * }</pre> + */ +public class MaintainerOperationTemplate { + + private final MaintainerMetrics metrics; + + /** + * Creates a new operation template with the given metrics collector. + * + * @param metrics the metrics collector (can be null, will use NOOP in that case) + */ + public MaintainerOperationTemplate(MaintainerMetrics metrics) { + this.metrics = metrics != null ? metrics : MaintainerMetrics.NOOP; + } + + /** + * Executes a maintainer operation with metrics recording. + * + * <p>This method will: + * + * <ol> + * <li>Record the operation start via {@link MaintainerMetrics#recordOperationStart} + * <li>Execute the provided operation + * <li>On success: record operation success via {@link MaintainerMetrics#recordOperationSuccess} + * <li>On failure: record operation failure via {@link MaintainerMetrics#recordOperationFailure} + * and rethrow the exception + * </ol> + * + * @param operationType the type of operation being executed + * @param operation the operation to execute + * @return true if operation succeeded, false otherwise + * @throws Throwable if the operation throws an exception + */ + public boolean execute(MaintainerOperationType operationType, MaintainerOperation operation) + throws Throwable { + long startTime = System.currentTimeMillis(); + metrics.recordOperationStart(operationType); + + try { + operation.execute(); + long duration = System.currentTimeMillis() - startTime; + metrics.recordOperationSuccess(operationType, duration); + return true; + } catch (Throwable t) { + long duration = System.currentTimeMillis() - startTime; + metrics.recordOperationFailure(operationType, duration, t); + throw t; + } + } + + /** + * Executes a maintainer operation with metrics recording and return result. + * + * <p>This method will: + * + * <ol> + * <li>Record the operation start via {@link MaintainerMetrics#recordOperationStart} + * <li>Execute the provided operation + * <li>On success: record operation success via {@link MaintainerMetrics#recordOperationSuccess} + * <li>On failure: record operation failure via {@link MaintainerMetrics#recordOperationFailure} + * and rethrow the exception + * </ol> + * + * @param operationType the type of operation being executed + * @param operation the operation to execute + * @param <T> the result type + * @return the operation result + * @throws Throwable if the operation throws an exception + */ + public <T> T executeAndReturn( + MaintainerOperationType operationType, MaintainerOperationWithResult<T> operation) + throws Throwable { + long startTime = System.currentTimeMillis(); + metrics.recordOperationStart(operationType); + + try { + T result = operation.execute(); + long duration = System.currentTimeMillis() - startTime; + metrics.recordOperationSuccess(operationType, duration); + return result; + } catch (Throwable t) { + long duration = System.currentTimeMillis() - startTime; + metrics.recordOperationFailure(operationType, duration, t); + throw t; + } + } + + /** Functional interface for maintainer operation without return value. */ + @FunctionalInterface + public interface MaintainerOperation { + /** Executes the operation. */ + void execute() throws Throwable; + } + + /** + * Functional interface for maintainer operation with return value. + * + * @param <T> the result type + */ + @FunctionalInterface + public interface MaintainerOperationWithResult<T> { Review Comment: I think we could make this more reasonable. like MaintainerCallable<T> and MaintainerRunner -- 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]
