aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/scala/org/apache/spark/ui/scope/RDDOperationGraphListener.scala
blob: bcae56e2f114c14ec1c864eb08317f3c28d81030 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/*
 * 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.spark.ui.scope

import scala.collection.mutable

import org.apache.spark.SparkConf
import org.apache.spark.scheduler._
import org.apache.spark.ui.SparkUI

/**
 * A SparkListener that constructs a DAG of RDD operations.
 */
private[ui] class RDDOperationGraphListener(conf: SparkConf) extends SparkListener {

  // Note: the fate of jobs and stages are tied. This means when we clean up a job,
  // we always clean up all of its stages. Similarly, when we clean up a stage, we
  // always clean up its job (and, transitively, other stages in the same job).
  private[ui] val jobIdToStageIds = new mutable.HashMap[Int, Seq[Int]]
  private[ui] val jobIdToSkippedStageIds = new mutable.HashMap[Int, Seq[Int]]
  private[ui] val stageIdToJobId = new mutable.HashMap[Int, Int]
  private[ui] val stageIdToGraph = new mutable.HashMap[Int, RDDOperationGraph]
  private[ui] val completedStageIds = new mutable.HashSet[Int]

  // Keep track of the order in which these are inserted so we can remove old ones
  private[ui] val jobIds = new mutable.ArrayBuffer[Int]
  private[ui] val stageIds = new mutable.ArrayBuffer[Int]

  // How many jobs or stages to retain graph metadata for
  private val retainedJobs =
    conf.getInt("spark.ui.retainedJobs", SparkUI.DEFAULT_RETAINED_JOBS)
  private val retainedStages =
    conf.getInt("spark.ui.retainedStages", SparkUI.DEFAULT_RETAINED_STAGES)

  /**
   * Return the graph metadata for all stages in the given job.
   * An empty list is returned if one or more of its stages has been cleaned up.
   */
  def getOperationGraphForJob(jobId: Int): Seq[RDDOperationGraph] = synchronized {
    val skippedStageIds = jobIdToSkippedStageIds.getOrElse(jobId, Seq.empty)
    val graphs = jobIdToStageIds.getOrElse(jobId, Seq.empty)
      .flatMap { sid => stageIdToGraph.get(sid) }
    // Mark any skipped stages as such
    graphs.foreach { g =>
      val stageId = g.rootCluster.id.replaceAll(RDDOperationGraph.STAGE_CLUSTER_PREFIX, "").toInt
      if (skippedStageIds.contains(stageId) && !g.rootCluster.name.contains("skipped")) {
        g.rootCluster.setName(g.rootCluster.name + " (skipped)")
      }
    }
    graphs
  }

  /** Return the graph metadata for the given stage, or None if no such information exists. */
  def getOperationGraphForStage(stageId: Int): Option[RDDOperationGraph] = synchronized {
    stageIdToGraph.get(stageId)
  }

  /** On job start, construct a RDDOperationGraph for each stage in the job for display later. */
  override def onJobStart(jobStart: SparkListenerJobStart): Unit = synchronized {
    val jobId = jobStart.jobId
    val stageInfos = jobStart.stageInfos

    jobIds += jobId
    jobIdToStageIds(jobId) = jobStart.stageInfos.map(_.stageId).sorted

    stageInfos.foreach { stageInfo =>
      val stageId = stageInfo.stageId
      stageIds += stageId
      stageIdToJobId(stageId) = jobId
      stageIdToGraph(stageId) = RDDOperationGraph.makeOperationGraph(stageInfo)
      trimStagesIfNecessary()
    }

    trimJobsIfNecessary()
  }

  /** Keep track of stages that have completed. */
  override def onStageCompleted(stageCompleted: SparkListenerStageCompleted): Unit = synchronized {
    val stageId = stageCompleted.stageInfo.stageId
    if (stageIdToJobId.contains(stageId)) {
      // Note: Only do this if the stage has not already been cleaned up
      // Otherwise, we may never clean this stage from `completedStageIds`
      completedStageIds += stageCompleted.stageInfo.stageId
    }
  }

  /** On job end, find all stages in this job that are skipped and mark them as such. */
  override def onJobEnd(jobEnd: SparkListenerJobEnd): Unit = synchronized {
    val jobId = jobEnd.jobId
    jobIdToStageIds.get(jobId).foreach { stageIds =>
      val skippedStageIds = stageIds.filter { sid => !completedStageIds.contains(sid) }
      // Note: Only do this if the job has not already been cleaned up
      // Otherwise, we may never clean this job from `jobIdToSkippedStageIds`
      jobIdToSkippedStageIds(jobId) = skippedStageIds
    }
  }

  /** Clean metadata for old stages if we have exceeded the number to retain. */
  private def trimStagesIfNecessary(): Unit = {
    if (stageIds.size >= retainedStages) {
      val toRemove = math.max(retainedStages / 10, 1)
      stageIds.take(toRemove).foreach { id => cleanStage(id) }
      stageIds.trimStart(toRemove)
    }
  }

  /** Clean metadata for old jobs if we have exceeded the number to retain. */
  private def trimJobsIfNecessary(): Unit = {
    if (jobIds.size >= retainedJobs) {
      val toRemove = math.max(retainedJobs / 10, 1)
      jobIds.take(toRemove).foreach { id => cleanJob(id) }
      jobIds.trimStart(toRemove)
    }
  }

  /** Clean metadata for the given stage, its job, and all other stages that belong to the job. */
  private[ui] def cleanStage(stageId: Int): Unit = {
    completedStageIds.remove(stageId)
    stageIdToGraph.remove(stageId)
    stageIdToJobId.remove(stageId).foreach { jobId => cleanJob(jobId) }
  }

  /** Clean metadata for the given job and all stages that belong to it. */
  private[ui] def cleanJob(jobId: Int): Unit = {
    jobIdToSkippedStageIds.remove(jobId)
    jobIdToStageIds.remove(jobId).foreach { stageIds =>
      stageIds.foreach { stageId => cleanStage(stageId) }
    }
  }

}