phoenix-core/src/main/java/org/apache/phoenix/monitoring/MemoryMetricsHolder.java

/*
 * 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.phoenix.monitoring;

import static org.apache.phoenix.monitoring.MetricType.MEMORY_CHUNK_BYTES;
import static org.apache.phoenix.monitoring.MetricType.MEMORY_WAIT_TIME;

/**
 * Class that encapsulates the metrics regarding memory resources needed for servicing a request.
 */
public class MemoryMetricsHolder {
    private final CombinableMetric memoryChunkSizeMetric;
    private final CombinableMetric memoryWaitTimeMetric;
    public static final MemoryMetricsHolder NO_OP_INSTANCE = new MemoryMetricsHolder(new ReadMetricQueue(false), null);
    
    public MemoryMetricsHolder(ReadMetricQueue readMetrics, String tableName) {
        this.memoryChunkSizeMetric = readMetrics.allotMetric(MEMORY_CHUNK_BYTES, tableName);
        this.memoryWaitTimeMetric = readMetrics.allotMetric(MEMORY_WAIT_TIME, tableName);
    }

    public CombinableMetric getMemoryChunkSizeMetric() {
        return memoryChunkSizeMetric;
    }

    public CombinableMetric getMemoryWaitTimeMetric() {
        return memoryWaitTimeMetric;
    }
}