com.google.cloud.hadoop.fs.gcs.GhfsStorageStatistics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gcs-connector Show documentation

An implementation of org.apache.hadoop.fs.FileSystem targeting Google Cloud Storage

There is a newer version: 3.1.3

/*
 * Copyright 2021 Google LLC
 *
 * Licensed 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 com.google.cloud.hadoop.fs.gcs;

import java.util.Map;
import org.apache.hadoop.fs.statistics.IOStatistics;
import org.apache.hadoop.fs.statistics.MeanStatistic;
import org.apache.hadoop.fs.statistics.StoreStatisticNames;
import org.apache.hadoop.fs.statistics.impl.StorageStatisticsFromIOStatistics;

/** Storage statistics for GCS, dynamically generated from the IOStatistics. */
public class GhfsStorageStatistics extends StorageStatisticsFromIOStatistics {

  /** {@value} The key that stores all the registered metrics */
  public static final String NAME = "GhfsFileSystemBasedStorageStatistics";

  /** Exention for minimum */
  private static final String MINIMUM = StoreStatisticNames.SUFFIX_MIN;
  /** Exention for maximum */
  private static final String MAXIMUM = StoreStatisticNames.SUFFIX_MAX;
  /** Exention for mean */
  private static final String MEAN = StoreStatisticNames.SUFFIX_MEAN;

  /** IOStatistics Instance */
  private final IOStatistics ioStatistics;

  /** Create the Storage Statistics instance from the IOStatistics */
  public GhfsStorageStatistics(IOStatistics ioStatistics) {
    super(NAME, "Ghfs", ioStatistics);
    this.ioStatistics = ioStatistics;
  }

  /**
   * To get the minimum value which is stored with MINIMUM extension
   *
   * @param symbol
   * @return minimum statistic value
   */
  public Long getMin(String symbol) {
    return minimums().get(symbol + MINIMUM);
  }

  /**
   * To get the maximum value which is stored with MAXIMUM extension
   *
   * @param symbol
   * @return maximum statistic value
   */
  public Long getMax(String symbol) {
    return maximums().get(symbol + MAXIMUM);
  }

  /**
   * To get the mean value which is stored with MEAN extension
   *
   * @param symbol
   * @return mean statistic value
   */
  public double getMean(String symbol) {
    return meanStatistics().get(symbol + MEAN).mean();
  }

  /**
   * Map of minimums
   *
   * @return current map of minimums
   */
  private Map minimums() {
    return ioStatistics.minimums();
  }

  /**
   * Map of maximums
   *
   * @return current map of maximums
   */
  private Map maximums() {
    return ioStatistics.maximums();
  }

  /**
   * Map of meanStatistics
   *
   * @return current map of MeanStatistic statistics
   */
  private Map meanStatistics() {
    return ioStatistics.meanStatistics();
  }
}