spark/storage/TimeTrackingOutputStream.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.storage;
0019
0020 import java.io.IOException;
0021 import java.io.OutputStream;
0022
0023 import org.apache.spark.annotation.Private;
0024 import org.apache.spark.shuffle.ShuffleWriteMetricsReporter;
0025
0026 /**
0027  * Intercepts write calls and tracks total time spent writing in order to update shuffle write
0028  * metrics. Not thread safe.
0029  */
0030 @Private
0031 public final class TimeTrackingOutputStream extends OutputStream {
0032
0033   private final ShuffleWriteMetricsReporter writeMetrics;
0034   private final OutputStream outputStream;
0035
0036   public TimeTrackingOutputStream(
0037       ShuffleWriteMetricsReporter writeMetrics, OutputStream outputStream) {
0038     this.writeMetrics = writeMetrics;
0039     this.outputStream = outputStream;
0040   }
0041
0042   @Override
0043   public void write(int b) throws IOException {
0044     final long startTime = System.nanoTime();
0045     outputStream.write(b);
0046     writeMetrics.incWriteTime(System.nanoTime() - startTime);
0047   }
0048
0049   @Override
0050   public void write(byte[] b) throws IOException {
0051     final long startTime = System.nanoTime();
0052     outputStream.write(b);
0053     writeMetrics.incWriteTime(System.nanoTime() - startTime);
0054   }
0055
0056   @Override
0057   public void write(byte[] b, int off, int len) throws IOException {
0058     final long startTime = System.nanoTime();
0059     outputStream.write(b, off, len);
0060     writeMetrics.incWriteTime(System.nanoTime() - startTime);
0061   }
0062
0063   @Override
0064   public void flush() throws IOException {
0065     final long startTime = System.nanoTime();
0066     outputStream.flush();
0067     writeMetrics.incWriteTime(System.nanoTime() - startTime);
0068   }
0069
0070   @Override
0071   public void close() throws IOException {
0072     final long startTime = System.nanoTime();
0073     outputStream.close();
0074     writeMetrics.incWriteTime(System.nanoTime() - startTime);
0075   }
0076 }