com.nvidia.spark.rapids.tool.analysis.AppSparkMetricsAggTrait.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rapids-4-spark-tools_2.12 Show documentation
RAPIDS Accelerator for Apache Spark tools
The newest version!
/*
 * Copyright (c) 2024, NVIDIA CORPORATION.
 *
 * 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.nvidia.spark.rapids.tool.analysis

import org.apache.spark.sql.rapids.tool.AppBase

// A trait that provides the common methods used for Spark metrics aggregator
// This is extended by the Qual/Prof aggregators
trait AppSparkMetricsAggTrait extends AppIndexMapperTrait {
  /**
   * Given an application and its index, this methods creates a new appAnalysis
   * object to aggregate the Raw metrics and returns the result
   * @param app the AppBase to be analyzed
   * @param index the application index
   * @return a single record of AggRawMetricsResult containing all the raw aggregated Spark
   *         metrics
   */
  def getAggRawMetrics(app: AppBase, index: Int): AggRawMetricsResult = {
    val analysisObj = new AppSparkMetricsAnalyzer(app)
    AggRawMetricsResult(
      analysisObj.aggregateSparkMetricsByJob(index),
      analysisObj.aggregateSparkMetricsByStage(index),
      analysisObj.shuffleSkewCheck(index),
      analysisObj.aggregateSparkMetricsBySql(index),
      analysisObj.aggregateIOMetricsBySql(analysisObj.aggregateSparkMetricsBySql(index)),
      analysisObj.aggregateDurationAndCPUTimeBySql(index),
      Seq(analysisObj.maxTaskInputSizeBytesPerSQL(index)))
  }

  /**
   * Given a list of applications, this method aggregates the raw metrics for all the applications
   * and returns the results as a single record
   * @param apps the sequence of the apps to be analyzed
   * @return a single record of all the aggregated metrics
   */
  def getAggregateRawMetrics(
      apps: Seq[AppBase]): AggRawMetricsResult = {
    zipAppsWithIndex(apps).map { case (app, index) =>
      getAggRawMetrics(app, index)
    }.reduce { (agg1, agg2) =>
      AggRawMetricsResult(
        agg1.jobAggs ++ agg2.jobAggs,
        agg1.stageAggs ++ agg2.stageAggs,
        agg1.taskShuffleSkew ++ agg2.taskShuffleSkew,
        agg1.sqlAggs ++ agg2.sqlAggs,
        agg1.ioAggs ++ agg2.ioAggs,
        agg1.sqlDurAggs ++ agg2.sqlDurAggs,
        agg1.maxTaskInputSizes ++ agg2.maxTaskInputSizes)
    }
  }
}