001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client;
019
020import java.io.IOException;
021import org.apache.hadoop.hbase.client.metrics.ScanMetrics;
022import org.apache.hadoop.hbase.trace.TraceUtil;
023
024/**
025 * A drop-in replacement for {@link BufferingScanResultConsumer} that adds tracing spans to its
026 * implementation of the {@link AdvancedScanResultConsumer} API.
027 */
028public class TracedAdvancedScanResultConsumer implements AdvancedScanResultConsumer {
029
030  private final BufferingScanResultConsumer delegate = new BufferingScanResultConsumer();
031
032  @Override
033  public void onScanMetricsCreated(ScanMetrics scanMetrics) {
034    TraceUtil.trace(() -> delegate.onScanMetricsCreated(scanMetrics),
035      "TracedAdvancedScanResultConsumer#onScanMetricsCreated");
036  }
037
038  @Override
039  public void onNext(Result[] results, ScanController controller) {
040    TraceUtil.trace(() -> delegate.onNext(results, controller),
041      "TracedAdvancedScanResultConsumer#onNext");
042  }
043
044  @Override
045  public void onError(Throwable error) {
046    TraceUtil.trace(() -> delegate.onError(error), "TracedAdvancedScanResultConsumer#onError");
047  }
048
049  @Override
050  public void onComplete() {
051    TraceUtil.trace(delegate::onComplete, "TracedAdvancedScanResultConsumer#onComplete");
052  }
053
054  public Result take() throws IOException, InterruptedException {
055    return delegate.take();
056  }
057
058  public ScanMetrics getScanMetrics() {
059    return delegate.getScanMetrics();
060  }
061}