mccheah commented on a change in pull request #25007: [SPARK-28209][CORE][SHUFFLE] Proposed new shuffle writer API URL: https://github.com/apache/spark/pull/25007#discussion_r307026088
########## File path: core/src/main/java/org/apache/spark/shuffle/api/ShuffleWriteSupport.java ########## @@ -0,0 +1,57 @@ +/* + * 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.spark.shuffle.api; + +import java.io.IOException; + +import org.apache.spark.annotation.Private; +import org.apache.spark.shuffle.ShuffleWriteMetricsReporter; + +/** + * :: Private :: + * A module that returns shuffle writers to persist data that is written by shuffle map tasks. + * + * @since 3.0.0 + */ +@Private +public interface ShuffleWriteSupport { + + /** + * Called once per map task to create a writer that will be responsible for persisting all the + * partitioned bytes written by that map task. + * + * @param shuffleId Unique identifier for the shuffle stage of the map task + * @param mapId Within the shuffle stage, the identifier of the map task + * @param mapTaskAttemptId Identifier of the task attempt. Multiple attempts of the same map task + * with the same (shuffleId, mapId) pair can be distinguished by the + * different values of mapTaskAttemptId. + * @param numPartitions The number of partitions that will be written by the map task. Some of + * these partitions may be empty. + * @param mapTaskWriteMetrics The map task's write metrics, which can be updated by the returned + * writer. The updates that are posted to this reporter are listed in + * the Spark UI. Note that the caller will update the total write time + * at the end of the map task, so implementations should not call + * {@link ShuffleWriteMetricsReporter#incWriteTime(long)}. + */ + ShuffleMapOutputWriter createMapOutputWriter( + int shuffleId, + int mapId, + long mapTaskAttemptId, + int numPartitions, + ShuffleWriteMetricsReporter mapTaskWriteMetrics) throws IOException; Review comment: This is in response to this thread: https://github.com/apache/spark/pull/25007#discussion_r304943320. I'd much rather not have this be part of the API and would rather have implementations call `TaskContext.get()` to get the metrics reporter for the task. ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
