hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-sharedcachemanager/src/main/java/org/apache/hadoop/yarn/server/sharedcachemanager/webapp/SCMMetricsInfo.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.hadoop.yarn.server.sharedcachemanager.webapp;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;

import org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.yarn.server.sharedcachemanager.metrics.CleanerMetrics;
import org.apache.hadoop.yarn.server.sharedcachemanager.metrics.ClientSCMMetrics;
import org.apache.hadoop.yarn.server.sharedcachemanager.metrics.SharedCacheUploaderMetrics;

/**
 * This class is used to summarize useful shared cache manager metrics for the
 * webUI display.
 */
@XmlRootElement(name = "SCMMetrics")
@XmlAccessorType(XmlAccessType.FIELD)
@Private
@Unstable
public class SCMMetricsInfo {
  protected long totalDeletedFiles;
  protected long totalProcessedFiles;
  protected long cacheHits;
  protected long cacheMisses;
  protected long cacheReleases;
  protected long acceptedUploads;
  protected long rejectedUploads;

  public SCMMetricsInfo() {
  }
  
  public SCMMetricsInfo(CleanerMetrics cleanerMetrics,
      ClientSCMMetrics clientSCMMetrics,
      SharedCacheUploaderMetrics scmUploaderMetrics) {
    totalDeletedFiles = cleanerMetrics.getTotalDeletedFiles();
    totalProcessedFiles = cleanerMetrics.getTotalProcessedFiles();
    cacheHits = clientSCMMetrics.getCacheHits();
    cacheMisses = clientSCMMetrics.getCacheMisses();
    cacheReleases = clientSCMMetrics.getCacheReleases();
    acceptedUploads = scmUploaderMetrics.getAcceptedUploads();
    rejectedUploads = scmUploaderMetrics.getRejectUploads();
  }

  public long getTotalDeletedFiles() { return totalDeletedFiles; }
  public long getTotalProcessedFiles() { return totalProcessedFiles; }
  public long getCacheHits() { return cacheHits; }
  public long getCacheMisses() { return cacheMisses; }
  public long getCacheReleases() { return cacheReleases; }
  public long getAcceptedUploads() { return acceptedUploads; }
  public long getRejectUploads() { return rejectedUploads; }
}