Table

of Contents
Introduction 1.1
Overview of Apache Spark 1.2

Spark Core / Transferring Data Blocks In

Spark Cluster
ShuffleClient — Contract to Fetch Shuffle Blocks 2.1
BlockTransferService — Pluggable Block Transfers (To Fetch and Upload Blocks)
ExternalShuffleClient 2.1.2 2.1.1
NettyBlockTransferService — Netty-Based BlockTransferService 2.2
NettyBlockRpcServer — NettyBlockTransferService’s RpcHandler 2.2.1
BlockFetchingListener 2.3
RetryingBlockFetcher 2.4
BlockFetchStarter 2.4.1

Spark Core / Web UI

Web UI — Spark Application’s Web Console 3.1
Jobs 3.1.1
Stages 3.1.2
Storage 3.1.3
Environment 3.1.4
Executors 3.1.5
JobsTab 3.2
AllJobsPage 3.2.1
JobPage 3.2.2
StagesTab — Stages for All Jobs 3.3
AllStagesPage — Stages for All Jobs 3.3.1
StagePage — Stage Details 3.3.2
PoolPage — Pool Details 3.3.3

1
StorageTab 3.4
StoragePage 3.4.1
RDDPage 3.4.2
EnvironmentTab 3.5
EnvironmentPage 3.5.1
ExecutorsTab 3.6
ExecutorsPage 3.6.1
ExecutorThreadDumpPage 3.6.2
SparkUI — Web UI of Spark Application 3.7
SparkUITab 3.7.1
BlockStatusListener Spark Listener 3.8
EnvironmentListener Spark Listener 3.9
ExecutorsListener Spark Listener 3.10
JobProgressListener Spark Listener 3.11
StorageStatusListener Spark Listener 3.12
StorageListener — Spark Listener for Tracking Persistence Status of RDD Blocks 3.13
RDDOperationGraphListener Spark Listener 3.14
WebUI — Framework For Web UIs 3.15
WebUIPage — Contract of Pages in Web UI 3.15.1
WebUITab — Contract of Tabs in Web UI 3.15.2
RDDStorageInfo 3.16
RDDInfo 3.17
LiveEntity 3.18
LiveRDD 3.18.1
UIUtils 3.19
JettyUtils 3.20
web UI Configuration Properties 3.21

Spark Core / Metrics

Spark Metrics 4.1
MetricsSystem 4.2
MetricsConfig — Metrics System Configuration 4.3
Source — Contract of Metrics Sources 4.4

2
Sink — Contract of Metrics Sinks 4.5
MetricsServlet JSON Metrics Sink 4.5.1
Metrics Configuration Properties 4.6

Spark Core / Status REST API

Status REST API — Monitoring Spark Applications Using REST API 5.1
ApiRootResource — /api/v1 URI Handler 5.2
ApplicationListResource — applications URI Handler 5.2.1
OneApplicationResource — applications/appId URI Handler 5.2.2
StagesResource 5.2.2.1
OneApplicationAttemptResource 5.2.3
AbstractApplicationResource 5.3
BaseAppResource 5.4
ApiRequestContext 5.5
UIRoot — Contract for Root Contrainers of Application UI Information 5.6
UIRootFromServletContext 5.6.1

Spark MLlib
Spark MLlib — Machine Learning in Spark 6.1
ML Pipelines (spark.ml) 6.2
Pipeline 6.2.1
PipelineStage 6.2.2
Transformers 6.2.3
Transformer 6.2.3.1
Tokenizer 6.2.3.2
Estimators 6.2.4
Estimator 6.2.4.1
StringIndexer 6.2.4.1.1
KMeans 6.2.4.1.2
TrainValidationSplit 6.2.4.1.3
Predictor 6.2.4.2
RandomForestRegressor 6.2.4.2.1

3
 Regressor 6.2.4.3
LinearRegression 6.2.4.3.1
Classifier 6.2.4.4
RandomForestClassifier 6.2.4.4.1
DecisionTreeClassifier 6.2.4.4.2
Models 6.2.5
Model 6.2.5.1
Evaluator — ML Pipeline Component for Model Scoring 6.2.6
BinaryClassificationEvaluator — Evaluator of Binary Classification Models
ClusteringEvaluator — Evaluator of Clustering Models 6.2.6.2 6.2.6.1
MulticlassClassificationEvaluator — Evaluator of Multiclass Classification
Models 6.2.6.3
RegressionEvaluator — Evaluator of Regression Models 6.2.6.4
CrossValidator — Model Tuning / Finding The Best Model 6.2.7
CrossValidatorModel 6.2.7.1
ParamGridBuilder 6.2.7.2
CrossValidator with Pipeline Example 6.2.7.3
Params and ParamMaps 6.2.8
ValidatorParams 6.2.8.1
HasParallelism 6.2.8.2
ML Persistence — Saving and Loading Models and Pipelines 6.3
MLWritable 6.3.1
MLReader 6.3.2
Example — Text Classification 6.4
Example — Linear Regression 6.5
Logistic Regression 6.6
LogisticRegression 6.6.1
Latent Dirichlet Allocation (LDA) 6.7
Vector 6.8
LabeledPoint 6.9
Streaming MLlib 6.10
GeneralizedLinearRegression 6.11
Alternating Least Squares (ALS) Matrix Factorization 6.12
ALS — Estimator for ALSModel 6.12.1

4
 ALSModel — Model for Predictions 6.12.2
ALSModelReader 6.12.3
Instrumentation 6.13
MLUtils 6.14

Spark Core / Tools

Spark Shell — spark-shell shell script 7.1
Spark Submit — spark-submit shell script 7.2
SparkSubmitArguments 7.2.1
SparkSubmitOptionParser — spark-submit’s Command-Line Parser 7.2.2
SparkSubmitCommandBuilder Command Builder 7.2.3
spark-class shell script 7.3
AbstractCommandBuilder 7.3.1
SparkLauncher — Launching Spark Applications Programmatically 7.4

Spark Core / Architecture

Spark Architecture 8.1
Driver 8.2
Executor 8.3
TaskRunner 8.3.1
ExecutorSource 8.3.2
Master 8.4
Workers 8.5

Spark Core / RDD

Anatomy of Spark Application 9.1
SparkConf — Programmable Configuration for Spark Applications 9.2
Spark Properties and spark-defaults.conf Properties File 9.2.1
Deploy Mode 9.2.2
SparkContext 9.3
HeartbeatReceiver RPC Endpoint 9.3.1

5
 Inside Creating SparkContext 9.3.2
ConsoleProgressBar 9.3.3
SparkStatusTracker 9.3.4
Local Properties — Creating Logical Job Groups 9.3.5
RDD — Resilient Distributed Dataset 9.4
RDD 9.4.1
RDD Lineage — Logical Execution Plan 9.4.2
TaskLocation 9.4.3
ParallelCollectionRDD 9.4.4
MapPartitionsRDD 9.4.5
OrderedRDDFunctions 9.4.6
CoGroupedRDD 9.4.7
SubtractedRDD 9.4.8
HadoopRDD 9.4.9
NewHadoopRDD 9.4.10
ShuffledRDD 9.4.11
Operators 9.5
Transformations 9.5.1
PairRDDFunctions 9.5.1.1
Actions 9.5.2
Caching and Persistence 9.6
StorageLevel 9.6.1
Partitions and Partitioning 9.7
Partition 9.7.1
Partitioner 9.7.2
HashPartitioner 9.7.2.1
Shuffling 9.8
Checkpointing 9.9
CheckpointRDD 9.9.1
RDD Dependencies 9.10
NarrowDependency — Narrow Dependencies 9.10.1
ShuffleDependency — Shuffle Dependencies 9.10.2
Map/Reduce-side Aggregator 9.11
AppStatusStore 9.12

6
AppStatusPlugin 9.13
AppStatusListener 9.14
KVStore 9.15
KVStoreView 9.15.1
ElementTrackingStore 9.15.2
InMemoryStore 9.15.3
LevelDB 9.15.4
InterruptibleIterator — Iterator With Support For Task Cancellation 9.16

Spark Core / Optimizations

Broadcast variables 10.1
Accumulators 10.2
AccumulatorContext 10.2.1

Spark Core / Services

SerializerManager 11.1
MemoryManager — Memory Management 11.2
UnifiedMemoryManager — Spark’s Memory Manager 11.2.1
StaticMemoryManager — Legacy Memory Manager 11.2.2
MemoryManager Configuration Properties 11.2.3
SparkEnv — Spark Runtime Environment 11.3
DAGScheduler — Stage-Oriented Scheduler 11.4
Jobs 11.4.1
Stage — Physical Unit Of Execution 11.4.2
ShuffleMapStage — Intermediate Stage in Execution DAG 11.4.2.1
ResultStage — Final Stage in Job 11.4.2.2
StageInfo 11.4.2.3
DAGSchedulerSource — Metrics Source for DAGScheduler 11.4.3
DAGScheduler Event Bus 11.4.4
JobListener 11.4.5
JobWaiter 11.4.5.1

7
TaskScheduler — Spark Scheduler 11.5
Tasks 11.5.1
ShuffleMapTask — Task for ShuffleMapStage 11.5.1.1
ResultTask 11.5.1.2
FetchFailedException 11.5.2
MapStatus — Shuffle Map Output Status 11.5.3
TaskSet — Set of Tasks for Stage 11.5.4
TaskSetManager 11.5.5
Schedulable 11.5.5.1
Schedulable Pool 11.5.5.2
Schedulable Builders 11.5.5.3
FIFOSchedulableBuilder 11.5.5.3.1
FairSchedulableBuilder 11.5.5.3.2
Scheduling Mode — spark.scheduler.mode Spark Property 11.5.5.4
TaskInfo 11.5.5.5
TaskDescription — Metadata of Single Task 11.5.6
TaskSchedulerImpl — Default TaskScheduler 11.5.7
Speculative Execution of Tasks 11.5.7.1
TaskResultGetter 11.5.7.2
TaskContext 11.5.8
TaskContextImpl 11.5.8.1
TaskResults — DirectTaskResult and IndirectTaskResult 11.5.9
TaskMemoryManager — Memory Manager of Single Task 11.5.10
MemoryConsumer 11.5.10.1
TaskMetrics 11.5.11
ShuffleWriteMetrics 11.5.11.1
TaskSetBlacklist — Blacklisting Executors and Nodes For TaskSet 11.5.12
SchedulerBackend — Pluggable Scheduler Backends 11.6
CoarseGrainedSchedulerBackend 11.6.1
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint 11.6.1.1
ExecutorBackend — Pluggable Executor Backends 11.7
CoarseGrainedExecutorBackend 11.7.1
MesosExecutorBackend 11.7.2
BlockManager — Key-Value Store of Blocks of Data 11.8

8
 MemoryStore 11.8.1
BlockEvictionHandler 11.8.2
StorageMemoryPool 11.8.3
MemoryPool 11.8.4
DiskStore 11.8.5
BlockDataManager 11.8.6
RpcHandler 11.8.7
RpcResponseCallback 11.8.8
TransportRequestHandler 11.8.9
TransportContext 11.8.10
TransportServer 11.8.11
TransportClientFactory 11.8.12
MessageHandler 11.8.13
BlockManagerMaster — BlockManager for Driver 11.8.14
BlockManagerMasterEndpoint — BlockManagerMaster RPC Endpoint
DiskBlockManager 11.8.15 11.8.14.1
BlockInfoManager 11.8.16
BlockInfo 11.8.16.1
BlockManagerSlaveEndpoint 11.8.17
DiskBlockObjectWriter 11.8.18
BlockManagerSource — Metrics Source for BlockManager 11.8.19
ShuffleMetricsSource — Metrics Source of BlockManager for Shuffle-Related
Metrics 11.8.20
StorageStatus 11.8.21
ManagedBuffer 11.8.22
MapOutputTracker — Shuffle Map Output Registry 11.9
MapOutputTrackerMaster — MapOutputTracker For Driver 11.9.1
MapOutputTrackerMasterEndpoint 11.9.1.1
MapOutputTrackerWorker — MapOutputTracker for Executors 11.9.2
ShuffleManager — Pluggable Shuffle Systems 11.10
SortShuffleManager — The Default Shuffle System 11.10.1
ExternalShuffleService 11.10.2
OneForOneStreamManager 11.10.3
ShuffleBlockResolver 11.10.4

9
 IndexShuffleBlockResolver 11.10.4.1
ShuffleWriter 11.10.5
BypassMergeSortShuffleWriter 11.10.5.1
SortShuffleWriter 11.10.5.2
UnsafeShuffleWriter — ShuffleWriter for SerializedShuffleHandle 11.10.5.3
BaseShuffleHandle — Fallback Shuffle Handle 11.10.6
BypassMergeSortShuffleHandle — Marker Interface for Bypass Merge Sort Shuffle
Handles 11.10.7
SerializedShuffleHandle — Marker Interface for Serialized Shuffle Handles 11.10.8
ShuffleReader 11.10.9
BlockStoreShuffleReader 11.10.9.1
ShuffleBlockFetcherIterator 11.10.10
ShuffleExternalSorter — Cache-Efficient Sorter 11.10.11
ExternalSorter 11.10.12
Serialization 11.11
Serializer — Task SerDe 11.11.1
SerializerInstance 11.11.2
SerializationStream 11.11.3
DeserializationStream 11.11.4
ExternalClusterManager — Pluggable Cluster Managers 11.12
BroadcastManager 11.13
BroadcastFactory — Pluggable Broadcast Variable Factories 11.13.1
TorrentBroadcastFactory 11.13.1.1
TorrentBroadcast 11.13.1.2
CompressionCodec 11.13.2
ContextCleaner — Spark Application Garbage Collector 11.14
CleanerListener 11.14.1
Dynamic Allocation (of Executors) 11.15
ExecutorAllocationManager — Allocation Manager for Spark Core 11.15.1
ExecutorAllocationClient 11.15.2
ExecutorAllocationListener 11.15.3
ExecutorAllocationManagerSource 11.15.4
HTTP File Server 11.16
Data Locality 11.17

10
Cache Manager 11.18
OutputCommitCoordinator 11.19
RpcEnv — RPC Environment 11.20
RpcEndpoint 11.20.1
RpcEndpointRef 11.20.2
RpcEnvFactory 11.20.3
Netty-based RpcEnv 11.20.4
TransportConf — Transport Configuration 11.21
Utils Helper Object 11.22

Spark Core / Security

Securing Web UI 12.1

Spark Deployment Environments

Deployment Environments — Run Modes 13.1
Spark local (pseudo-cluster) 13.2
LocalSchedulerBackend 13.2.1
LocalEndpoint 13.2.2
Spark on cluster 13.3

Spark on YARN
Spark on YARN 14.1
YarnShuffleService — ExternalShuffleService on YARN 14.2
ExecutorRunnable 14.3
Client 14.4
YarnRMClient 14.5
ApplicationMaster 14.6
AMEndpoint — ApplicationMaster RPC Endpoint 14.6.1
YarnClusterManager — ExternalClusterManager for YARN 14.7
TaskSchedulers for YARN 14.8

11
 YarnScheduler 14.8.1
YarnClusterScheduler 14.8.2
SchedulerBackends for YARN 14.9
YarnSchedulerBackend 14.9.1
YarnClientSchedulerBackend 14.9.2
YarnClusterSchedulerBackend 14.9.3
YarnSchedulerEndpoint RPC Endpoint 14.9.4
YarnAllocator 14.10
Introduction to Hadoop YARN 14.11
Setting up YARN Cluster 14.12
Kerberos 14.13
ConfigurableCredentialManager 14.13.1
ClientDistributedCacheManager 14.14
YarnSparkHadoopUtil 14.15
Settings 14.16

Spark Standalone
Spark Standalone 15.1
Standalone Master — Cluster Manager of Spark Standalone 15.2
Standalone Worker 15.3
web UI 15.4
ApplicationPage 15.4.1
LocalSparkCluster — Single-JVM Spark Standalone Cluster 15.5
Submission Gateways 15.6
Management Scripts for Standalone Master 15.7
Management Scripts for Standalone Workers 15.8
Checking Status 15.9
Example 2-workers-on-1-node Standalone Cluster (one executor per worker) 15.10
StandaloneSchedulerBackend 15.11

Spark on Mesos
Spark on Mesos 16.1

12
MesosCoarseGrainedSchedulerBackend 16.2
About Mesos 16.3

Execution Model
Execution Model 17.1

Monitoring, Tuning and Debugging

Unified Memory Management 18.1
Spark History Server 18.2
HistoryServer — WebUI For Active And Completed Spark Applications 18.2.1
SQLHistoryListener 18.2.2
FsHistoryProvider — File-System-Based History Provider 18.2.3
ApplicationHistoryProvider 18.2.4
HistoryServerArguments 18.2.5
ApplicationCacheOperations 18.2.6
ApplicationCache 18.2.7
Logging 18.3
Performance Tuning 18.4
SparkListener — Intercepting Events from Spark Scheduler 18.5
LiveListenerBus 18.5.1
ReplayListenerBus 18.5.2
SparkListenerBus — Internal Contract for Spark Event Buses 18.5.3
EventLoggingListener — Spark Listener for Persisting Events 18.5.4
StatsReportListener — Logging Summary Statistics 18.5.5
JsonProtocol 18.6
Debugging Spark 18.7

Varia
Building Apache Spark from Sources 19.1
Spark and Hadoop 19.2
SparkHadoopUtil 19.2.1

13
Spark and software in-memory file systems 19.3
Spark and The Others 19.4
Distributed Deep Learning on Spark 19.5
Spark Packages 19.6

Interactive Notebooks
Interactive Notebooks 20.1
Apache Zeppelin 20.1.1
Spark Notebook 20.1.2

Spark Tips and Tricks

Spark Tips and Tricks 21.1
Access private members in Scala in Spark shell 21.2
SparkException: Task not serializable 21.3
Running Spark Applications on Windows 21.4

Exercises
One-liners using PairRDDFunctions 22.1
Learning Jobs and Partitions Using take Action 22.2
Spark Standalone - Using ZooKeeper for High-Availability of Master 22.3
Spark’s Hello World using Spark shell and Scala 22.4
WordCount using Spark shell 22.5
Your first complete Spark application (using Scala and sbt) 22.6
Spark (notable) use cases 22.7
Using Spark SQL to update data in Hive using ORC files 22.8
Developing Custom SparkListener to monitor DAGScheduler in Scala 22.9
Developing RPC Environment 22.10
Developing Custom RDD 22.11
Working with Datasets from JDBC Data Sources (and PostgreSQL) 22.12
Causing Stage to Fail 22.13

14
Further Learning
Courses 23.1
Books 23.2

(separate book) Spark SQL

Spark SQL — Batch and Streaming Queries Over Structured Data on Massive Scale
24.1

(separate book) Spark Structured Streaming

Spark Structured Streaming — Streaming Datasets 25.1

(obsolete) Spark Streaming

Spark Streaming — Streaming RDDs 26.1
BlockRDD 26.1.1

(obsolete) Spark GraphX

Spark GraphX — Distributed Graph Computations 27.1
Graph Algorithms 27.2

15
Introduction

Mastering Apache Spark (2.3.1)

Welcome to Mastering Apache Spark gitbook! I’m very excited to have you here and hope
you will enjoy exploring the internals of Apache Spark (Core) as much as I have.

I write to discover what I know.

— Flannery O'Connor
I’m Jacek Laskowski, an independent consultant, software developer and technical instructor
specializing in Apache Spark, Apache Kafka and Kafka Streams (with Scala, sbt,
Kubernetes, DC/OS, Apache Mesos, and Hadoop YARN).

I offer software development and consultancy services with very hands-on in-depth
workshops and mentoring. Reach out to me at [email protected] or @jaceklaskowski to
discuss opportunities.

Consider joining me at Warsaw Scala Enthusiasts and Warsaw Spark meetups in Warsaw,
Poland.

I’m also writing Mastering Spark SQL, Mastering Kafka Streams, Apache Kafka
Tip
Notebook and Spark Structured Streaming Notebook gitbooks.

Expect text and code snippets from a variety of public sources. Attribution follows.

Now, let me introduce you to Apache Spark.

16
Overview of Apache Spark

Apache Spark
Apache Spark is an open-source distributed general-purpose cluster computing
framework with (mostly) in-memory data processing engine that can do ETL, analytics,
machine learning and graph processing on large volumes of data at rest (batch processing)
or in motion (streaming processing) with rich concise high-level APIs for the programming
languages: Scala, Python, Java, R, and SQL.

Figure 1. The Spark Platform

You could also describe Spark as a distributed, data processing engine for batch and
streaming modes featuring SQL queries, graph processing, and machine learning.

In contrast to Hadoop’s two-stage disk-based MapReduce computation engine, Spark’s

multi-stage (mostly) in-memory computing engine allows for running most computations in
memory, and hence most of the time provides better performance for certain applications,
e.g. iterative algorithms or interactive data mining (read Spark officially sets a new record in
large-scale sorting).

Spark aims at speed, ease of use, extensibility and interactive analytics.

Spark is often called cluster computing engine or simply execution engine.

Spark is a distributed platform for executing complex multi-stage applications, like

machine learning algorithms, and interactive ad hoc queries. Spark provides an efficient
abstraction for in-memory cluster computing called Resilient Distributed Dataset.

17
Overview of Apache Spark

Using Spark Application Frameworks, Spark simplifies access to machine learning and
predictive analytics at scale.

Spark is mainly written in Scala, but provides developer API for languages like Java, Python,
and R.

Microsoft’s Mobius project provides C# API for Spark "enabling the

Note implementation of Spark driver program and data processing operations in the
languages supported in the .NET framework like C# or F#."

If you have large amounts of data that requires low latency processing that a typical
MapReduce program cannot provide, Spark is a viable alternative.

Access any data type across any data source.

Huge demand for storage and data processing.

The Apache Spark project is an umbrella for SQL (with Datasets), streaming, machine
learning (pipelines) and graph processing engines built atop Spark Core. You can run them
all in a single application using a consistent API.

Spark runs locally as well as in clusters, on-premises or in cloud. It runs on top of Hadoop
YARN, Apache Mesos, standalone or in the cloud (Amazon EC2 or IBM Bluemix).

Spark can access data from many data sources.

Apache Spark’s Streaming and SQL programming models with MLlib and GraphX make it
easier for developers and data scientists to build applications that exploit machine learning
and graph analytics.

At a high level, any Spark application creates RDDs out of some input, run (lazy)
transformations of these RDDs to some other form (shape), and finally perform actions to
collect or store data. Not much, huh?

You can look at Spark from programmer’s, data engineer’s and administrator’s point of view.
And to be honest, all three types of people will spend quite a lot of their time with Spark to
finally reach the point where they exploit all the available features. Programmers use
language-specific APIs (and work at the level of RDDs using transformations and actions),
data engineers use higher-level abstractions like DataFrames or Pipelines APIs or external
tools (that connect to Spark), and finally it all can only be possible to run because
administrators set up Spark clusters to deploy Spark applications to.

It is Spark’s goal to be a general-purpose computing platform with various specialized

applications frameworks on top of a single unified engine.

18
Overview of Apache Spark

When you hear "Apache Spark" it can be two things — the Spark engine aka
Spark Core or the Apache Spark open source project which is an "umbrella"
term for Spark Core and the accompanying Spark Application Frameworks, i.e.
Note
Spark SQL, Spark Streaming, Spark MLlib and Spark GraphX that sit on top of
Spark Core and the main data abstraction in Spark called RDD - Resilient
Distributed Dataset.

Why Spark
Let’s list a few of the many reasons for Spark. We are doing it first, and then comes the
overview that lends a more technical helping hand.

Easy to Get Started

Spark offers spark-shell that makes for a very easy head start to writing and running Spark
applications on the command line on your laptop.

You could then use Spark Standalone built-in cluster manager to deploy your Spark
applications to a production-grade cluster to run on a full dataset.

Unified Engine for Diverse Workloads

As said by Matei Zaharia - the author of Apache Spark - in Introduction to AmpLab Spark
Internals video (quoting with few changes):

One of the Spark project goals was to deliver a platform that supports a very wide array
of diverse workflows - not only MapReduce batch jobs (there were available in
Hadoop already at that time), but also iterative computations like graph algorithms or
Machine Learning.

And also different scales of workloads from sub-second interactive jobs to jobs that run
for many hours.

Spark combines batch, interactive, and streaming workloads under one rich concise API.

Spark supports near real-time streaming workloads via Spark Streaming application
framework.

ETL workloads and Analytics workloads are different, however Spark attempts to offer a
unified platform for a wide variety of workloads.

Graph and Machine Learning algorithms are iterative by nature and less saves to disk or
transfers over network means better performance.

There is also support for interactive workloads using Spark shell.

19
Overview of Apache Spark

You should watch the video What is Apache Spark? by Mike Olson, Chief Strategy Officer
and Co-Founder at Cloudera, who provides a very exceptional overview of Apache Spark, its
rise in popularity in the open source community, and how Spark is primed to replace
MapReduce as the general processing engine in Hadoop.

Leverages the Best in distributed batch data processing

When you think about distributed batch data processing, Hadoop naturally comes to mind
as a viable solution.

Spark draws many ideas out of Hadoop MapReduce. They work together well - Spark on
YARN and HDFS - while improving on the performance and simplicity of the distributed
computing engine.

For many, Spark is Hadoop++, i.e. MapReduce done in a better way.

And it should not come as a surprise, without Hadoop MapReduce (its advances and
deficiencies), Spark would not have been born at all.

RDD - Distributed Parallel Scala Collections

As a Scala developer, you may find Spark’s RDD API very similar (if not identical) to Scala’s
Collections API.

It is also exposed in Java, Python and R (as well as SQL, i.e. SparkSQL, in a sense).

So, when you have a need for distributed Collections API in Scala, Spark with RDD API
should be a serious contender.

Rich Standard Library

Not only can you use map and reduce (as in Hadoop MapReduce jobs) in Spark, but also
a vast array of other higher-level operators to ease your Spark queries and application
development.

It expanded on the available computation styles beyond the only map-and-reduce available
in Hadoop MapReduce.

Unified development and deployment environment for all

Regardless of the Spark tools you use - the Spark API for the many programming languages
supported - Scala, Java, Python, R, or the Spark shell, or the many Spark Application
Frameworks leveraging the concept of RDD, i.e. Spark SQL, Spark Streaming, Spark MLlib

20
Overview of Apache Spark

and Spark GraphX, you still use the same development and deployment environment to for
large data sets to yield a result, be it a prediction (Spark MLlib), a structured data queries
(Spark SQL) or just a large distributed batch (Spark Core) or streaming (Spark Streaming)
computation.

It’s also very productive of Spark that teams can exploit the different skills the team
members have acquired so far. Data analysts, data scientists, Python programmers, or Java,
or Scala, or R, can all use the same Spark platform using tailor-made API. It makes for
bringing skilled people with their expertise in different programming languages together to a
Spark project.

Interactive Exploration / Exploratory Analytics

It is also called ad hoc queries.

Using the Spark shell you can execute computations to process large amount of data (The
Big Data). It’s all interactive and very useful to explore the data before final production
release.

Also, using the Spark shell you can access any Spark cluster as if it was your local machine.
Just point the Spark shell to a 20-node of 10TB RAM memory in total (using --master ) and
use all the components (and their abstractions) like Spark SQL, Spark MLlib, Spark
Streaming, and Spark GraphX.

Depending on your needs and skills, you may see a better fit for SQL vs programming APIs
or apply machine learning algorithms (Spark MLlib) from data in graph data structures
(Spark GraphX).

Single Environment
Regardless of which programming language you are good at, be it Scala, Java, Python, R or
SQL, you can use the same single clustered runtime environment for prototyping, ad hoc
queries, and deploying your applications leveraging the many ingestion data points offered
by the Spark platform.

You can be as low-level as using RDD API directly or leverage higher-level APIs of Spark
SQL (Datasets), Spark MLlib (ML Pipelines), Spark GraphX (Graphs) or Spark Streaming
(DStreams).

Or use them all in a single application.

The single programming model and execution engine for different kinds of workloads
simplify development and deployment architectures.

21
Overview of Apache Spark

Data Integration Toolkit with Rich Set of Supported Data

Sources
Spark can read from many types of data sources — relational, NoSQL, file systems, etc. — 
using many types of data formats - Parquet, Avro, CSV, JSON.

Both, input and output data sources, allow programmers and data engineers use Spark as
the platform with the large amount of data that is read from or saved to for processing,
interactively (using Spark shell) or in applications.

Tools unavailable then, at your fingertips now

As much and often as it’s recommended to pick the right tool for the job, it’s not always
feasible. Time, personal preference, operating system you work on are all factors to decide
what is right at a time (and using a hammer can be a reasonable choice).

Spark embraces many concepts in a single unified development and runtime environment.

Machine learning that is so tool- and feature-rich in Python, e.g. SciKit library, can now
be used by Scala developers (as Pipeline API in Spark MLlib or calling pipe() ).

DataFrames from R are available in Scala, Java, Python, R APIs.

Single node computations in machine learning algorithms are migrated to their

distributed versions in Spark MLlib.

This single platform gives plenty of opportunities for Python, Scala, Java, and R
programmers as well as data engineers (SparkR) and scientists (using proprietary enterprise
data warehouses with Thrift JDBC/ODBC Server in Spark SQL).

Mind the proverb if all you have is a hammer, everything looks like a nail, too.

Low-level Optimizations
Apache Spark uses a directed acyclic graph (DAG) of computation stages (aka execution
DAG). It postpones any processing until really required for actions. Spark’s lazy evaluation
gives plenty of opportunities to induce low-level optimizations (so users have to know less to
do more).

Mind the proverb less is more.

Excels at low-latency iterative workloads

22
Overview of Apache Spark

Spark supports diverse workloads, but successfully targets low-latency iterative ones. They
are often used in Machine Learning and graph algorithms.

Many Machine Learning algorithms require plenty of iterations before the result models get
optimal, like logistic regression. The same applies to graph algorithms to traverse all the
nodes and edges when needed. Such computations can increase their performance when
the interim partial results are stored in memory or at very fast solid state drives.

Spark can cache intermediate data in memory for faster model building and training. Once
the data is loaded to memory (as an initial step), reusing it multiple times incurs no
performance slowdowns.

Also, graph algorithms can traverse graphs one connection per iteration with the partial
result in memory.

Less disk access and network can make a huge difference when you need to process lots of
data, esp. when it is a BIG Data.

ETL done easier

Spark gives Extract, Transform and Load (ETL) a new look with the many programming
languages supported - Scala, Java, Python (less likely R). You can use them all or pick the
best for a problem.

Scala in Spark, especially, makes for a much less boiler-plate code (comparing to other
languages and approaches like MapReduce in Java).

Unified Concise High-Level API

Spark offers a unified, concise, high-level APIs for batch analytics (RDD API), SQL
queries (Dataset API), real-time analysis (DStream API), machine learning (ML Pipeline API)
and graph processing (Graph API).

Developers no longer have to learn many different processing engines and platforms, and let
the time be spent on mastering framework APIs per use case (atop a single computation
engine Spark).

Different kinds of data processing using unified API

Spark offers three kinds of data processing using batch, interactive, and stream
processing with the unified API and data structures.

Little to no disk use for better performance

23
Overview of Apache Spark

In the no-so-long-ago times, when the most prevalent distributed computing framework was
Hadoop MapReduce, you could reuse a data between computation (even partial ones!) only
after you’ve written it to an external storage like Hadoop Distributed Filesystem (HDFS). It
can cost you a lot of time to compute even very basic multi-stage computations. It simply
suffers from IO (and perhaps network) overhead.

One of the many motivations to build Spark was to have a framework that is good at data
reuse.

Spark cuts it out in a way to keep as much data as possible in memory and keep it there
until a job is finished. It doesn’t matter how many stages belong to a job. What does matter
is the available memory and how effective you are in using Spark API (so no shuffle occur).

The less network and disk IO, the better performance, and Spark tries hard to find ways to
minimize both.

Fault Tolerance included

Faults are not considered a special case in Spark, but obvious consequence of being a
parallel and distributed system. Spark handles and recovers from faults by default without
particularly complex logic to deal with them.

Small Codebase Invites Contributors

Spark’s design is fairly simple and the code that comes out of it is not huge comparing to the
features it offers.

The reasonably small codebase of Spark invites project contributors - programmers who
extend the platform and fix bugs in a more steady pace.

Further reading or watching

(video) Keynote: Spark 2.0 - Matei Zaharia, Apache Spark Creator and CTO of
Databricks

24
ShuffleClient — Contract to Fetch Shuffle Blocks

ShuffleClient — Contract to Fetch Shuffle

Blocks
ShuffleClient is the contract of clients that can fetch shuffle block files.

ShuffleClient can optionally be initialized with an appId (that actually does nothing by

default)

ShuffleClient has shuffle-related Spark metrics that are used when BlockManager is

requested for a shuffle-related Spark metrics source (only when Executor is created for a
non-local / cluster mode).

package org.apache.spark.network.shuffle;

abstract class ShuffleClient implements Closeable {

// only required methods that have no implementation
// the others follow
abstract void fetchBlocks(
String host,
int port,
String execId,
String[] blockIds,
BlockFetchingListener listener,
TempFileManager tempFileManager);
}

Table 1. (Subset of) ShuffleClient Contract

Method Description
Fetches a sequence of blocks from a remote block
manager node asynchronously
fetchBlocks
Used exclusively when ShuffleBlockFetcherIterator is
requested to sendRequest

Table 2. ShuffleClients
ShuffleClient Description

BlockTransferService

ExternalShuffleClient

init Method

25
ShuffleClient — Contract to Fetch Shuffle Blocks

void init(String appId)

init does nothing by default.

init is used when:

BlockManager is requested to initialize

Note
Spark on Mesos' MesosCoarseGrainedSchedulerBackend is requested to
registered

Requesting Shuffle-Related Spark Metrics 

—  shuffleMetrics Method

MetricSet shuffleMetrics()

shuffleMetrics returns an empty Dropwizard Metrics' MetricSet by default.

shuffleMetrics is used exclusively when BlockManager is requested for a

Note shuffle-related Spark metrics source (only when Executor is created for a non-
local / cluster mode).

26
BlockTransferService — Pluggable Block Transfers (To Fetch and Upload Blocks)

BlockTransferService — Pluggable Block
Transfers (To Fetch and Upload Blocks)
BlockTransferService is the base for ShuffleClients that can fetch and upload blocks of data

synchronously or asynchronously.

package org.apache.spark.network

abstract class BlockTransferService extends ShuffleClient {

// only required methods that have no implementation
// the others follow
def init(blockDataManager: BlockDataManager): Unit
def close(): Unit
def port: Int
def hostName: String
def fetchBlocks(
host: String,
port: Int,
execId: String,
blockIds: Array[String],
listener: BlockFetchingListener,
tempFileManager: TempFileManager): Unit
def uploadBlock(
hostname: String,
port: Int,
execId: String,
blockId: BlockId,
blockData: ManagedBuffer,
level: StorageLevel,
classTag: ClassTag[_]): Future[Unit]
}

Note BlockTransferService is a private[spark] contract.

27
BlockTransferService — Pluggable Block Transfers (To Fetch and Upload Blocks)

Table 1. (Subset of) BlockTransferService Contract

Method Description
init Used when…​FIXME

close Used when…​FIXME

port Used when…​FIXME

hostName Used when…​FIXME

Fetches a sequence of blocks from a remote node

asynchronously
Used exclusively when BlockTransferService is
fetchBlocks
requested to fetch only one block (in a blocking fashion)

fetchBlocks is part of ShuffleClient Contract

Note
to…​FIXME.

Used exclusively when BlockTransferService is

uploadBlock requested to upload a single block to a remote node (in a
blocking fashion).

NettyBlockTransferService is the one and only known implementation of

Note
BlockTransferService Contract.

BlockTransferService was introduced in SPARK-3019 Pluggable block transfer

Note
interface (BlockTransferService) and is available since Spark 1.2.0.

fetchBlockSync Method

fetchBlockSync(
host: String,
port: Int,
execId: String,
blockId: String,
tempFileManager: TempFileManager): ManagedBuffer

fetchBlockSync …​FIXME

Synchronous (and hence blocking) fetchBlockSync to fetch one block blockId (that
corresponds to the ShuffleClient parent’s asynchronous fetchBlocks).

fetchBlockSync is a mere wrapper around fetchBlocks to fetch one blockId block that

waits until the fetch finishes.

28
BlockTransferService — Pluggable Block Transfers (To Fetch and Upload Blocks)

Note fetchBlockSync is used when…​FIXME

Uploading Single Block to Remote Node (Blocking

Fashion) —  uploadBlockSync Method

uploadBlockSync(
hostname: String,
port: Int,
execId: String,
blockId: BlockId,
blockData: ManagedBuffer,
level: StorageLevel,
classTag: ClassTag[_]): Unit

uploadBlockSync …​FIXME

uploadBlockSync is a mere blocking wrapper around uploadBlock that waits until the upload

finishes.

uploadBlockSync is used exclusively when BlockManager is requested to

Note
replicate (when a replication level is greater than 1).

29
ExternalShuffleClient

ExternalShuffleClient
ExternalShuffleClient is a ShuffleClient that…​FIXME

Register Block Manager with Shuffle Server 

—  registerWithShuffleServer Method

void registerWithShuffleServer(
String host,
int port,
String execId,
ExecutorShuffleInfo executorInfo) throws IOException, InterruptedException

registerWithShuffleServer …​FIXME

Note registerWithShuffleServer is used when…​FIXME

fetchBlocks Method

void fetchBlocks(
String host,
int port,
String execId,
String[] blockIds,
BlockFetchingListener listener,
TempFileManager tempFileManager)

Note fetchBlocks is part of ShuffleClient Contract to…​FIXME.

fetchBlocks …​FIXME

30
NettyBlockTransferService — Netty-Based BlockTransferService

NettyBlockTransferService — Netty-Based
BlockTransferService
NettyBlockTransferService is a BlockTransferService that uses Netty for uploading or

fetching blocks of data.

NettyBlockTransferService is created when SparkEnv is created for the driver and

executors (to create the BlockManager).

Figure 1. Creating NettyBlockTransferService for BlockManager

BlockManager uses NettyBlockTransferService for the following:

FIXME (should it be here or in BlockManager?)

ShuffleClient (when spark.shuffle.service.enabled configuration property is off)

for…​FIXME

NettyBlockTransferService simply requests the TransportServer for the port.

Enable INFO or TRACE logging level for

org.apache.spark.network.netty.NettyBlockTransferService logger to see what
happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.network.netty.NettyBlockTransferService=TRACE

Refer to Logging.

fetchBlocks Method

31
NettyBlockTransferService — Netty-Based BlockTransferService

fetchBlocks(
host: String,
port: Int,
execId: String,
blockIds: Array[String],
listener: BlockFetchingListener): Unit

Note fetchBlocks is part of BlockTransferService Contract to…​FIXME.

When executed, fetchBlocks prints out the following TRACE message in the logs:

TRACE Fetch blocks from [host]:[port] (executor id [execId])

fetchBlocks then creates a RetryingBlockFetcher.BlockFetchStarter where

createAndStart method…​FIXME

Depending on the maximum number of acceptable IO exceptions (such as connection

timeouts) per request, if the number is greater than 0 , fetchBlocks creates a
RetryingBlockFetcher and starts it immediately.

RetryingBlockFetcher is created with the

Note RetryingBlockFetcher.BlockFetchStarter created earlier, the input blockIds
and listener .

If however the number of retries is not greater than 0 (it could be 0 or less), the
RetryingBlockFetcher.BlockFetchStarter created earlier is started (with the input blockIds

and listener ).

In case of any Exception , you should see the following ERROR message in the logs and
the input BlockFetchingListener gets notified (using onBlockFetchFailure for every block
id).

ERROR Exception while beginning fetchBlocks

Application Id —  appId Property

Caution FIXME

Closing NettyBlockTransferService —  close Method

close(): Unit

32
NettyBlockTransferService — Netty-Based BlockTransferService

Note close is part of the BlockTransferService Contract.

close …​FIXME

Initializing NettyBlockTransferService —  init Method

init(blockDataManager: BlockDataManager): Unit

Note init is part of the BlockTransferService Contract.

init starts a server for…​FIXME

Internally, init creates a NettyBlockRpcServer (using the application id, a JavaSerializer

and the input blockDataManager ).

Caution FIXME Describe security when authEnabled is enabled.

init creates a TransportContext with the NettyBlockRpcServer created earlier.

Caution FIXME Describe transportConf and TransportContext .

init creates the internal clientFactory and a server.

Caution FIXME What’s the "a server"?

In the end, you should see the INFO message in the logs:

INFO NettyBlockTransferService: Server created on [hostName]:[port]

hostname is given when NettyBlockTransferService is created and is

controlled by spark.driver.host Spark property for the driver and differs per
Note
deployment environment for executors (as controlled by --hostname for
CoarseGrainedExecutorBackend ).

Uploading Block —  uploadBlock Method

uploadBlock(
hostname: String,
port: Int,
execId: String,
blockId: BlockId,
blockData: ManagedBuffer,
level: StorageLevel,
classTag: ClassTag[_]): Future[Unit]

33
NettyBlockTransferService — Netty-Based BlockTransferService

Note uploadBlock is part of the BlockTransferService Contract.

Internally, uploadBlock creates a TransportClient client to send a UploadBlock message

(to the input hostname and port ).

Note UploadBlock message is processed by NettyBlockRpcServer.

The UploadBlock message holds the application id, the input execId and blockId . It also
holds the serialized bytes for block metadata with level and classTag serialized (using
the internal JavaSerializer ) as well as the serialized bytes for the input blockData itself
(this time however the serialization uses ManagedBuffer.nioByteBuffer method).

The entire UploadBlock message is further serialized before sending (using

TransportClient.sendRpc ).

Caution FIXME Describe TransportClient and clientFactory.createClient .

When blockId block was successfully uploaded, you should see the following TRACE
message in the logs:

TRACE NettyBlockTransferService: Successfully uploaded block [blockId]

When an upload failed, you should see the following ERROR message in the logs:

ERROR Error while uploading block [blockId]

UploadBlock Message
UploadBlock is a BlockTransferMessage that describes a block being uploaded, i.e. send

over the wire from a NettyBlockTransferService to a NettyBlockRpcServer.

Table 1. UploadBlock Attributes

Attribute Description
appId The application id (the block belongs to)

execId The executor id

blockId The block id

metadata

blockData The block data as an array of bytes

34
NettyBlockTransferService — Netty-Based BlockTransferService

As an Encodable , UploadBlock can calculate the encoded size and do encoding and
decoding itself to or from a ByteBuf , respectively.

createServer Internal Method

createServer(bootstraps: List[TransportServerBootstrap]): TransportServer

createServer …​FIXME

createServer is used exclusively when NettyBlockTransferService is

Note
requested to init.

Creating NettyBlockTransferService Instance

NettyBlockTransferService takes the following when created:

SparkConf

SecurityManager

Bind address to bind to

Host name to bind to

Port number

Number of CPU cores

NettyBlockTransferService initializes the internal registries and counters.

35
NettyBlockRpcServer — NettyBlockTransferService’s RpcHandler

NettyBlockRpcServer — 
NettyBlockTransferService’s RpcHandler
NettyBlockRpcServer is a RpcHandler that handles messages for

NettyBlockTransferService.

NettyBlockRpcServer is created when…​FIXME

NettyBlockRpcServer uses a OneForOneStreamManager for…​FIXME

Table 1. NettyBlockRpcServer Messages

Message Behaviour
Obtaining local blocks and registering them with the
OpenBlocks
internal OneForOneStreamManager

UploadBlock Deserializes a block and stores it in BlockDataManager

Tip Enable TRACE logging level to see received messages in the logs.

Enable TRACE logging level for

org.apache.spark.network.netty.NettyBlockRpcServer logger to see what happens
inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.network.netty.NettyBlockRpcServer=TRACE

Refer to Logging.

Obtaining Local Blocks and Registering with Internal

OneForOneStreamManager  —  OpenBlocks Message
Handler
When OpenBlocks arrives, NettyBlockRpcServer requests block data (from
BlockDataManager ) for every block id in the message. The block data is a collection of

ManagedBuffer for every block id in the incoming message.

Note BlockDataManager is given when NettyBlockRpcServer is created.

NettyBlockRpcServer then registers a stream of ManagedBuffer s (for the blocks) with the

internal StreamManager under streamId .

36
NettyBlockRpcServer — NettyBlockTransferService’s RpcHandler

The internal StreamManager is OneForOneStreamManager and is created when

Note
NettyBlockRpcServer is created.

You should see the following TRACE message in the logs:

TRACE NettyBlockRpcServer: Registered streamId [streamId] with [size] buffers

In the end, NettyBlockRpcServer responds with a StreamHandle (with the streamId and the
number of blocks). The response is serialized as a ByteBuffer .

Deserializing Block and Storing in BlockDataManager  

—  UploadBlock Message Handler
When UploadBlock arrives, NettyBlockRpcServer deserializes the metadata of the input
message to get the StorageLevel and ClassTag of the block being uploaded.

metadata is serialized before NettyBlockTransferService sends a

Note UploadBlock message (using the internal JavaSerializer ) that is given as
serializer when NettyBlockRpcServer is created.

NettyBlockRpcServer creates a BlockId for the block id and requests the

BlockDataManager to store the block.

Note The BlockDataManager is passed in when NettyBlockRpcServer is created.

In the end, NettyBlockRpcServer responds with a 0 -capacity ByteBuffer .

Note UploadBlock is sent when NettyBlockTransferService uploads a block.

Creating NettyBlockRpcServer Instance

NettyBlockRpcServer takes the following when created:

Application ID

Serializer

BlockDataManager

NettyBlockRpcServer initializes the internal registries and counters.

Receiving RPC Messages —  receive Method

37
NettyBlockRpcServer — NettyBlockTransferService’s RpcHandler

receive(
client: TransportClient,
rpcMessage: ByteBuffer,
responseContext: RpcResponseCallback): Unit

Note receive is part of RpcHandler Contract to…​FIXME.

receive …​FIXME

38
BlockFetchingListener

BlockFetchingListener
BlockFetchingListener is the contract of EventListeners that want to be notified about

onBlockFetchSuccess and onBlockFetchFailure.

BlockFetchingListener is used when:

ShuffleClient, BlockTransferService, NettyBlockTransferService, and

ExternalShuffleClient are requested to fetch a sequence of blocks

BlockFetchStarter is requested to createAndStart

RetryingBlockFetcher and OneForOneBlockFetcher are created

package org.apache.spark.network.shuffle;

interface BlockFetchingListener extends EventListener {

void onBlockFetchSuccess(String blockId, ManagedBuffer data);
void onBlockFetchFailure(String blockId, Throwable exception);
}

Table 1. BlockFetchingListener Contract

Method Description
onBlockFetchSuccess Used when…​FIXME

onBlockFetchFailure Used when…​FIXME

Table 2. BlockFetchingListeners
BlockFetchingListener Description

RetryingBlockFetchListener

"Unnamed" in
ShuffleBlockFetcherIterator

"Unnamed" in
BlockTransferService

39
RetryingBlockFetcher

RetryingBlockFetcher
RetryingBlockFetcher is…​FIXME

RetryingBlockFetcher is created and immediately started when:

NettyBlockTransferService is requested to fetchBlocks (when maxIORetries is greater

than 0 which it is by default)

ExternalShuffleClient is requested to fetchBlocks (when maxIORetries is greater than

0 which it is by default)

RetryingBlockFetcher uses a BlockFetchStarter to createAndStart when requested to start

and later initiateRetry.

RetryingBlockFetcher uses outstandingBlocksIds internal registry of outstanding block IDs

to fetch that is initially the block IDs to fetch when created.

At initiateRetry, RetryingBlockFetcher prints out the following INFO message to the logs
(with the number of outstandingBlocksIds):

Retrying fetch ([retryCount]/[maxRetries]) for [size] outstanding blocks after [retryW

aitTime] ms

On onBlockFetchSuccess and onBlockFetchFailure, RetryingBlockFetchListener removes

the block ID from outstandingBlocksIds.

RetryingBlockFetcher uses a RetryingBlockFetchListener to remove block IDs from the

outstandingBlocksIds internal registry.

Creating RetryingBlockFetcher Instance

RetryingBlockFetcher takes the following when created:

TransportConf

BlockFetchStarter

Block IDs to fetch

BlockFetchingListener

Starting RetryingBlockFetcher —  start Method

40
RetryingBlockFetcher

void start()

start simply fetchAllOutstanding.

start is used when:

NettyBlockTransferService is requested to fetchBlocks (when

Note maxIORetries is greater than 0 which it is by default)

ExternalShuffleClient is requested to fetchBlocks (when maxIORetries is
greater than 0 which it is by default)

initiateRetry Internal Method

synchronized void initiateRetry()

initiateRetry …​FIXME

initiateRetry is used when:

RetryingBlockFetcher is requested to fetchAllOutstanding

Note
RetryingBlockFetchListener is requested to onBlockFetchFailure

fetchAllOutstanding Internal Method

void fetchAllOutstanding()

fetchAllOutstanding requests BlockFetchStarter to createAndStart for the

outstandingBlocksIds.

fetchAllOutstanding is used when RetryingBlockFetcher is requested to start

Note
and initiateRetry.

RetryingBlockFetchListener
RetryingBlockFetchListener is a BlockFetchingListener that RetryingBlockFetcher uses to

remove block IDs from the outstandingBlocksIds internal registry.

onBlockFetchSuccess Method

41
RetryingBlockFetcher

void onBlockFetchSuccess(String blockId, ManagedBuffer data)

Note onBlockFetchSuccess is part of BlockFetchingListener Contract to…​FIXME.

onBlockFetchSuccess …​FIXME

onBlockFetchFailure Method

void onBlockFetchFailure(String blockId, Throwable exception)

Note onBlockFetchFailure is part of BlockFetchingListener Contract to…​FIXME.

onBlockFetchFailure …​FIXME

42
BlockFetchStarter

BlockFetchStarter
BlockFetchStarter is the contract of…​FIXME…​to createAndStart.

void createAndStart(String[] blockIds, BlockFetchingListener listener)

throws IOException, InterruptedException;

createAndStart is used when:

ExternalShuffleClient is requested to fetchBlocks (when maxIORetries is 0 )

NettyBlockTransferService is requested to fetchBlocks (when maxIORetries is 0 )

RetryingBlockFetcher is requested to fetchAllOutstanding

43
Web UI — Spark Application’s Web Console

Web UI — Spark Application’s Web Console

Web UI (aka Application UI or webUI or Spark UI) is the web interface of a Spark
application to monitor and inspect Spark job executions in a web browser.

Figure 1. Welcome page - Jobs page

Every time you create a SparkContext in a Spark application you also launch an instance of
web UI. The web UI is available at http://[driverHostname]:4040 by default.

The default port can be changed using spark.ui.port configuration property.

Note SparkContext will increase the port if it is already taken until an open port is
found.

web UI comes with the following tabs (which may not all be visible immediately, but only
after the respective modules are in use, e.g. the SQL or Streaming tabs):

1. Jobs

2. Stages

3. Storage

4. Environment

5. Executors

You can use the web UI after the application has finished by persisting events
Tip
(using EventLoggingListener) and using Spark History Server.

44
Web UI — Spark Application’s Web Console

All the information that is displayed in web UI is available thanks to

Note JobProgressListener and other SparkListeners. One could say that web UI is a
web layer to Spark listeners.

45
Jobs

Jobs Tab
Jobs tab in web UI shows status of all Spark jobs in a Spark application (i.e. a
SparkContext).

Figure 1. Jobs Tab in Web UI

The Jobs tab is available under /jobs URL, i.e. http://localhost:4040/jobs.

Figure 2. Event Timeline in Jobs Tab

The Jobs tab consists of two pages, i.e. All Jobs and Details for Job pages.

Internally, the Jobs tab is represented by JobsTab.

Details for Job —  JobPage Page

When you click a job in AllJobsPage, you see the Details for Job page.

46
Jobs

Figure 3. Details for Job Page

JobPage is a WebUIPage that shows statistics and stage list for a given job.

Details for Job page is registered under /job URL, i.e. http://localhost:4040/jobs/job/?
id=0 and accepts one mandatory id request parameter as a job identifier.

When a job id is not found, you should see "No information to display for job ID" message.

Figure 4. "No information to display for job" in Details for Job Page
JobPage displays the job’s status, group (if available), and the stages per state: active,

pending, completed, skipped, and failed.

Note A job can be in a running, succeeded, failed or unknown state.

47
Jobs

Figure 5. Details for Job Page with Active and Pending Stages

48
Jobs

Figure 6. Details for Job Page with Four Stages

49
Stages

Stages Tab
Stages tab in web UI shows…​FIXME

Figure 1. Stages Tab in Web UI

The Stages tab is available under /stages URL, i.e. http://localhost:4040/stages.

Internally, the Stages tab is represented by StagesTab.

50
Storage

Storage Tab
Storage tab in web UI shows…​FIXME

Figure 1. Storage Tab in Web UI

The Storage tab is available under /storage URL, i.e. http://localhost:4040/storage.

Internally, the Storage tab is represented by StorageTab.

51
Environment

Environment Tab
Environment tab in web UI shows…​FIXME

Figure 1. Environment Tab in Web UI

The Environment tab is available under /environment URL, i.e.
http://localhost:4040/environment.

Internally, the Environment tab is represented by EnvironmentTab.

52
Executors

Executors Tab
Executors tab in web UI shows…​FIXME

Figure 1. Executors Tab in web UI (local mode)

The Executors tab is available under /executors URL, i.e. http://localhost:4040/executors.

Internally, the Executors tab is represented by ExecutorsTab.

What’s interesting in how Storage Memory is displayed in the Executors tab is that the default
in a way that is different from what the page displays (using the custom JavaScript

// local mode with spark.driver.memory 2g

// ./bin/spark-shell --conf spark.driver.memory=2g
// UnifiedMemoryManager reports 912MB
// You can see it after enabling INFO messages for BlockManagerMasterEndpoint

INFO BlockManagerMasterEndpoint: Registering block manager 192.168.1.8:54503 with

Note // custom JavaScript `formatBytes` function (from utils.js) reports...956.6MB

// See https://github.com/apache/spark/blob/master/core/src/main/resources/org/apache/spark
def formatBytes(bytes: Double) = {
val k = 1000
val i = math.floor(math.log(bytes) / math.log(k))
val maxMemoryWebUI = bytes / math.pow(k, i)
f"$maxMemoryWebUI%1.1f"
}
scala> println(formatBytes(maxMemory))
956.6

getExecInfo Method

getExecInfo(
listener: ExecutorsListener,
statusId: Int,
isActive: Boolean): ExecutorSummary

53
Executors

getExecInfo creates a ExecutorSummary .

Caution FIXME

Note getExecInfo is used when…​FIXME

Settings

spark.ui.threadDumpsEnabled
spark.ui.threadDumpsEnabled (default: true ) is to enable ( true ) or disable ( false )

ExecutorThreadDumpPage.

54
JobsTab

JobsTab
JobsTab is a SparkUITab with jobs prefix.

JobsTab is created exclusively when SparkUI is initialized.

JobsTab takes the following when created:

Parent SparkUI

AppStatusStore

When created, JobsTab creates the following pages and attaches them immediately:

AllJobsPage

JobPage

The Jobs tab uses JobProgressListener to access statistics of job executions in

Note
a Spark application to display.

handleKillRequest Method

handleKillRequest(request: HttpServletRequest): Unit

handleKillRequest …​FIXME

Note handleKillRequest is used when…​FIXME

55
AllJobsPage

AllJobsPage — Showing All Jobs in Web UI

AllJobsPage is a WebUIPage with an empty prefix.

AllJobsPage is created exclusively when JobsTab is created.

AllJobsPage renders a summary, an event timeline, and active, completed, and failed jobs

of a Spark application.

Tip Jobs (in any state) are displayed when their number is greater than 0 .

AllJobsPage displays the Summary section with the current Spark user, total uptime,

scheduling mode, and the number of jobs per status.

Note AllJobsPage uses JobProgressListener for Scheduling Mode .

Figure 1. Summary Section in Jobs Tab

Under the summary section is the Event Timeline section.

Figure 2. Event Timeline in Jobs Tab

Note AllJobsPage uses ExecutorsListener to build the event timeline.

56
AllJobsPage

Active Jobs, Completed Jobs, and Failed Jobs sections follow.

Figure 3. Job Status Section in Jobs Tab

Jobs are clickable, i.e. you can click on a job to see information about the stages of tasks
inside it.

When you hover over a job in Event Timeline not only you see the job legend but also the
job is highlighted in the Summary section.

Figure 4. Hovering Over Job in Event Timeline Highlights The Job in Status Section
The Event Timeline section shows not only jobs but also executors.

57
AllJobsPage

Figure 5. Executors in Event Timeline

Use Programmable Dynamic Allocation (using SparkContext ) to manage
Tip
executors for demo purposes.

Creating AllJobsPage Instance

AllJobsPage takes the following when created:

Parent JobsTab

AppStatusStore

58
JobPage

JobPage
JobPage is a WebUIPage with job prefix.

JobPage is created exclusively when JobsTab is created.

Creating JobPage Instance

JobPage takes the following when created:

Parent JobsTab

AppStatusStore

59
StagesTab — Stages for All Jobs

StagesTab — Stages for All Jobs

StagesTab is a SparkUITab with stages prefix.

StagesTab is created exclusively when SparkUI is initialized.

When created, StagesTab creates the following pages and attaches them immediately:

AllStagesPage

StagePage

PoolPage

Stages tab in web UI shows the current state of all stages of all jobs in a Spark application
(i.e. a SparkContext) with two optional pages for the tasks and statistics for a stage (when a
stage is selected) and pool details (when the application works in FAIR scheduling mode).

The title of the tab is Stages for All Jobs.

You can access the Stages tab under /stages URL, i.e. http://localhost:4040/stages.

With no jobs submitted yet (and hence no stages to display), the page shows nothing but the
title.

Figure 1. Stages Page Empty

The Stages page shows the stages in a Spark application per state in their respective
sections — Active Stages, Pending Stages, Completed Stages, and Failed Stages.

Figure 2. Stages Page With One Stage Completed

60
StagesTab — Stages for All Jobs

The state sections are only displayed when there are stages in a given state.
Note
Refer to Stages for All Jobs.

In FAIR scheduling mode you have access to the table showing the scheduler pools.

Figure 3. Fair Scheduler Pools Table

Internally, the page is represented by org.apache.spark.ui.jobs.StagesTab class.

The page uses the parent’s SparkUI to access required services, i.e. SparkContext,
SparkConf, JobProgressListener, RDDOperationGraphListener, and to know whether kill is
enabled or not.

StagesTab is created when…​FIXME

killEnabled flag

Caution FIXME

Creating StagesTab Instance

StagesTab takes the following when created:

SparkUI

AppStatusStore

Handling Request to Kill Stage (from web UI) 

—  handleKillRequest Method

handleKillRequest(request: HttpServletRequest): Unit

handleKillRequest …​FIXME

Note handleKillRequest is used when…​FIXME

61
StagesTab — Stages for All Jobs

62
AllStagesPage — Stages for All Jobs

Stages for All Jobs Page

AllStagesPage is a web page (section) that is registered with the Stages tab that displays all

stages in a Spark application - active, pending, completed, and failed stages with their count.

Figure 1. Stages Tab in web UI for FAIR scheduling mode (with pools only)
In FAIR scheduling mode you have access to the table showing the scheduler pools as well
as the pool names per stage.

Note Pool names are calculated using SparkContext.getAllPools.

Internally, AllStagesPage is a WebUIPage with access to the parent Stages tab and more
importantly the JobProgressListener to have access to current state of the entire Spark
application.

Rendering AllStagesPage (render method)

render(request: HttpServletRequest): Seq[Node]

render generates a HTML page to display in a web browser.

It uses the parent’s JobProgressListener to know about:

active stages (as activeStages )

pending stages (as pendingStages )

completed stages (as completedStages )

failed stages (as failedStages )

the number of completed stages (as numCompletedStages )

the number of failed stages (as numFailedStages )

Note Stage information is available as StageInfo object.

63
AllStagesPage — Stages for All Jobs

There are 4 different tables for the different states of stages - active, pending, completed,
and failed. They are displayed only when there are stages in a given state.

Figure 2. Stages Tab in web UI for FAIR scheduling mode (with pools and stages)
You could also notice "retry" for stage when it was retried.

Caution FIXME A screenshot

64
StagePage — Stage Details

StagePage — Stage Details
StagePage is a WebUIPage with stage prefix.

StagePage is created exclusively when StagesTab is created.

StagePage shows the task details for a stage given its id and attempt id.

Figure 1. Details for Stage

StagePage renders a page available under /stage URL that requires two request

parameters —  id and attempt , e.g. http://localhost:4040/stages/stage/?id=2&attempt=0.

StagePage uses the parent’s JobProgressListener and RDDOperationGraphListener to

calculate the metrics. More specifically, StagePage uses JobProgressListener 's

stageIdToData registry to access the stage for given stage id and attempt .

StagePage uses ExecutorsListener to display stdout and stderr logs of the executors in

Tasks section.

Tasks Section

65
StagePage — Stage Details

Figure 2. Tasks Section

Tasks paged table displays StageUIData that JobProgressListener collected for a stage and
stage attempt.

The section uses ExecutorsListener to access stdout and stderr logs for
Note
Executor ID / Host column.

Summary Metrics for Completed Tasks in Stage

The summary metrics table shows the metrics for the tasks in a given stage that have
already finished with SUCCESS status and metrics available.

The table consists of the following columns: Metric, Min, 25th percentile, Median, 75th
percentile, Max.

Figure 3. Summary Metrics for Completed Tasks in Stage

All the quantiles are doubles using TaskUIData.metrics (sorted in ascending
Note
order).

66
StagePage — Stage Details

The 1st row is Duration which includes the quantiles based on executorRunTime .

The 2nd row is the optional Scheduler Delay which includes the time to ship the task from
the scheduler to executors, and the time to send the task result from the executors to the
scheduler. It is not enabled by default and you should select Scheduler Delay checkbox
under Show Additional Metrics to include it in the summary table.

If Scheduler Delay is large, consider decreasing the size of tasks or decreasing

Tip
the size of task results.

The 3rd row is the optional Task Deserialization Time which includes the quantiles based
on executorDeserializeTime task metric. It is not enabled by default and you should select
Task Deserialization Time checkbox under Show Additional Metrics to include it in the
summary table.

The 4th row is GC Time which is the time that an executor spent paused for Java garbage
collection while the task was running (using jvmGCTime task metric).

The 5th row is the optional Result Serialization Time which is the time spent serializing the
task result on a executor before sending it back to the driver (using
resultSerializationTime task metric). It is not enabled by default and you should select

Result Serialization Time checkbox under Show Additional Metrics to include it in the
summary table.

The 6th row is the optional Getting Result Time which is the time that the driver spends
fetching task results from workers. It is not enabled by default and you should select Getting
Result Time checkbox under Show Additional Metrics to include it in the summary table.

If Getting Result Time is large, consider decreasing the amount of data returned
Tip
from each task.

If Tungsten is enabled (it is by default), the 7th row is the optional Peak Execution Memory
which is the sum of the peak sizes of the internal data structures created during shuffles,
aggregations and joins (using peakExecutionMemory task metric). For SQL jobs, this only
tracks all unsafe operators, broadcast joins, and external sort. It is not enabled by default
and you should select Peak Execution Memory checkbox under Show Additional Metrics
to include it in the summary table.

If the stage has an input, the 8th row is Input Size / Records which is the bytes and records
read from Hadoop or from a Spark storage (using inputMetrics.bytesRead and
inputMetrics.recordsRead task metrics).

If the stage has an output, the 9th row is Output Size / Records which is the bytes and
records written to Hadoop or to a Spark storage (using outputMetrics.bytesWritten and
outputMetrics.recordsWritten task metrics).

67
StagePage — Stage Details

If the stage has shuffle read there will be three more rows in the table. The first row is
Shuffle Read Blocked Time which is the time that tasks spent blocked waiting for shuffle
data to be read from remote machines (using shuffleReadMetrics.fetchWaitTime task
metric). The other row is Shuffle Read Size / Records which is the total shuffle bytes and
records read (including both data read locally and data read from remote executors using
shuffleReadMetrics.totalBytesRead and shuffleReadMetrics.recordsRead task metrics). And

the last row is Shuffle Remote Reads which is the total shuffle bytes read from remote
executors (which is a subset of the shuffle read bytes; the remaining shuffle data is read
locally). It uses shuffleReadMetrics.remoteBytesRead task metric.

If the stage has shuffle write, the following row is Shuffle Write Size / Records (using
shuffleWriteMetrics.bytesWritten and shuffleWriteMetrics.recordsWritten task metrics).

If the stage has bytes spilled, the following two rows are Shuffle spill (memory) (using
memoryBytesSpilled task metric) and Shuffle spill (disk) (using diskBytesSpilled task

metric).

Request Parameters
id is…​

attempt is…​

id and attempt uniquely identify the stage in

Note
JobProgressListener.stageIdToData to retrieve StageUIData .

task.page (default: 1 ) is…​

task.sort (default: Index )

task.desc (default: false )

task.pageSize (default: 100 )

task.prevPageSize (default: task.pageSize )

Metrics
Scheduler Delay is…​FIXME

Task Deserialization Time is…​FIXME

Result Serialization Time is…​FIXME

Getting Result Time is…​FIXME

Peak Execution Memory is…​FIXME

68
StagePage — Stage Details

Shuffle Read Time is…​FIXME

Executor Computing Time is…​FIXME

Shuffle Write Time is…​FIXME

Figure 4. DAG Visualization

69
StagePage — Stage Details

Figure 5. Event Timeline

Figure 6. Stage Task and Shuffle Stats

Aggregated Metrics by Executor

ExecutorTable table shows the following columns:

Executor ID

Address

Task Time

Total Tasks

Failed Tasks

Killed Tasks

Succeeded Tasks

(optional) Input Size / Records (only when the stage has an input)

(optional) Output Size / Records (only when the stage has an output)

(optional) Shuffle Read Size / Records (only when the stage read bytes for a shuffle)

(optional) Shuffle Write Size / Records (only when the stage wrote bytes for a shuffle)

70
StagePage — Stage Details

(optional) Shuffle Spill (Memory) (only when the stage spilled memory bytes)

(optional) Shuffle Spill (Disk) (only when the stage spilled bytes to disk)

Figure 7. Aggregated Metrics by Executor

It gets executorSummary from StageUIData (for the stage and stage attempt id) and creates
rows per executor.

It also requests BlockManagers (from JobProgressListener) to map executor ids to a pair of

host and port to display in Address column.

Accumulators
Stage page displays the table with named accumulators (only if they exist). It contains the
name and value of the accumulators.

Figure 8. Accumulators Section

The information with name and value is stored in AccumulableInfo (that is
Note
available in StageUIData).

Creating StagePage Instance

StagePage takes the following when created:

Parent StagesTab

AppStatusStore

71
PoolPage — Pool Details

PoolPage — Fair Scheduler Pool Details Page

PoolPage is a WebUIPage with pool prefix.

The Fair Scheduler Pool Details page shows information about a Schedulable pool and is
only available when a Spark application uses the FAIR scheduling mode (which is controlled
by spark.scheduler.mode setting).

Figure 1. Details Page for production Pool

PoolPage renders a page under /pool URL and requires one request parameter poolname

that is the name of the pool to display, e.g. http://localhost:4040/stages/pool/?

poolname=production. It is made up of two tables: Summary (with the details of the pool)
and Active Stages (with the active stages in the pool).

PoolPage is created exclusively when StagesTab is created.

PoolPage takes a StagesTab when created.

PoolPage uses the parent’s SparkContext to access information about the pool and

JobProgressListener for active stages in the pool (sorted by submissionTime in descending

order by default).

Summary Table
The Summary table shows the details of a Schedulable pool.

Figure 2. Summary for production Pool

It uses the following columns:

Pool Name

72
PoolPage — Pool Details

Minimum Share

Pool Weight

Active Stages - the number of the active stages in a Schedulable pool.

Running Tasks

SchedulingMode

All the columns are the attributes of a Schedulable but the number of active stages which is
calculated using the list of active stages of a pool (from the parent’s JobProgressListener).

Active Stages Table

The Active Stages table shows the active stages in a pool.

Figure 3. Active Stages for production Pool

It uses the following columns:

Stage Id

(optional) Pool Name - only available when in FAIR scheduling mode.

Description

Submitted

Duration

Tasks: Succeeded/Total

Input — Bytes and records read from Hadoop or from Spark storage.

Output — Bytes and records written to Hadoop.

Shuffle Read — Total shuffle bytes and records read (includes both data read locally
and data read from remote executors).

Shuffle Write — Bytes and records written to disk in order to be read by a shuffle in a

future stage.

The table uses JobProgressListener for information per stage in the pool.

Request Parameters

73
PoolPage — Pool Details

poolname
poolname is the name of the scheduler pool to display on the page. It is a mandatory

request parameter.

74
StorageTab

StorageTab
StorageTab is a SparkUITab with storage prefix.

StorageTab is created exclusively when SparkUI is initialized.

StorageTab takes the following when created:

Parent SparkUI

AppStatusStore

When created, StorageTab creates the following pages and attaches them immediately:

StoragePage

RDDPage

75
StoragePage

StoragePage
StoragePage is a WebUIPage with an empty prefix.

StoragePage is created exclusively when StorageTab is created.

StoragePage takes the following when created:

Parent SparkUITab

AppStatusStore

Rendering HTML Table Row for RDD Details —  rddRow

Internal Method

rddRow(rdd: v1.RDDStorageInfo): Seq[Node]

rddRow …​FIXME

Note rddRow is used when…​FIXME

Rendering HTML Table with RDD Details —  rddTable

Method

rddTable(rdds: Seq[v1.RDDStorageInfo]): Seq[Node]

rddTable …​FIXME

Note rddTable is used when…​FIXME

receiverBlockTables Method

receiverBlockTables(blocks: Seq[StreamBlockData]): Seq[Node]

receiverBlockTables …​FIXME

Note receiverBlockTables is used when…​FIXME

Rendering Page —  render Method

76
StoragePage

render(request: HttpServletRequest): Seq[Node]

Note render is part of WebUIPage Contract to…​FIXME.

render requests the AppStatusStore for rddList and renders an HTML table with their

details (if available).

render requests the AppStatusStore for streamBlocksList and renders an HTML table with

receiver blocks (if available).

In the end, render requests UIUtils to headerSparkPage (with Storage title).

77
RDDPage

RDDPage
RDDPage is a WebUIPage with rdd prefix.

RDDPage is created exclusively when StorageTab is created.

RDDPage takes the following when created:

Parent SparkUITab

AppStatusStore

render Method

render(request: HttpServletRequest): Seq[Node]

Note render is part of WebUIPage Contract to…​FIXME.

render …​FIXME

78
EnvironmentTab

EnvironmentTab
EnvironmentTab is a SparkUITab with environment prefix.

EnvironmentTab is created exclusively when SparkUI is initialized.

EnvironmentTab takes the following when created:

Parent SparkUI

AppStatusStore

When created, EnvironmentTab creates the EnvironmentPage page and attaches it

immediately.

79
EnvironmentPage

EnvironmentPage
EnvironmentPage is a WebUIPage with an empty prefix.

EnvironmentPage is created exclusively when EnvironmentTab is created.

Creating EnvironmentPage Instance

EnvironmentPage takes the following when created:

Parent EnvironmentTab

SparkConf

AppStatusStore

80
ExecutorsTab

ExecutorsTab
ExecutorsTab is a SparkUITab with executors prefix.

ExecutorsTab is created exclusively when SparkUI is initialized.

ExecutorsTab takes the parent SparkUI when created.

When created, ExecutorsTab creates the following pages and attaches them immediately:

ExecutorsPage

ExecutorThreadDumpPage

ExecutorsTab uses ExecutorsListener to collect information about executors in a Spark

application.

81
ExecutorsPage

ExecutorsPage
ExecutorsPage is a WebUIPage with an empty prefix.

ExecutorsPage is created exclusively when ExecutorsTab is created.

Creating ExecutorsPage Instance

ExecutorsPage takes the following when created:

Parent SparkUITab

threadDumpEnabled flag

82
ExecutorThreadDumpPage

ExecutorThreadDumpPage
ExecutorThreadDumpPage is a WebUIPage with threadDump prefix.

ExecutorThreadDumpPage is created exclusively when ExecutorsTab is created (with

spark.ui.threadDumpsEnabled configuration property enabled).

spark.ui.threadDumpsEnabled configuration property is enabled (i.e. true ) by

Note
default.

Creating ExecutorThreadDumpPage Instance

ExecutorThreadDumpPage takes the following when created:

SparkUITab

Optional SparkContext

83
SparkUI — Web UI of Spark Application

SparkUI — Web UI of Spark Application

SparkUI is the web UI of a Spark application (aka Application UI).

SparkUI is created along with the following:

SparkContext (for a live Spark application with spark.ui.enabled configuration property

enabled)

FsHistoryProvider is requested for the application UI (for a live or completed Spark

application)

Figure 1. Creating SparkUI for Live Spark Application

When created (while SparkContext is created for a live Spark application), SparkUI gets
the following:

Live AppStatusStore (with a ElementTrackingStore using an InMemoryStore and a live

AppStatusListener)

Name of the Spark application that is exactly the value of spark.app.name configuration
property

Empty base path

When started, SparkUI binds to appUIAddress address that you can control using
SPARK_PUBLIC_DNS environment variable or spark.driver.host Spark property.

With spark.ui.killEnabled configuration property turned on, SparkUI allows to

Note kill jobs and stages (subject to SecurityManager.checkModifyPermissions
permissions).

SparkUI gets an AppStatusStore that is then used for the following:

Initializing tabs, i.e. JobsTab, StagesTab, StorageTab, EnvironmentTab

AbstractApplicationResource is requested for jobsList, oneJob, executorList,

allExecutorList, rddList, rddData, environmentInfo

84
SparkUI — Web UI of Spark Application

StagesResource is requested for stageList, stageData, oneAttemptData, taskSummary,

taskList

SparkUI is requested for the current Spark user

Creating Spark SQL’s SQLTab (when SQLHistoryServerPlugin is requested to

setupUI )

Spark Streaming’s BatchPage is created

Table 1. SparkUI’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
appId

Enable INFO logging level for org.apache.spark.ui.SparkUI logger to see what

happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.ui.SparkUI=INFO

Refer to Logging.

Assigning Unique Identifier of Spark Application 

—  setAppId Method

setAppId(id: String): Unit

setAppId sets the internal appId.

Note setAppId is used exclusively when SparkContext is initialized.

Stopping SparkUI  —  stop Method

stop(): Unit

stop stops the HTTP server and prints the following INFO message to the logs:

INFO SparkUI: Stopped Spark web UI at [appUIAddress]

85
SparkUI — Web UI of Spark Application

appUIAddress in the above INFO message is the result of appUIAddress

Note
method.

appUIAddress Method

appUIAddress: String

appUIAddress returns the entire URL of a Spark application’s web UI, including http://

scheme.

Internally, appUIAddress uses appUIHostPort.

Accessing Spark User —  getSparkUser Method

getSparkUser: String

getSparkUser returns the name of the user a Spark application runs as.

Internally, getSparkUser requests user.name System property from EnvironmentListener

Spark listener.

Note getSparkUser is used…​FIXME

createLiveUI Method

createLiveUI(
sc: SparkContext,
conf: SparkConf,
listenerBus: SparkListenerBus,
jobProgressListener: JobProgressListener,
securityManager: SecurityManager,
appName: String,
startTime: Long): SparkUI

createLiveUI creates a SparkUI for a live running Spark application.

Internally, createLiveUI simply forwards the call to create.

createLiveUI is called when SparkContext is created (and spark.ui.enabled is

Note
enabled).

86
SparkUI — Web UI of Spark Application

createHistoryUI Method

Caution FIXME

appUIHostPort Method

appUIHostPort: String

appUIHostPort returns the Spark application’s web UI which is the public hostname and

port, excluding the scheme.

Note appUIAddress uses appUIHostPort and adds http:// scheme.

getAppName Method

getAppName: String

getAppName returns the name of the Spark application (of a SparkUI instance).

Note getAppName is used when…​FIXME

Creating SparkUI Instance —  create Factory Method

create(
sc: Option[SparkContext],
store: AppStatusStore,
conf: SparkConf,
securityManager: SecurityManager,
appName: String,
basePath: String = "",
startTime: Long,
appSparkVersion: String = org.apache.spark.SPARK_VERSION): SparkUI

create creates a SparkUI backed by a AppStatusStore.

Internally, create simply creates a new SparkUI (with the predefined Spark version).

87
SparkUI — Web UI of Spark Application

create is used when:

SparkContext is created (for a running Spark application)

Note
FsHistoryProvider is requested to getAppUI (for a Spark application that
already finished)

Creating SparkUI Instance

SparkUI takes the following when created:

AppStatusStore

SparkContext

SparkConf

SecurityManager

Application name

basePath

Start time

appSparkVersion

SparkUI initializes the internal registries and counters and the tabs and handlers.

Attaching Tabs and Context Handlers —  initialize

Method

initialize(): Unit

Note initialize is part of WebUI Contract to initialize web components.

initialize creates and attaches the following tabs (with the reference to the SparkUI and

its AppStatusStore):

1. JobsTab

2. StagesTab

3. StorageTab

4. EnvironmentTab

88
SparkUI — Web UI of Spark Application

5. ExecutorsTab

In the end, initialize creates and attaches the following ServletContextHandlers :

1. Creates a static handler for serving files from a static directory, i.e. /static to serve
static files from org/apache/spark/ui/static directory (on CLASSPATH)

2. Creates a redirect handler to redirect / to /jobs/ (and so the Jobs tab is the
welcome tab when you open the web UI)

3. Creates the /api/* context handler for the Status REST API

4. Creates a redirect handler to redirect /jobs/job/kill to /jobs/ and request the

JobsTab to execute handleKillRequest before redirection

5. Creates a redirect handler to redirect /stages/stage/kill to /stages/ and request the

StagesTab to execute handleKillRequest before redirection

89
SparkUITab

SparkUITab
SparkUITab is the contract of WebUITab extensions with two additional properties:

appName

appSparkVersion

package org.apache.spark.ui

abstract class SparkUITab(parent: SparkUI, prefix: String)

extends WebUITab(parent, prefix) {
def appName: String
def appSparkVersion: String
}

Note SparkUITab is a private[spark] contract.

Table 1. SparkUITab Contract

Method Description
appName Used when…​FIXME

appSparkVersion Used when…​FIXME

Table 2. SparkUITabs
SparkUITab Description
EnvironmentTab

ExecutorsTab

JobsTab

StagesTab

StorageTab

SQLTab Used in Spark SQL module

StreamingTab Used in Spark Streaming module

ThriftServerTab Used in Spark Thrift Server

90
SparkUITab

91
BlockStatusListener Spark Listener

BlockStatusListener Spark Listener

BlockStatusListener is a SparkListener that tracks BlockManagers and the blocks for

Storage tab in web UI.

Table 1. BlockStatusListener Registries

Registry Description

blockManagers
The lookup table for a collection of BlockId and
BlockUIData per BlockManagerId.

Caution FIXME When are the events posted?

Table 2. BlockStatusListener Event Handlers

Event Handler Description

onBlockManagerAdded
Registers a BlockManager in blockManagers internal
registry (with no blocks).

onBlockManagerRemoved
Removes a BlockManager from blockManagers internal
registry.

Puts an updated BlockUIData for BlockId for

BlockManagerId in blockManagers internal registry.

onBlockUpdated
Ignores updates for unregistered BlockManager s or
non- StreamBlockId s.

For invalid StorageLevels (i.e. they do not use a memory

or a disk or no replication) the block is removed.

92
EnvironmentListener Spark Listener

EnvironmentListener Spark Listener

Caution FIXME

93
ExecutorsListener Spark Listener

ExecutorsListener Spark Listener

ExecutorsListener is a SparkListener that tracks executors and their tasks in a Spark

application for Stage Details page, Jobs tab and /allexecutors REST endpoint.

Table 1. ExecutorsListener’s SparkListener Callbacks (in alphabetical order)

Event Handler Description
May create an entry for the driver in
onApplicationStart
executorToTaskSummary registry

May create an entry in executorToTaskSummary registry.

It also makes sure that the number of entries for dead
executors does not exceed
onExecutorAdded spark.ui.retainedDeadExecutors and removes excess.
Adds an entry to executorEvents registry and optionally
removes the oldest if the number of entries exceeds
spark.ui.timeline.executors.maximum.

onExecutorBlacklisted FIXME

Marks an executor dead in executorToTaskSummary

registry.
onExecutorRemoved Adds an entry to executorEvents registry and optionally
removes the oldest if the number of entries exceeds
spark.ui.timeline.executors.maximum.

onExecutorUnblacklisted FIXME

onNodeBlacklisted FIXME

onNodeUnblacklisted FIXME

May create an entry for an executor in

onTaskStart
executorToTaskSummary registry.

May create an entry for an executor in

onTaskEnd
executorToTaskSummary registry.

ExecutorsListener requires a StorageStatusListener and SparkConf.

94
ExecutorsListener Spark Listener

Table 2. ExecutorsListener’s Internal Registries and Counters

Registry Description

The lookup table for ExecutorTaskSummary per executor

id.
executorToTaskSummary Used to build a ExecutorSummary for /allexecutors
REST endpoint, to display stdout and stderr logs in Tasks
and Aggregated Metrics by Executor sections in Stage
Details page.

A collection of SparkListenerEvents.
executorEvents
Used to build the event timeline in AllJobsPage and
Details for Job pages.

updateExecutorBlacklist Method

Caution FIXME

Intercepting Executor Was Blacklisted Events 

—  onExecutorBlacklisted Callback

Caution FIXME

Intercepting Executor Is No Longer Blacklisted Events 

—  onExecutorUnblacklisted Callback

Caution FIXME

Intercepting Node Was Blacklisted Events 

—  onNodeBlacklisted Callback

Caution FIXME

Intercepting Node Is No Longer Blacklisted Events 

—  onNodeUnblacklisted Callback

Caution FIXME

95
ExecutorsListener Spark Listener

Intercepting Application Started Events 

—  onApplicationStart Callback

onApplicationStart(applicationStart: SparkListenerApplicationStart): Unit

onApplicationStart is part of SparkListener contract to announce that a Spark

Note
application has been started.

onApplicationStart takes driverLogs property from the input applicationStart (if

defined) and finds the driver’s active StorageStatus (using the current
StorageStatusListener). onApplicationStart then uses the driver’s StorageStatus (if
defined) to set executorLogs .

Table 3. ExecutorTaskSummary and ExecutorInfo Attributes

SparkListenerApplicationStart
ExecutorTaskSummary Attribute
Attribute
executorLogs driverLogs (if defined)

Intercepting Executor Added Events 

—  onExecutorAdded Callback

onExecutorAdded(executorAdded: SparkListenerExecutorAdded): Unit

onExecutorAdded is part of SparkListener contract to announce that a new

Note
executor has been registered with the Spark application.

onExecutorAdded finds the executor (using the input executorAdded ) in the internal

executorToTaskSummary registry and sets the attributes. If not found, onExecutorAdded

creates a new entry.

Table 4. ExecutorTaskSummary and ExecutorInfo Attributes

ExecutorTaskSummary Attribute ExecutorInfo Attribute
executorLogs logUrlMap

totalCores totalCores

tasksMax totalCores / spark.task.cpus

96
ExecutorsListener Spark Listener

onExecutorAdded adds the input executorAdded to executorEvents collection. If the number

of elements in executorEvents collection is greater than

spark.ui.timeline.executors.maximum configuration property, the first/oldest event is
removed.

onExecutorAdded removes the oldest dead executor from executorToTaskSummary lookup

table if their number is greater than spark.ui.retainedDeadExecutors.

Intercepting Executor Removed Events 

—  onExecutorRemoved Callback

onExecutorRemoved(executorRemoved: SparkListenerExecutorRemoved): Unit

onExecutorRemoved is part of SparkListener contract to announce that an

Note
executor has been unregistered with the Spark application.

onExecutorRemoved adds the input executorRemoved to executorEvents collection. It then

removes the oldest event if the number of elements in executorEvents collection is greater
than spark.ui.timeline.executors.maximum configuration property.

The executor is marked as removed/inactive in executorToTaskSummary lookup table.

Intercepting Task Started Events —  onTaskStart

Callback

onTaskStart(taskStart: SparkListenerTaskStart): Unit

onTaskStart is part of SparkListener contract to announce that a task has been

Note
started.

onTaskStart increments tasksActive for the executor (using the input

SparkListenerTaskStart ).

Table 5. ExecutorTaskSummary and SparkListenerTaskStart Attributes

ExecutorTaskSummary Attribute Description
tasksActive Uses taskStart.taskInfo.executorId .

Intercepting Task End Events —  onTaskEnd Callback

97
ExecutorsListener Spark Listener

onTaskEnd(taskEnd: SparkListenerTaskEnd): Unit

Note onTaskEnd is part of SparkListener contract to announce that a task has ended.

onTaskEnd takes TaskInfo from the input taskEnd (if available).

Depending on the reason for SparkListenerTaskEnd onTaskEnd does the following:

Table 6. onTaskEnd Behaviour per SparkListenerTaskEnd Reason

SparkListenerTaskEnd
onTaskEnd Behaviour
Reason
Resubmitted Does nothing

ExceptionFailure Increment tasksFailed

anything Increment tasksComplete

tasksActive is decremented but only when the number of active tasks for the executor is

greater than 0 .

Table 7. ExecutorTaskSummary and onTaskEnd Behaviour

ExecutorTaskSummary Attribute Description
tasksActive Decremented if greater than 0.

duration Uses taskEnd.taskInfo.duration

If the TaskMetrics (in the input taskEnd ) is available, the metrics are added to the
taskSummary for the task’s executor.

98
ExecutorsListener Spark Listener

Table 8. Task Metrics and Task Summary

Task Summary Task Metric
inputBytes inputMetrics.bytesRead

inputRecords inputMetrics.recordsRead

outputBytes outputMetrics.bytesWritten

outputRecords outputMetrics.recordsWritten

shuffleRead shuffleReadMetrics.remoteBytesRead

shuffleWrite shuffleWriteMetrics.bytesWritten

jvmGCTime metrics.jvmGCTime

Finding Active BlockManagers 

—  activeStorageStatusList Method

activeStorageStatusList: Seq[StorageStatus]

activeStorageStatusList requests StorageStatusListener for active BlockManagers (on

executors).

activeStorageStatusList is used when:

FIXME
AllExecutorListResource does executorList
Note
ExecutorListResource does executorList

ExecutorsListener gets informed that the Spark application has started,

onNodeBlacklisted, and onNodeUnblacklisted

99
JobProgressListener Spark Listener

JobProgressListener Spark Listener

JobProgressListener is a SparkListener for web UI.

JobProgressListener intercepts the following Spark events.

Table 1. JobProgressListener Events

Handler Purpose

Creates a JobUIData. It updates jobGroupToJobIds,

onJobStart pendingStages, jobIdToData, activeJobs,
stageIdToActiveJobIds, stageIdToInfo and stageIdToData.

Removes an entry in activeJobs. It also removes entries

in pendingStages and stageIdToActiveJobIds. It updates
onJobEnd
completedJobs, numCompletedJobs, failedJobs,
numFailedJobs and skippedStages.

onStageCompleted Updates the StageUIData and JobUIData .

Updates the task’s StageUIData and JobUIData , and

onTaskStart
registers a new TaskUIData .

Updates the task’s StageUIData (and TaskUIData ),

onTaskEnd
ExecutorSummary , and JobUIData .

onExecutorMetricsUpdate

Sets schedulingMode property using the current

spark.scheduler.mode (from Spark Properties
environment details).
onEnvironmentUpdate
Used in AllJobsPage (for the Scheduling Mode), and to
display pools in JobsTab and StagesTab.

FIXME: Add the links/screenshots for pools.

onBlockManagerAdded
Records an executor and its block manager in the internal
executorIdToBlockManagerId registry.

onBlockManagerRemoved
Removes the executor from the internal
executorIdToBlockManagerId registry.

Records a Spark application’s start time (in the internal

startTime ).
onApplicationStart
Used in Jobs tab (for a total uptime and the event
timeline) and Job page (for the event timeline).

100
JobProgressListener Spark Listener

Records a Spark application’s end time (in the internal

onApplicationEnd endTime ).

Used in Jobs tab (for a total uptime).

Does nothing.
onTaskGettingResult
FIXME: Why is this event intercepted at all?!

updateAggregateMetrics Method

Caution FIXME

Registries and Counters

JobProgressListener uses registries to collect information about job executions.

101
JobProgressListener Spark Listener

Table 2. JobProgressListener Registries and Counters

Name Description
numCompletedStages

numFailedStages

stageIdToData
Holds StageUIData per stage, i.e. the stage and stage
attempt ids.

stageIdToInfo

stageIdToActiveJobIds

poolToActiveStages

activeJobs

completedJobs

failedJobs

jobIdToData

jobGroupToJobIds

pendingStages

activeStages

completedStages

skippedStages

failedStages

The lookup table for BlockManagerId per executor id.

Used to track block managers so the Stage page can

executorIdToBlockManagerId display Address in Aggregated Metrics by Executor.
FIXME: How does Executors page collect the very
same information?

onJobStart Callback

onJobStart(jobStart: SparkListenerJobStart): Unit

102
JobProgressListener Spark Listener

onJobStart creates a JobUIData. It updates jobGroupToJobIds, pendingStages,

jobIdToData, activeJobs, stageIdToActiveJobIds, stageIdToInfo and stageIdToData.

onJobStart reads the optional Spark Job group id as spark.jobGroup.id (from properties

in the input jobStart ).

onJobStart then creates a JobUIData using the input jobStart with status attribute set

to JobExecutionStatus.RUNNING and records it in jobIdToData and activeJobs registries.

onJobStart looks the job ids for the group id (in jobGroupToJobIds registry) and adds the

job id.

The internal pendingStages is updated with StageInfo for the stage id (for every StageInfo
in SparkListenerJobStart.stageInfos collection).

onJobStart records the stages of the job in stageIdToActiveJobIds.

onJobStart records StageInfos in stageIdToInfo and stageIdToData.

onJobEnd Method

onJobEnd(jobEnd: SparkListenerJobEnd): Unit

onJobEnd removes an entry in activeJobs. It also removes entries in pendingStages and

stageIdToActiveJobIds. It updates completedJobs, numCompletedJobs, failedJobs,

numFailedJobs and skippedStages.

onJobEnd removes the job from activeJobs registry. It removes stages from pendingStages

registry.

When completed successfully, the job is added to completedJobs registry with status
attribute set to JobExecutionStatus.SUCCEEDED . numCompletedJobs gets incremented.

When failed, the job is added to failedJobs registry with status attribute set to
JobExecutionStatus.FAILED . numFailedJobs gets incremented.

For every stage in the job, the stage is removed from the active jobs (in
stageIdToActiveJobIds) that can remove the entire entry if no active jobs exist.

Every pending stage in stageIdToInfo gets added to skippedStages.

onExecutorMetricsUpdate Method

103
JobProgressListener Spark Listener

onExecutorMetricsUpdate(executorMetricsUpdate: SparkListenerExecutorMetricsUpdate): Un
it

onTaskStart Method

onTaskStart(taskStart: SparkListenerTaskStart): Unit

onTaskStart updates StageUIData and JobUIData , and registers a new TaskUIData .

onTaskStart takes TaskInfo from the input taskStart .

onTaskStart looks the StageUIData for the stage and stage attempt ids up (in

stageIdToData registry).

onTaskStart increments numActiveTasks and puts a TaskUIData for the task in

stageData.taskData .

Ultimately, onTaskStart looks the stage in the internal stageIdToActiveJobIds and for each
active job reads its JobUIData (from jobIdToData). It then increments numActiveTasks .

onTaskEnd Method

onTaskEnd(taskEnd: SparkListenerTaskEnd): Unit

onTaskEnd updates the StageUIData (and TaskUIData ), ExecutorSummary , and JobUIData .

onTaskEnd takes TaskInfo from the input taskEnd .

onTaskEnd does its processing when the TaskInfo is available and

Note
stageAttemptId is not -1 .

onTaskEnd looks the StageUIData for the stage and stage attempt ids up (in stageIdToData

registry).

onTaskEnd saves accumulables in the StageUIData .

onTaskEnd reads the ExecutorSummary for the executor (the task has finished on).

Depending on the task end’s reason onTaskEnd increments succeededTasks , killedTasks

or failedTasks counters.

onTaskEnd adds the task’s duration to taskTime .

onTaskEnd decrements the number of active tasks (in the StageUIData ).

104
JobProgressListener Spark Listener

Again, depending on the task end’s reason onTaskEnd computes errorMessage and
updates StageUIData .

FIXME Why is the same information in two different registries —  stageData

Caution
and execSummary ?!

If taskMetrics is available, updateAggregateMetrics is executed.

The task’s TaskUIData is looked up in stageData.taskData and updateTaskInfo and

updateTaskMetrics are executed. errorMessage is updated.

onTaskEnd makes sure that the number of tasks in StageUIData ( stageData.taskData ) is

not above spark.ui.retainedTasks and drops the excess.

Ultimately, onTaskEnd looks the stage in the internal stageIdToActiveJobIds and for each
active job reads its JobUIData (from jobIdToData). It then decrements numActiveTasks and
increments numCompletedTasks , numKilledTasks or numFailedTasks depending on the task’s
end reason.

onStageSubmitted Method

onStageSubmitted(stageSubmitted: SparkListenerStageSubmitted): Unit

onStageCompleted Method

onStageCompleted(stageCompleted: SparkListenerStageCompleted): Unit

onStageCompleted updates the StageUIData and JobUIData .

onStageCompleted reads stageInfo from the input stageCompleted and records it in

stageIdToInfo registry.

onStageCompleted looks the StageUIData for the stage and the stage attempt ids up in

stageIdToData registry.

onStageCompleted records accumulables in StageUIData .

onStageCompleted removes the stage from poolToActiveStages and activeStages registries.

If the stage completed successfully (i.e. has no failureReason ), onStageCompleted adds the
stage to completedStages registry and increments numCompletedStages counter. It trims
completedStages.

105
JobProgressListener Spark Listener

Otherwise, when the stage failed, onStageCompleted adds the stage to failedStages registry
and increments numFailedStages counter. It trims failedStages.

Ultimately, onStageCompleted looks the stage in the internal stageIdToActiveJobIds and for
each active job reads its JobUIData (from jobIdToData). It then decrements
numActiveStages . When completed successfully, it adds the stage to

completedStageIndices . With failure, numFailedStages gets incremented.

JobUIData

Caution FIXME

blockManagerIds method

blockManagerIds: Seq[BlockManagerId]

Caution FIXME

StageUIData
Caution FIXME

Settings
Table 3. Spark Properties
Setting Default Value Description

spark.ui.retainedJobs 1000
The number of jobs to hold
information about

spark.ui.retainedStages 1000
The number of stages to
hold information about

spark.ui.retainedTasks 100000
The number of tasks to
hold information about

106
StorageStatusListener Spark Listener

StorageStatusListener — Spark Listener for

Tracking BlockManagers
StorageStatusListener is a SparkListener that uses SparkListener callbacks to track status

of every BlockManager in a Spark application.

StorageStatusListener is created and registered when SparkUI is created. It is later used

to create ExecutorsListener and StorageListener Spark listeners.

Table 1. StorageStatusListener’s SparkListener Callbacks (in alphabetical order)

Callback Description
Adds an executor id with StorageStatus (with
BlockManager and maximum memory on the executor) to
executorIdToStorageStatus internal registry.
onBlockManagerAdded
Removes any other BlockManager that may have been
registered for the executor earlier in
deadExecutorStorageStatus internal registry.

Removes an executor from executorIdToStorageStatus

internal registry and adds the removed StorageStatus to
deadExecutorStorageStatus internal registry.
onBlockManagerRemoved
Removes the oldest StorageStatus when the number of
entries in deadExecutorStorageStatus is bigger than
spark.ui.retainedDeadExecutors.

Updates StorageStatus for an executor in

onBlockUpdated executorIdToStorageStatus internal registry, i.e. removes
a block for NONE storage level and updates otherwise.

Removes the RDD blocks for an unpersisted RDD (on

onUnpersistRDD every BlockManager registered as StorageStatus in
executorIdToStorageStatus internal registry).

107
StorageStatusListener Spark Listener

Table 2. StorageStatusListener’s Internal Registries and Counters

Name Description

Collection of StorageStatus of removed/inactive

BlockManagers .

Accessible using deadStorageStatusList method.

Adds an element when StorageStatusListener handles
deadExecutorStorageStatus a BlockManager being removed (possibly removing one
element from the head when the number of elements are
above spark.ui.retainedDeadExecutors property).
Removes an element when StorageStatusListener
handles a new BlockManager (per executor) so the
executor is not longer dead.

Lookup table of StorageStatus per executor (including

the driver).
Adds an entry when StorageStatusListener handles a
new BlockManager.
executorIdToStorageStatus
Removes an entry when StorageStatusListener handles
a BlockManager being removed.
Updates StorageStatus of an executor when
StorageStatusListener handles StorageStatus updates.

Updating Storage Status For Executor 

—  updateStorageStatus Method

Caution FIXME

Active BlockManagers (on Executors) 

—  storageStatusList Method

storageStatusList: Seq[StorageStatus]

storageStatusList gives a collection of StorageStatus (from executorIdToStorageStatus

internal registry).

108
StorageStatusListener Spark Listener

storageStatusList is used when:

StorageStatusListener removes the RDD blocks for an unpersisted RDD

Note
ExecutorsListener does activeStorageStatusList

StorageListener does activeStorageStatusList

deadStorageStatusList Method

deadStorageStatusList: Seq[StorageStatus]

deadStorageStatusList gives deadExecutorStorageStatus internal registry.

deadStorageStatusList is used when ExecutorsListener is requested for

Note
inactive/dead BlockManagers.

Removing RDD Blocks for Unpersisted RDD 

—  updateStorageStatus Internal Method

updateStorageStatus(unpersistedRDDId: Int)

updateStorageStatus takes active BlockManagers.

updateStorageStatus then finds RDD blocks for unpersistedRDDId RDD (for every

BlockManager ) and removes the blocks.

storageStatusList is used exclusively when StorageStatusListener is notified

Note
that an RDD was unpersisted.

109
StorageListener — Spark Listener for Tracking Persistence Status of RDD Blocks

StorageListener — Spark Listener for Tracking

Persistence Status of RDD Blocks
StorageListener is a BlockStatusListener that uses SparkListener callbacks to track

changes in the persistence status of RDD blocks in a Spark application.

Table 1. StorageListener’s SparkListener Callbacks (in alphabetical order)

Callback Description
onBlockUpdated Updates _rddInfoMap with the update to a single block.

Removes RDDInfo instances from _rddInfoMap that

onStageCompleted participated in the completed stage as well as the ones
that are no longer cached.

Updates _rddInfoMap registry with the names of every

onStageSubmitted RDDInfo in the submitted stage, possibly adding new
RDDInfo instances if they were not registered yet.

Removes an RDDInfo from _rddInfoMap registry for the

onUnpersistRDD
unpersisted RDD.

Table 2. StorageListener’s Internal Registries and Counters

Name Description
RDDInfo instances per IDs
_rddInfoMap
Used when…​FIXME

Creating StorageListener Instance

StorageListener takes the following when created:

StorageStatusListener

StorageListener initializes the internal registries and counters.

Note StorageListener is created when SparkUI is created.

Finding Active BlockManagers 

—  activeStorageStatusList Method

110
StorageListener — Spark Listener for Tracking Persistence Status of RDD Blocks

activeStorageStatusList: Seq[StorageStatus]

activeStorageStatusList requests StorageStatusListener for active BlockManagers (on

executors).

activeStorageStatusList is used when:

AllRDDResource does rddList and getRDDStorageInfo

Note
StorageListener updates registered RDDInfos (with block updates from
BlockManagers)

Intercepting Block Status Update Events 

—  onBlockUpdated Callback

onBlockUpdated(blockUpdated: SparkListenerBlockUpdated): Unit

onBlockUpdated creates a BlockStatus (from the input SparkListenerBlockUpdated ) and

updates registered RDDInfos (with block updates from BlockManagers) (passing in BlockId
and BlockStatus as a single-element collection of updated blocks).

onBlockUpdated is part of SparkListener contract to announce that there was a

Note
change in a block status (on a BlockManager on an executor).

Intercepting Stage Completed Events 

—  onStageCompleted Callback

onStageCompleted(stageCompleted: SparkListenerStageCompleted): Unit

onStageCompleted finds the identifiers of the RDDs that have participated in the completed

stage and removes them from _rddInfoMap registry as well as the RDDs that are no longer
cached.

onStageCompleted is part of SparkListener contract to announce that a stage

Note
has finished.

Intercepting Stage Submitted Events 

—  onStageSubmitted Callback

onStageSubmitted(stageSubmitted: SparkListenerStageSubmitted): Unit

111
StorageListener — Spark Listener for Tracking Persistence Status of RDD Blocks

onStageSubmitted updates _rddInfoMap registry with the names of every RDDInfo in

stageSubmitted , possibly adding new RDDInfo instances if they were not registered yet.

onStageSubmitted is part of SparkListener contract to announce that the

Note
missing tasks of a stage were submitted for execution.

Intercepting Unpersist RDD Events —  onUnpersistRDD

Callback

onUnpersistRDD(unpersistRDD: SparkListenerUnpersistRDD): Unit

onUnpersistRDD removes the RDDInfo from _rddInfoMap registry for the unpersisted RDD

(from unpersistRDD ).

onUnpersistRDD is part of SparkListener contract to announce that an RDD has

Note
been unpersisted.

Updating Registered RDDInfos (with Block Updates from

BlockManagers) —  updateRDDInfo Internal Method

updateRDDInfo(updatedBlocks: Seq[(BlockId, BlockStatus)]): Unit

updateRDDInfo finds the RDDs for the input updatedBlocks (for BlockIds).

Note updateRDDInfo finds BlockIds that are RDDBlockIds.

updateRDDInfo takes RDDInfo entries (in _rddInfoMap registry) for which there are blocks in

the input updatedBlocks and updates RDDInfos (using StorageStatus) (from

activeStorageStatusList).

updateRDDInfo is used exclusively when StorageListener gets notified about a

Note
change in a block status (on a BlockManager on an executor).

Updating RDDInfos (using StorageStatus) 

—  StorageUtils.updateRddInfo Method

updateRddInfo(rddInfos: Seq[RDDInfo], statuses: Seq[StorageStatus]): Unit

Caution FIXME

112
StorageListener — Spark Listener for Tracking Persistence Status of RDD Blocks

updateRddInfo is used when:

SparkContext is requested for storage status of cached RDDs

Note
StorageListener updates registered RDDInfos (with block updates from
BlockManagers)

113
RDDOperationGraphListener Spark Listener

RDDOperationGraphListener Spark Listener

Caution FIXME

114
WebUI — Framework For Web UIs

WebUI — Base Web UI
WebUI is the base of the web UIs in Apache Spark:

Active Spark applications

Spark History Server

Spark Standalone cluster manager

Spark on Mesos cluster manager

Note Spark on YARN uses a different web framework for the web UI.

WebUI is used as the parent of WebUITabs.

package org.apache.spark.ui

abstract class WebUI {

// only required methods that have no implementation
// the others follow
def initialize(): Unit
}

Note WebUI is a private[spark] contract.

Table 1. (Subset of) WebUI Contract

Method Description
Used in implementations only to let them initialize their
web components

initialize does not add anything special to

initialize the Scala type hierarchy but a common
name to use across WebUIs (that could also
Note
be possible without it). In other words,
initialize does not participate in any
design pattern or a type hierarchy.

WebUI is a Scala abstract class and cannot be created directly, but only as one of the web

UIs.

115
WebUI — Framework For Web UIs

Table 2. WebUIs
WebUI Description

HistoryServer Used in Spark History Server

MasterWebUI Used in Spark Standalone cluster manager

MesosClusterUI Used in Spark on Mesos cluster manager

SparkUI WebUI of a Spark application

WorkerWebUI Used in Spark Standalone cluster manager

Once bound to a Jetty HTTP server, WebUI is available at an HTTP port (and is used in the
web URL as boundPort ).

WebUI is available at a web URL, i.e. http://[publicHostName]:[boundPort] . The

publicHostName is…​FIXME and the boundPort is the port that the port the Jetty HTTP
Server bound to.

116
WebUI — Framework For Web UIs

Table 3. WebUI’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description

WebUITabs
tabs
Used when…​FIXME

ServletContextHandlers
handlers
Used when…​FIXME

ServletContextHandlers per WebUIPage

pageToHandlers
Used when…​FIXME

Optional ServerInfo (default: None )

serverInfo
Used when…​FIXME

Host name of the UI

publicHostName is either SPARK_PUBLIC_DNS environment
variable or spark.driver.host configuration property.
Defaults to the following if defined (in order):
publicHostName 1. SPARK_LOCAL_HOSTNAME environment variable

2. Host name of SPARK_LOCAL_IP environment variable

3. Utils.findLocalInetAddress

Used exclusively when WebUI is requested for the web

URL

className
Used when…​FIXME

Enable INFO or ERROR logging level for the corresponding loggers of the
WebUIs, e.g. org.apache.spark.ui.SparkUI , to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.ui=INFO

Refer to Logging.

Creating WebUI Instance

WebUI takes the following when created:

117
WebUI — Framework For Web UIs

SecurityManager

SSLOptions

Port number

SparkConf

basePath (default: empty)

Name (default: empty)

WebUI initializes the internal registries and counters.

WebUI is a Scala abstract class and cannot be created directly, but only as one
Note
of the implementations.

Detaching Page And Associated Handlers from UI 

—  detachPage Method

detachPage(page: WebUIPage): Unit

detachPage …​FIXME

Note detachPage is used when…​FIXME

Detaching Tab And Associated Pages from UI 

—  detachTab Method

detachTab(tab: WebUITab): Unit

detachTab …​FIXME

Note detachTab is used when…​FIXME

Detaching Handler —  detachHandler Method

detachHandler(handler: ServletContextHandler): Unit

detachHandler …​FIXME

Note detachHandler is used when…​FIXME

118
WebUI — Framework For Web UIs

Detaching Handler At Path —  detachHandler Method

detachHandler(path: String): Unit

detachHandler …​FIXME

Note detachHandler is used when…​FIXME

Attaching Page to UI —  attachPage Method

attachPage(page: WebUIPage): Unit

Internally, attachPage creates the path of the WebUIPage that is / (forward slash)
followed by the prefix of the page.

attachPage creates a HTTP request handler…​FIXME

attachPage is used when:

WebUI is requested to attach a WebUITab (the WebUIPages actually)

Note
HistoryServer, Spark Standalone’s MasterWebUI and WorkerWebUI , Spark
on Mesos' MesosClusterUI are requested to initialize

Attaching Tab And Associated Pages to UI —  attachTab

Method

attachTab(tab: WebUITab): Unit

attachTab attaches every WebUIPage of the input WebUITab.

In the end, attachTab adds the input WebUITab to WebUITab tabs.

Note attachTab is used when…​FIXME

Attaching Static Handler —  addStaticHandler Method

addStaticHandler(resourceBase: String, path: String): Unit

addStaticHandler …​FIXME

119
WebUI — Framework For Web UIs

Note addStaticHandler is used when…​FIXME

Attaching Handler to UI —  attachHandler Method

attachHandler(handler: ServletContextHandler): Unit

attachHandler simply adds the input Jetty ServletContextHandler to handlers registry and

requests the ServerInfo to addHandler (only if the ServerInfo is defined).

attachHandler is used when:

web UIs (i.e. HistoryServer, Spark Standalone’s MasterWebUI and

WorkerWebUI , Spark on Mesos' MesosClusterUI , SparkUI) are requested to
initialize
WebUI is requested to attach a page to web UI and addStaticHandler
Note
SparkContext is created (and attaches the driver metrics servlet handler to
the web UI)
HistoryServer is requested to attachSparkUI

Spark Standalone’s Master and Worker are requested to onStart (and

attach their metrics servlet handlers to the web ui)

getBasePath Method

getBasePath: String

getBasePath simply returns the base path.

getBasePath is used exclusively when WebUITab is requested for the base

Note
path.

Requesting Header Tabs —  getTabs Method

getTabs: Seq[WebUITab]

getTabs simply returns the registered tabs.

Note getTabs is used exclusively when WebUITab is requested for the header tabs.

120
WebUI — Framework For Web UIs

Requesting Handlers —  getHandlers Method

getHandlers: Seq[ServletContextHandler]

getHandlers simply returns the registered handlers.

Note getHandlers is used when…​FIXME

Binding UI to Jetty HTTP Server on Host —  bind Method

bind(): Unit

bind …​FIXME

Note bind is used when…​FIXME

Stopping UI —  stop Method

stop(): Unit

stop …​FIXME

Note stop is used when…​FIXME

121
WebUIPage — Contract of Pages in Web UI

WebUIPage — Contract of Pages in Web UI

WebUIPage is the contract of web pages of a WebUI that can be rendered in HTML and

JSON.

WebUIPage can be:

attached or detached from a WebUI

attached to a WebUITab

WebUIPage has a prefix that…​FIXME

package org.apache.spark.ui

abstract class WebUIPage(var prefix: String) {

def render(request: HttpServletRequest): Seq[Node]
def renderJson(request: HttpServletRequest): JValue = JNothing
}

Note WebUIPage is a private[spark] contract.

Table 1. WebUIPage Contract

Method Description

render
Used exclusively when WebUI is requested to attach a
page (and…​FIXME)

renderJson Used when…​FIXME

Table 2. WebUIPages
WebUIPage Description
AllExecutionsPage Used in Spark SQL module

AllJobsPage

AllStagesPage

ApplicationPage Used in Spark Standalone cluster manager

BatchPage Used in Spark Streaming module

DriverPage Used in Spark on Mesos module

122
WebUIPage — Contract of Pages in Web UI

EnvironmentPage

ExecutionPage Used in Spark SQL module

ExecutorsPage

ExecutorThreadDumpPage

HistoryPage Used in Spark History Server module

JobPage

LogPage Used in Spark Standalone cluster manager

MasterPage Used in Spark Standalone cluster manager

MesosClusterPage Used in Spark on Mesos module

PoolPage

RDDPage

StagePage

StoragePage

StreamingPage Used in Spark Streaming module

ThriftServerPage Used in Spark Thrift Server module

ThriftServerSessionPage Used in Spark Thrift Server module

WorkerPage Used in Spark Standalone cluster manager

123
WebUITab — Contract of Tabs in Web UI

WebUITab — Contract of Tabs in Web UI

WebUITab represents a tab in web UI with a name and pages.

WebUITab can be:

attached or detached from a WebUI

attached to a WebUITab

WebUITab is simply a collection of WebUIPages that can be attached to the tab.

WebUITab has a name (and defaults to prefix capitalized).

Note SparkUITab is the one and only implementation of WebUITab contract.

Note WebUITab is a private[spark] contract.

Attaching Page to Tab —  attachPage Method

attachPage(page: WebUIPage): Unit

attachPage prepends the page prefix (of the input WebUIPage ) with the tab prefix (with no

ending slash, i.e. / , if the page prefix is undefined).

In the end, attachPage adds the WebUIPage to pages registry.

Note attachPage is used when web UI tabs register their pages.

Requesting Base URI Path —  basePath Method

basePath: String

basePath requests the parent WebUI for the base path.

Note basePath is used when…​FIXME

Requesting Header Tabs —  headerTabs Method

headerTabs: Seq[WebUITab]

124
WebUITab — Contract of Tabs in Web UI

headerTabs requests the parent WebUI for the header tabs.

headerTabs is used exclusively when UIUtils is requested to

Note
headerSparkPage.

Creating WebUITab Instance

WebUITab takes the following when created:

Parent WebUI

Prefix

WebUITab initializes the internal registries and counters.

WebUITab is a Scala abstract class and cannot be created directly, but only as
Note
one of the implementations.

125
RDDStorageInfo

RDDStorageInfo
RDDStorageInfo contains information about RDD persistence:

RDD id

RDD name

Number of RDD partitions

Number of cached RDD partitions

Storage level ID

Memory used

Disk used

Data distribution (as Seq[RDDDataDistribution] )

Partitions (as Seq[RDDPartitionInfo]] )

RDDStorageInfo is created exclusively when LiveRDD is requested to doUpdate (when

requested to write).

RDDStorageInfo is used when:

1. web UI’s StoragePage is requested to render an HTML table row and an entire table for
RDD details

2. REST API’s AbstractApplicationResource is requested for rddList (at storage/rdd

path)

3. AppStatusStore is requested for rddList

126
RDDInfo

RDDInfo
RDDInfo is…​FIXME

127
LiveEntity

LiveEntity
LiveEntity is the contract of a live entity in Spark that…​FIXME

package org.apache.spark.status

abstract class LiveEntity {

// only required methods that have no implementation
// the others follow
protected def doUpdate(): Any
}

Note LiveEntity is a private[spark] contract.

Table 1. LiveEntity Contract

Method Description
doUpdate Used exclusivey when LiveEntity is requested to write.

LiveEntity tracks the last write time (in lastWriteTime internal registry).

write Method

write(store: ElementTrackingStore, now: Long, checkTriggers: Boolean = false): Unit

write requests the input ElementTrackingStore to write the updated value.

In the end, write records the time in the lastWriteTime.

write is used when:

1. AppStatusListener is requested to update

Note
2. SQLAppStatusListener is created (and registers a flush trigger) and
requested to update

128
LiveRDD

LiveRDD
LiveRDD is a LiveEntity that…​FIXME

LiveRDD is created exclusively when AppStatusListener is requested to handle

onStageSubmitted event

LiveRDD takes a RDDInfo when created.

doUpdate Method

doUpdate(): Any

Note doUpdate is part of LiveEntity Contract to…​FIXME.

doUpdate …​FIXME

129
UIUtils

UIUtils
UIUtils is a utility object for…​FIXME

headerSparkPage Method

headerSparkPage(
request: HttpServletRequest,
title: String,
content: => Seq[Node],
activeTab: SparkUITab,
refreshInterval: Option[Int] = None,
helpText: Option[String] = None,
showVisualization: Boolean = false,
useDataTables: Boolean = false): Seq[Node]

headerSparkPage …​FIXME

Note headerSparkPage is used when…​FIXME

130
JettyUtils

JettyUtils
JettyUtils is a set of utility methods for creating Jetty HTTP Server-specific components.

Table 1. JettyUtils’s Utility Methods

Name Description

createServlet Creates an HttpServlet

createStaticHandler Creates a Handler for a static content

createServletHandler Creates a ServletContextHandler for a path

createRedirectHandler

Creating ServletContextHandler for Path 

—  createServletHandler Method

createServletHandler(
path: String,
servlet: HttpServlet,
basePath: String): ServletContextHandler (1)
createServletHandler[T <: AnyRef](
path: String,
servletParams: ServletParams[T],
securityMgr: SecurityManager,
conf: SparkConf,
basePath: String = ""): ServletContextHandler (2)

1. Calls the first three-argument createServletHandler with

createServletHandler …​FIXME

createServletHandler is used when:

WebUI is requested to attachPage

Note
MetricsServlet is requested to getHandlers

Spark Standalone’s WorkerWebUI is requested to initialize

Creating HttpServlet —  createServlet Method

131
JettyUtils

createServlet[T <: AnyRef](

servletParams: ServletParams[T],
securityMgr: SecurityManager,
conf: SparkConf): HttpServlet

createServlet creates the X-Frame-Options header that can be either ALLOW-FROM with the

value of spark.ui.allowFramingFrom configuration property if defined or SAMEORIGIN .

createServlet creates a Java Servlets HttpServlet with support for GET requests.

When handling GET requests, the HttpServlet first checks view permissions of the remote
user (by requesting the SecurityManager to checkUIViewPermissions of the remote user).

Enable DEBUG logging level for org.apache.spark.SecurityManager logger to see what happens w
SecurityManager does the security check.

Add the following line to conf/log4j.properties :

log4j.logger.org.apache.spark.SecurityManager=DEBUG
Tip

You should see the following DEBUG message in the logs:

DEBUG SecurityManager: user=[user] aclsEnabled=[aclsEnabled] viewAcls=[viewAcls] viewAclsGrou

With view permissions check passed, the HttpServlet sends a response with the following:

FIXME

In case the view permissions didn’t allow to view the page, the HttpServlet sends an error
response with the following:

Status 403

Cache-Control header with "no-cache, no-store, must-revalidate"

Error message: "User is not authorized to access this page."

createServlet is used exclusively when JettyUtils is requested to

Note
createServletHandler.

Creating Handler For Static Content 

—  createStaticHandler Method

createStaticHandler(resourceBase: String, path: String): ServletContextHandler

132
JettyUtils

createStaticHandler creates a handler for serving files from a static directory

Internally, createStaticHandler creates a Jetty ServletContextHandler and sets

org.eclipse.jetty.servlet.Default.gzip init parameter to false .

createRedirectHandler creates a Jetty DefaultServlet.

Quoting the official documentation of Jetty’s DefaultServlet:

DefaultServlet The default servlet. This servlet, normally mapped to / ,
provides the handling for static content, OPTION and TRACE methods for
the context. The following initParameters are supported, these can be set
either on the servlet itself or as ServletContext initParameters with a prefix
of org.eclipse.jetty.servlet.Default.
Note
With that, org.eclipse.jetty.servlet.Default.gzip is to configure gzip init
parameter for Jetty’s DefaultServlet .
gzip If set to true, then static content will be served as gzip content
encoded if a matching resource is found ending with ".gz" (default false )
(deprecated: use precompressed)

createRedirectHandler resolves the resourceBase in the Spark classloader and, if

successful, sets resourceBase init parameter of the Jetty DefaultServlet to the URL.

Note resourceBase init parameter is used to replace the context resource base.

createRedirectHandler requests the ServletContextHandler to use the path as the context

path and register the DefaultServlet to serve it.

createRedirectHandler throws an Exception if the input resourceBase could not be

resolved.

Could not find resource path for Web UI: [resourceBase]

createStaticHandler is used when SparkUI, HistoryServer, Spark Standalone’s

Note MasterWebUI and WorkerWebUI , Spark on Mesos' MesosClusterUI are
requested to initialize.

createRedirectHandler Method

createRedirectHandler(
srcPath: String,
destPath: String,
beforeRedirect: HttpServletRequest => Unit = x => (),
basePath: String = "",
httpMethods: Set[String] = Set("GET")): ServletContextHandler

133
JettyUtils

createRedirectHandler …​FIXME

createRedirectHandler is used when SparkUI and Spark Standalone’s

Note
MasterWebUI are requested to initialize.

134
web UI Configuration Properties

web UI Configuration Properties

Table 1. web UI Configuration Properties
Default
Name Description
Value

Defines the URL to use in

ALLOW-FROM in X-Frame-Options
header (as described in
spark.ui.allowFramingFrom http://tools.ietf.org/html/rfc7034).
Used exclusively when
JettyUtils is requested to
create an HttpServlet.

spark.ui.consoleProgress.update.interval
200 Update interval, i.e. how often to
(ms) show the progress.

The flag to control whether the

spark.ui.enabled true web UI is started ( true ) or not
( false ).

The port web UI binds to.

If multiple SparkContext s
attempt to run on the same host
spark.ui.port 4040 (it is not possible to have two or
more Spark contexts on a single
JVM, though), they will bind to
successive ports beginning with
spark.ui.port .

Enables jobs and stages to be

killed from the web UI ( true )
or not ( false ).
Used exclusively when
spark.ui.killEnabled true
SparkUI is requested to
initialize (and registers the
redirect handlers for
/jobs/job/kill and
/stages/stage/kill URIs)

The maximum number of

entries in
executorToTaskSummary (in
ExecutorsListener ) and
spark.ui.retainedDeadExecutors 100

135
web UI Configuration Properties

deadExecutorStorageStatus (in
StorageStatusListener ) internal
registries.

Controls whether to create

spark.ui.showConsoleProgress true ConsoleProgressBar ( true ) or
not ( false ).

The maximum number of

spark.ui.timeline.executors.maximum 1000 entries in executorEvents
registry.

spark.ui.timeline.tasks.maximum 1000

136
Spark Metrics

Spark Metrics
Spark Metrics gives you execution metrics of Spark subsystems (aka metrics instances),
e.g. the driver of a Spark application or the master of a Spark Standalone cluster.

Spark Metrics uses Dropwizard Metrics 3.1.0 Java library for the metrics infrastructure.

Metrics is a Java library which gives you unparalleled insight into what your code does
in production.

Metrics provides a powerful toolkit of ways to measure the behavior of critical

components in your production environment.

MetricsSystem — Registry of Metrics Sources and Sinks of

Spark Subsystem
The main part of Spark Metrics is MetricsSystem which is a registry of metrics sources and
sinks of a Spark subsystem.

MetricsSystem uses Dropwizard Metrics' MetricRegistry that acts as the integration point

between Spark and the metrics library.

A Spark subsystem can access the MetricsSystem through the SparkEnv.metricsSystem

property.

val metricsSystem = SparkEnv.get.metricsSystem

MetricsConfig — Metrics System Configuration

MetricsConfig is the configuration of the MetricsSystem (i.e. metrics sources and sinks).

metrics.properties is the default metrics configuration file. It is configured using

spark.metrics.conf configuration property. The file is first loaded from the path directly before
using Spark’s CLASSPATH.

MetricsConfig also accepts a metrics configuration using spark.metrics.conf. -prefixed

configuration properties.

Spark comes with conf/metrics.properties.template file that is a template of metrics

configuration.

MetricsServlet Metrics Sink

137
Spark Metrics

Among the metrics sinks is MetricsServlet that is used when sink.servlet metrics sink is
configured in metrics configuration.

Caution FIXME Describe configuration files and properties

JmxSink Metrics Sink

Enable org.apache.spark.metrics.sink.JmxSink in metrics configuration.

You can then use jconsole to access Spark metrics through JMX.

*.sink.jmx.class=org.apache.spark.metrics.sink.JmxSink

Figure 1. jconsole and JmxSink in spark-shell

JSON URI Path

Metrics System is available at http://localhost:4040/metrics/json (for the default setup of a
Spark application).

$ http --follow http://localhost:4040/metrics/json

HTTP/1.1 200 OK
Cache-Control: no-cache, no-store, must-revalidate
Content-Length: 2200

138
Spark Metrics

Content-Type: text/json;charset=utf-8
Date: Sat, 25 Feb 2017 14:14:16 GMT
Server: Jetty(9.2.z-SNAPSHOT)
X-Frame-Options: SAMEORIGIN

{
"counters": {
"app-20170225151406-0000.driver.HiveExternalCatalog.fileCacheHits": {
"count": 0
},
"app-20170225151406-0000.driver.HiveExternalCatalog.filesDiscovered": {
"count": 0
},
"app-20170225151406-0000.driver.HiveExternalCatalog.hiveClientCalls": {
"count": 2
},
"app-20170225151406-0000.driver.HiveExternalCatalog.parallelListingJobCount":
{
"count": 0
},
"app-20170225151406-0000.driver.HiveExternalCatalog.partitionsFetched": {
"count": 0
}
},
"gauges": {
...
"timers": {
"app-20170225151406-0000.driver.DAGScheduler.messageProcessingTime": {
"count": 0,
"duration_units": "milliseconds",
"m15_rate": 0.0,
"m1_rate": 0.0,
"m5_rate": 0.0,
"max": 0.0,
"mean": 0.0,
"mean_rate": 0.0,
"min": 0.0,
"p50": 0.0,
"p75": 0.0,
"p95": 0.0,
"p98": 0.0,
"p99": 0.0,
"p999": 0.0,
"rate_units": "calls/second",
"stddev": 0.0
}
},
"version": "3.0.0"
}

139
Spark Metrics

You can access a Spark subsystem’s MetricsSystem using its corresponding

Note "leading" port, e.g. 4040 for the driver , 8080 for Spark Standalone’s
master and applications .

Note You have to use the trailing slash ( / ) to have the output.

Spark Standalone Master

$ http http://192.168.1.4:8080/metrics/master/json/path
HTTP/1.1 200 OK
Cache-Control: no-cache, no-store, must-revalidate
Content-Length: 207
Content-Type: text/json;charset=UTF-8
Server: Jetty(8.y.z-SNAPSHOT)
X-Frame-Options: SAMEORIGIN

{
"counters": {},
"gauges": {
"master.aliveWorkers": {
"value": 0
},
"master.apps": {
"value": 0
},
"master.waitingApps": {
"value": 0
},
"master.workers": {
"value": 0
}
},
"histograms": {},
"meters": {},
"timers": {},
"version": "3.0.0"
}

140
MetricsSystem

MetricsSystem — Registry of Metrics Sources

and Sinks of Spark Subsystem
MetricsSystem is a registry of metrics sources and sinks of a Spark subsystem, e.g. the

driver of a Spark application.

Figure 1. Creating MetricsSystem for Driver

MetricsSystem may have at most one MetricsServlet JSON metrics sink (which is registered

by default).

When created, MetricsSystem requests MetricsConfig to initialize.

Figure 2. Creating MetricsSystem

141
MetricsSystem

Table 1. Metrics Instances (Subsystems) and MetricsSystems

Name When Created
applications Spark Standalone’s Master is created.

driver SparkEnv is created for the driver.

executor SparkEnv is created for an executor.

master Spark Standalone’s Master is created.

mesos_cluster Spark on Mesos' MesosClusterScheduler is created.

shuffleService ExternalShuffleService is created.

worker Spark Standalone’s Worker is created.

MetricsSystem uses MetricRegistry as the integration point to Dropwizard Metrics library.

142
MetricsSystem

Table 2. MetricsSystem’s Internal Registries and Counters

Name Description

MetricsConfig
metricsConfig Initialized when MetricsSystem is created.
Used when MetricsSystem registers sinks and sources.

MetricsServlet JSON metrics sink that is only available for

the metrics instances with a web UI, i.e. the driver of a
Spark application and Spark Standalone’s Master .
metricsServlet Initialized when MetricsSystem registers sinks (and finds
a configuration entry with servlet sink name).
Used exclusively when MetricsSystem is requested for a
JSON servlet handler.

Dropwizard Metrics' MetricRegistry

Used when MetricsSystem is requested to:
registry register a metrics source
remove a metrics source
start (that in turn registers metrics sinks)

Flag that indicates whether MetricsSystem has been

running started ( true ) or not ( false )
Default: false

Metrics sinks in a Spark application.

sinks
Used when MetricsSystem registers a new metrics sink
and starts them eventually.

Metrics sources in a Spark application.

sources
Used when MetricsSystem registers a new metrics
source.

143
MetricsSystem

Enable WARN or ERROR logging levels for

org.apache.spark.metrics.MetricsSystem logger to see what happens in
MetricsSystem .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.metrics.MetricsSystem=WARN

Refer to Logging.

"Static" Metrics Sources for Spark SQL — StaticSources

Caution FIXME

Registering Metrics Source —  registerSource Method

registerSource(source: Source): Unit

registerSource adds source to sources internal registry.

registerSource creates an identifier for the metrics source and registers it with

MetricRegistry.

registerSource uses Metrics' MetricRegistry.register to register a metrics

Note
source under a given name.

When registerSource tries to register a name more than once, you should see the following
INFO message in the logs:

INFO Metrics already registered

144
MetricsSystem

registerSource is used when:

SparkContext registers metrics sources for:

DAGScheduler
BlockManager

ExecutorAllocationManager (when dynamic allocation is enabled)

MetricsSystem is started (and registers the "static" metrics sources 
—  CodegenMetrics and HiveCatalogMetrics ) and does registerSources.
Executor is created (and registers a ExecutorSource)

ExternalShuffleService is started (and registers

Note ExternalShuffleServiceSource )

Spark Structured Streaming’s StreamExecution runs batches as data

arrives (when metrics are enabled).
Spark Streaming’s StreamingContext is started (and registers
StreamingSource )

Spark Standalone’s Master and Worker start (and register their

MasterSource and WorkerSource , respectively)

Spark Standalone’s Master registers a Spark application (and registers a

ApplicationSource )

Spark on Mesos' MesosClusterScheduler is started (and registers a

MesosClusterSchedulerSource )

Building Metrics Source Identifier 

—  buildRegistryName Method

buildRegistryName(source: Source): String

buildRegistryName is used to build the metrics source identifiers for a Spark

Note application’s driver and executors, but also for other Spark framework’s
components (e.g. Spark Standalone’s master and workers).

buildRegistryName uses spark.metrics.namespace and spark.executor.id Spark

Note properties to differentiate between a Spark application’s driver and executors,
and the other Spark framework’s components.

(only when instance is driver or executor ) buildRegistryName builds metrics source

name that is made up of spark.metrics.namespace, spark.executor.id and the name of the
source .

145
MetricsSystem

buildRegistryName uses Dropwizard Metrics' MetricRegistry to build metrics

Note
source identifiers.

Caution FIXME Finish for the other components.

buildRegistryName is used when MetricsSystem registers or removes a metrics

Note
source.

Registering Metrics Sources for Spark Instance 

—  registerSources Internal Method

registerSources(): Unit

registerSources finds metricsConfig configuration for the metrics instance.

Note instance is defined when MetricsSystem is created.

registerSources finds the configuration of all the metrics sources for the subsystem (as

described with source. prefix).

For every metrics source, registerSources finds class property, creates an instance, and
in the end registers it.

When registerSources fails, you should see the following ERROR message in the logs
followed by the exception.

ERROR Source class [classPath] cannot be instantiated

Note registerSources is used exclusively when MetricsSystem is started.

Requesting JSON Servlet Handler 

—  getServletHandlers Method

getServletHandlers: Array[ServletContextHandler]

If the MetricsSystem is running and the MetricsServlet is defined for the metrics system,
getServletHandlers simply requests the MetricsServlet for the JSON servlet handler.

When MetricsSystem is not running getServletHandlers throws an

IllegalArgumentException .

146
MetricsSystem

Can only call getServletHandlers on a running MetricsSystem

getServletHandlers is used when:

SparkContext is created
Note
Spark Standalone’s Master and Worker are requested to start (as
onStart )

Registering Metrics Sinks —  registerSinks Internal

Method

registerSinks(): Unit

registerSinks requests the MetricsConfig for the configuration of the instance.

registerSinks requests the MetricsConfig for the configuration of all metrics sinks (i.e.

configuration entries that match ^sink\\.(.)\\.(.) regular expression).

For every metrics sink configuration, registerSinks takes class property and (if defined)
creates an instance of the metric sink using an constructor that takes the configuration,
MetricRegistry and SecurityManager.

For a single servlet metrics sink, registerSinks converts the sink to a MetricsServlet and
sets the metricsServlet internal registry.

For all other metrics sinks, registerSinks adds the sink to the sinks internal registry.

In case of an Exception , registerSinks prints out the following ERROR message to the
logs:

Sink class [classPath] cannot be instantiated

Note registerSinks is used exclusively when MetricsSystem is requested to start.

stop Method

stop(): Unit

stop …​FIXME

147
MetricsSystem

Note stop is used when…​FIXME

getSourcesByName Method

getSourcesByName(sourceName: String): Seq[Source]

getSourcesByName …​FIXME

Note getSourcesByName is used when…​FIXME

removeSource Method

removeSource(source: Source): Unit

removeSource …​FIXME

Note removeSource is used when…​FIXME

Creating MetricsSystem Instance

MetricsSystem takes the following when created:

Instance name

SparkConf

SecurityManager

MetricsSystem initializes the internal registries and counters.

When created, MetricsSystem requests MetricsConfig to initialize.

Note createMetricsSystem is used to create a new MetricsSystems instance instead.

Creating MetricsSystem Instance For Subsystem 

—  createMetricsSystem Factory Method

createMetricsSystem(
instance: String
conf: SparkConf
securityMgr: SecurityManager): MetricsSystem

148
MetricsSystem

createMetricsSystem returns a new MetricsSystem.

Note createMetricsSystem is used when a metrics instance is created.

Requesting Sinks to Report Metrics —  report Method

report(): Unit

report simply requests the registered metrics sinks to report metrics.

report is used when SparkContext, Executor, Spark Standalone’s Master

Note
and Worker , Spark on Mesos' MesosClusterScheduler are requested to stop

Starting MetricsSystem —  start Method

start(): Unit

start turns running flag on.

start can only be called once and throws an IllegalArgumentException when

Note
called multiple times.

start registers the "static" metrics sources for Spark SQL, i.e. CodegenMetrics and

HiveCatalogMetrics .

start then registers the configured metrics sources and sinks for the Spark instance.

In the end, start requests the registered metrics sinks to start.

start throws an IllegalArgumentException when running flag is on.

requirement failed: Attempting to start a MetricsSystem that is already running

start is used when:

SparkContext is created

SparkEnv is created (on executors)

Note
ExternalShuffleService is requested to start

Spark Standalone’s Master and Worker , and Spark on Mesos'

MesosClusterScheduler are requested to start

149
MetricsSystem

150
MetricsConfig — Metrics System Configuration

MetricsConfig — Metrics System Configuration

MetricsConfig is the configuration of the MetricsSystem (i.e. metrics sources and sinks).

MetricsConfig is created when MetricsSystem is.

MetricsConfig uses metrics.properties as the default metrics configuration file. It is

configured using spark.metrics.conf configuration property. The file is first loaded from the
path directly before using Spark’s CLASSPATH.

MetricsConfig accepts a metrics configuration using spark.metrics.conf. -prefixed

configuration properties.

Spark comes with conf/metrics.properties.template file that is a template of metrics

configuration.

MetricsConfig makes sure that the default metrics properties are always defined.

Table 1. MetricsConfig’s Default Metrics Properties

Name Description
*.sink.servlet.class org.apache.spark.metrics.sink.MetricsServlet

*.sink.servlet.path /metrics/json

master.sink.servlet.path /metrics/master/json

applications.sink.servlet.path /metrics/applications/json

The order of precedence of metrics configuration settings is as follows:

1. Default metrics properties

Note 2. spark.metrics.conf configuration property or metrics.properties
configuration file

3. spark.metrics.conf. -prefixed Spark properties

MetricsConfig takes a SparkConf when created.

151
MetricsConfig — Metrics System Configuration

Table 2. MetricsConfig’s Internal Registries and Counters

Name Description

java.util.Properties with metrics properties

properties
Used to initialize per-subsystem’s
perInstanceSubProperties.

perInstanceSubProperties Lookup table of metrics properties per subsystem

Initializing MetricsConfig —  initialize Method

initialize(): Unit

initialize sets the default properties and loads configuration properties from a

configuration file (that is defined using spark.metrics.conf configuration property).

initialize takes all Spark properties that start with spark.metrics.conf. prefix from

SparkConf and adds them to properties (without the prefix).

In the end, initialize splits configuration per Spark subsystem with the default
configuration (denoted as * ) assigned to all subsystems afterwards.

initialize accepts * (star) for the default configuration or any combination

Note
of lower- and upper-case letters for Spark subsystem names.

Note initialize is used exclusively when MetricsSystem is created.

setDefaultProperties Internal Method

setDefaultProperties(prop: Properties): Unit

setDefaultProperties sets the default properties (in the input prop ).

Note setDefaultProperties is used exclusively when MetricsConfig is initialized.

Loading Custom Metrics Configuration File or

metrics.properties —  loadPropertiesFromFile Method

loadPropertiesFromFile(path: Option[String]): Unit

152
MetricsConfig — Metrics System Configuration

loadPropertiesFromFile tries to open the input path file (if defined) or the default metrics

configuration file metrics.properties (on CLASSPATH).

If either file is available, loadPropertiesFromFile loads the properties (to properties registry).

In case of exceptions, you should see the following ERROR message in the logs followed by
the exception.

ERROR Error loading configuration file [file]

Note loadPropertiesFromFile is used exclusively when MetricsConfig is initialized.

Grouping Properties Per Subsystem —  subProperties

Method

subProperties(prop: Properties, regex: Regex): mutable.HashMap[String, Properties]

subProperties takes prop properties and destructures keys given regex . subProperties

takes the matching prefix (of a key per regex ) and uses it as a new key with the value(s)
being the matching suffix(es).

driver.hello.world => (driver, (hello.world))

subProperties is used when MetricsConfig is initialized (to apply the default

Note metrics configuration) and when MetricsSystem registers metrics sources and
sinks.

getInstance Method

getInstance(inst: String): Properties

getInstance …​FIXME

Note getInstance is used when…​FIXME

153
Source — Contract of Metrics Sources

Source — Contract of Metrics Sources

Source is a contract of metrics sources.

package org.apache.spark.metrics.source

trait Source {
def sourceName: String
def metricRegistry: MetricRegistry
}

Note Source is a private[spark] contract.

Table 1. Source Contract

Method Description
sourceName Used when…​FIXME

Dropwizard Metrics' MetricRegistry

metricRegistry
Used when…​FIXME

154
Source — Contract of Metrics Sources

Table 2. Sources
Source Description
ApplicationSource

BlockManagerSource

CacheMetrics

CodegenMetrics

DAGSchedulerSource

ExecutorAllocationManagerSource

ExecutorSource

ExternalShuffleServiceSource

HiveCatalogMetrics

JvmSource

LiveListenerBusMetrics

MasterSource

MesosClusterSchedulerSource

ShuffleMetricsSource

StreamingSource

WorkerSource

155
Sink — Contract of Metrics Sinks

Sink — Contract of Metrics Sinks

Sink is a contract of metrics sinks.

package org.apache.spark.metrics.sink

trait Sink {
def start(): Unit
def stop(): Unit
def report(): Unit
}

Note Sink is a private[spark] contract.

Table 1. Sink Contract

Method Description
start Used when…​FIXME

stop Used when…​FIXME

report Used when…​FIXME

Table 2. Sinks
Sink Description
ConsoleSink

CsvSink

GraphiteSink

JmxSink

MetricsServlet

Slf4jSink

StatsdSink

All known Sinks in Spark 2.3 are in org.apache.spark.metrics.sink Scala

Note
package.

156
Sink — Contract of Metrics Sinks

157
MetricsServlet JSON Metrics Sink

MetricsServlet JSON Metrics Sink

MetricsServlet is a metrics sink that gives metrics snapshots in JSON format.

MetricsServlet is a "special" sink as it is only available to the metrics instances with a web

UI:

Driver of a Spark application

Spark Standalone’s Master and Worker

You can access the metrics from MetricsServlet at /metrics/json URI by default. The entire
URL depends on a metrics instance, e.g. http://localhost:4040/metrics/json/ for a running
Spark application.

158
MetricsServlet JSON Metrics Sink

$ http http://localhost:4040/metrics/json/
HTTP/1.1 200 OK
Cache-Control: no-cache, no-store, must-revalidate
Content-Length: 5005
Content-Type: text/json;charset=utf-8
Date: Mon, 11 Jun 2018 06:29:03 GMT
Server: Jetty(9.3.z-SNAPSHOT)
X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block

{
"counters": {
"local-1528698499919.driver.HiveExternalCatalog.fileCacheHits": {
"count": 0
},
"local-1528698499919.driver.HiveExternalCatalog.filesDiscovered": {
"count": 0
},
"local-1528698499919.driver.HiveExternalCatalog.hiveClientCalls": {
"count": 0
},
"local-1528698499919.driver.HiveExternalCatalog.parallelListingJobCount": {
"count": 0
},
"local-1528698499919.driver.HiveExternalCatalog.partitionsFetched": {
"count": 0
},
"local-1528698499919.driver.LiveListenerBus.numEventsPosted": {
"count": 7
},
"local-1528698499919.driver.LiveListenerBus.queue.appStatus.numDroppedEvents":
{
"count": 0
},
"local-1528698499919.driver.LiveListenerBus.queue.executorManagement.numDroppe
dEvents": {
"count": 0
}
},
...

MetricsServlet is created exclusively when MetricsSystem is started (and requested to

register metrics sinks).

MetricsServlet can be configured using configuration properties with sink.servlet prefix (in

metrics configuration). That is not required since MetricsConfig makes sure that
MetricsServlet is always configured.

159
MetricsServlet JSON Metrics Sink

MetricsServlet uses jackson-databind, the general data-binding package for Jackson (as

ObjectMapper) with Dropwizard Metrics library (i.e. registering a Coda Hale MetricsModule ).

Table 1. MetricsServlet’s Configuration Properties

Name Default Description
path /metrics/json/ Path URI prefix to bind to

sample false
Whether to show entire set of samples for
histograms

Table 2. MetricsServlet’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
Jaxson’s com.fasterxml.jackson.databind.ObjectMapper
that "provides functionality for reading and writing JSON,
either to and from basic POJOs (Plain Old Java Objects),
or to and from a general-purpose JSON Tree Model
(JsonNode), as well as related functionality for performing
mapper conversions."
When created, mapper is requested to register a Coda
Hale com.codahale.metrics.json.MetricsModule.

Used exclusively when MetricsServlet is requested to

getMetricsSnapshot.

servletPath Value of path configuration property

Flag to control whether to show samples ( true ) or not

( false ).
servletShowSample is the value of sample configuration
servletShowSample
property (if defined) or false .

Used when ObjectMapper is requested to register a Coda

Hale com.codahale.metrics.json.MetricsModule.

Creating MetricsServlet Instance

MetricsServlet takes the following when created:

Configuration Properties (as Java Properties )

Dropwizard Metrics' MetricRegistry

SecurityManager

MetricsServlet initializes the internal registries and counters.

160
MetricsServlet JSON Metrics Sink

Requesting Metrics Snapshot —  getMetricsSnapshot

Method

getMetricsSnapshot(request: HttpServletRequest): String

getMetricsSnapshot simply requests the Jackson ObjectMapper to serialize the

MetricRegistry to a JSON string (using ObjectMapper.writeValueAsString).

getMetricsSnapshot is used exclusively when MetricsServlet is requested to

Note
getHandlers.

Requesting JSON Servlet Handler —  getHandlers

Method

getHandlers(conf: SparkConf): Array[ServletContextHandler]

getHandlers returns just a single ServletContextHandler (in a collection) that gives metrics

snapshot in JSON format at every request at servletPath URI path.

getHandlers is used exclusively when MetricsSystem is requested for metrics

Note
ServletContextHandlers.

161
Metrics Configuration Properties

Metrics Configuration Properties

Table 1. Metrics Configuration Properties
Name Default Value Description
spark.metrics.conf metrics.properties The metrics configuration file.

Root namespace for metrics

reporting.
Since a Spark application’s ID
Spark application’s changes with every execution of a
ID (i.e. Spark application, a custom
spark.metrics.namespace spark.app.id spark.metrics.namespace can be
configuration specified for an easier metrics
property) reporting.
Used when MetricsSystem is
requested for a metrics source
identifier (aka metrics namespace)

162
Status REST API — Monitoring Spark Applications Using REST API

Status REST API — Monitoring Spark

Applications Using REST API
Status REST API is a collection of REST endpoints under /api/v1 URI path in the root
containers for application UI information:

SparkUI - Application UI for an active Spark application (i.e. a Spark application that is
still running)

HistoryServer - Application UI for active and completed Spark applications (i.e. Spark
applications that are still running or have already finished)

Status REST API uses ApiRootResource main resource class that registers /api/v1 URI
path and the subpaths.

Table 1. URI Paths

Path Description
applications Delegates to the ApplicationListResource resource class

applications/{appId} Delegates to the OneApplicationResource resource class

version Creates a VersionInfo with the current version of Spark

Status REST API uses the following components:

Jersey RESTful Web Services framework with support for the Java API for RESTful
Web Services (JAX-RS API)

Eclipse Jetty as the lightweight HTTP server and the Java Servlet container

163
ApiRootResource — /api/v1 URI Handler

ApiRootResource — /api/v1 URI Handler

ApiRootResource is the ApiRequestContext for the /v1 URI path.

ApiRootResource uses @Path("/v1") annotation at the class level. It is a partial URI path

template relative to the base URI of the server on which the resource is deployed, the
context root of the application, and the URL pattern to which the JAX-RS runtime responds.

Learn more about @Path annotation in The @Path Annotation and URI Path
Tip
Templates.

ApiRootResource registers the /api/* context handler (with the REST resources and

providers in org.apache.spark.status.api.v1 package).

With the @Path("/v1") annotation and after registering the /api/* context handler,
ApiRootResource serves HTTP requests for paths under the /api/v1 URI paths for SparkUI

and HistoryServer.

ApiRootResource gives the metrics of a Spark application in JSON format (using JAX-RS

API).

164
ApiRootResource — /api/v1 URI Handler

// start spark-shell
$ http http://localhost:4040/api/v1/applications
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Length: 257
Content-Type: application/json
Date: Tue, 05 Jun 2018 18:36:16 GMT
Server: Jetty(9.3.z-SNAPSHOT)
Vary: Accept-Encoding, User-Agent

[
{
"attempts": [
{
"appSparkVersion": "2.3.1-SNAPSHOT",
"completed": false,
"duration": 0,
"endTime": "1969-12-31T23:59:59.999GMT",
"endTimeEpoch": -1,
"lastUpdated": "2018-06-05T15:04:48.328GMT",
"lastUpdatedEpoch": 1528211088328,
"sparkUser": "jacek",
"startTime": "2018-06-05T15:04:48.328GMT",
"startTimeEpoch": 1528211088328
}
],
"id": "local-1528211089216",
"name": "Spark shell"
}
]

// Fixed in Spark 2.3.1

// https://issues.apache.org/jira/browse/SPARK-24188
$ http http://localhost:4040/api/v1/version
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Length: 43
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:19:06 GMT
Server: Jetty(9.3.z-SNAPSHOT)
Vary: Accept-Encoding, User-Agent

{
"spark": "2.3.1"
}

165
ApiRootResource — /api/v1 URI Handler

Table 1. ApiRootResource’s Paths

Path HTTP Method Description

applications
Delegates to the
ApplicationListResource resource class

applications/{appId}
Delegates to the
OneApplicationResource resource class

Creates a VersionInfo with the current

version GET
version of Spark

Creating /api/* Context Handler —  getServletHandler

Method

getServletHandler(uiRoot: UIRoot): ServletContextHandler

getServletHandler creates a Jetty ServletContextHandler for /api context path.

The Jetty ServletContextHandler created does not support HTTP sessions as

Note
REST API is stateless.

getServletHandler creates a Jetty ServletHolder with the resources and providers in

org.apache.spark.status.api.v1 package. It then registers the ServletHolder to serve /*

context path (under the ServletContextHandler for /api ).

getServletHandler requests UIRootFromServletContext to setUiRoot with the

ServletContextHandler and the input UIRoot.

getServletHandler is used when SparkUI and HistoryServer are requested to

Note
initialize.

166
ApplicationListResource — applications URI Handler

ApplicationListResource — applications URI
Handler
ApplicationListResource is a ApiRequestContext that ApiRootResource uses to handle

applications URI path.

Table 1. ApplicationListResource’s Paths

Path HTTP Method Description
/ GET appList

// start spark-shell
// there should be a single Spark application -- the spark-shell itself
$ http http://localhost:4040/api/v1/applications
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Length: 255
Content-Type: application/json
Date: Wed, 06 Jun 2018 12:40:33 GMT
Server: Jetty(9.3.z-SNAPSHOT)
Vary: Accept-Encoding, User-Agent

[
{
"attempts": [
{
"appSparkVersion": "2.3.1-SNAPSHOT",
"completed": false,
"duration": 0,
"endTime": "1969-12-31T23:59:59.999GMT",
"endTimeEpoch": -1,
"lastUpdated": "2018-06-06T12:30:19.220GMT",
"lastUpdatedEpoch": 1528288219220,
"sparkUser": "jacek",
"startTime": "2018-06-06T12:30:19.220GMT",
"startTimeEpoch": 1528288219220
}
],
"id": "local-1528288219790",
"name": "Spark shell"
}
]

isAttemptInRange Internal Method

167
ApplicationListResource — applications URI Handler

isAttemptInRange(
attempt: ApplicationAttemptInfo,
minStartDate: SimpleDateParam,
maxStartDate: SimpleDateParam,
minEndDate: SimpleDateParam,
maxEndDate: SimpleDateParam,
anyRunning: Boolean): Boolean

isAttemptInRange …​FIXME

isAttemptInRange is used exclusively when ApplicationListResource is

Note
requested to handle a GET / HTTP request.

appList Method

appList(
@QueryParam("status") status: JList[ApplicationStatus],
@DefaultValue("2010-01-01") @QueryParam("minDate") minDate: SimpleDateParam,
@DefaultValue("3000-01-01") @QueryParam("maxDate") maxDate: SimpleDateParam,
@DefaultValue("2010-01-01") @QueryParam("minEndDate") minEndDate: SimpleDateParam,
@DefaultValue("3000-01-01") @QueryParam("maxEndDate") maxEndDate: SimpleDateParam,
@QueryParam("limit") limit: Integer)
: Iterator[ApplicationInfo]

appList …​FIXME

Note appList is used when…​FIXME

168
OneApplicationResource — applications/appId URI Handler

OneApplicationResource — applications/appId
URI Handler
OneApplicationResource is a AbstractApplicationResource (and so a ApiRequestContext

indirectly) that ApiRootResource uses to handle applications/appId URI path.

Table 1. OneApplicationResource’s Paths

Path HTTP Method Description
/ GET getApp

// start spark-shell
// there should be a single Spark application -- the spark-shell itself
$ http http://localhost:4040/api/v1/applications
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Length: 255
Content-Type: application/json
Date: Wed, 06 Jun 2018 12:40:33 GMT
Server: Jetty(9.3.z-SNAPSHOT)
Vary: Accept-Encoding, User-Agent

[
{
"attempts": [
{
"appSparkVersion": "2.3.1-SNAPSHOT",
"completed": false,
"duration": 0,
"endTime": "1969-12-31T23:59:59.999GMT",
"endTimeEpoch": -1,
"lastUpdated": "2018-06-06T12:30:19.220GMT",
"lastUpdatedEpoch": 1528288219220,
"sparkUser": "jacek",
"startTime": "2018-06-06T12:30:19.220GMT",
"startTimeEpoch": 1528288219220
}
],
"id": "local-1528288219790",
"name": "Spark shell"
}
]

$ http http://localhost:4040/api/v1/applications/local-1528288219790
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Length: 255

169
OneApplicationResource — applications/appId URI Handler

Content-Type: application/json
Date: Wed, 06 Jun 2018 12:41:43 GMT
Server: Jetty(9.3.z-SNAPSHOT)
Vary: Accept-Encoding, User-Agent

{
"attempts": [
{
"appSparkVersion": "2.3.1-SNAPSHOT",
"completed": false,
"duration": 0,
"endTime": "1969-12-31T23:59:59.999GMT",
"endTimeEpoch": -1,
"lastUpdated": "2018-06-06T12:30:19.220GMT",
"lastUpdatedEpoch": 1528288219220,
"sparkUser": "jacek",
"startTime": "2018-06-06T12:30:19.220GMT",
"startTimeEpoch": 1528288219220
}
],
"id": "local-1528288219790",
"name": "Spark shell"
}

getApp Method

getApp(): ApplicationInfo

getApp requests the UIRoot for the application info (given the appId).

In the end, getApp returns the ApplicationInfo if available or reports a

NotFoundException :

unknown app: [appId]

170
StagesResource

StagesResource
StagesResource is…​FIXME

Table 1. StagesResource’s Paths

Path HTTP Method Description

GET stageList

{stageId: \d+} GET stageData

{stageId:
\d+}/{stageAttemptId: GET oneAttemptData
\d+}

{stageId:
\d+}/{stageAttemptId: GET taskSummary
\d+}/taskSummary

{stageId:
\d+}/{stageAttemptId: GET taskList
\d+}/taskList

stageList Method

stageList(@QueryParam("status") statuses: JList[StageStatus]): Seq[StageData]

stageList …​FIXME

Note stageList is used when…​FIXME

stageData Method

stageData(
@PathParam("stageId") stageId: Int,
@QueryParam("details") @DefaultValue("true") details: Boolean): Seq[StageData]

stageData …​FIXME

Note stageData is used when…​FIXME

oneAttemptData Method

171
StagesResource

oneAttemptData(
@PathParam("stageId") stageId: Int,
@PathParam("stageAttemptId") stageAttemptId: Int,
@QueryParam("details") @DefaultValue("true") details: Boolean): StageData

oneAttemptData …​FIXME

Note oneAttemptData is used when…​FIXME

taskSummary Method

taskSummary(
@PathParam("stageId") stageId: Int,
@PathParam("stageAttemptId") stageAttemptId: Int,
@DefaultValue("0.05,0.25,0.5,0.75,0.95") @QueryParam("quantiles") quantileString: St
ring)
: TaskMetricDistributions

taskSummary …​FIXME

Note taskSummary is used when…​FIXME

taskList Method

taskList(
@PathParam("stageId") stageId: Int,
@PathParam("stageAttemptId") stageAttemptId: Int,
@DefaultValue("0") @QueryParam("offset") offset: Int,
@DefaultValue("20") @QueryParam("length") length: Int,
@DefaultValue("ID") @QueryParam("sortBy") sortBy: TaskSorting): Seq[TaskData]

taskList …​FIXME

Note taskList is used when…​FIXME

172
OneApplicationAttemptResource

OneApplicationAttemptResource
OneApplicationAttemptResource is a AbstractApplicationResource (and so a

ApiRequestContext indirectly).

OneApplicationAttemptResource is used when AbstractApplicationResource is requested to

applicationAttempt.

Table 1. OneApplicationAttemptResource’s Paths

Path HTTP Method Description
/ GET getAttempt

// start spark-shell
// there should be a single Spark application -- the spark-shell itself
// CAUTION: FIXME Demo of OneApplicationAttemptResource in Action

getAttempt Method

getAttempt(): ApplicationAttemptInfo

getAttempt requests the UIRoot for the application info (given the appId) and finds the

attemptId among the available attempts.

Note appId and attemptId are path parameters.

In the end, getAttempt returns the ApplicationAttemptInfo if available or reports a

NotFoundException :

unknown app [appId], attempt [attemptId]

173
AbstractApplicationResource

AbstractApplicationResource
AbstractApplicationResource is a BaseAppResource with a set of URI paths that are

common across implementations.

174
AbstractApplicationResource

// start spark-shell
$ http http://localhost:4040/api/v1/applications
HTTP/1.1 200 OK
Content-Encoding: gzip
Content-Length: 257
Content-Type: application/json
Date: Tue, 05 Jun 2018 18:46:32 GMT
Server: Jetty(9.3.z-SNAPSHOT)
Vary: Accept-Encoding, User-Agent

[
{
"attempts": [
{
"appSparkVersion": "2.3.1-SNAPSHOT",
"completed": false,
"duration": 0,
"endTime": "1969-12-31T23:59:59.999GMT",
"endTimeEpoch": -1,
"lastUpdated": "2018-06-05T15:04:48.328GMT",
"lastUpdatedEpoch": 1528211088328,
"sparkUser": "jacek",
"startTime": "2018-06-05T15:04:48.328GMT",
"startTimeEpoch": 1528211088328
}
],
"id": "local-1528211089216",
"name": "Spark shell"
}
]

$ http http://localhost:4040/api/v1/applications/local-1528211089216/storage/rdd
HTTP/1.1 200 OK
Content-Length: 3
Content-Type: application/json
Date: Tue, 05 Jun 2018 18:48:00 GMT
Server: Jetty(9.3.z-SNAPSHOT)
Vary: Accept-Encoding, User-Agent

[]

// Execute the following query in spark-shell

spark.range(5).cache.count

$ http http://localhost:4040/api/v1/applications/local-1528211089216/storage/rdd
// output omitted for brevity

175
AbstractApplicationResource

Table 1. AbstractApplicationResources
AbstractApplicationResource Description

OneApplicationResource Handles applications/appId requests

OneApplicationAttemptResource

Table 2. AbstractApplicationResource’s Paths

Path HTTP Method Description
allexecutors GET allExecutorList

environment GET environmentInfo

executors GET executorList

jobs GET jobsList

jobs/{jobId: \\d+} GET oneJob

logs GET getEventLogs

stages stages

storage/rdd/{rddId:
\\d+} GET rddData

storage/rdd GET rddList

rddList Method

rddList(): Seq[RDDStorageInfo]

rddList …​FIXME

Note rddList is used when…​FIXME

environmentInfo Method

environmentInfo(): ApplicationEnvironmentInfo

environmentInfo …​FIXME

176
AbstractApplicationResource

Note environmentInfo is used when…​FIXME

rddData Method

rddData(@PathParam("rddId") rddId: Int): RDDStorageInfo

rddData …​FIXME

Note rddData is used when…​FIXME

allExecutorList Method

allExecutorList(): Seq[ExecutorSummary]

allExecutorList …​FIXME

Note allExecutorList is used when…​FIXME

executorList Method

executorList(): Seq[ExecutorSummary]

executorList …​FIXME

Note executorList is used when…​FIXME

oneJob Method

oneJob(@PathParam("jobId") jobId: Int): JobData

oneJob …​FIXME

Note oneJob is used when…​FIXME

jobsList Method

jobsList(@QueryParam("status") statuses: JList[JobExecutionStatus]): Seq[JobData]

177
AbstractApplicationResource

jobsList …​FIXME

Note jobsList is used when…​FIXME

178
BaseAppResource

BaseAppResource
BaseAppResource is the contract of ApiRequestContexts that can withUI and use appId and

attemptId path parameters in URI paths.

Table 1. BaseAppResource’s Path Parameters

Name Description
@PathParam("appId")
appId
Used when…​FIXME

@PathParam("attemptId")
attemptId
Used when…​FIXME

Table 2. BaseAppResources
BaseAppResource Description
AbstractApplicationResource

BaseStreamingAppResource

StagesResource

Note BaseAppResource is a private[v1] contract.

withUI Method

withUI[T](fn: SparkUI => T): T

withUI …​FIXME

Note withUI is used when…​FIXME

179
ApiRequestContext

ApiRequestContext
ApiRequestContext is the contract of…​FIXME

package org.apache.spark.status.api.v1

trait ApiRequestContext {
// only required methods that have no implementation
// the others follow
@Context
var servletContext: ServletContext = _

@Context
var httpRequest: HttpServletRequest = _
}

Note ApiRequestContext is a private[v1] contract.

Table 1. ApiRequestContext Contract

Method Description
Java Servlets' HttpServletRequest
httpRequest
Used when…​FIXME

Java Servlets' ServletContext

servletContext
Used when…​FIXME

Table 2. ApiRequestContexts
ApiRequestContext Description
ApiRootResource

ApiStreamingApp

ApplicationListResource

BaseAppResource

SecurityFilter

Getting Current UIRoot —  uiRoot Method

180
ApiRequestContext

uiRoot: UIRoot

uiRoot simply requests UIRootFromServletContext to get the current UIRoot (for the given

servletContext).

Note uiRoot is used when…​FIXME

181
UIRoot — Contract for Root Contrainers of Application UI Information

UIRoot — Contract for Root Contrainers of

Application UI Information
UIRoot is the contract of the root containers for application UI information.

package org.apache.spark.status.api.v1

trait UIRoot {
// only required methods that have no implementation
// the others follow
def withSparkUI[T](appId: String, attemptId: Option[String])(fn: SparkUI => T): T
def getApplicationInfoList: Iterator[ApplicationInfo]
def getApplicationInfo(appId: String): Option[ApplicationInfo]
def securityManager: SecurityManager
}

Note UIRoot is a private[spark] contract.

Table 1. UIRoot Contract

Method Description
getApplicationInfo Used when…​FIXME

getApplicationInfoList Used when…​FIXME

securityManager Used when…​FIXME

withSparkUI
Used exclusively when BaseAppResource is requested
withUI

Table 2. UIRoots
UIRoot Description
Application UI for active and completed Spark
HistoryServer applications (i.e. Spark applications that are still running
or have already finished)

Application UI for an active Spark application (i.e. a Spark

SparkUI
application that is still running)

writeEventLogs Method

182
UIRoot — Contract for Root Contrainers of Application UI Information

writeEventLogs(appId: String, attemptId: Option[String], zipStream: ZipOutputStream):

Unit

writeEventLogs …​FIXME

Note writeEventLogs is used when…​FIXME

183
UIRootFromServletContext

UIRootFromServletContext
UIRootFromServletContext manages the current UIRoot object in a Jetty ContextHandler .

UIRootFromServletContext uses its canonical name for the context attribute that is used to

set or get the current UIRoot object (in Jetty’s ContextHandler ).

ContextHandler is the environment for multiple Jetty Handlers , e.g. URI

Note
context path, class loader, static resource base.

In essence, UIRootFromServletContext is simply a "bridge" between two worlds, Spark’s

UIRoot and Jetty’s ContextHandler .

setUiRoot Method

setUiRoot(contextHandler: ContextHandler, uiRoot: UIRoot): Unit

setUiRoot …​FIXME

setUiRoot is used exclusively when ApiRootResource is requested to register

Note
/api/* context handler.

getUiRoot Method

getUiRoot(context: ServletContext): UIRoot

getUiRoot …​FIXME

getUiRoot is used exclusively when ApiRequestContext is requested for the

Note
current UIRoot.

184
Spark MLlib — Machine Learning in Spark

Spark MLlib
I’m new to Machine Learning as a discipline and Spark MLlib in particular so
Caution
mistakes in this document are considered a norm (not an exception).

Spark MLlib is a module (a library / an extension) of Apache Spark to provide distributed

machine learning algorithms on top of Spark’s RDD abstraction. Its goal is to simplify the
development and usage of large scale machine learning.

You can find the following types of machine learning algorithms in MLlib:

Classification

Regression

Frequent itemsets (via FP-growth Algorithm)

Recommendation

Feature extraction and selection

Clustering

Statistics

Linear Algebra

You can also do the following using MLlib:

Model import and export

Pipelines

There are two libraries for Machine Learning in Spark MLlib:

org.apache.spark.mllib for RDD-based Machine Learning and a higher-level
Note
API under org.apache.spark.ml for DataFrame-based Machine Learning with
Pipelines.

Machine Learning uses large datasets to identify (infer) patterns and make decisions (aka
predictions). Automated decision making is what makes Machine Learning so appealing.
You can teach a system from a dataset and let the system act by itself to predict future.

The amount of data (measured in TB or PB) is what makes Spark MLlib especially important
since a human could not possibly extract much value from the dataset in a short time.

Spark handles data distribution and makes the huge data available by means of RDDs,
DataFrames, and recently Datasets.

185
Spark MLlib — Machine Learning in Spark

Use cases for Machine Learning (and hence Spark MLlib that comes with appropriate
algorithms):

Security monitoring and fraud detection

Operational optimizations

Product recommendations or (more broadly) Marketing optimization

Ad serving and optimization

Concepts
This section introduces the concepts of Machine Learning and how they are modeled in
Spark MLlib.

Observation
An observation is used to learn about or evaluate (i.e. draw conclusions about) the
observed item’s target value.

Spark models observations as rows in a DataFrame .

Feature
A feature (aka dimension or variable) is an attribute of an observation. It is an independent
variable.

Spark models features as columns in a DataFrame (one per feature or a set of features).

Note Ultimately, it is up to an algorithm to expect one or many features per column.

There are two classes of features:

Categorical with discrete values, i.e. the set of possible values is limited, and can range
from one to many thousands. There is no ordering implied, and so the values are
incomparable.

Numerical with quantitative values, i.e. any numerical values that you can compare to
each other. You can further classify them into discrete and continuous features.

Label
A label is a variable that a machine learning system learns to predict that are assigned to
observations.

186
Spark MLlib — Machine Learning in Spark

There are categorical and numerical labels.

A label is a dependent variable that depends on other dependent or independent variables

like features.

FP-growth Algorithm
Spark 1.5 have significantly improved on frequent pattern mining capabilities with new
algorithms for association rule generation and sequential pattern mining.

Frequent Itemset Mining using the Parallel FP-growth algorithm (since Spark 1.3)

Frequent Pattern Mining in MLlib User Guide

frequent pattern mining

reveals the most frequently visited site in a particular period

finds popular routing paths that generate most traffic in a particular region

models its input as a set of transactions, e.g. a path of nodes.

A transaction is a set of items, e.g. network nodes.

the algorithm looks for common subsets of items that appear across transactions,
e.g. sub-paths of the network that are frequently traversed.

A naive solution: generate all possible itemsets and count their occurrence

A subset is considered a pattern when it appears in some minimum proportion of

all transactions - the support.

the items in a transaction are unordered

analyzing traffic patterns from network logs

the algorithm finds all frequent itemsets without generating and testing all
candidates

suffix trees (FP-trees) constructed and grown from filtered transactions

Also available in Mahout, but slower.

Distributed generation of association rules (since Spark 1.5).

in a retailer’s transaction database, a rule {toothbrush, floss} ⇒ {toothpaste} with

a confidence value 0.8 would indicate that 80% of customers who buy a
toothbrush and floss also purchase a toothpaste in the same transaction. The

187
Spark MLlib — Machine Learning in Spark

retailer could then use this information, put both toothbrush and floss on sale, but
raise the price of toothpaste to increase overall profit.

FPGrowth model

parallel sequential pattern mining (since Spark 1.5)

PrefixSpan algorithm with modifications to parallelize the algorithm for Spark.

extract frequent sequential patterns like routing updates, activation failures, and
broadcasting timeouts that could potentially lead to customer complaints and
proactively reach out to customers when it happens.

Power Iteration Clustering

since Spark 1.3

unsupervised learning including clustering

identifying similar behaviors among users or network clusters

Power Iteration Clustering (PIC) in MLlib, a simple and scalable graph clustering
method

PIC in MLlib User Guide

org.apache.spark.mllib.clustering.PowerIterationClustering

a graph algorithm

Among the first MLlib algorithms built upon GraphX.

takes an undirected graph with similarities defined on edges and outputs clustering
assignment on nodes

uses truncated power iteration to find a very low-dimensional embedding of the

nodes, and this embedding leads to effective graph clustering.

stores the normalized similarity matrix as a graph with normalized similarities

defined as edge properties

The edge properties are cached and remain static during the power iterations.

The embedding of nodes is defined as node properties on the same graph

topology.

update the embedding through power iterations, where aggregateMessages is

used to compute matrix-vector multiplications, the essential operation in a power
iteration method

188
Spark MLlib — Machine Learning in Spark

k-means is used to cluster nodes using the embedding.

able to distinguish clearly the degree of similarity – as represented by the Euclidean

distance among the points – even though their relationship is non-linear

Further reading or watching

Improved Frequent Pattern Mining in Spark 1.5: Association Rules and Sequential
Patterns

New MLlib Algorithms in Spark 1.3: FP-Growth and Power Iteration Clustering

(video) GOTO 2015 • A Taste of Random Decision Forests on Apache Spark • Sean
Owen

189
ML Pipelines (spark.ml)

ML Pipelines (spark.ml)
ML Pipeline API (aka Spark ML or spark.ml due to the package the API lives in) lets Spark
users quickly and easily assemble and configure practical distributed Machine Learning
pipelines (aka workflows) by standardizing the APIs for different Machine Learning concepts.

Both scikit-learn and GraphLab have the concept of pipelines built into their
Note
system.

The ML Pipeline API is a new DataFrame-based API developed under org.apache.spark.ml

package and is the primary API for MLlib as of Spark 2.0.

The previous RDD-based API under org.apache.spark.mllib package is in

Important maintenance-only mode which means that it is still maintained with bug
fixes but no new features are expected.

The key concepts of Pipeline API (aka spark.ml Components):

Pipeline

PipelineStage

Transformers

Models

Estimators

Evaluator

Params (and ParamMaps)

Figure 1. Pipeline with Transformers and Estimator (and corresponding Model)

The beauty of using Spark ML is that the ML dataset is simply a DataFrame (and all
calculations are simply UDF applications on columns).

190
ML Pipelines (spark.ml)

Use of a machine learning algorithm is only one component of a predictive analytic

workflow. There can also be additional pre-processing steps for the machine learning
algorithm to work.

While a RDD computation in Spark Core, a Dataset manipulation in Spark SQL,

Note a continuous DStream computation in Spark Streaming are the main data
abstractions a ML Pipeline is in Spark MLlib.

A typical standard machine learning workflow is as follows:

1. Loading data (aka data ingestion)

2. Extracting features (aka feature extraction)

3. Training model (aka model training)

4. Evaluate (or predictionize)

You may also think of two additional steps before the final model becomes production ready
and hence of any use:

1. Testing model (aka model testing)

2. Selecting the best model (aka model selection or model tuning)

3. Deploying model (aka model deployment and integration)

Note The Pipeline API lives under org.apache.spark.ml package.

Given the Pipeline Components, a typical machine learning pipeline is as follows:

You use a collection of Transformer instances to prepare input DataFrame - the dataset
with proper input data (in columns) for a chosen ML algorithm.

You then fit (aka build) a Model .

With a Model you can calculate predictions (in prediction column) on features input
column through DataFrame transformation.

Example: In text classification, preprocessing steps like n-gram extraction, and TF-IDF
feature weighting are often necessary before training of a classification model like an SVM.

Upon deploying a model, your system must not only know the SVM weights to apply to input
features, but also transform raw data into the format the model is trained on.

Pipeline for text categorization

Pipeline for image classification

Pipelines are like a query plan in a database system.

191
ML Pipelines (spark.ml)

Components of ML Pipeline:

Pipeline Construction Framework – A DSL for the construction of pipelines that

includes concepts of Nodes and Pipelines.

Nodes are data transformation steps (Transformers)

Pipelines are a DAG of Nodes.

Pipelines become objects that can be saved out and applied in real-time to new
data.

It can help creating domain-specific feature transformers, general purpose transformers,

statistical utilities and nodes.

You could persist (i.e. save to a persistent storage) or unpersist (i.e. load from a
persistent storage) ML components as described in Persisting Machine Learning
Components.

A ML component is any object that belongs to Pipeline API, e.g. Pipeline,

Note
LinearRegressionModel, etc.

Features of Pipeline API

The features of the Pipeline API in Spark MLlib:

DataFrame as a dataset format

ML Pipelines API is similar to scikit-learn

Easy debugging (via inspecting columns added during execution)

Parameter tuning

Compositions (to build more complex pipelines out of existing ones)

Pipelines
A ML pipeline (or a ML workflow) is a sequence of Transformers and Estimators to fit a
PipelineModel to an input dataset.

pipeline: DataFrame =[fit]=> DataFrame (using transformers and estimators)

A pipeline is represented by Pipeline class.

import org.apache.spark.ml.Pipeline

192
ML Pipelines (spark.ml)

Pipeline is also an Estimator (so it is acceptable to set up a Pipeline with other

Pipeline instances).

The Pipeline object can read or load pipelines (refer to Persisting Machine Learning
Components page).

read: MLReader[Pipeline]
load(path: String): Pipeline

You can create a Pipeline with an optional uid identifier. It is of the format
pipeline_[randomUid] when unspecified.

val pipeline = new Pipeline()

scala> println(pipeline.uid)
pipeline_94be47c3b709

val pipeline = new Pipeline("my_pipeline")

scala> println(pipeline.uid)
my_pipeline

The identifier uid is used to create an instance of PipelineModel to return from

fit(dataset: DataFrame): PipelineModel method.

scala> val pipeline = new Pipeline("my_pipeline")

pipeline: org.apache.spark.ml.Pipeline = my_pipeline

scala> val df = (0 to 9).toDF("num")

df: org.apache.spark.sql.DataFrame = [num: int]

scala> val model = pipeline.setStages(Array()).fit(df)

model: org.apache.spark.ml.PipelineModel = my_pipeline

The stages mandatory parameter can be set using setStages(value:

Array[PipelineStage]): this.type method.

Pipeline Fitting (fit method)

fit(dataset: DataFrame): PipelineModel

The fit method returns a PipelineModel that holds a collection of Transformer objects
that are results of Estimator.fit method for every Estimator in the Pipeline (with possibly-
modified dataset ) or simply input Transformer objects. The input dataset DataFrame is

193
ML Pipelines (spark.ml)

passed to transform for every Transformer instance in the Pipeline.

It first transforms the schema of the input dataset DataFrame.

It then searches for the index of the last Estimator to calculate Transformers for Estimator
and simply return Transformer back up to the index in the pipeline. For each Estimator the
fit method is called with the input dataset . The result DataFrame is passed to the next

Transformer in the chain.

An IllegalArgumentException exception is thrown when a stage is neither

Note
Estimator or Transformer .

transform method is called for every Transformer calculated but the last one (that is the

result of executing fit on the last Estimator ).

The calculated Transformers are collected.

After the last Estimator there can only be Transformer stages.

The method returns a PipelineModel with uid and transformers. The parent Estimator is
the Pipeline itself.

Further reading or watching

ML Pipelines

ML Pipelines: A New High-Level API for MLlib

(video) Building, Debugging, and Tuning Spark Machine Learning Pipelines - Joseph
Bradley (Databricks)

(video) Spark MLlib: Making Practical Machine Learning Easy and Scalable

(video) Apache Spark MLlib 2 0 Preview: Data Science and Production by Joseph K.
Bradley (Databricks)

194
Pipeline

Pipeline — ML Pipeline Component

Pipeline is a ML component in Spark MLlib 2 that…​FIXME

195
PipelineStage

PipelineStage — ML Pipeline Component

The PipelineStage abstract class represents a single stage in a Pipeline.

PipelineStage has the following direct implementations (of which few are abstract classes,

too):

Estimators

Models

Pipeline

Predictor

Transformer

Each PipelineStage transforms schema using transformSchema family of methods:

transformSchema(schema: StructType): StructType

transformSchema(schema: StructType, logging: Boolean): StructType

Note StructType describes a schema of a DataFrame.

Enable DEBUG logging level for the respective PipelineStage implementations to

Tip see what happens beneath.

196
Transformers

Transformers
A transformer is a ML Pipeline component that transforms a DataFrame into another
DataFrame (both called datasets).

transformer: DataFrame =[transform]=> DataFrame

Transformers prepare a dataset for an machine learning algorithm to work with. They are
also very helpful to transform DataFrames in general (even outside the machine learning
space).

Transformers are instances of org.apache.spark.ml.Transformer abstract class that offers

transform family of methods:

transform(dataset: DataFrame): DataFrame

transform(dataset: DataFrame, paramMap: ParamMap): DataFrame
transform(dataset: DataFrame, firstParamPair: ParamPair[_], otherParamPairs: ParamPair
[_]*): DataFrame

A Transformer is a PipelineStage and thus can be a part of a Pipeline.

A few available implementations of Transformer :

StopWordsRemover

Binarizer

SQLTransformer

VectorAssembler — a feature transformer that assembles (merges) multiple columns

into a (feature) vector column.

UnaryTransformer

Tokenizer

RegexTokenizer

NGram

HashingTF

OneHotEncoder

Model

197
Transformers

See Custom UnaryTransformer section for a custom Transformer implementation.

StopWordsRemover
StopWordsRemover is a machine learning feature transformer that takes a string array column

and outputs a string array column with all defined stop words removed. The transformer
comes with a standard set of English stop words as default (that are the same as scikit-learn
uses, i.e. from the Glasgow Information Retrieval Group).

It works as if it were a UnaryTransformer but it has not been migrated to extend

Note
the class yet.

StopWordsRemover class belongs to org.apache.spark.ml.feature package.

import org.apache.spark.ml.feature.StopWordsRemover
val stopWords = new StopWordsRemover

It accepts the following parameters:

scala> println(stopWords.explainParams)
caseSensitive: whether to do case-sensitive comparison during filtering (default: false
)
inputCol: input column name (undefined)
outputCol: output column name (default: stopWords_9c2c0fdd8a68__output)
stopWords: stop words (default: [Ljava.lang.String;@5dabe7c8)

null values from the input array are preserved unless adding null to
Note
stopWords explicitly.

198
Transformers

import org.apache.spark.ml.feature.RegexTokenizer
val regexTok = new RegexTokenizer("regexTok")
.setInputCol("text")
.setPattern("\\W+")

import org.apache.spark.ml.feature.StopWordsRemover
val stopWords = new StopWordsRemover("stopWords")
.setInputCol(regexTok.getOutputCol)

val df = Seq("please find it done (and empty)", "About to be rich!", "empty")

.zipWithIndex
.toDF("text", "id")

scala> stopWords.transform(regexTok.transform(df)).show(false)
+-------------------------------+---+------------------------------------+------------
-----+
|text |id |regexTok__output |stopWords__o
utput|
+-------------------------------+---+------------------------------------+------------
-----+
|please find it done (and empty)|0 |[please, find, it, done, and, empty]|[]
|
|About to be rich! |1 |[about, to, be, rich] |[rich]
|
|empty |2 |[empty] |[]
|
+-------------------------------+---+------------------------------------+------------
-----+

Binarizer
Binarizer is a Transformer that splits the values in the input column into two groups -

"ones" for values larger than the threshold and "zeros" for the others.

It works with DataFrames with the input column of DoubleType or VectorUDT. The type of
the result output column matches the type of the input column, i.e. DoubleType or
VectorUDT .

199
Transformers

import org.apache.spark.ml.feature.Binarizer
val bin = new Binarizer()
.setInputCol("rating")
.setOutputCol("label")
.setThreshold(3.5)

scala> println(bin.explainParams)
inputCol: input column name (current: rating)
outputCol: output column name (default: binarizer_dd9710e2a831__output, current: label
)
threshold: threshold used to binarize continuous features (default: 0.0, current: 3.5)

val doubles = Seq((0, 1d), (1, 1d), (2, 5d)).toDF("id", "rating")

scala> bin.transform(doubles).show
+---+------+-----+
| id|rating|label|
+---+------+-----+
| 0| 1.0| 0.0|
| 1| 1.0| 0.0|
| 2| 5.0| 1.0|
+---+------+-----+

import org.apache.spark.mllib.linalg.Vectors
val denseVec = Vectors.dense(Array(4.0, 0.4, 3.7, 1.5))
val vectors = Seq((0, denseVec)).toDF("id", "rating")

scala> bin.transform(vectors).show
+---+-----------------+-----------------+
| id| rating| label|
+---+-----------------+-----------------+
| 0|[4.0,0.4,3.7,1.5]|[1.0,0.0,1.0,0.0]|
+---+-----------------+-----------------+

SQLTransformer
SQLTransformer is a Transformer that does transformations by executing SELECT …​ FROM

THIS with THIS being the underlying temporary table registered for the input dataset.

Internally, THIS is replaced with a random name for a temporary table (using
registerTempTable).

Note It has been available since Spark 1.6.0.

It requires that the SELECT query uses THIS that corresponds to a temporary table and
simply executes the mandatory statement using sql method.

You have to specify the mandatory statement parameter using setStatement method.

200
Transformers

import org.apache.spark.ml.feature.SQLTransformer
val sql = new SQLTransformer()

// dataset to work with

val df = Seq((0, s"""hello\tworld"""), (1, "two spaces inside")).toDF("label", "sente
nce")

scala> sql.setStatement("SELECT sentence FROM __THIS__ WHERE label = 0").transform(df)

.show
+-----------+
| sentence|
+-----------+
|hello world|
+-----------+

scala> println(sql.explainParams)
statement: SQL statement (current: SELECT sentence FROM __THIS__ WHERE label = 0)

VectorAssembler
VectorAssembler is a feature transformer that assembles (merges) multiple columns into a

(feature) vector column.

It supports columns of the types NumericType , BooleanType , and VectorUDT . Doubles are
passed on untouched. Other numberic types and booleans are cast to doubles.

201
Transformers

import org.apache.spark.ml.feature.VectorAssembler
val vecAssembler = new VectorAssembler()

scala> print(vecAssembler.explainParams)
inputCols: input column names (undefined)
outputCol: output column name (default: vecAssembler_5ac31099dbee__output)

final case class Record(id: Int, n1: Int, n2: Double, flag: Boolean)
val ds = Seq(Record(0, 4, 2.0, true)).toDS

scala> ds.printSchema
root
|-- id: integer (nullable = false)
|-- n1: integer (nullable = false)
|-- n2: double (nullable = false)
|-- flag: boolean (nullable = false)

val features = vecAssembler

.setInputCols(Array("n1", "n2", "flag"))
.setOutputCol("features")
.transform(ds)

scala> features.printSchema
root
|-- id: integer (nullable = false)
|-- n1: integer (nullable = false)
|-- n2: double (nullable = false)
|-- flag: boolean (nullable = false)
|-- features: vector (nullable = true)

scala> features.show
+---+---+---+----+-------------+
| id| n1| n2|flag| features|
+---+---+---+----+-------------+
| 0| 4|2.0|true|[4.0,2.0,1.0]|
+---+---+---+----+-------------+

UnaryTransformers
The UnaryTransformer abstract class is a specialized Transformer that applies
transformation to one input column and writes results to another (by appending a new
column).

Each UnaryTransformer defines the input and output columns using the following "chain"
methods (they return the transformer on which they were executed and so are chainable):

setInputCol(value: String)

202
Transformers

setOutputCol(value: String)

Each UnaryTransformer calls validateInputType while executing transformSchema(schema:

StructType) (that is part of PipelineStage contract).

Note A UnaryTransformer is a PipelineStage.

When transform is called, it first calls transformSchema (with DEBUG logging enabled) and
then adds the column as a result of calling a protected abstract createTransformFunc .

createTransformFunc function is abstract and defined by concrete

Note
UnaryTransformer objects.

Internally, transform method uses Spark SQL’s udf to define a function (based on
createTransformFunc function described above) that will create the new output column (with

appropriate outputDataType ). The UDF is later applied to the input column of the input
DataFrame and the result becomes the output column (using DataFrame.withColumn

method).

Using udf and withColumn methods from Spark SQL demonstrates an

Note
excellent integration between the Spark modules: MLlib and SQL.

The following are UnaryTransformer implementations in spark.ml:

Tokenizer that converts a string column to lowercase and then splits it by white spaces.

RegexTokenizer that extracts tokens.

NGram that converts the input array of strings into an array of n-grams.

HashingTF that maps a sequence of terms to their term frequencies (cf. SPARK-13998
HashingTF should extend UnaryTransformer)

OneHotEncoder that maps a numeric input column of label indices onto a column of
binary vectors.

RegexTokenizer
RegexTokenizer is a UnaryTransformer that tokenizes a String into a collection of String .

203
Transformers

import org.apache.spark.ml.feature.RegexTokenizer
val regexTok = new RegexTokenizer()

// dataset to transform with tabs and spaces

val df = Seq((0, s"""hello\tworld"""), (1, "two spaces inside")).toDF("label", "sente
nce")

val tokenized = regexTok.setInputCol("sentence").transform(df)

scala> tokenized.show(false)
+-----+------------------+-----------------------------+
|label|sentence |regexTok_810b87af9510__output|
+-----+------------------+-----------------------------+
|0 |hello world |[hello, world] |
|1 |two spaces inside|[two, spaces, inside] |
+-----+------------------+-----------------------------+

Note Read the official scaladoc for org.apache.spark.ml.feature.RegexTokenizer.

It supports minTokenLength parameter that is the minimum token length that you can change
using setMinTokenLength method. It simply filters out smaller tokens and defaults to 1 .

// see above to set up the vals

scala> rt.setInputCol("line").setMinTokenLength(6).transform(df).show
+-----+--------------------+-----------------------------+
|label| line|regexTok_8c74c5e8b83a__output|
+-----+--------------------+-----------------------------+
| 1| hello world| []|
| 2|yet another sentence| [another, sentence]|
+-----+--------------------+-----------------------------+

It has gaps parameter that indicates whether regex splits on gaps ( true ) or matches
tokens ( false ). You can set it using setGaps . It defaults to true .

When set to true (i.e. splits on gaps) it uses Regex.split while Regex.findAllIn for false .

204
Transformers

scala> rt.setInputCol("line").setGaps(false).transform(df).show
+-----+--------------------+-----------------------------+
|label| line|regexTok_8c74c5e8b83a__output|
+-----+--------------------+-----------------------------+
| 1| hello world| []|
| 2|yet another sentence| [another, sentence]|
+-----+--------------------+-----------------------------+

scala> rt.setInputCol("line").setGaps(false).setPattern("\\W").transform(df).show(false
)
+-----+--------------------+-----------------------------+
|label|line |regexTok_8c74c5e8b83a__output|
+-----+--------------------+-----------------------------+
|1 |hello world |[] |
|2 |yet another sentence|[another, sentence] |
+-----+--------------------+-----------------------------+

It has pattern parameter that is the regex for tokenizing. It uses Scala’s .r method to
convert the string to regex. Use setPattern to set it. It defaults to \\s+ .

It has toLowercase parameter that indicates whether to convert all characters to lowercase
before tokenizing. Use setToLowercase to change it. It defaults to true .

NGram
In this example you use org.apache.spark.ml.feature.NGram that converts the input
collection of strings into a collection of n-grams (of n words).

import org.apache.spark.ml.feature.NGram

val bigram = new NGram("bigrams")

val df = Seq((0, Seq("hello", "world"))).toDF("id", "tokens")
bigram.setInputCol("tokens").transform(df).show

+---+--------------+---------------+
| id| tokens|bigrams__output|
+---+--------------+---------------+
| 0|[hello, world]| [hello world]|
+---+--------------+---------------+

HashingTF
Another example of a transformer is org.apache.spark.ml.feature.HashingTF that works on a
Column of ArrayType .

It transforms the rows for the input column into a sparse term frequency vector.

205
Transformers

import org.apache.spark.ml.feature.HashingTF
val hashingTF = new HashingTF()
.setInputCol("words")
.setOutputCol("features")
.setNumFeatures(5000)

// see above for regexTok transformer

val regexedDF = regexTok.transform(df)

// Use HashingTF
val hashedDF = hashingTF.transform(regexedDF)

scala> hashedDF.show(false)
+---+------------------+---------------------+-----------------------------------+
|id |text |words |features |
+---+------------------+---------------------+-----------------------------------+
|0 |hello world |[hello, world] |(5000,[2322,3802],[1.0,1.0])
|
|1 |two spaces inside|[two, spaces, inside]|(5000,[276,940,2533],[1.0,1.0,1.0])|
+---+------------------+---------------------+-----------------------------------+

The name of the output column is optional, and if not specified, it becomes the identifier of a
HashingTF object with the __output suffix.

scala> hashingTF.uid
res7: String = hashingTF_fe3554836819

scala> hashingTF.transform(regexDF).show(false)
+---+------------------+---------------------+----------------------------------------
---+
|id |text |words |hashingTF_fe3554836819__output
|
+---+------------------+---------------------+----------------------------------------
---+
|0 |hello world |[hello, world] |(262144,[71890,72594],[1.0,1.0])
|
|1 |two spaces inside|[two, spaces, inside]|(262144,[53244,77869,115276],[1.0,1.0,1.0
])|
+---+------------------+---------------------+----------------------------------------
---+

OneHotEncoder
OneHotEncoder is a Tokenizer that maps a numeric input column of label indices onto a

column of binary vectors.

206
Transformers

// dataset to transform
val df = Seq(
(0, "a"), (1, "b"),
(2, "c"), (3, "a"),
(4, "a"), (5, "c"))
.toDF("label", "category")
import org.apache.spark.ml.feature.StringIndexer
val indexer = new StringIndexer().setInputCol("category").setOutputCol("cat_index").fi
t(df)
val indexed = indexer.transform(df)

import org.apache.spark.sql.types.NumericType

scala> indexed.schema("cat_index").dataType.isInstanceOf[NumericType]
res0: Boolean = true

import org.apache.spark.ml.feature.OneHotEncoder
val oneHot = new OneHotEncoder()
.setInputCol("cat_index")
.setOutputCol("cat_vec")

val oneHotted = oneHot.transform(indexed)

scala> oneHotted.show(false)
+-----+--------+---------+-------------+
|label|category|cat_index|cat_vec |
+-----+--------+---------+-------------+
|0 |a |0.0 |(2,[0],[1.0])|
|1 |b |2.0 |(2,[],[]) |
|2 |c |1.0 |(2,[1],[1.0])|
|3 |a |0.0 |(2,[0],[1.0])|
|4 |a |0.0 |(2,[0],[1.0])|
|5 |c |1.0 |(2,[1],[1.0])|
+-----+--------+---------+-------------+

scala> oneHotted.printSchema
root
|-- label: integer (nullable = false)
|-- category: string (nullable = true)
|-- cat_index: double (nullable = true)
|-- cat_vec: vector (nullable = true)

scala> oneHotted.schema("cat_vec").dataType.isInstanceOf[VectorUDT]
res1: Boolean = true

Custom UnaryTransformer
The following class is a custom UnaryTransformer that transforms words using upper letters.

207
Transformers

package pl.japila.spark

import org.apache.spark.ml._
import org.apache.spark.ml.util.Identifiable
import org.apache.spark.sql.types._

class UpperTransformer(override val uid: String)

extends UnaryTransformer[String, String, UpperTransformer] {

def this() = this(Identifiable.randomUID("upper"))

override protected def validateInputType(inputType: DataType): Unit = {

require(inputType == StringType)
}

protected def createTransformFunc: String => String = {

_.toUpperCase
}

protected def outputDataType: DataType = StringType

}

Given a DataFrame you could use it as follows:

val upper = new UpperTransformer

scala> upper.setInputCol("text").transform(df).show
+---+-----+--------------------------+
| id| text|upper_0b559125fd61__output|
+---+-----+--------------------------+
| 0|hello| HELLO|
| 1|world| WORLD|
+---+-----+--------------------------+

208
Transformer

Transformer
Transformer is the contract in Spark MLlib for transformers that transform one dataset into

another.

Transformer is a PipelineStage and so…​FIXME

Transforming Dataset with Extra Parameters 

—  transform Method

Caution FIXME

Transformer Contract

package org.apache.spark.ml

abstract class Evaluator {

// only required methods that have no implementation
def transform(dataset: Dataset[_]): DataFrame
def copy(extra: ParamMap): Transformer
}

Table 1. Transformer Contract

Method Description
copy Used when…​

transform Used when…​

209
Tokenizer

Tokenizer
Tokenizer is a unary transformer that converts the column of String values to lowercase

and then splits it by white spaces.

import org.apache.spark.ml.feature.Tokenizer
val tok = new Tokenizer()

// dataset to transform
val df = Seq(
(1, "Hello world!"),
(2, "Here is yet another sentence.")).toDF("id", "sentence")

val tokenized = tok.setInputCol("sentence").setOutputCol("tokens").transform(df)

scala> tokenized.show(truncate = false)

+---+-----------------------------+-----------------------------------+
|id |sentence |tokens |
+---+-----------------------------+-----------------------------------+
|1 |Hello world! |[hello, world!] |
|2 |Here is yet another sentence.|[here, is, yet, another, sentence.]|
+---+-----------------------------+-----------------------------------+

210
Estimators

Estimators — ML Pipeline Component

An estimator is an abstraction of a learning algorithm that fits a model on a dataset.

That was so machine learning to explain an estimator this way, wasn’t it? It is
Note that the more I spend time with Pipeline API the often I use the terms and
phrases from this space. Sorry.

Technically, an Estimator produces a Model (i.e. a Transformer) for a given DataFrame and
parameters (as ParamMap ). It fits a model to the input DataFrame and ParamMap to produce
a Transformer (a Model ) that can calculate predictions for any DataFrame -based input
datasets.

It is basically a function that maps a DataFrame onto a Model through fit method, i.e. it
takes a DataFrame and produces a Transformer as a Model .

estimator: DataFrame =[fit]=> Model

Estimators are instances of org.apache.spark.ml.Estimator abstract class that comes with

fit method (with the return type M being a Model ):

fit(dataset: DataFrame): M

Estimator is a PipelineStage and so it can be a part of a Pipeline.

Pipeline considers Estimator special and executes fit method before

Note transform (as for other Transformer objects in a pipeline). Consult Pipeline
document.

211
Estimator

Estimator
Estimator is the contract in Spark MLlib for estimators that fit models to a dataset.

Estimator accepts parameters that you can set through dedicated setter methods upon

creating an Estimator . You could also fit a model with extra parameters.

import org.apache.spark.ml.classification.LogisticRegression

// Define parameters upon creating an Estimator

val lr = new LogisticRegression().
setMaxIter(5).
setRegParam(0.01)
val training: DataFrame = ...
val model1 = lr.fit(training)

// Define parameters through fit

import org.apache.spark.ml.param.ParamMap
val customParams = ParamMap(
lr.maxIter -> 10,
lr.featuresCol -> "custom_features"
)
val model2 = lr.fit(training, customParams)

Estimator is a PipelineStage and so can be a part of a Pipeline.

Estimator Contract

package org.apache.spark.ml

abstract class Estimator[M <: Model[M]] {

// only required methods that have no implementation
def fit(dataset: Dataset[_]): M
def copy(extra: ParamMap): Estimator[M]
}

Table 1. Estimator Contract

Method Description
copy Used when…​

fit Used when…​

212
Estimator

Fitting Model with Extra Parameters —  fit Method

fit(dataset: Dataset[_], paramMap: ParamMap): M

fit copies the extra paramMap and fits a model (of type M ).

fit is used mainly for model tuning to find the best model (using
Note
CrossValidator and TrainValidationSplit).

213
Estimator

StringIndexer
org.apache.spark.ml.feature.StringIndexer is an Estimator that produces a

StringIndexerModel .

val df = ('a' to 'a' + 9).map(_.toString)

.zip(0 to 9)
.map(_.swap)
.toDF("id", "label")

import org.apache.spark.ml.feature.StringIndexer
val strIdx = new StringIndexer()
.setInputCol("label")
.setOutputCol("index")

scala> println(strIdx.explainParams)
handleInvalid: how to handle invalid entries. Options are skip (which will filter out
rows with bad values), or error (which will throw an error). More options may be added
later (default: error)
inputCol: input column name (current: label)
outputCol: output column name (default: strIdx_ded89298e014__output, current: index)

val model = strIdx.fit(df)

val indexed = model.transform(df)

scala> indexed.show
+---+-----+-----+
| id|label|index|
+---+-----+-----+
| 0| a| 3.0|
| 1| b| 5.0|
| 2| c| 7.0|
| 3| d| 9.0|
| 4| e| 0.0|
| 5| f| 2.0|
| 6| g| 6.0|
| 7| h| 8.0|
| 8| i| 4.0|
| 9| j| 1.0|
+---+-----+-----+

214
Estimator

KMeans
KMeans class is an implementation of the K-means clustering algorithm in machine learning

with support for k-means|| (aka k-means parallel) in Spark MLlib.

Roughly, k-means is an unsupervised iterative algorithm that groups input data in a

predefined number of k clusters. Each cluster has a centroid which is a cluster center. It is
a highly iterative machine learning algorithm that measures the distance (between a vector
and centroids) as the nearest mean. The algorithm steps are repeated till the convergence
of a specified number of steps.

Note K-Means algorithm uses Lloyd’s algorithm in computer science.

It is an Estimator that produces a KMeansModel.

Do import org.apache.spark.ml.clustering.KMeans to work with KMeans

Tip
algorithm.

KMeans defaults to use the following values:

Number of clusters or centroids ( k ): 2

Maximum number of iterations ( maxIter ): 20

Initialization algorithm ( initMode ): k-means||

Number of steps for the k-means|| ( initSteps ): 5

Convergence tolerance ( tol ): 1e-4

import org.apache.spark.ml.clustering._
val kmeans = new KMeans()

scala> println(kmeans.explainParams)
featuresCol: features column name (default: features)
initMode: initialization algorithm (default: k-means||)
initSteps: number of steps for k-means|| (default: 5)
k: number of clusters to create (default: 2)
maxIter: maximum number of iterations (>= 0) (default: 20)
predictionCol: prediction column name (default: prediction)
seed: random seed (default: -1689246527)
tol: the convergence tolerance for iterative algorithms (default: 1.0E-4)

KMeans assumes that featuresCol is of type VectorUDT and appends predictionCol of

type IntegerType .

215
Estimator

Internally, fit method "unwraps" the feature vector in featuresCol column in the input
DataFrame and creates an RDD[Vector] . It then hands the call over to the MLlib variant of

KMeans in org.apache.spark.mllib.clustering.KMeans . The result is copied to KMeansModel

with a calculated KMeansSummary .

Each item (row) in a data set is described by a numeric vector of attributes called features .
A single feature (a dimension of the vector) represents a word (token) with a value that is a
metric that defines the importance of that word or term in the document.

Enable INFO logging level for org.apache.spark.mllib.clustering.KMeans logger

to see what happens inside a KMeans .
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.mllib.clustering.KMeans=INFO

Refer to Logging.

KMeans Example
You can represent a text corpus (document collection) using the vector space model. In this
representation, the vectors have dimension that is the number of different words in the
corpus. It is quite natural to have vectors with a lot of zero values as not all words will be in a
document. We will use an optimized memory representation to avoid zero values using
sparse vectors.

This example shows how to use k-means to classify emails as a spam or not.

// NOTE Don't copy and paste the final case class with the other lines
// It won't work with paste mode in spark-shell
final case class Email(id: Int, text: String)

val emails = Seq(

"This is an email from your lovely wife. Your mom says...",
"SPAM SPAM spam",
"Hello, We'd like to offer you").zipWithIndex.map(_.swap).toDF("id", "text").as[Email
]

// Prepare data for k-means

// Pass emails through a "pipeline" of transformers
import org.apache.spark.ml.feature._
val tok = new RegexTokenizer()
.setInputCol("text")
.setOutputCol("tokens")
.setPattern("\\W+")

val hashTF = new HashingTF()

216
Estimator

.setInputCol("tokens")
.setOutputCol("features")
.setNumFeatures(20)

val preprocess = (tok.transform _).andThen(hashTF.transform)

val features = preprocess(emails.toDF)

scala> features.select('text, 'features).show(false)

+--------------------------------------------------------+----------------------------
--------------------------------+
|text |features
|
+--------------------------------------------------------+----------------------------
--------------------------------+
|This is an email from your lovely wife. Your mom says...|(20,[0,3,6,8,10,11,17,19],[1
.0,2.0,1.0,1.0,2.0,1.0,2.0,1.0])|
|SPAM SPAM spam |(20,[13],[3.0])
|
|Hello, We'd like to offer you |(20,[0,2,7,10,11,19],[2.0,1.0
,1.0,1.0,1.0,1.0]) |
+--------------------------------------------------------+----------------------------
--------------------------------+

import org.apache.spark.ml.clustering.KMeans
val kmeans = new KMeans

scala> val kmModel = kmeans.fit(features.toDF)

16/04/08 15:57:37 WARN KMeans: The input data is not directly cached, which may hurt p
erformance if its parent RDDs are also uncached.
16/04/08 15:57:37 INFO KMeans: Initialization with k-means|| took 0.219 seconds.
16/04/08 15:57:37 INFO KMeans: Run 0 finished in 1 iterations
16/04/08 15:57:37 INFO KMeans: Iterations took 0.030 seconds.
16/04/08 15:57:37 INFO KMeans: KMeans converged in 1 iterations.
16/04/08 15:57:37 INFO KMeans: The cost for the best run is 5.000000000000002.
16/04/08 15:57:37 WARN KMeans: The input data was not directly cached, which may hurt
performance if its parent RDDs are also uncached.
kmModel: org.apache.spark.ml.clustering.KMeansModel = kmeans_7a13a617ce0b

scala> kmModel.clusterCenters.map(_.toSparse)
res36: Array[org.apache.spark.mllib.linalg.SparseVector] = Array((20,[13],[3.0]), (20,[
0,2,3,6,7,8,10,11,17,19],[1.5,0.5,1.0,0.5,0.5,0.5,1.5,1.0,1.0,1.0]))

val email = Seq("hello mom").toDF("text")

val result = kmModel.transform(preprocess(email))

scala> .show(false)
+---------+------------+---------------------+----------+
|text |tokens |features |prediction|
+---------+------------+---------------------+----------+
|hello mom|[hello, mom]|(20,[2,19],[1.0,1.0])|1 |
+---------+------------+---------------------+----------+

217
Estimator

218
Estimator

TrainValidationSplit
TrainValidationSplit is…​FIXME

Validating and Transforming Schema 

—  transformSchema Method

transformSchema(schema: StructType): StructType

Note transformSchema is part of PipelineStage Contract.

transformSchema simply passes the call to transformSchemaImpl (that is shared between

CrossValidator and TrainValidationSplit ).

219
Predictor

Predictor
Predictor is an Estimator for a PredictionModel with its own abstract train method.

train(dataset: DataFrame): M

The train method is supposed to ease dealing with schema validation and copying
parameters to a trained PredictionModel model. It also sets the parent of the model to itself.

A Predictor is basically a function that maps a DataFrame onto a PredictionModel .

predictor: DataFrame =[train]=> PredictionModel

It implements the abstract fit(dataset: DataFrame) of the Estimator abstract class that
validates and transforms the schema of a dataset (using a custom transformSchema of
PipelineStage), and then calls the abstract train method.

Validation and transformation of a schema (using transformSchema ) makes sure that:

1. features column exists and is of correct type (defaults to Vector).

2. label column exists and is of Double type.

As the last step, it adds the prediction column of Double type.

220
Predictor

RandomForestRegressor
RandomForestRegressor is a Predictor for Random Forest machine learning algorithm that

trains a RandomForestRegressionModel .

221
Predictor

import org.apache.spark.mllib.linalg.Vectors
val features = Vectors.sparse(10, Seq((2, 0.2), (4, 0.4)))

val data = (0.0 to 4.0 by 1).map(d => (d, features)).toDF("label", "features")

// data.as[LabeledPoint]

scala> data.show(false)
+-----+--------------------------+
|label|features |
+-----+--------------------------+
|0.0 |(10,[2,4,6],[0.2,0.4,0.6])|
|1.0 |(10,[2,4,6],[0.2,0.4,0.6])|
|2.0 |(10,[2,4,6],[0.2,0.4,0.6])|
|3.0 |(10,[2,4,6],[0.2,0.4,0.6])|
|4.0 |(10,[2,4,6],[0.2,0.4,0.6])|
+-----+--------------------------+

import org.apache.spark.ml.regression.{ RandomForestRegressor, RandomForestRegressionM

odel }
val rfr = new RandomForestRegressor
val model: RandomForestRegressionModel = rfr.fit(data)

scala> model.trees.foreach(println)
DecisionTreeRegressionModel (uid=dtr_247e77e2f8e0) of depth 1 with 3 nodes
DecisionTreeRegressionModel (uid=dtr_61f8eacb2b61) of depth 2 with 7 nodes
DecisionTreeRegressionModel (uid=dtr_63fc5bde051c) of depth 2 with 5 nodes
DecisionTreeRegressionModel (uid=dtr_64d4e42de85f) of depth 2 with 5 nodes
DecisionTreeRegressionModel (uid=dtr_693626422894) of depth 3 with 9 nodes
DecisionTreeRegressionModel (uid=dtr_927f8a0bc35e) of depth 2 with 5 nodes
DecisionTreeRegressionModel (uid=dtr_82da39f6e4e1) of depth 3 with 7 nodes
DecisionTreeRegressionModel (uid=dtr_cb94c2e75bd1) of depth 0 with 1 nodes
DecisionTreeRegressionModel (uid=dtr_29e3362adfb2) of depth 1 with 3 nodes
DecisionTreeRegressionModel (uid=dtr_d6d896abcc75) of depth 3 with 7 nodes
DecisionTreeRegressionModel (uid=dtr_aacb22a9143d) of depth 2 with 5 nodes
DecisionTreeRegressionModel (uid=dtr_18d07dadb5b9) of depth 2 with 7 nodes
DecisionTreeRegressionModel (uid=dtr_f0615c28637c) of depth 2 with 5 nodes
DecisionTreeRegressionModel (uid=dtr_4619362d02fc) of depth 2 with 5 nodes
DecisionTreeRegressionModel (uid=dtr_d39502f828f4) of depth 2 with 5 nodes
DecisionTreeRegressionModel (uid=dtr_896f3a4272ad) of depth 3 with 9 nodes
DecisionTreeRegressionModel (uid=dtr_891323c29838) of depth 3 with 7 nodes
DecisionTreeRegressionModel (uid=dtr_d658fe871e99) of depth 2 with 5 nodes
DecisionTreeRegressionModel (uid=dtr_d91227b13d41) of depth 2 with 5 nodes
DecisionTreeRegressionModel (uid=dtr_4a7976921f4b) of depth 2 with 5 nodes

scala> model.treeWeights
res12: Array[Double] = Array(1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0
, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0)

scala> model.featureImportances
res13: org.apache.spark.mllib.linalg.Vector = (1,[0],[1.0])

222
Predictor

223
Regressor

Regressor
Regressor is…​FIXME

224
Regressor

LinearRegression
LinearRegression is a Regressor that represents the linear regression algorithm in Machine

Learning.

LinearRegression belongs to org.apache.spark.ml.regression package.

Tip Read the scaladoc of LinearRegression.

It expects org.apache.spark.mllib.linalg.Vector as the input type of the column in a

dataset and produces LinearRegressionModel.

import org.apache.spark.ml.regression.LinearRegression
val lr = new LinearRegression

The acceptable parameters:

scala> println(lr.explainParams)
elasticNetParam: the ElasticNet mixing parameter, in range [0, 1]. For alpha = 0, the
penalty is an L2 penalty. For alpha = 1, it is an L1 penalty (default: 0.0)
featuresCol: features column name (default: features)
fitIntercept: whether to fit an intercept term (default: true)
labelCol: label column name (default: label)
maxIter: maximum number of iterations (>= 0) (default: 100)
predictionCol: prediction column name (default: prediction)
regParam: regularization parameter (>= 0) (default: 0.0)
solver: the solver algorithm for optimization. If this is not set or empty, default va
lue is 'auto' (default: auto)
standardization: whether to standardize the training features before fitting the model
(default: true)
tol: the convergence tolerance for iterative algorithms (default: 1.0E-6)
weightCol: weight column name. If this is not set or empty, we treat all instance weig
hts as 1.0 (default: )

LinearRegression Example

import org.apache.spark.mllib.linalg.Vectors
import org.apache.spark.mllib.regression.LabeledPoint
val data = (0.0 to 9.0 by 1) // create a collection of Doubles
.map(n => (n, n)) // make it pairs
.map { case (label, features) =>
LabeledPoint(label, Vectors.dense(features)) } // create labeled points of dense v
ectors
.toDF // make it a DataFrame

225
Regressor

scala> data.show
+-----+--------+
|label|features|
+-----+--------+
| 0.0| [0.0]|
| 1.0| [1.0]|
| 2.0| [2.0]|
| 3.0| [3.0]|
| 4.0| [4.0]|
| 5.0| [5.0]|
| 6.0| [6.0]|
| 7.0| [7.0]|
| 8.0| [8.0]|
| 9.0| [9.0]|
+-----+--------+

import org.apache.spark.ml.regression.LinearRegression
val lr = new LinearRegression

val model = lr.fit(data)

scala> model.intercept
res1: Double = 0.0

scala> model.coefficients
res2: org.apache.spark.mllib.linalg.Vector = [1.0]

// make predictions
scala> val predictions = model.transform(data)
predictions: org.apache.spark.sql.DataFrame = [label: double, features: vector ... 1 m
ore field]

scala> predictions.show
+-----+--------+----------+
|label|features|prediction|
+-----+--------+----------+
| 0.0| [0.0]| 0.0|
| 1.0| [1.0]| 1.0|
| 2.0| [2.0]| 2.0|
| 3.0| [3.0]| 3.0|
| 4.0| [4.0]| 4.0|
| 5.0| [5.0]| 5.0|
| 6.0| [6.0]| 6.0|
| 7.0| [7.0]| 7.0|
| 8.0| [8.0]| 8.0|
| 9.0| [9.0]| 9.0|
+-----+--------+----------+

import org.apache.spark.ml.evaluation.RegressionEvaluator

// rmse is the default metric

// We're explicit here for learning purposes
val regEval = new RegressionEvaluator().setMetricName("rmse")

226
Regressor

val rmse = regEval.evaluate(predictions)

scala> println(s"Root Mean Squared Error: $rmse")

Root Mean Squared Error: 0.0

import org.apache.spark.mllib.linalg.DenseVector
// NOTE Follow along to learn spark.ml-way (not RDD-way)
predictions.rdd.map { r =>
(r(0).asInstanceOf[Double], r(1).asInstanceOf[DenseVector](0).toDouble, r(2).asInsta
nceOf[Double]))
.toDF("label", "feature0", "prediction").show
+-----+--------+----------+
|label|feature0|prediction|
+-----+--------+----------+
| 0.0| 0.0| 0.0|
| 1.0| 1.0| 1.0|
| 2.0| 2.0| 2.0|
| 3.0| 3.0| 3.0|
| 4.0| 4.0| 4.0|
| 5.0| 5.0| 5.0|
| 6.0| 6.0| 6.0|
| 7.0| 7.0| 7.0|
| 8.0| 8.0| 8.0|
| 9.0| 9.0| 9.0|
+-----+--------+----------+

// Let's make it nicer to the eyes using a Scala case class

scala> :pa
// Entering paste mode (ctrl-D to finish)

import org.apache.spark.sql.Row
import org.apache.spark.mllib.linalg.DenseVector
case class Prediction(label: Double, feature0: Double, prediction: Double)
object Prediction {
def apply(r: Row) = new Prediction(
label = r(0).asInstanceOf[Double],
feature0 = r(1).asInstanceOf[DenseVector](0).toDouble,
prediction = r(2).asInstanceOf[Double])
}

// Exiting paste mode, now interpreting.

import org.apache.spark.sql.Row
import org.apache.spark.mllib.linalg.DenseVector
defined class Prediction
defined object Prediction

scala> predictions.rdd.map(Prediction.apply).toDF.show
+-----+--------+----------+
|label|feature0|prediction|
+-----+--------+----------+
| 0.0| 0.0| 0.0|
| 1.0| 1.0| 1.0|

227
Regressor

| 2.0| 2.0| 2.0|

| 3.0| 3.0| 3.0|
| 4.0| 4.0| 4.0|
| 5.0| 5.0| 5.0|
| 6.0| 6.0| 6.0|
| 7.0| 7.0| 7.0|
| 8.0| 8.0| 8.0|
| 9.0| 9.0| 9.0|
+-----+--------+----------+

train Method

train(dataset: DataFrame): LinearRegressionModel

train (protected) method of LinearRegression expects a dataset DataFrame with two

columns:

1. label of type DoubleType .

2. features of type Vector.

It returns LinearRegressionModel .

It first counts the number of elements in features column (usually features ). The column
has to be of mllib.linalg.Vector type (and can easily be prepared using HashingTF
transformer).

val spam = Seq(

(0, "Hi Jacek. Wanna more SPAM? Best!"),
(1, "This is SPAM. This is SPAM")).toDF("id", "email")

import org.apache.spark.ml.feature.RegexTokenizer
val regexTok = new RegexTokenizer()
val spamTokens = regexTok.setInputCol("email").transform(spam)

scala> spamTokens.show(false)
+---+--------------------------------+---------------------------------------+
|id |email |regexTok_646b6bcc4548__output |
+---+--------------------------------+---------------------------------------+
|0 |Hi Jacek. Wanna more SPAM? Best!|[hi, jacek., wanna, more, spam?, best!]|
|1 |This is SPAM. This is SPAM |[this, is, spam., this, is, spam] |
+---+--------------------------------+---------------------------------------+

import org.apache.spark.ml.feature.HashingTF
val hashTF = new HashingTF()
.setInputCol(regexTok.getOutputCol)
.setOutputCol("features")
.setNumFeatures(5000)

228
Regressor

val spamHashed = hashTF.transform(spamTokens)

scala> spamHashed.select("email", "features").show(false)

+--------------------------------+----------------------------------------------------
------------+
|email |features
|
+--------------------------------+----------------------------------------------------
------------+
|Hi Jacek. Wanna more SPAM? Best!|(5000,[2525,2943,3093,3166,3329,3980],[1.0,1.0,1.0,1
.0,1.0,1.0])|
|This is SPAM. This is SPAM |(5000,[1713,3149,3370,4070],[1.0,1.0,2.0,2.0])
|
+--------------------------------+----------------------------------------------------
------------+

// Create labeled datasets for spam (1)

val spamLabeled = spamHashed.withColumn("label", lit(1d))

scala> spamLabeled.show
+---+--------------------+-----------------------------+--------------------+-----+
| id| email|regexTok_646b6bcc4548__output| features|label|
+---+--------------------+-----------------------------+--------------------+-----+
| 0|Hi Jacek. Wanna m...| [hi, jacek., wann...|(5000,[2525,2943,...| 1.0|
| 1|This is SPAM. Thi...| [this, is, spam.,...|(5000,[1713,3149,...| 1.0|
+---+--------------------+-----------------------------+--------------------+-----+

val regular = Seq(

(2, "Hi Jacek. I hope this email finds you well. Spark up!"),
(3, "Welcome to Apache Spark project")).toDF("id", "email")
val regularTokens = regexTok.setInputCol("email").transform(regular)
val regularHashed = hashTF.transform(regularTokens)
// Create labeled datasets for non-spam regular emails (0)
val regularLabeled = regularHashed.withColumn("label", lit(0d))

val training = regularLabeled.union(spamLabeled).cache

scala> training.show
+---+--------------------+-----------------------------+--------------------+-----+
| id| email|regexTok_646b6bcc4548__output| features|label|
+---+--------------------+-----------------------------+--------------------+-----+
| 2|Hi Jacek. I hope ...| [hi, jacek., i, h...|(5000,[72,105,942...| 0.0|
| 3|Welcome to Apache...| [welcome, to, apa...|(5000,[2894,3365,...| 0.0|
| 0|Hi Jacek. Wanna m...| [hi, jacek., wann...|(5000,[2525,2943,...| 1.0|
| 1|This is SPAM. Thi...| [this, is, spam.,...|(5000,[1713,3149,...| 1.0|
+---+--------------------+-----------------------------+--------------------+-----+

import org.apache.spark.ml.regression.LinearRegression
val lr = new LinearRegression

// the following calls train by the Predictor contract (see above)

val lrModel = lr.fit(training)

229
Regressor

// Let's predict whether an email is a spam or not

val email = Seq("Hi Jacek. you doing well? Bye!").toDF("email")
val emailTokens = regexTok.setInputCol("email").transform(email)
val emailHashed = hashTF.transform(emailTokens)

scala> lrModel.transform(emailHashed).select("prediction").show
+-----------------+
| prediction|
+-----------------+
|0.563603440350882|
+-----------------+

230
Classifier

Classifier
Classifier is a Predictor that…​FIXME

Classifier accepts parameters.

extractLabeledPoints Method

extractLabeledPoints(dataset: Dataset[_], numClasses: Int): RDD[LabeledPoint]

extractLabeledPoints …​FIXME

Note extractLabeledPoints is used when…​FIXME

getNumClasses Method

getNumClasses(dataset: Dataset[_], maxNumClasses: Int = 100): Int

getNumClasses …​FIXME

Note getNumClasses is used when…​FIXME

231
Classifier

RandomForestClassifier
RandomForestClassifier is a probabilistic Classifier for…​FIXME

232
Classifier

DecisionTreeClassifier
DecisionTreeClassifier is a probabilistic Classifier for…​FIXME

233
Models

ML Pipeline Models
Model abstract class is a Transformer with the optional Estimator that has produced it (as a

transient parent field).

model: DataFrame =[predict]=> DataFrame (with predictions)

An Estimator is optional and is available only after fit (of an Estimator) has
Note
been executed whose result a model is.

As a Transformer it takes a DataFrame and transforms it to a result DataFrame with

prediction column added.

There are two direct implementations of the Model class that are not directly related to a
concrete ML algorithm:

PipelineModel

PredictionModel

PipelineModel

Caution PipelineModel is a private[ml] class.

PipelineModel is a Model of Pipeline estimator.

Once fit, you can use the result model as any other models to transform datasets (as
DataFrame ).

A very interesting use case of PipelineModel is when a Pipeline is made up of

Transformer instances.

234
Models

// Transformer #1
import org.apache.spark.ml.feature.Tokenizer
val tok = new Tokenizer().setInputCol("text")

// Transformer #2
import org.apache.spark.ml.feature.HashingTF
val hashingTF = new HashingTF().setInputCol(tok.getOutputCol).setOutputCol("features")

// Fuse the Transformers in a Pipeline

import org.apache.spark.ml.Pipeline
val pipeline = new Pipeline().setStages(Array(tok, hashingTF))

val dataset = Seq((0, "hello world")).toDF("id", "text")

// Since there's no fitting, any dataset works fine

val featurize = pipeline.fit(dataset)

// Use the pipelineModel as a series of Transformers

scala> featurize.transform(dataset).show(false)
+---+-----------+------------------------+--------------------------------+
|id |text |tok_8aec9bfad04a__output|features |
+---+-----------+------------------------+--------------------------------+
|0 |hello world|[hello, world] |(262144,[71890,72594],[1.0,1.0])|
+---+-----------+------------------------+--------------------------------+

PredictionModel
PredictionModel is an abstract class to represent a model for prediction algorithms like

regression and classification (that have their own specialized models - details coming up
below).

PredictionModel is basically a Transformer with predict method to calculate predictions

(that end up in prediction column).

PredictionModel belongs to org.apache.spark.ml package.

import org.apache.spark.ml.PredictionModel

The contract of PredictionModel class requires that every custom implementation defines
predict method (with FeaturesType type being the type of features ).

predict(features: FeaturesType): Double

The direct less-algorithm-specific extensions of the PredictionModel class are:

RegressionModel

235
Models

ClassificationModel

RandomForestRegressionModel

As a custom Transformer it comes with its own custom transform method.

Internally, transform first ensures that the type of the features column matches the type
of the model and adds the prediction column of type Double to the schema of the result
DataFrame .

It then creates the result DataFrame and adds the prediction column with a predictUDF
function applied to the values of the features column.

FIXME A diagram to show the transformation from a dataframe (on the left)
Caution and another (on the right) with an arrow to represent the transformation
method.

Enable DEBUG logging level for a PredictionModel implementation, e.g.

LinearRegressionModel, to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.ml.regression.LinearRegressionModel=DEBUG

Refer to Logging.

ClassificationModel
ClassificationModel is a PredictionModel that transforms a DataFrame with mandatory

features , label , and rawPrediction (of type Vector) columns to a DataFrame with

prediction column added.

A Model with ClassifierParams parameters, e.g. ClassificationModel ,

Note requires that a DataFrame have the mandatory features , label (of type
Double ), and rawPrediction (of type Vector) columns.

ClassificationModel comes with its own transform (as Transformer) and predict (as

PredictionModel).

The following is a list of the known ClassificationModel custom implementations (as of

March, 24th):

ProbabilisticClassificationModel (the abstract parent of the following classification

models)

DecisionTreeClassificationModel ( final )

236
Models

LogisticRegressionModel

NaiveBayesModel

RandomForestClassificationModel ( final )

RegressionModel
RegressionModel is a PredictionModel that transforms a DataFrame with mandatory label ,

features , and prediction columns.

It comes with no own methods or values and so is more a marker abstract class (to combine
different features of regression models under one type).

LinearRegressionModel
LinearRegressionModel represents a model produced by a LinearRegression estimator. It

transforms the required features column of type org.apache.spark.mllib.linalg.Vector.

It is a private[ml] class so what you, a developer, may eventually work with is

Note the more general RegressionModel , and since RegressionModel is just a
marker no-method abstract class, it is more a PredictionModel.

As a linear regression model that extends LinearRegressionParams it expects the following

schema of an input DataFrame :

label (required)

features (required)

prediction

regParam

elasticNetParam

maxIter (Int)

tol (Double)

fitIntercept (Boolean)

standardization (Boolean)

weightCol (String)

solver (String)

237
Models

(New in 1.6.0) LinearRegressionModel is also a MLWritable (so you can save it to a

persistent storage for later reuse).

With DEBUG logging enabled (see above) you can see the following messages in the logs
when transform is called and transforms the schema.

16/03/21 06:55:32 DEBUG LinearRegressionModel: Input schema: {"type":"struct","fields"

:[{"name":"label","type":"double","nullable":false,"metadata":{}},{"name":"features","
type":{"type":"udt","class":"org.apache.spark.mllib.linalg.VectorUDT","pyClass":"pyspa
rk.mllib.linalg.VectorUDT","sqlType":{"type":"struct","fields":[{"name":"type","type":
"byte","nullable":false,"metadata":{}},{"name":"size","type":"integer","nullable":true
,"metadata":{}},{"name":"indices","type":{"type":"array","elementType":"integer","cont
ainsNull":false},"nullable":true,"metadata":{}},{"name":"values","type":{"type":"array
","elementType":"double","containsNull":false},"nullable":true,"metadata":{}}]}},"null
able":true,"metadata":{}}]}
16/03/21 06:55:32 DEBUG LinearRegressionModel: Expected output schema: {"type":"struct
","fields":[{"name":"label","type":"double","nullable":false,"metadata":{}},{"name":"f
eatures","type":{"type":"udt","class":"org.apache.spark.mllib.linalg.VectorUDT","pyCla
ss":"pyspark.mllib.linalg.VectorUDT","sqlType":{"type":"struct","fields":[{"name":"typ
e","type":"byte","nullable":false,"metadata":{}},{"name":"size","type":"integer","null
able":true,"metadata":{}},{"name":"indices","type":{"type":"array","elementType":"inte
ger","containsNull":false},"nullable":true,"metadata":{}},{"name":"values","type":{"ty
pe":"array","elementType":"double","containsNull":false},"nullable":true,"metadata":{}
}]}},"nullable":true,"metadata":{}},{"name":"prediction","type":"double","nullable":fa
lse,"metadata":{}}]}

The implementation of predict for LinearRegressionModel calculates dot(v1, v2) of two

Vectors - features and coefficients - (of DenseVector or SparseVector types) of the
same size and adds intercept .

The coefficients Vector and intercept Double are the integral part of
Note
LinearRegressionModel as the required input parameters of the constructor.

LinearRegressionModel Example

238
Models

// Create a (sparse) Vector

import org.apache.spark.mllib.linalg.Vectors
val indices = 0 to 4
val elements = indices.zip(Stream.continually(1.0))
val sv = Vectors.sparse(elements.size, elements)

// Create a proper DataFrame

val ds = sc.parallelize(Seq((0.5, sv))).toDF("label", "features")

import org.apache.spark.ml.regression.LinearRegression
val lr = new LinearRegression

// Importing LinearRegressionModel and being explicit about the type of model value
// is for learning purposes only
import org.apache.spark.ml.regression.LinearRegressionModel
val model: LinearRegressionModel = lr.fit(ds)

// Use the same ds - just for learning purposes

scala> model.transform(ds).show
+-----+--------------------+----------+
|label| features|prediction|
+-----+--------------------+----------+
| 0.5|(5,[0,1,2,3,4],[1...| 0.5|
+-----+--------------------+----------+

RandomForestRegressionModel
RandomForestRegressionModel is a PredictionModel with features column of type Vector.

Interestingly, DataFrame transformation (as part of Transformer contract) uses

SparkContext.broadcast to send itself to the nodes in a Spark cluster and calls calculates
predictions (as prediction column) on features .

KMeansModel
KMeansModel is a Model of KMeans algorithm.

It belongs to org.apache.spark.ml.clustering package.

239
Models

// See spark-mllib-estimators.adoc#KMeans
val kmeans: KMeans = ???
val trainingDF: DataFrame = ???
val kmModel = kmeans.fit(trainingDF)

// Know the cluster centers

scala> kmModel.clusterCenters
res0: Array[org.apache.spark.mllib.linalg.Vector] = Array([0.1,0.3], [0.1,0.1])

val inputDF = Seq((0.0, Vectors.dense(0.2, 0.4))).toDF("label", "features")

scala> kmModel.transform(inputDF).show(false)
+-----+---------+----------+
|label|features |prediction|
+-----+---------+----------+
|0.0 |[0.2,0.4]|0 |
+-----+---------+----------+

240
Model

Model
Model is the contract for a fitted model, i.e. a Transformer that was produced by an

Estimator.

Model Contract

package org.apache.spark.ml

abstract class Model[M] extends Transformer {

def copy(extra: ParamMap): M
}

Table 1. Model Contract

Method Description
copy Used when…​

parent Estimator that produced this model.

241
Evaluator — ML Pipeline Component for Model Scoring

Evaluator — ML Pipeline Component for Model

Scoring
Evaluator is the contract in Spark MLlib for ML Pipeline components that can evaluate

models for given parameters.

ML Pipeline evaluators are transformers that take DataFrames and compute metrics
indicating how good a model is.

evaluator: DataFrame =[evaluate]=> Double

Evaluator is used to evaluate models and is usually (if not always) used for best model

selection by CrossValidator and TrainValidationSplit.

Evaluator uses isLargerBetter method to indicate whether the Double metric should be

maximized ( true ) or minimized ( false ). It considers a larger value better ( true ) by

default.

Table 1. Evaluators
Evaluator Description
BinaryClassificationEvaluator Evaluator of binary classification models

ClusteringEvaluator Evaluator of clustering models

MulticlassClassificationEvaluator Evaluator of multiclass classification models

RegressionEvaluator Evaluator of regression models

Evaluating Model Output with Extra Parameters 

—  evaluate Method

evaluate(dataset: Dataset[_], paramMap: ParamMap): Double

evaluate copies the extra paramMap and evaluates a model output.

Note evaluate is used…​FIXME

Evaluator Contract

242
Evaluator — ML Pipeline Component for Model Scoring

package org.apache.spark.ml.evaluation

abstract class Evaluator {

def evaluate(dataset: Dataset[_]): Double
def copy(extra: ParamMap): Evaluator
def isLargerBetter: Boolean = true
}

Table 2. Evaluator Contract

Method Description
copy Used when…​

evaluate Used when…​

Indicates whether the metric returned by evaluate should

isLargerBetter be maximized ( true ) or minimized ( false ).
Gives true by default.

243
BinaryClassificationEvaluator — Evaluator of Binary Classification Models

BinaryClassificationEvaluator — Evaluator of
Binary Classification Models
BinaryClassificationEvaluator is an Evaluator of cross-validate models from binary

classifications (e.g. LogisticRegression, RandomForestClassifier, NaiveBayes ,

DecisionTreeClassifier, MultilayerPerceptronClassifier , GBTClassifier , LinearSVC ).

BinaryClassificationEvaluator finds the best model by maximizing the model evaluation

metric that is the area under the specified curve (and so isLargerBetter is turned on for either
metric).

import org.apache.spark.ml.evaluation.BinaryClassificationEvaluator
val binEval = new BinaryClassificationEvaluator().
setMetricName("areaUnderROC").
setRawPredictionCol("rawPrediction").
setLabelCol("label")

scala> binEval.isLargerBetter
res0: Boolean = true

scala> println(binEval.explainParams)
labelCol: label column name (default: label)
metricName: metric name in evaluation (areaUnderROC|areaUnderPR) (default: areaUnderRO
C)
rawPredictionCol: raw prediction (a.k.a. confidence) column name (default: rawPredicti
on)

Table 1. BinaryClassificationEvaluator' Parameters

Parameter Default Value Description
Name of the classification metric for
evaluation
metricName areaUnderROC
Can be either areaUnderROC (default) or
areaUnderPR

rawPredictionCol rawPrediction
Column name with raw predictions (a.k.a.
confidence)

labelCol label
Name of the column with indexed labels
(i.e. 0 s or 1 s)

Evaluating Model Output —  evaluate Method

244
BinaryClassificationEvaluator — Evaluator of Binary Classification Models

evaluate(dataset: Dataset[_]): Double

Note evaluate is part of Evaluator Contract.

evaluate …​FIXME

245
ClusteringEvaluator — Evaluator of Clustering Models

ClusteringEvaluator — Evaluator of Clustering
Models
ClusteringEvaluator is an Evaluator of clustering models (e.g. FPGrowth ,

GaussianMixture , ALS, KMeans , LinearSVC , RandomForestRegressor ,

GeneralizedLinearRegression , LinearRegression, GBTRegressor , DecisionTreeRegressor ,

NaiveBayes )

Note ClusteringEvaluator is available since Spark 2.3.0.

ClusteringEvaluator finds the best model by maximizing the model evaluation metric (i.e.

isLargerBetter is always turned on).

import org.apache.spark.ml.evaluation.ClusteringEvaluator
val cluEval = new ClusteringEvaluator().
setPredictionCol("prediction").
setFeaturesCol("features").
setMetricName("silhouette")

scala> cluEval.isLargerBetter
res0: Boolean = true

scala> println(cluEval.explainParams)
featuresCol: features column name (default: features, current: features)
metricName: metric name in evaluation (silhouette) (default: silhouette, current: silh
ouette)
predictionCol: prediction column name (default: prediction, current: prediction)

Table 1. ClusteringEvaluator' Parameters

Parameter Default Value Description

featuresCol features
Name of the column with features (of type
VectorUDT )

Name of the classification metric for

evaluation
metricName silhouette
metricName can only be
Note
silhouette .

predictionCol prediction
Name of the column with prediction (of
type NumericType )

246
ClusteringEvaluator — Evaluator of Clustering Models

Evaluating Model Output —  evaluate Method

evaluate(dataset: Dataset[_]): Double

Note evaluate is part of Evaluator Contract.

evaluate …​FIXME

247
MulticlassClassificationEvaluator — Evaluator of Multiclass Classification Models

MulticlassClassificationEvaluator — Evaluator
of Multiclass Classification Models
MulticlassClassificationEvaluator is an Evaluator that takes datasets with the following

two columns:

prediction (of DoubleType values)

label (of float or double values)

248
RegressionEvaluator — Evaluator of Regression Models

RegressionEvaluator — Evaluator of
Regression Models
RegressionEvaluator is an Evaluator of regression models (e.g. ALS,

DecisionTreeRegressor , DecisionTreeClassifier, GBTRegressor , GBTClassifier ,

RandomForestRegressor, RandomForestClassifier, LinearRegression, RFormula ,

NaiveBayes , LogisticRegression, MultilayerPerceptronClassifier , LinearSVC ,

GeneralizedLinearRegression).

Table 1. RegressionEvaluator’s Metrics and isLargerBetter Flag

Metric Description isLargerBetter
rmse Root mean squared error false

mse Mean squared error false

(default) Unadjusted coefficient of

r2 determination true

Regression through the origin

mae Mean absolute error false

import org.apache.spark.ml.evaluation.RegressionEvaluator
val regEval = new RegressionEvaluator().
setMetricName("r2").
setPredictionCol("prediction").
setLabelCol("label")

scala> regEval.isLargerBetter
res0: Boolean = true

scala> println(regEval.explainParams)
labelCol: label column name (default: label, current: label)
metricName: metric name in evaluation (mse|rmse|r2|mae) (default: rmse, current: r2)
predictionCol: prediction column name (default: prediction, current: prediction)

249
RegressionEvaluator — Evaluator of Regression Models

Table 2. RegressionEvaluator' Parameters

Parameter Default Value Description

Name of the classification metric for

evaluation
metricName areaUnderROC
Can be one of the following: mae , mse ,
rmse (default), r2

predictionCol prediction Name of the column with predictions

labelCol label Name of the column with indexed labels

250
RegressionEvaluator — Evaluator of Regression Models

// prepare a fake input dataset using transformers

import org.apache.spark.ml.feature.Tokenizer
val tok = new Tokenizer().setInputCol("text")

import org.apache.spark.ml.feature.HashingTF
val hashTF = new HashingTF()
.setInputCol(tok.getOutputCol) // it reads the output of tok
.setOutputCol("features")

// Scala trick to chain transform methods

// It's of little to no use since we've got Pipelines
// Just to have it as an alternative
val transform = (tok.transform _).andThen(hashTF.transform _)

val dataset = Seq((0, "hello world", 0.0)).toDF("id", "text", "label")

// we're using Linear Regression algorithm

import org.apache.spark.ml.regression.LinearRegression
val lr = new LinearRegression

import org.apache.spark.ml.Pipeline
val pipeline = new Pipeline().setStages(Array(tok, hashTF, lr))

val model = pipeline.fit(dataset)

// Let's do prediction
// Note that we're using the same dataset as for fitting the model
// Something you'd definitely not be doing in prod
val predictions = model.transform(dataset)

// Now we're ready to evaluate the model

// Evaluator works on datasets with predictions

import org.apache.spark.ml.evaluation.RegressionEvaluator
val regEval = new RegressionEvaluator

scala> regEval.evaluate(predictions)
res0: Double = 0.0

Evaluating Model Output —  evaluate Method

evaluate(dataset: Dataset[_]): Double

Note evaluate is part of Evaluator Contract.

evaluate …​FIXME

251
RegressionEvaluator — Evaluator of Regression Models

252
CrossValidator — Model Tuning / Finding The Best Model

CrossValidator — Model Tuning / Finding The

Best Model
CrossValidator is an Estimator for model tuning, i.e. finding the best model for given

parameters and a dataset.

CrossValidator splits the dataset into a set of non-overlapping randomly-partitioned

numFolds pairs of training and validation datasets.

CrossValidator generates a CrossValidatorModel to hold the best model and average

cross-validation metrics.

CrossValidator takes any Estimator for model selection, including the Pipeline
Note
that is used to transform raw datasets and generate a Model.

Use ParamGridBuilder for the parameter grid, i.e. collection of ParamMaps for
Note
model tuning.

import org.apache.spark.ml.Pipeline
val pipeline: Pipeline = ...

import org.apache.spark.ml.param.ParamMap
val paramGrid: Array[ParamMap] = new ParamGridBuilder().
addGrid(...).
addGrid(...).
build

import org.apache.spark.ml.tuning.CrossValidator
val cv = new CrossValidator().
setEstimator(pipeline).
setEvaluator(...).
setEstimatorParamMaps(paramGrid).
setNumFolds(...).
setParallelism(...)

import org.apache.spark.ml.tuning.CrossValidatorModel
val bestModel: CrossValidatorModel = cv.fit(training)

CrossValidator is a MLWritable.

253
CrossValidator — Model Tuning / Finding The Best Model

Table 1. CrossValidator' Parameters

Parameter Default Value Description
estimator (undefined) Estimator for best model selection.

estimatorParamMaps (undefined) Param maps for the estimator

Evaluator to select hyper-parameters that

evaluator (undefined)
maximize the validated metric

The number of folds for cross validation

numFolds 3
Must be at least 2 .

The number of threads to use while fitting

parallelism 1 a model
Must be at least 1 .

seed Random seed

Enable INFO or DEBUG logging levels for

org.apache.spark.ml.tuning.CrossValidator logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.ml.tuning.CrossValidator=DEBUG

Refer to Logging.

Finding The Best Model —  fit Method

fit(dataset: Dataset[_]): CrossValidatorModel

Note fit is part of Estimator Contract to fit a model (i.e. produce a model).

fit validates the schema (with logging turned on).

You should see the following DEBUG message in the logs:

DEBUG CrossValidator: Input schema: [json]

fit makes sure that estimator, evaluator, estimatorParamMaps and parallelism

parameters are defined or reports a NoSuchElementException .

254
CrossValidator — Model Tuning / Finding The Best Model

java.util.NoSuchElementException: Failed to find a default value for [name]

fit creates a ExecutionContext (per parallelism parameter).

fit creates a Instrumentation and requests it to print out the parameters numFolds,

seed, parallelism to the logs.

INFO ...FIXME

fit requests Instrumentation to print out the tuning parameters to the logs.

INFO ...FIXME

fit kFolds the RDD of the dataset per numFolds and seed parameters.

Note fit passes the underlying RDD of the dataset to kFolds.

fit computes metrics for every pair of training and validation RDDs.

fit calculates the average metrics over all kFolds.

You should see the following INFO message in the logs:

INFO Average cross-validation metrics: [metrics]

fit requests the Evaluator for the best cross-validation metric.

You should see the following INFO message in the logs:

INFO Best set of parameters:

[estimatorParamMap]
INFO Best cross-validation metric: [bestMetric].

fit requests the Estimator to fit the best model (for the dataset and the best set of

estimatorParamMap).

You should see the following INFO message in the logs:

INFO training finished

In the end, fit creates a CrossValidatorModel (for the ID, the best model and the average
metrics for every kFold) and copies parameters to it.

255
CrossValidator — Model Tuning / Finding The Best Model

fit and Computing Metric for Training and Validation RDDs

fit computes metrics for every pair of training and validation RDDs (from kFold).

fit creates and persists training and validation datasets.

Tip You can monitor the storage for persisting the datasets in web UI’s Storage tab.

fit Prints out the following DEBUG message to the logs

DEBUG Train split [index] with multiple sets of parameters.

For every map in estimatorParamMaps parameter fit fits a model using the Estimator.

fit does the fitting in parallel per parallelism parameter.

Note parallelism parameter defaults to 1 , i.e. no parallelism for fitting models.

fit unpersists the training data (per pair of training and validation RDDs)
Note
when all models have been trained.

fit requests the models to transform their respective validation datasets (with the

corresponding parameters from estimatorParamMaps) and then requests the Evaluator to

evaluate the transformed datasets.

fit prints out the following DEBUG message to the logs:

DEBUG Got metric [metric] for model trained with $paramMap.

fit waits until all metrics are available and unpersists the validation dataset.

Creating CrossValidator Instance

CrossValidator takes the following when created:

Unique ID

Validating and Transforming Schema 

—  transformSchema Method

transformSchema(schema: StructType): StructType

Note transformSchema is part of PipelineStage Contract.

256
CrossValidator — Model Tuning / Finding The Best Model

transformSchema simply passes the call to transformSchemaImpl (that is shared between

CrossValidator and TrainValidationSplit).

257
CrossValidatorModel

CrossValidatorModel
CrossValidatorModel is a Model that is created when CrossValidator is requested to find

the best model (per parameters and dataset).

CrossValidatorModel is MLWritable, i.e. FIXME

Creating CrossValidatorModel Instance

CrossValidatorModel takes the following when created:

Unique ID

Best Model

Average cross-validation metrics

CrossValidatorModel initializes the internal registries and counters.

258
ParamGridBuilder

ParamGridBuilder
ParamGridBuilder is…​FIXME

259
CrossValidator with Pipeline Example

CrossValidator with Pipeline Example

Caution FIXME The example below does NOT work. Being investigated.

FIXME Can k-means be crossvalidated? Does it make any sense? Does it

Caution
only applies to supervised learning?

// Let's create a pipeline with transformers and estimator

import org.apache.spark.ml.feature._

val tok = new Tokenizer().setInputCol("text")

val hashTF = new HashingTF()

.setInputCol(tok.getOutputCol)
.setOutputCol("features")
.setNumFeatures(10)

import org.apache.spark.ml.classification.RandomForestClassifier
val rfc = new RandomForestClassifier

import org.apache.spark.ml.Pipeline
val pipeline = new Pipeline()
.setStages(Array(tok, hashTF, rfc))

// CAUTION: label must be double

// 0 = scientific text
// 1 = non-scientific text
val trainDS = Seq(
(0L, "[science] hello world", 0d),
(1L, "long text", 1d),
(2L, "[science] hello all people", 0d),
(3L, "[science] hello hello", 0d)).toDF("id", "text", "label").cache

// Check out the train dataset

// Values in label and prediction columns should be alike
val sampleModel = pipeline.fit(trainDS)
sampleModel
.transform(trainDS)
.select('text, 'label, 'features, 'prediction)
.show(truncate = false)

+--------------------------+-----+--------------------------+----------+
|text |label|features |prediction|
+--------------------------+-----+--------------------------+----------+
|[science] hello world |0.0 |(10,[0,8],[2.0,1.0]) |0.0 |
|long text |1.0 |(10,[4,9],[1.0,1.0]) |1.0 |
|[science] hello all people|0.0 |(10,[0,6,8],[1.0,1.0,2.0])|0.0 |
|[science] hello hello |0.0 |(10,[0,8],[1.0,2.0]) |0.0 |
+--------------------------+-----+--------------------------+----------+

260
CrossValidator with Pipeline Example

val input = Seq("Hello ScienCE").toDF("text")

sampleModel
.transform(input)
.select('text, 'rawPrediction, 'prediction)
.show(truncate = false)

+-------------+--------------------------------------+----------+
|text |rawPrediction |prediction|
+-------------+--------------------------------------+----------+
|Hello ScienCE|[12.666666666666668,7.333333333333333]|0.0 |
+-------------+--------------------------------------+----------+

import org.apache.spark.ml.tuning.ParamGridBuilder
val paramGrid = new ParamGridBuilder().build

import org.apache.spark.ml.evaluation.BinaryClassificationEvaluator
val binEval = new BinaryClassificationEvaluator

import org.apache.spark.ml.tuning.CrossValidator
val cv = new CrossValidator()
.setEstimator(pipeline) // <-- pipeline is the estimator
.setEvaluator(binEval) // has to match the estimator
.setEstimatorParamMaps(paramGrid)

// WARNING: It does not work!!!

val cvModel = cv.fit(trainDS)

261
Params and ParamMaps

Params (and ParamMaps)

Params is the contract in Spark MLlib for ML components that take parameters.

Params has params collection of Param objects.

import org.apache.spark.ml.recommendation.ALS
val als = new ALS().
setMaxIter(5).
setRegParam(0.01).
setUserCol("userId").
setItemCol("movieId").
setRatingCol("rating")
scala> :type als.params
Array[org.apache.spark.ml.param.Param[_]]

scala> println(als.explainParams)
alpha: alpha for implicit preference (default: 1.0)
checkpointInterval: set checkpoint interval (>= 1) or disable checkpoint (-1). E.g. 10
means that the cache will get checkpointed every 10 iterations (default: 10)
coldStartStrategy: strategy for dealing with unknown or new users/items at prediction
time. This may be useful in cross-validation or production scenarios, for handling use
r/item ids the model has not seen in the training data. Supported values: nan,drop. (d
efault: nan)
finalStorageLevel: StorageLevel for ALS model factors. (default: MEMORY_AND_DISK)
implicitPrefs: whether to use implicit preference (default: false)
intermediateStorageLevel: StorageLevel for intermediate datasets. Cannot be 'NONE'. (d
efault: MEMORY_AND_DISK)
itemCol: column name for item ids. Ids must be within the integer value range. (defaul
t: item, current: movieId)
maxIter: maximum number of iterations (>= 0) (default: 10, current: 5)
nonnegative: whether to use nonnegative constraint for least squares (default: false)
numItemBlocks: number of item blocks (default: 10)
numUserBlocks: number of user blocks (default: 10)
predictionCol: prediction column name (default: prediction)
rank: rank of the factorization (default: 10)
ratingCol: column name for ratings (default: rating, current: rating)
regParam: regularization parameter (>= 0) (default: 0.1, current: 0.01)
seed: random seed (default: 1994790107)
userCol: column name for user ids. Ids must be within the integer value range. (defaul
t: user, current: userId)

262
Params and ParamMaps

import org.apache.spark.ml.tuning.CrossValidator
val cv = new CrossValidator
scala> println(cv.explainParams)
estimator: estimator for selection (undefined)
estimatorParamMaps: param maps for the estimator (undefined)
evaluator: evaluator used to select hyper-parameters that maximize the validated metri
c (undefined)
numFolds: number of folds for cross validation (>= 2) (default: 3)
seed: random seed (default: -1191137437)

Params comes with $ (dollar) method for Spark MLlib developers to access the user-

defined or the default value of a parameter.

Params Contract

package org.apache.spark.ml.param

trait Params {
def copy(extra: ParamMap): Params
}

Table 1. (Subset of) Params Contract

Method Description
copy

Explaining Parameters —  explainParams Method

explainParams(): String

explainParams takes params collection of parameters and converts every parameter to a

corresponding help text with the param name, the description and optionally the default and
the user-defined values if available.

263
Params and ParamMaps

import org.apache.spark.ml.recommendation.ALS
val als = new ALS().
setMaxIter(5).
setRegParam(0.01).
setUserCol("userId").
setItemCol("movieId").
setRatingCol("rating")
scala> println(als.explainParams)
alpha: alpha for implicit preference (default: 1.0)
checkpointInterval: set checkpoint interval (>= 1) or disable checkpoint (-1). E.g. 10
means that the cache will get checkpointed every 10 iterations (default: 10)
coldStartStrategy: strategy for dealing with unknown or new users/items at prediction
time. This may be useful in cross-validation or production scenarios, for handling use
r/item ids the model has not seen in the training data. Supported values: nan,drop. (d
efault: nan)
finalStorageLevel: StorageLevel for ALS model factors. (default: MEMORY_AND_DISK)
implicitPrefs: whether to use implicit preference (default: false)
intermediateStorageLevel: StorageLevel for intermediate datasets. Cannot be 'NONE'. (d
efault: MEMORY_AND_DISK)
itemCol: column name for item ids. Ids must be within the integer value range. (default
: item, current: movieId)
maxIter: maximum number of iterations (>= 0) (default: 10, current: 5)
nonnegative: whether to use nonnegative constraint for least squares (default: false)
numItemBlocks: number of item blocks (default: 10)
numUserBlocks: number of user blocks (default: 10)
predictionCol: prediction column name (default: prediction)
rank: rank of the factorization (default: 10)
ratingCol: column name for ratings (default: rating, current: rating)
regParam: regularization parameter (>= 0) (default: 0.1, current: 0.01)
seed: random seed (default: 1994790107)
userCol: column name for user ids. Ids must be within the integer value range. (default
: user, current: userId)

Copying Parameters with Optional Extra Values 

—  copyValues Method

copyValues[T](to: T, extra: ParamMap = ParamMap.empty): T

copyValues adds extra parameters to paramMap, possibly overridding existing keys.

copyValues iterates over params collection and sets the default value followed by what may

have been defined using the user-defined and extra parameters.

Note copyValues is used mainly for copy method.

264
Params and ParamMaps

265
ValidatorParams

ValidatorParams
Table 1. ValidatorParams' Parameters
Parameter Default Value Description
estimator (undefined) Estimator for best model selection

estimatorParamMaps (undefined) Param maps for the estimator

Evaluator to select hyper-parameters that

evaluator (undefined)
maximize the validated metric

logTuningParams Method

logTuningParams(instrumentation: Instrumentation[_]): Unit

logTuningParams …​FIXME

Note logTuningParams is used when…​FIXME

loadImpl Method

loadImpl[M](
path: String,
sc: SparkContext,
expectedClassName: String): (Metadata, Estimator[M], Evaluator, Array[ParamMap])

loadImpl …​FIXME

Note loadImpl is used when…​FIXME

transformSchemaImpl Method

transformSchemaImpl(schema: StructType): StructType

transformSchemaImpl …​FIXME

transformSchemaImpl is used when CrossValidator and TrainValidationSplit

Note
validate and transform schema.

266
ValidatorParams

267
HasParallelism

HasParallelism
HasParallelism is a Scala trait for Spark MLlib components that allow for specifying the

level of parallelism for multi-threaded execution and provide a thread-pool-based execution

context.

HasParallelism defines parallelism parameter that controls the number of threads in a

cached thread pool.

Table 1. HasParallelism' Parameters

Parameter Default Value Description
The number of threads to use when
parallelism 1 running parallel algorithms
Must be at least 1 .

getExecutionContext Method

getExecutionContext: ExecutionContext

getExecutionContext …​FIXME

Note getExecutionContext is used when…​FIXME

268
ML Persistence — Saving and Loading Models and Pipelines

ML Persistence — Saving and Loading Models

and Pipelines
MLWriter and MLReader belong to org.apache.spark.ml.util package.

They allow you to save and load models despite the languages — Scala, Java, Python or R 
— they have been saved in and loaded later on.

MLWriter
MLWriter abstract class comes with save(path: String) method to save a ML component

to a given path .

save(path: String): Unit

It comes with another (chainable) method overwrite to overwrite the output path if it
already exists.

overwrite(): this.type

The component is saved into a JSON file (see MLWriter Example section below).

Enable INFO logging level for the MLWriter implementation logger to see what
happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.ml.Pipeline$.PipelineWriter=INFO

Refer to Logging.

FIXME The logging doesn’t work and overwriting does not print out INFO
Caution
message to the logs :(

MLWriter Example

import org.apache.spark.ml._
val pipeline = new Pipeline().setStages(Array.empty[PipelineStage])
pipeline.write.overwrite.save("sample-pipeline")

269
ML Persistence — Saving and Loading Models and Pipelines

The result of save for "unfitted" pipeline is a JSON file for metadata (as shown below).

$ cat sample-pipeline/metadata/part-00000 | jq
{
"class": "org.apache.spark.ml.Pipeline",
"timestamp": 1472747720477,
"sparkVersion": "2.1.0-SNAPSHOT",
"uid": "pipeline_181c90b15d65",
"paramMap": {
"stageUids": []
}
}

The result of save for pipeline model is a JSON file for metadata while Parquet for model
data, e.g. coefficients.

val model = pipeline.fit(training)

model.write.save("sample-model")

270
ML Persistence — Saving and Loading Models and Pipelines

$ cat sample-model/metadata/part-00000 | jq
{
"class": "org.apache.spark.ml.PipelineModel",
"timestamp": 1472748168005,
"sparkVersion": "2.1.0-SNAPSHOT",
"uid": "pipeline_3ed598da1c4b",
"paramMap": {
"stageUids": [
"regexTok_bf73e7c36e22",
"hashingTF_ebece38da130",
"logreg_819864aa7120"
]
}
}

$ tree sample-model/stages/
sample-model/stages/
|-- 0_regexTok_bf73e7c36e22
| `-- metadata
| |-- _SUCCESS
| `-- part-00000
|-- 1_hashingTF_ebece38da130
| `-- metadata
| |-- _SUCCESS
| `-- part-00000
`-- 2_logreg_819864aa7120
|-- data
| |-- _SUCCESS
| `-- part-r-00000-56423674-0208-4768-9d83-2e356ac6a8d2.snappy.parquet
`-- metadata
|-- _SUCCESS
`-- part-00000

7 directories, 8 files

MLReader
MLReader abstract class comes with load(path: String) method to load a ML component

from a given path .

271
ML Persistence — Saving and Loading Models and Pipelines

import org.apache.spark.ml._
val pipeline = Pipeline.read.load("sample-pipeline")

scala> val stageCount = pipeline.getStages.size

stageCount: Int = 0

val pipelineModel = PipelineModel.read.load("sample-model")

scala> pipelineModel.stages
res1: Array[org.apache.spark.ml.Transformer] = Array(regexTok_bf73e7c36e22, hashingTF_
ebece38da130, logreg_819864aa7120)

272
MLWritable

MLWritable
MLWritable is…​FIXME

273
MLReader

MLReader
MLReader is the contract for…​FIXME

MLReader Contract

package org.apache.spark.ml.util

abstract class MLReader[T] {

def load(path: String): T
}

Table 1. MLReader Contract

Method Description
load Used when…​

274
Example — Text Classification

Example — Text Classification
The example was inspired by the video Building, Debugging, and Tuning Spark
Note
Machine Learning Pipelines - Joseph Bradley (Databricks).

Problem: Given a text document, classify it as a scientific or non-scientific one.

The example uses a case class LabeledText to have the schema described
Note
nicely.

import spark.implicits._

sealed trait Category

case object Scientific extends Category
case object NonScientific extends Category

// FIXME: Define schema for Category

case class LabeledText(id: Long, category: Category, text: String)

val data = Seq(LabeledText(0, Scientific, "hello world"), LabeledText(1, NonScientific

, "witaj swiecie")).toDF

scala> data.show
+-----+-------------+
|label| text|
+-----+-------------+
| 0| hello world|
| 1|witaj swiecie|
+-----+-------------+

It is then tokenized and transformed into another DataFrame with an additional column
called features that is a Vector of numerical values.

Note Paste the code below into Spark Shell using :paste mode.

import spark.implicits._

case class Article(id: Long, topic: String, text: String)

val articles = Seq(
Article(0, "sci.math", "Hello, Math!"),
Article(1, "alt.religion", "Hello, Religion!"),
Article(2, "sci.physics", "Hello, Physics!"),
Article(3, "sci.math", "Hello, Math Revised!"),
Article(4, "sci.math", "Better Math"),
Article(5, "alt.religion", "TGIF")).toDS

275
Example — Text Classification

Now, the tokenization part comes that maps the input text of each text document into tokens
(a Seq[String] ) and then into a Vector of numerical values that can only then be
understood by a machine learning algorithm (that operates on Vector instances).

scala> articles.show
+---+------------+--------------------+
| id| topic| text|
+---+------------+--------------------+
| 0| sci.math| Hello, Math!|
| 1|alt.religion| Hello, Religion!|
| 2| sci.physics| Hello, Physics!|
| 3| sci.math|Hello, Math Revised!|
| 4| sci.math| Better Math|
| 5|alt.religion| TGIF|
+---+------------+--------------------+

val topic2Label: Boolean => Double = isSci => if (isSci) 1 else 0

val toLabel = udf(topic2Label)

val labelled = articles.withColumn("label", toLabel($"topic".like("sci%"))).cache

val Array(trainDF, testDF) = labelled.randomSplit(Array(0.75, 0.25))

scala> trainDF.show
+---+------------+--------------------+-----+
| id| topic| text|label|
+---+------------+--------------------+-----+
| 1|alt.religion| Hello, Religion!| 0.0|
| 3| sci.math|Hello, Math Revised!| 1.0|
+---+------------+--------------------+-----+

scala> testDF.show
+---+------------+---------------+-----+
| id| topic| text|label|
+---+------------+---------------+-----+
| 0| sci.math| Hello, Math!| 1.0|
| 2| sci.physics|Hello, Physics!| 1.0|
| 4| sci.math| Better Math| 1.0|
| 5|alt.religion| TGIF| 0.0|
+---+------------+---------------+-----+

The train a model phase uses the logistic regression machine learning algorithm to build a
model and predict label for future input text documents (and hence classify them as
scientific or non-scientific).

276
Example — Text Classification

import org.apache.spark.ml.feature.RegexTokenizer
val tokenizer = new RegexTokenizer()
.setInputCol("text")
.setOutputCol("words")

import org.apache.spark.ml.feature.HashingTF
val hashingTF = new HashingTF()
.setInputCol(tokenizer.getOutputCol) // it does not wire transformers -- it's just
a column name
.setOutputCol("features")
.setNumFeatures(5000)

import org.apache.spark.ml.classification.LogisticRegression
val lr = new LogisticRegression().setMaxIter(20).setRegParam(0.01)

import org.apache.spark.ml.Pipeline
val pipeline = new Pipeline().setStages(Array(tokenizer, hashingTF, lr))

It uses two columns, namely label and features vector to build a logistic regression
model to make predictions.

277
Example — Text Classification

val model = pipeline.fit(trainDF)

val trainPredictions = model.transform(trainDF)

val testPredictions = model.transform(testDF)

scala> trainPredictions.select('id, 'topic, 'text, 'label, 'prediction).show

+---+------------+--------------------+-----+----------+
| id| topic| text|label|prediction|
+---+------------+--------------------+-----+----------+
| 1|alt.religion| Hello, Religion!| 0.0| 0.0|
| 3| sci.math|Hello, Math Revised!| 1.0| 1.0|
+---+------------+--------------------+-----+----------+

// Notice that the computations add new columns

scala> trainPredictions.printSchema
root
|-- id: long (nullable = false)
|-- topic: string (nullable = true)
|-- text: string (nullable = true)
|-- label: double (nullable = true)
|-- words: array (nullable = true)
| |-- element: string (containsNull = true)
|-- features: vector (nullable = true)
|-- rawPrediction: vector (nullable = true)
|-- probability: vector (nullable = true)
|-- prediction: double (nullable = true)

import org.apache.spark.ml.evaluation.BinaryClassificationEvaluator
val evaluator = new BinaryClassificationEvaluator().setMetricName("areaUnderROC")

import org.apache.spark.ml.param.ParamMap
val evaluatorParams = ParamMap(evaluator.metricName -> "areaUnderROC")

scala> val areaTrain = evaluator.evaluate(trainPredictions, evaluatorParams)

areaTrain: Double = 1.0

scala> val areaTest = evaluator.evaluate(testPredictions, evaluatorParams)

areaTest: Double = 0.6666666666666666

Let’s tune the model’s hyperparameters (using "tools" from org.apache.spark.ml.tuning

package).

FIXME Review the available classes in the org.apache.spark.ml.tuning

Caution
package.

278
Example — Text Classification

import org.apache.spark.ml.tuning.ParamGridBuilder
val paramGrid = new ParamGridBuilder()
.addGrid(hashingTF.numFeatures, Array(100, 1000))
.addGrid(lr.regParam, Array(0.05, 0.2))
.addGrid(lr.maxIter, Array(5, 10, 15))
.build

// That gives all the combinations of the parameters

paramGrid: Array[org.apache.spark.ml.param.ParamMap] =
Array({
logreg_cdb8970c1f11-maxIter: 5,
hashingTF_8d7033d05904-numFeatures: 100,
logreg_cdb8970c1f11-regParam: 0.05
}, {
logreg_cdb8970c1f11-maxIter: 5,
hashingTF_8d7033d05904-numFeatures: 1000,
logreg_cdb8970c1f11-regParam: 0.05
}, {
logreg_cdb8970c1f11-maxIter: 10,
hashingTF_8d7033d05904-numFeatures: 100,
logreg_cdb8970c1f11-regParam: 0.05
}, {
logreg_cdb8970c1f11-maxIter: 10,
hashingTF_8d7033d05904-numFeatures: 1000,
logreg_cdb8970c1f11-regParam: 0.05
}, {
logreg_cdb8970c1f11-maxIter: 15,
hashingTF_8d7033d05904-numFeatures: 100,
logreg_cdb8970c1f11-regParam: 0.05
}, {
logreg_cdb8970c1f11-maxIter: 15,
hashingTF_8d7033d05904-numFeatures: 1000,
logreg_cdb8970c1f11-...

import org.apache.spark.ml.tuning.CrossValidator
import org.apache.spark.ml.param._
val cv = new CrossValidator()
.setEstimator(pipeline)
.setEstimatorParamMaps(paramGrid)
.setEvaluator(evaluator)
.setNumFolds(10)

val cvModel = cv.fit(trainDF)

Let’s use the cross-validated model to calculate predictions and evaluate their precision.

279
Example — Text Classification

val cvPredictions = cvModel.transform(testDF)

scala> cvPredictions.select('topic, 'text, 'prediction).show

+------------+---------------+----------+
| topic| text|prediction|
+------------+---------------+----------+
| sci.math| Hello, Math!| 0.0|
| sci.physics|Hello, Physics!| 0.0|
| sci.math| Better Math| 1.0|
|alt.religion| TGIF| 0.0|
+------------+---------------+----------+

scala> evaluator.evaluate(cvPredictions, evaluatorParams)

res26: Double = 0.6666666666666666

scala> val bestModel = cvModel.bestModel

bestModel: org.apache.spark.ml.Model[_] = pipeline_8873b744aac7

FIXME Review
Caution
https://github.com/apache/spark/blob/master/mllib/src/test/scala/org/apache/spark/ml/tuning

You can eventually save the model for later use.

cvModel.write.overwrite.save("model")

Congratulations! You’re done.

280
Example — Linear Regression

Example — Linear Regression
The DataFrame used for Linear Regression has to have features column of
org.apache.spark.mllib.linalg.VectorUDT type.

Note You can change the name of the column using featuresCol parameter.

The list of the parameters of LinearRegression :

scala> println(lr.explainParams)
elasticNetParam: the ElasticNet mixing parameter, in range [0, 1]. For alpha = 0, the
penalty is an L2 penalty. For alpha = 1, it is an L1 penalty (default: 0.0)
featuresCol: features column name (default: features)
fitIntercept: whether to fit an intercept term (default: true)
labelCol: label column name (default: label)
maxIter: maximum number of iterations (>= 0) (default: 100)
predictionCol: prediction column name (default: prediction)
regParam: regularization parameter (>= 0) (default: 0.0)
solver: the solver algorithm for optimization. If this is not set or empty, default va
lue is 'auto' (default: auto)
standardization: whether to standardize the training features before fitting the model
(default: true)
tol: the convergence tolerance for iterative algorithms (default: 1.0E-6)
weightCol: weight column name. If this is not set or empty, we treat all instance weig
hts as 1.0 (default: )

Caution FIXME The following example is work in progress.

281
Example — Linear Regression

import org.apache.spark.ml.Pipeline
val pipeline = new Pipeline("my_pipeline")

import org.apache.spark.ml.regression._
val lr = new LinearRegression

val df = sc.parallelize(0 to 9).toDF("num")

val stages = Array(lr)
val model = pipeline.setStages(stages).fit(df)

// the above lines gives:

java.lang.IllegalArgumentException: requirement failed: Column features must be of type
org.apache.spark.mllib.linalg.VectorUDT@f71b0bce but was actually IntegerType.
at scala.Predef$.require(Predef.scala:219)
at org.apache.spark.ml.util.SchemaUtils$.checkColumnType(SchemaUtils.scala:42)
at org.apache.spark.ml.PredictorParams$class.validateAndTransformSchema(Predictor.sc
ala:51)
at org.apache.spark.ml.Predictor.validateAndTransformSchema(Predictor.scala:72)
at org.apache.spark.ml.Predictor.transformSchema(Predictor.scala:117)
at org.apache.spark.ml.Pipeline$$anonfun$transformSchema$4.apply(Pipeline.scala:182)
at org.apache.spark.ml.Pipeline$$anonfun$transformSchema$4.apply(Pipeline.scala:182)
at scala.collection.IndexedSeqOptimized$class.foldl(IndexedSeqOptimized.scala:57)
at scala.collection.IndexedSeqOptimized$class.foldLeft(IndexedSeqOptimized.scala:66)
at scala.collection.mutable.ArrayOps$ofRef.foldLeft(ArrayOps.scala:186)
at org.apache.spark.ml.Pipeline.transformSchema(Pipeline.scala:182)
at org.apache.spark.ml.PipelineStage.transformSchema(Pipeline.scala:66)
at org.apache.spark.ml.Pipeline.fit(Pipeline.scala:133)
... 51 elided

282
Logistic Regression

Logistic Regression
In statistics, logistic regression, or logit regression, or logit model is a regression
model where the dependent variable (DV) is categorical.

— Wikipedia, the free encyclopedia

Logistic regression

283
LogisticRegression

LogisticRegression
LogisticRegression is…​FIXME

284
Latent Dirichlet Allocation (LDA)

Latent Dirichlet Allocation (LDA)

Information here are based almost exclusively from the blog post Topic
Note
modeling with LDA: MLlib meets GraphX.

Topic modeling is a type of model that can be very useful in identifying hidden thematic
structure in documents. Broadly speaking, it aims to find structure within an unstructured
collection of documents. Once the structure is "discovered", you may answer questions like:

What is document X about?

How similar are documents X and Y?

If I am interested in topic Z, which documents should I read first?

Spark MLlib offers out-of-the-box support for Latent Dirichlet Allocation (LDA) which is the
first MLlib algorithm built upon GraphX.

Topic models automatically infer the topics discussed in a collection of documents.

Example

FIXME Use Tokenizer, StopWordsRemover, CountVectorizer, and finally LDA

Caution
in a pipeline.

285
Vector

Vector
Vector sealed trait represents a numeric vector of values (of Double type) and their

indices (of Int type).

It belongs to org.apache.spark.mllib.linalg package.

To Scala and Java developers:

Vector class in Spark MLlib belongs to org.apache.spark.mllib.linalg

Note package.
It is not the Vector type in Scala or Java. Train your eyes to see two types of
the same name. You’ve been warned.

A Vector object knows its size .

A Vector object can be converted to:

Array[Double] using toArray .

a dense vector as DenseVector using toDense .

a sparse vector as SparseVector using toSparse .

(1.6.0) a JSON string using toJson .

(internal) a breeze vector as BV[Double] using toBreeze .

There are exactly two available implementations of Vector sealed trait (that also belong to
org.apache.spark.mllib.linalg package):

DenseVector

SparseVector

Use Vectors factory object to create vectors, be it DenseVector or

Tip
SparseVector .

286
Vector

import org.apache.spark.mllib.linalg.Vectors

// You can create dense vectors explicitly by giving values per index
val denseVec = Vectors.dense(Array(0.0, 0.4, 0.3, 1.5))
val almostAllZeros = Vectors.dense(Array(0.0, 0.4, 0.3, 1.5, 0.0, 0.0, 0.0, 0.0, 0.0,
0.0))

// You can however create a sparse vector by the size and non-zero elements
val sparse = Vectors.sparse(10, Seq((1, 0.4), (2, 0.3), (3, 1.5)))

// Convert a dense vector to a sparse one

val fromSparse = sparse.toDense

scala> almostAllZeros == fromSparse

res0: Boolean = true

Note The factory object is called Vectors (plural).

import org.apache.spark.mllib.linalg._

// prepare elements for a sparse vector

// NOTE: It is more Scala rather than Spark
val indices = 0 to 4
val elements = indices.zip(Stream.continually(1.0))
val sv = Vectors.sparse(elements.size, elements)

// Notice how Vector is printed out

scala> sv
res4: org.apache.spark.mllib.linalg.Vector = (5,[0,1,2,3,4],[1.0,1.0,1.0,1.0,1.0])

scala> sv.size
res0: Int = 5

scala> sv.toArray
res1: Array[Double] = Array(1.0, 1.0, 1.0, 1.0, 1.0)

scala> sv == sv.copy
res2: Boolean = true

scala> sv.toJson
res3: String = {"type":0,"size":5,"indices":[0,1,2,3,4],"values":[1.0,1.0,1.0,1.0,1.0]}

287
LabeledPoint

LabeledPoint
Caution FIXME

LabeledPoint is a convenient class for declaring a schema for DataFrames that are used as

input data for Linear Regression in Spark MLlib.

288
Streaming MLlib

Streaming MLlib
The following Machine Learning algorithms have their streaming variants in MLlib:

k-means

Linear Regression

Logistic Regression

They can train models and predict on streaming data.

Note The streaming algorithms belong to spark.mllib (the older RDD-based API).

Streaming k-means
org.apache.spark.mllib.clustering.StreamingKMeans

Streaming Linear Regression

org.apache.spark.mllib.regression.StreamingLinearRegressionWithSGD

Streaming Logistic Regression

org.apache.spark.mllib.classification.StreamingLogisticRegressionWithSGD

Sources
Streaming Machine Learning in Spark- Jeremy Freeman (HHMI Janelia Research
Center)

289
GeneralizedLinearRegression

GeneralizedLinearRegression (GLM)
GeneralizedLinearRegression is a regression algorithm. It supports the following error

distribution families:

1. gaussian

2. binomial

3. poisson

4. gamma

GeneralizedLinearRegression supports the following relationship between the linear

predictor and the mean of the distribution function links:

1. identity

2. logit

3. log

4. inverse

5. probit

6. cloglog

7. sqrt

GeneralizedLinearRegression supports 4096 features.

The label column has to be of DoubleType type.

GeneralizedLinearRegression belongs to org.apache.spark.ml.regression

Note
package.

import org.apache.spark.ml.regression._
val glm = new GeneralizedLinearRegression()

import org.apache.spark.ml.linalg._
val features = Vectors.sparse(5, Seq((3,1.0)))
val trainDF = Seq((0, features, 1)).toDF("id", "features", "label")
val glmModel = glm.fit(trainDF)

GeneralizedLinearRegression is a Regressor with features of Vector type that can train a

GeneralizedLinearRegressionModel.

290
GeneralizedLinearRegression

GeneralizedLinearRegressionModel

Regressor
Regressor is a custom Predictor.

291
Alternating Least Squares (ALS) Matrix Factorization

Alternating Least Squares (ALS) Matrix

Factorization for Recommender Systems
Alternating Least Squares (ALS) Matrix Factorization is a recommendation
algorithm…​FIXME

Read the original paper Scalable Collaborative Filtering with Jointly Derived
Tip
Neighborhood Interpolation Weights by Robert M. Bell and Yehuda Koren.

Recommender systems based on collaborative filtering predict user preferences for

products or services by learning past user-item relationships. A predominant approach
to collaborative filtering is neighborhood based ("k-nearest neighbors"), where a user-
item preference rating is interpolated from ratings of similar items and/or users.

Our method is very fast in practice, generating a prediction in about 0.2 milliseconds.
Importantly, it does not require training many parameters or a lengthy preprocessing,
making it very practical for large scale applications. Finally, we show how to apply these
methods to the perceivably much slower user-oriented approach. To this end, we
suggest a novel scheme for low dimensional embedding of the users. We evaluate
these methods on the Netflix dataset, where they deliver significantly better results than
the commercial Netflix Cinematch recommender system.

— Robert M. Bell and Yehuda Koren

Scalable Collaborative Filtering with Jointly Derived Neighborhood Interpolation Weights
Read the follow-up paper Collaborative Filtering for Implicit Feedback Datasets
Tip
by Yifan Hu, Yehuda Koren and Chris Volinsky.

ALS Example

// Based on JavaALSExample from the official Spark examples

// https://github.com/apache/spark/blob/master/examples/src/main/java/org/apache/spark
/examples/ml/JavaALSExample.java

// 1. Save the code to als.scala

// 2. Run `spark-shell -i als.scala`

import spark.implicits._

import org.apache.spark.ml.recommendation.ALS
val als = new ALS().
setMaxIter(5).
setRegParam(0.01).
setUserCol("userId").
setItemCol("movieId").
setRatingCol("rating")

292
Alternating Least Squares (ALS) Matrix Factorization

import org.apache.spark.ml.recommendation.ALS.Rating
// FIXME Use a much richer dataset, i.e. Spark's data/mllib/als/sample_movielens_ratin
gs.txt
// FIXME Load it using spark.read
val ratings = Seq(
Rating(0, 2, 3),
Rating(0, 3, 1),
Rating(0, 5, 2),
Rating(1, 2, 2)).toDF("userId", "movieId", "rating")
val Array(training, testing) = ratings.randomSplit(Array(0.8, 0.2))

// Make sure that the RDDs have at least one record

assert(training.count > 0)
assert(testing.count > 0)

import org.apache.spark.ml.recommendation.ALSModel
val model = als.fit(training)

// drop NaNs
model.setColdStartStrategy("drop")
val predictions = model.transform(testing)

import org.apache.spark.ml.evaluation.RegressionEvaluator
val evaluator = new RegressionEvaluator().
setMetricName("rmse"). // root mean squared error
setLabelCol("rating").
setPredictionCol("prediction")
val rmse = evaluator.evaluate(predictions)
println(s"Root-mean-square error = $rmse")

// Model is ready for recommendations

// Generate top 10 movie recommendations for each user

val userRecs = model.recommendForAllUsers(10)
userRecs.show(truncate = false)

// Generate top 10 user recommendations for each movie

val movieRecs = model.recommendForAllItems(10)
movieRecs.show(truncate = false)

// Generate top 10 movie recommendations for a specified set of users

// Use a trick to make sure we work with the known users from the input
val users = ratings.select(als.getUserCol).distinct.limit(3)
val userSubsetRecs = model.recommendForUserSubset(users, 10)
userSubsetRecs.show(truncate = false)

// Generate top 10 user recommendations for a specified set of movies

val movies = ratings.select(als.getItemCol).distinct.limit(3)
val movieSubSetRecs = model.recommendForItemSubset(movies, 10)
movieSubSetRecs.show(truncate = false)

System.exit(0)

293
Alternating Least Squares (ALS) Matrix Factorization

294
ALS — Estimator for ALSModel

ALS — Estimator for ALSModel

ALS is an Estimator that generates a ALSModel.

ALS uses als-[random-numbers] for the default identifier.

ALS can be fine-tuned using parameters.

Table 1. ALS’s Parameters (aka ALSParams)

Parameter Default Value Description
Alpha constant in the implicit
preference formulation
Must be non-negative, i.e. at
least 0 .
alpha 1.0
Used when ALS trains a model
(and computes factors for users
and items datasets) with
implicit preference enabled
(which is disabled by default)

Checkpoint interval, i.e. how

many iterations between
checkpointInterval 10 checkpoints.
Must be at least 1 or exactly
-1 to disable checkpointing

Strategy for dealing with

unknown or new users/items at
prediction time, i.e. what
happens for user or item ids the
model has not seen in the
training data.

Supported values:
coldStartStrategy nan
nan - predicted value for
unknown ids will be NaN
drop - rows in the input
DataFrame containing
unknown ids are dropped
from the output DataFrame
(with predictions).

StorageLevel for ALS model

finalStorageLevel MEMORY_AND_DISK
factors

295
ALS — Estimator for ALSModel

implicitPrefs false Flag to turn implicit preference

on ( true ) or off ( false )

StorageLevel for intermediate

intermediateStorageLevel MEMORY_AND_DISK
datasets. Must not be NONE .

Column name for item ids

itemCol item Must be all integers or
numerics within the integer
value range

Maximum number of iterations

maxIter 10
Must be non-negative, i.e. at
least 0 .

Flag to decide whether to apply

nonnegative Disabled ( false ) nonnegativity constraints for
least squares.

Number of user blocks

numUserBlocks 10
Has to be at least 1 .

Number of item blocks

numItemBlocks 10
Has to be at least 1 .

Column name for predictions

predictionCol prediction
The main purpose of the
estimator

Of type FloatType

Rank of the matrix factorization

rank 10
Has to be at least 1 .

Column name for ratings

Must be all integers or

numerics within the integer
ratingCol rating value range
Cast to FloatType
Set to 1.0 when
undefined

Regularization parameter

296
ALS — Estimator for ALSModel

regParam 10 Must be non-negative, i.e. at

least 0 .

seed Randomly-generated Random seed

Column name for user ids

userCol user Must be all integers or
numerics within the integer
value range

computeFactors Internal Method

computeFactors[ID](
srcFactorBlocks: RDD[(Int, FactorBlock)],
srcOutBlocks: RDD[(Int, OutBlock)],
dstInBlocks: RDD[(Int, InBlock[ID])],
rank: Int,
regParam: Double,
srcEncoder: LocalIndexEncoder,
implicitPrefs: Boolean = false,
alpha: Double = 1.0,
solver: LeastSquaresNESolver): RDD[(Int, FactorBlock)]

computeFactors …​FIXME

Note computeFactors is used when…​FIXME

Fitting ALSModel —  fit Method

fit(dataset: Dataset[_]): ALSModel

Internally, fit validates the schema of the dataset (to make sure that the types of the
columns are correct and the prediction column is not available yet).

fit casts the rating column (as defined using ratingCol parameter) to FloatType .

fit selects user, item and rating columns (from the dataset ) and converts it to RDD of

Rating instances.

Note fit converts the dataset to RDD using rdd operator.

fit prints out the training parameters as INFO message to the logs:

297
ALS — Estimator for ALSModel

INFO ...FIXME

fit trains a model, i.e. generates a pair of RDDs of user and item factors.

fit converts the RDDs with user and item factors to corresponding DataFrames with id

and features columns.

fit creates a ALSModel .

fit prints out the following INFO message to the logs:

INFO training finished

Caution FIXME Check out the log

In the end, fit copies parameter values to the ALSModel model.

Caution FIXME Why is the copying necessary?

partitionRatings Internal Method

partitionRatings[ID](
ratings: RDD[Rating[ID]],
srcPart: Partitioner,
dstPart: Partitioner): RDD[((Int, Int), RatingBlock[ID])]

partitionRatings …​FIXME

Note partitionRatings is used when…​FIXME

makeBlocks Internal Method

makeBlocks[ID](
prefix: String,
ratingBlocks: RDD[((Int, Int), RatingBlock[ID])],
srcPart: Partitioner,
dstPart: Partitioner,
storageLevel: StorageLevel)(
implicit srcOrd: Ordering[ID]): (RDD[(Int, InBlock[ID])], RDD[(Int, OutBlock)])

makeBlocks …​FIXME

Note makeBlocks is used when…​FIXME

298
ALS — Estimator for ALSModel

train Method

train[ID](
ratings: RDD[Rating[ID]],
rank: Int = 10,
numUserBlocks: Int = 10,
numItemBlocks: Int = 10,
maxIter: Int = 10,
regParam: Double = 0.1,
implicitPrefs: Boolean = false,
alpha: Double = 1.0,
nonnegative: Boolean = false,
intermediateRDDStorageLevel: StorageLevel = StorageLevel.MEMORY_AND_DISK,
finalRDDStorageLevel: StorageLevel = StorageLevel.MEMORY_AND_DISK,
checkpointInterval: Int = 10,
seed: Long = 0L)(
implicit ord: Ordering[ID]): (RDD[(ID, Array[Float])], RDD[(ID, Array[Float])])

train first creates

train partition the ratings RDD (using two HashPartitioners with numUserBlocks and

numItemBlocks partitions) and immediately persists the RDD per

intermediateRDDStorageLevel storage level.

train creates a pair of user in and out block RDDs for blockRatings .

train triggers caching.

train uses a Spark idiom to trigger caching by counting the elements of an

Note
RDD.

train swaps users and items to create a swappedBlockRatings RDD.

train creates a pair of user in and out block RDDs for the swappedBlockRatings RDD.

train triggers caching.

train creates LocalIndexEncoders for user and item HashPartitioner partitioners.

Caution FIXME train gets too "heavy", i.e. advanced. Gave up for now. Sorry.

train throws a IllegalArgumentException when ratings is empty.

requirement failed: No ratings available from [ratings]

train throws a IllegalArgumentException when intermediateRDDStorageLevel is NONE .

299
ALS — Estimator for ALSModel

requirement failed: ALS is not designed to run without persisting intermediate RDDs.

Note train is used when…​FIXME

validateAndTransformSchema Internal Method

validateAndTransformSchema(schema: StructType): StructType

validateAndTransformSchema …​FIXME

validateAndTransformSchema is used exclusively when ALS is requested to

Note
transform a dataset schema.

Transforming Dataset Schema —  transformSchema

Method

transformSchema(schema: StructType): StructType

Internally, transformSchema …​FIXME

300
ALSModel — Model for Predictions

ALSModel — Model for Predictions

ALSModel is a model fitted by ALS algorithm.

A Model in Spark MLlib is a Transformer that comes with a custom transform

Note
method.

When making prediction (i.e. executed), ALSModel …​FIXME

ALSModel is created when:

ALS fits a ALSModel

ALSModel copies a ALSModel

ALSModelReader loads a ALSModel from a persistent storage

ALSModel is a MLWritable.

301
ALSModel — Model for Predictions

// The following spark-shell session is used to show

// how ALSModel works under the covers
// Mostly to learn how to work with the private ALSModel class

// Use paste raw mode to copy the code

// :paste -raw (or its shorter version :pa -raw)
// BEGIN :pa -raw
package org.apache.spark.ml

import org.apache.spark.sql._
class MyALS(spark: SparkSession) {
import spark.implicits._
val userFactors = Seq((0, Seq(0.3, 0.2))).toDF("id", "features")
val itemFactors = Seq((0, Seq(0.3, 0.2))).toDF("id", "features")
import org.apache.spark.ml.recommendation._
val alsModel = new ALSModel(uid = "uid", rank = 10, userFactors, itemFactors)
}
// END :pa -raw

// Copy the following to spark-shell directly

import org.apache.spark.ml._
val model = new MyALS(spark).
alsModel.
setUserCol("user").
setItemCol("item")

import org.apache.spark.sql.types._
val mySchema = new StructType().
add($"user".float).
add($"item".float)

val transformedSchema = model.transformSchema(mySchema)

scala> transformedSchema.printTreeString
root
|-- user: float (nullable = true)
|-- item: float (nullable = true)
|-- prediction: float (nullable = false)

Making Predictions —  transform Method

transform(dataset: Dataset[_]): DataFrame

Note transform is part of Transformer Contract.

Internally, transform validates the schema of the dataset .

transform left-joins the dataset with userFactors dataset (using userCol column of

dataset and id column of userFactors).

302
ALSModel — Model for Predictions

Left join takes two datasets and gives all the rows from the left side (of the join)
combined with the corresponding row from the right side if available or null .

val rows0 = spark.range(0)

val rows5 = spark.range(5)
scala> rows0.join(rows5, Seq("id"), "left").show
+---+
| id|
+---+
+---+

scala> rows5.join(rows0, Seq("id"), "left").count

res3: Long = 5

scala> spark.range(0, 55).join(spark.range(56, 200), Seq("id"), "left").count

res4: Long = 55

val rows02 = spark.range(0, 2)

Note val rows39 = spark.range(3, 9)
scala> rows02.join(rows39, Seq("id"), "left").show
+---+
| id|
+---+
| 0|
| 1|
+---+

val names = Seq((3, "three"), (4, "four")).toDF("id", "name")

scala> rows02.join(names, Seq("id"), "left").show
+---+----+
| id|name|
+---+----+
| 0|null|
| 1|null|
+---+----+

transform left-joins the dataset with itemFactors dataset (using itemCol column of

dataset and id column of itemFactors).

transform makes predictions using the features columns of userFactors and itemFactors

datasets (per every row in the left-joined dataset).

transform takes (selects) all the columns from the dataset and predictionCol with

predictions.

Ultimately, transform drops rows containing null or NaN values for predictions if
coldStartStrategy is drop .

The default value of coldStartStrategy is nan that does not drop missing
Note
values from predictions column.

transformSchema Method

transformSchema(schema: StructType): StructType

303
ALSModel — Model for Predictions

Note transformSchema is part of Transformer Contract.

Internally, transform validates the schema of the dataset .

Creating ALSModel Instance

ALSModel takes the following when created:

Unique ID

Rank

DataFrame of user factors

DataFrame of item factors

ALSModel initializes the internal registries and counters.

Requesting sdot from BLAS —  predict Internal Property

predict: UserDefinedFunction

predict is a user-defined function (UDF) that takes two collections of float numbers and

requests BLAS for sdot .

Caution FIXME Read about com.github.fommil.netlib.BLAS.getInstance.sdot .

Note predict is a mere wrapper of com.github.fommil.netlib.BLAS.

Note predict is used exclusively when ALSModel is requested to transform.

Creating ALSModel with Extra Parameters —  copy

Method

copy(extra: ParamMap): ALSModel

Note copy is part of Model Contract.

copy creates a new ALSModel .

copy then copies extra parameters to the new ALSModel and sets the parent.

304
ALSModel — Model for Predictions

305
ALSModelReader

ALSModelReader
ALSModelReader is…​FIXME

load Method

load(path: String): ALSModel

Note load is part of MLReader Contract.

load …​FIXME

306
Instrumentation

Instrumentation
Instrumentation is…​FIXME

Printing Out Parameters to Logs —  logParams Method

logParams(params: Param[_]*): Unit

logParams …​FIXME

Note logParams is used when…​FIXME

Creating Instrumentation —  create Method

create[E](estimator: E, dataset: Dataset[_]): Instrumentation[E]

create …​FIXME

Note create is used when…​FIXME

307
MLUtils

MLUtils
MLUtils is…​FIXME

kFold Method

kFold[T](rdd: RDD[T], numFolds: Int, seed: Long): Array[(RDD[T], RDD[T])]

kFold …​FIXME

Note kFold is used when…​FIXME

308
Spark Shell — spark-shell shell script

Spark Shell — spark-shell shell script

Spark shell is an interactive environment where you can learn how to make the most out of
Apache Spark quickly and conveniently.

Tip Spark shell is particularly helpful for fast interactive prototyping.

Under the covers, Spark shell is a standalone Spark application written in Scala that offers
environment with auto-completion (using TAB key) where you can run ad-hoc queries and
get familiar with the features of Spark (that help you in developing your own standalone
Spark applications). It is a very convenient tool to explore the many things available in Spark
with immediate feedback. It is one of the many reasons why Spark is so helpful for tasks to
process datasets of any size.

There are variants of Spark shell for different languages: spark-shell for Scala, pyspark
for Python and sparkR for R.

Note This document (and the book in general) uses spark-shell for Scala only.

You can start Spark shell using spark-shell script.

$ ./bin/spark-shell
scala>

spark-shell is an extension of Scala REPL with automatic instantiation of SparkSession as

spark (and SparkContext as sc ).

scala> :type spark

org.apache.spark.sql.SparkSession

// Learn the current version of Spark in use

scala> spark.version
res0: String = 2.1.0-SNAPSHOT

spark-shell also imports Scala SQL’s implicits and sql method.

scala> :imports
1) import spark.implicits._ (59 terms, 38 are implicit)
2) import spark.sql (1 terms)

309
Spark Shell — spark-shell shell script

When you execute spark-shell you actually execute Spark submit as follows:

org.apache.spark.deploy.SparkSubmit --class
org.apache.spark.repl.Main --name Spark shell spark-
Note shell

Set SPARK_PRINT_LAUNCH_COMMAND to see the entire command to be executed.

Refer to Print Launch Command of Spark Scripts.

Using Spark shell

You start Spark shell using spark-shell script (available in bin directory).

$ ./bin/spark-shell
Setting default log level to "WARN".
To adjust logging level use sc.setLogLevel(newLevel). For SparkR, use setLogLevel(newL
evel).
WARN NativeCodeLoader: Unable to load native-hadoop library for your platform... using
builtin-java classes where applicable
WARN ObjectStore: Failed to get database global_temp, returning NoSuchObjectException
Spark context Web UI available at http://10.47.71.138:4040
Spark context available as 'sc' (master = local[*], app id = local-1477858597347).
Spark session available as 'spark'.
Welcome to
____ __
/ __/__ ___ _____/ /__
_\ \/ _ \/ _ `/ __/ '_/
/___/ .__/\_,_/_/ /_/\_\ version 2.1.0-SNAPSHOT
/_/

Using Scala version 2.11.8 (Java HotSpot(TM) 64-Bit Server VM, Java 1.8.0_112)
Type in expressions to have them evaluated.
Type :help for more information.

scala>

Spark shell creates an instance of SparkSession under the name spark for you (so you
don’t have to know the details how to do it yourself on day 1).

scala> :type spark

org.apache.spark.sql.SparkSession

Besides, there is also sc value created which is an instance of SparkContext.

310
Spark Shell — spark-shell shell script

scala> :type sc
org.apache.spark.SparkContext

To close Spark shell, you press Ctrl+D or type in :q (or any subset of :quit ).

scala> :q

Settings
Table 1. Spark Properties
Spark Property Default Value Description
Used in spark-shell to create REPL
ClassLoader to load new classes defined
in the Scala REPL as a user types code.

spark.repl.class.uri null Enable INFO logging level for

org.apache.spark.executor.Executor
logger to have the value printed out to
the logs:
INFO Using REPL class URI: [classUri]

311
Spark Submit — spark-submit shell script

Spark Submit —  spark-submit shell script

spark-submit shell script allows you to manage your Spark applications.

You can submit your Spark application to a Spark deployment environment for execution, kill
or request status of Spark applications.

You can find spark-submit script in bin directory of the Spark distribution.

$ ./bin/spark-submit
Usage: spark-submit [options] <app jar | python file> [app arguments]
Usage: spark-submit --kill [submission ID] --master [spark://...]
Usage: spark-submit --status [submission ID] --master [spark://...]
Usage: spark-submit run-example [options] example-class [example args]
...

When executed, spark-submit script first checks whether SPARK_HOME environment variable
is set and sets it to the directory that contains bin/spark-submit shell script if not. It then
executes spark-class shell script to run SparkSubmit standalone application.

FIXME Add Cluster Manager and Deploy Mode to the table below (see
Caution
options value)

Table 1. Command-Line Options, Spark Properties and Environment Variables (from SparkSubmitArgum
handle)
Command-
Spark Property Environment Variable
Line Option
action Defaults to

--archives

--conf

--deploy-
mode
spark.submit.deployMode DEPLOY_MODE Deploy mode

--driver-
class-path
spark.driver.extraClassPath The driver’s class path

--driver-
java-options
spark.driver.extraJavaOptions The driver’s JVM option

--driver-
library-path
spark.driver.extraLibraryPath The driver’s native libra

--driver-
memory
spark.driver.memory SPARK_DRIVER_MEMORY The driver’s memory

312
Spark Submit — spark-submit shell script

--driver-
spark.driver.cores
cores

--exclude-
spark.jars.excludes
packages

--executor-
cores
spark.executor.cores SPARK_EXECUTOR_CORES The number of executo

--executor-
memory
spark.executor.memory SPARK_EXECUTOR_MEMORY An executor’s memory

--files spark.files

ivyRepoPath spark.jars.ivy

--jars spark.jars

--keytab spark.yarn.keytab

submissionToKill
--kill
to KILL

--master spark.master MASTER Master URL. Defaults to

--class

SPARK_YARN_APP_NAME
Uses mainClass
--name spark.app.name
(YARN only) off primaryResource
ways set it

--num-
executors spark.executor.instances

--packages spark.jars.packages

--principal spark.yarn.principal

--
properties- spark.yarn.principal
file

--proxy-
user

--py-files

--queue

--
repositories

313
Spark Submit — spark-submit shell script

submissionToRequestSta
--status
action set to

--supervise

--total-
executor- spark.cores.max
cores

--verbose

--version SparkSubmit.printVersi

--help printUsageAndExit(0)

--usage-
printUsageAndExit(1)
error

Set SPARK_PRINT_LAUNCH_COMMAND environment variable to have the complete

Spark command printed out to the console, e.g.

$ SPARK_PRINT_LAUNCH_COMMAND=1 ./bin/spark-shell
Spark Command: /Library/Ja...
Tip

Refer to Print Launch Command of Spark Scripts (or

org.apache.spark.launcher.Main Standalone Application where this environment
variable is actually used).

Avoid using scala.App trait for a Spark application’s main class in Scala as
reported in SPARK-4170 Closure problems when running Scala app that "extends
Tip App".
Refer to Executing Main —  runMain internal method in this document.

Preparing Submit Environment 

—  prepareSubmitEnvironment Internal Method

prepareSubmitEnvironment(args: SparkSubmitArguments)
: (Seq[String], Seq[String], Map[String, String], String)

prepareSubmitEnvironment creates a 4-element tuple, i.e. (childArgs, childClasspath,

sysProps, childMainClass) .

314
Spark Submit — spark-submit shell script

Table 2. prepareSubmitEnvironment 's Four-Element Return Tuple

Element Description
childArgs Arguments

childClasspath Classpath elements

sysProps Spark properties

childMainClass Main class

prepareSubmitEnvironment uses options to…​

Caution FIXME

Note prepareSubmitEnvironment is used in SparkSubmit object.

Tip See the elements of the return tuple using --verbose command-line option.

Custom Spark Properties File —  --properties-file

command-line option

--properties-file [FILE]

--properties-file command-line option sets the path to a file FILE from which Spark

loads extra Spark properties.

Tip Spark uses conf/spark-defaults.conf by default.

Driver Cores in Cluster Deploy Mode —  --driver-cores

command-line option

--driver-cores NUM

--driver-cores command-line option sets the number of cores to NUM for the driver in the

cluster deploy mode.

--driver-cores switch is only available for cluster mode (for Standalone,

Note
Mesos, and YARN).

Note It corresponds to spark.driver.cores setting.

315
Spark Submit — spark-submit shell script

Note It is printed out to the standard error output in verbose mode.

Additional JAR Files to Distribute —  --jars command-

line option

--jars JARS

--jars is a comma-separated list of local jars to include on the driver’s and executors'

classpaths.

Caution FIXME

Additional Files to Distribute --files command-line

option

--files FILES

Caution FIXME

Additional Archives to Distribute —  --archives

command-line option

--archives ARCHIVES

Caution FIXME

Specifying YARN Resource Queue —  --queue command-

line option

--queue QUEUE_NAME

With --queue you can choose the YARN resource queue to submit a Spark application to.
The default queue name is default .

Caution FIXME What is a queue ?

Note It corresponds to spark.yarn.queue Spark’s setting.

316
Spark Submit — spark-submit shell script

Tip It is printed out to the standard error output in verbose mode.

Actions

Submitting Applications for Execution —  submit method

The default action of spark-submit script is to submit a Spark application to a deployment
environment for execution.

Use --verbose command-line switch to know the main class to be executed,

Tip arguments, system properties, and classpath (to ensure that the command-line
arguments and switches were processed properly).

When executed, spark-submit executes submit method.

submit(args: SparkSubmitArguments): Unit

If proxyUser is set it will…​FIXME

Caution FIXME Review why and when to use proxyUser .

It passes the execution on to runMain.

Executing Main —  runMain internal method

runMain(
childArgs: Seq[String],
childClasspath: Seq[String],
sysProps: Map[String, String],
childMainClass: String,
verbose: Boolean): Unit

runMain is an internal method to build execution environment and invoke the main method

of the Spark application that has been submitted for execution.

Note It is exclusively used when submitting applications for execution.

When verbose input flag is enabled (i.e. true ) runMain prints out all the input
parameters, i.e. childMainClass , childArgs , sysProps , and childClasspath (in that
order).

317
Spark Submit — spark-submit shell script

Main class:
[childMainClass]
Arguments:
[childArgs one per line]
System properties:
[sysProps one per line]
Classpath elements:
[childClasspath one per line]

Note Use spark-submit 's --verbose command-line option to enable verbose flag.

runMain builds the context classloader (as loader ) depending on

spark.driver.userClassPathFirst flag.

Caution FIXME Describe spark.driver.userClassPathFirst

It adds the jars specified in childClasspath input parameter to the context classloader (that
is later responsible for loading the childMainClass main class).

childClasspath input parameter corresponds to --jars command-line option

Note
with the primary resource if specified in client deploy mode.

It sets all the system properties specified in sysProps input parameter (using Java’s
System.setProperty method).

It creates an instance of childMainClass main class (as mainClass ).

Note childMainClass is the main class spark-submit has been invoked with.

Avoid using scala.App trait for a Spark application’s main class in Scala as
Tip reported in SPARK-4170 Closure problems when running Scala app that "extends
App".

If you use scala.App for the main class, you should see the following warning message in
the logs:

Warning: Subclasses of scala.App may not work correctly. Use a main() method instead.

Finally, runMain executes the main method of the Spark application passing in the
childArgs arguments.

Any SparkUserAppException exceptions lead to System.exit while the others are simply re-
thrown.

Adding Local Jars to ClassLoader —  addJarToClasspath internal method

318
Spark Submit — spark-submit shell script

addJarToClasspath(localJar: String, loader: MutableURLClassLoader)

addJarToClasspath is an internal method to add file or local jars (as localJar ) to the

loader classloader.

Internally, addJarToClasspath resolves the URI of localJar . If the URI is file or local
and the file denoted by localJar exists, localJar is added to loader . Otherwise, the
following warning is printed out to the logs:

Warning: Local jar /path/to/fake.jar does not exist, skipping.

For all other URIs, the following warning is printed out to the logs:

Warning: Skip remote jar hdfs://fake.jar.

addJarToClasspath assumes file URI when localJar has no URI specified,

Note
e.g. /path/to/local.jar .

FIXME What is a URI fragment? How does this change re YARN distributed
Caution
cache? See Utils#resolveURI .

Killing Applications —  --kill command-line option

--kill

Requesting Application Status —  --status command-line

option
--status

Command-line Options
Execute spark-submit --help to know about the command-line options supported.

➜ spark git:(master) ✗ ./bin/spark-submit --help

Usage: spark-submit [options] <app jar | python file> [app arguments]
Usage: spark-submit --kill [submission ID] --master [spark://...]
Usage: spark-submit --status [submission ID] --master [spark://...]
Usage: spark-submit run-example [options] example-class [example args]

Options:
--master MASTER_URL spark://host:port, mesos://host:port, yarn, or local.
--deploy-mode DEPLOY_MODE Whether to launch the driver program locally ("client")

319
Spark Submit — spark-submit shell script

or
on one of the worker machines inside the cluster ("clust
er")
(Default: client).
--class CLASS_NAME Your application's main class (for Java / Scala apps).
--name NAME A name of your application.
--jars JARS Comma-separated list of local jars to include on the dri
ver
and executor classpaths.
--packages Comma-separated list of maven coordinates of jars to inc
lude
on the driver and executor classpaths. Will search the l
ocal
maven repo, then maven central and any additional remote
repositories given by --repositories. The format for the
coordinates should be groupId:artifactId:version.
--exclude-packages Comma-separated list of groupId:artifactId, to exclude w
hile
resolving the dependencies provided in --packages to avo
id
dependency conflicts.
--repositories Comma-separated list of additional remote repositories t
o
search for the maven coordinates given with --packages.
--py-files PY_FILES Comma-separated list of .zip, .egg, or .py files to plac
e
on the PYTHONPATH for Python apps.
--files FILES Comma-separated list of files to be placed in the workin
g
directory of each executor.

--conf PROP=VALUE Arbitrary Spark configuration property.

--properties-file FILE Path to a file from which to load extra properties. If n
ot
specified, this will look for conf/spark-defaults.conf.

--driver-memory MEM Memory for driver (e.g. 1000M, 2G) (Default: 1024M).
--driver-java-options Extra Java options to pass to the driver.
--driver-library-path Extra library path entries to pass to the driver.
--driver-class-path Extra class path entries to pass to the driver. Note tha
t
jars added with --jars are automatically included in the
classpath.

--executor-memory MEM Memory per executor (e.g. 1000M, 2G) (Default: 1G).

--proxy-user NAME User to impersonate when submitting the application.

This argument does not work with --principal / --keytab.

--help, -h Show this help message and exit.

--verbose, -v Print additional debug output.
--version, Print the version of current Spark.

320
Spark Submit — spark-submit shell script

Spark standalone with cluster deploy mode only:

--driver-cores NUM Cores for driver (Default: 1).

Spark standalone or Mesos with cluster deploy mode only:

--supervise If given, restarts the driver on failure.
--kill SUBMISSION_ID If given, kills the driver specified.
--status SUBMISSION_ID If given, requests the status of the driver specified.

Spark standalone and Mesos only:

--total-executor-cores NUM Total cores for all executors.

Spark standalone and YARN only:

--executor-cores NUM Number of cores per executor. (Default: 1 in YARN mode,
or all available cores on the worker in standalone mode)

YARN-only:
--driver-cores NUM Number of cores used by the driver, only in cluster mode
(Default: 1).
--queue QUEUE_NAME The YARN queue to submit to (Default: "default").
--num-executors NUM Number of executors to launch (Default: 2).
--archives ARCHIVES Comma separated list of archives to be extracted into th
e
working directory of each executor.
--principal PRINCIPAL Principal to be used to login to KDC, while running on
secure HDFS.
--keytab KEYTAB The full path to the file that contains the keytab for t
he
principal specified above. This keytab will be copied to
the node running the Application Master via the Secure
Distributed Cache, for renewing the login tickets and th
e
delegation tokens periodically.

--class

--conf or -c

--deploy-mode (see Deploy Mode)

--driver-class-path (see --driver-class-path command-line option)

--driver-cores (see Driver Cores in Cluster Deploy Mode)

--driver-java-options

--driver-library-path

--driver-memory

--executor-memory

--files

321
Spark Submit — spark-submit shell script

--jars

--kill for Standalone cluster mode only

--master

--name

--packages

--exclude-packages

--properties-file (see Custom Spark Properties File)

--proxy-user

--py-files

--repositories

--status for Standalone cluster mode only

--total-executor-cores

List of switches, i.e. command-line options that do not take parameters:

--help or -h

--supervise for Standalone cluster mode only

--usage-error

--verbose or -v (see Verbose Mode)

--version (see Version)

YARN-only options:

--archives

--executor-cores

--keytab

--num-executors

--principal

--queue (see Specifying YARN Resource Queue (--queue switch))

--driver-class-path command-line option

322
Spark Submit — spark-submit shell script

--driver-class-path command-line option sets the extra class path entries (e.g. jars and

directories) that should be added to a driver’s JVM.

You should use --driver-class-path in client deploy mode (not SparkConf) to

Tip ensure that the CLASSPATH is set up with the entries. client deploy mode
uses the same JVM for the driver as spark-submit 's.

--driver-class-path sets the internal driverExtraClassPath property (when

SparkSubmitArguments.handle called).

It works for all cluster managers and deploy modes.

If driverExtraClassPath not set on command-line, the spark.driver.extraClassPath setting is

used.

Command-line options (e.g. --driver-class-path ) have higher precedence

than their corresponding Spark settings in a Spark properties file (e.g.
Note
spark.driver.extraClassPath ). You can therefore control the final settings by
overriding Spark settings on command line using the command-line options.

Table 3. Spark Settings in Spark Properties File and on Command Line

Setting / System Property Command-Line Option Description
Extra class path entries
spark.driver.extraClassPath --driver-class-path (e.g. jars and directories)
to pass to a driver’s JVM.

Version —  --version command-line option

$ ./bin/spark-submit --version
Welcome to
____ __
/ __/__ ___ _____/ /__
_\ \/ _ \/ _ `/ __/ '_/
/___/ .__/\_,_/_/ /_/\_\ version 2.1.0-SNAPSHOT
/_/

Branch master
Compiled by user jacek on 2016-09-30T07:08:39Z
Revision 1fad5596885aab8b32d2307c0edecbae50d5bd7a
Url https://github.com/apache/spark.git
Type --help for more information.

Verbose Mode —  --verbose command-line option

323
Spark Submit — spark-submit shell script

When spark-submit is executed with --verbose command-line option, it enters verbose

mode.

In verbose mode, the parsed arguments are printed out to the System error output.

FIXME

It also prints out propertiesFile and the properties from the file.

FIXME

Deploy Mode —  --deploy-mode command-line option

You use spark-submit’s --deploy-mode command-line option to specify the deploy mode for
a Spark application.

Environment Variables
The following is the list of environment variables that are considered when command-line
options are not specified:

MASTER for --master

SPARK_DRIVER_MEMORY for --driver-memory

SPARK_EXECUTOR_MEMORY (see Environment Variables in the SparkContext document)

SPARK_EXECUTOR_CORES

DEPLOY_MODE

SPARK_YARN_APP_NAME

_SPARK_CMD_USAGE

External packages and custom repositories

The spark-submit utility supports specifying external packages using Maven coordinates
using --packages and custom repositories using --repositories .

./bin/spark-submit \
--packages my:awesome:package \
--repositories s3n://$aws_ak:$aws_sak@bucket/path/to/repo

324
Spark Submit — spark-submit shell script

FIXME Why should I care?

Launching SparkSubmit Standalone Application —  main

method

The source code of the script lives in

Tip
https://github.com/apache/spark/blob/master/bin/spark-submit.

When executed, spark-submit script simply passes the call to spark-class with
org.apache.spark.deploy.SparkSubmit class followed by command-line arguments.

spark-class uses the class name —  org.apache.spark.deploy.SparkSubmit  — to

parse command-line arguments appropriately.
Tip
Refer to org.apache.spark.launcher.Main Standalone Application

It creates an instance of SparkSubmitArguments.

If in verbose mode, it prints out the application arguments.

It then relays the execution to action-specific internal methods (with the application
arguments):

When no action was explicitly given, it is assumed submit action.

kill (when --kill switch is used)

requestStatus (when --status switch is used)

The action can only have one of the three available values: SUBMIT , KILL , or
Note
REQUEST_STATUS .

spark-env.sh - load additional environment settings

spark-env.sh consists of environment settings to configure Spark for your site.

export JAVA_HOME=/your/directory/java
export HADOOP_HOME=/usr/lib/hadoop
export SPARK_WORKER_CORES=2
export SPARK_WORKER_MEMORY=1G

spark-env.sh is loaded at the startup of Spark’s command line scripts.

SPARK_ENV_LOADED env var is to ensure the spark-env.sh script is loaded once.

325
Spark Submit — spark-submit shell script

SPARK_CONF_DIR points at the directory with spark-env.sh or $SPARK_HOME/conf is used.

spark-env.sh is executed if it exists.

$SPARK_HOME/conf directory has spark-env.sh.template file that serves as a template

for your own custom configuration.

Consult Environment Variables in the official documentation.

326
SparkSubmitArguments

SparkSubmitArguments  — spark-submit’s
Command-Line Argument Parser
SparkSubmitArguments is a custom SparkSubmitArgumentsParser to handle the command-line

arguments of spark-submit script that the actions (i.e. submit, kill and status) use for their
execution (possibly with the explicit env environment).

SparkSubmitArguments is created when launching spark-submit script with only

Note
args passed in and later used for printing the arguments in verbose mode.

Calculating Spark Properties 

—  loadEnvironmentArguments internal method

loadEnvironmentArguments(): Unit

loadEnvironmentArguments calculates the Spark properties for the current execution of spark-

submit.

loadEnvironmentArguments reads command-line options first followed by Spark properties

and System’s environment variables.

Spark config properties start with spark. prefix and can be set using --conf
Note
[key=value] command-line option.

handle Method

protected def handle(opt: String, value: String): Boolean

handle parses the input opt argument and returns true or throws an

IllegalArgumentException when it finds an unknown opt .

handle sets the internal properties in the table Command-Line Options, Spark Properties

and Environment Variables.

mergeDefaultSparkProperties Internal Method

mergeDefaultSparkProperties(): Unit

327
SparkSubmitArguments

mergeDefaultSparkProperties merges Spark properties from the default Spark properties file,

i.e. spark-defaults.conf with those specified through --conf command-line option.

328
SparkSubmitOptionParser — spark-submit’s Command-Line Parser

SparkSubmitOptionParser  — spark-submit’s
Command-Line Parser
SparkSubmitOptionParser is the parser of spark-submit's command-line options.

Table 1. spark-submit Command-Line Options

Command-Line Option Description
--archives

--class The main class to run (as mainClass internal attribute).

All = -separated values end up in conf potentially

--conf [prop=value] or -
c [prop=value]
overriding existing settings. Order on command-line
matters.

--deploy-mode deployMode internal property

spark.driver.extraClassPath in conf  — the driver class

--driver-class-path
path

--driver-cores

spark.driver.extraJavaOptions in conf  — the driver VM

--driver-java-options
options

spark.driver.extraLibraryPath in conf  — the driver

--driver-library-path
native library path

--driver-memory spark.driver.memory in conf

--exclude-packages

--executor-cores

--executor-memory

--files

--help or -h The option is added to sparkArgs

--jars

--keytab

--kill The option and a value are added to sparkArgs

329
SparkSubmitOptionParser — spark-submit’s Command-Line Parser

--kill The option and a value are added to sparkArgs

--master master internal property

--name

--num-executors

--packages

--principal

propertiesFile internal property. Refer to Custom Spark

--properties-file [FILE] Properties File —  --properties-file command-line
option.

--proxy-user

--py-files

--queue

--repositories

--status The option and a value are added to sparkArgs

--supervise

--total-executor-cores

--usage-error The option is added to sparkArgs

--verbose or -v

--version The option is added to sparkArgs

SparkSubmitOptionParser Callbacks
SparkSubmitOptionParser is supposed to be overriden for the following capabilities (as

callbacks).

330
SparkSubmitOptionParser — spark-submit’s Command-Line Parser

Table 2. Callbacks
Callback Description
handle Executed when an option with an argument is parsed.

handleUnknown Executed when an unrecognized option is parsed.

handleExtraArgs
Executed for the command-line arguments that handle and
handleUnknown callbacks have not processed.

SparkSubmitOptionParser belongs to org.apache.spark.launcher Scala package and spark-

launcher Maven/sbt module.

org.apache.spark.launcher.SparkSubmitArgumentsParser is a custom
Note
SparkSubmitOptionParser .

Parsing Command-Line Arguments —  parse Method

final void parse(List<String> args)

parse parses a list of command-line arguments.

parse calls handle callback whenever it finds a known command-line option or a switch (a

command-line option with no parameter). It calls handleUnknown callback for unrecognized

command-line options.

parse keeps processing command-line arguments until handle or handleUnknown callback

return false or all command-line arguments have been consumed.

Ultimately, parse calls handleExtraArgs callback.

331
SparkSubmitCommandBuilder Command Builder

SparkSubmitCommandBuilder Command Builder

SparkSubmitCommandBuilder is used to build a command that spark-submit and

SparkLauncher use to launch a Spark application.

SparkSubmitCommandBuilder uses the first argument to distinguish between shells:

1. pyspark-shell-main

2. sparkr-shell-main

3. run-example

Caution FIXME Describe run-example

SparkSubmitCommandBuilder parses command-line arguments using OptionParser (which is

a SparkSubmitOptionParser). OptionParser comes with the following methods:

1. handle to handle the known options (see the table below). It sets up master ,

deployMode , propertiesFile , conf , mainClass , sparkArgs internal properties.

2. handleUnknown to handle unrecognized options that usually lead to Unrecognized

option error message.

3. handleExtraArgs to handle extra arguments that are considered a Spark application’s

arguments.

For spark-shell it assumes that the application arguments are after spark-
Note
submit 's arguments.

SparkSubmitCommandBuilder.buildCommand /
buildSparkSubmitCommand

public List<String> buildCommand(Map<String, String> env)

Note buildCommand is part of the AbstractCommandBuilder public API.

SparkSubmitCommandBuilder.buildCommand simply passes calls on to

buildSparkSubmitCommand private method (unless it was executed for pyspark or sparkr

scripts which we are not interested in in this document).

buildSparkSubmitCommand Internal Method

332
SparkSubmitCommandBuilder Command Builder

private List<String> buildSparkSubmitCommand(Map<String, String> env)

buildSparkSubmitCommand starts by building so-called effective config. When in client mode,

buildSparkSubmitCommand adds spark.driver.extraClassPath to the result Spark command.

Note Use spark-submit to have spark.driver.extraClassPath in effect.

buildSparkSubmitCommand builds the first part of the Java command passing in the extra

classpath (only for client deploy mode).

Caution FIXME Add isThriftServer case.

buildSparkSubmitCommand appends SPARK_SUBMIT_OPTS and SPARK_JAVA_OPTS environment

variables.

(only for client deploy mode) …​

Caution FIXME Elaborate on the client deply mode case.

addPermGenSizeOpt case…​elaborate

Caution FIXME Elaborate on addPermGenSizeOpt

buildSparkSubmitCommand appends org.apache.spark.deploy.SparkSubmit and the command-

line arguments (using buildSparkSubmitArgs).

buildSparkSubmitArgs method

List<String> buildSparkSubmitArgs()

buildSparkSubmitArgs builds a list of command-line arguments for spark-submit.

buildSparkSubmitArgs uses a SparkSubmitOptionParser to add the command-line

arguments that spark-submit recognizes (when it is executed later on and uses the very
same SparkSubmitOptionParser parser to parse command-line arguments).

333
SparkSubmitCommandBuilder Command Builder

Table 1. SparkSubmitCommandBuilder Properties and Corresponding

SparkSubmitOptionParser Attributes

SparkSubmitCommandBuilder Property SparkSubmitOptionParser Attribute

verbose VERBOSE

master MASTER [master]

deployMode DEPLOY_MODE [deployMode]

appName NAME [appName]

conf CONF [key=value]*

propertiesFile PROPERTIES_FILE [propertiesFile]

jars JARS [comma-separated jars]

files FILES [comma-separated files]

pyFiles PY_FILES [comma-separated pyFiles]

mainClass CLASS [mainClass]

sparkArgs sparkArgs (passed straight through)

appResource appResource (passed straight through)

appArgs appArgs (passed straight through)

getEffectiveConfig Internal Method

Map<String, String> getEffectiveConfig()

getEffectiveConfig internal method builds effectiveConfig that is conf with the Spark

properties file loaded (using loadPropertiesFile internal method) skipping keys that have
already been loaded (it happened when the command-line options were parsed in handle
method).

Command-line options (e.g. --driver-class-path ) have higher precedence

than their corresponding Spark settings in a Spark properties file (e.g.
Note spark.driver.extraClassPath ). You can therefore control the final settings by
overriding Spark settings on command line using the command-line options.
charset and trims white spaces around values.

334
SparkSubmitCommandBuilder Command Builder

isClientMode Internal Method

private boolean isClientMode(Map<String, String> userProps)

isClientMode checks master first (from the command-line options) and then spark.master

Spark property. Same with deployMode and spark.submit.deployMode .

Caution FIXME Review master and deployMode . How are they set?

isClientMode responds positive when no explicit master and client deploy mode set

explicitly.

OptionParser
OptionParser is a custom SparkSubmitOptionParser that SparkSubmitCommandBuilder uses

to parse command-line arguments. It defines all the SparkSubmitOptionParser callbacks, i.e.

handle, handleUnknown, and handleExtraArgs, for command-line argument handling.

OptionParser’s handle Callback

boolean handle(String opt, String value)

OptionParser comes with a custom handle callback (from the SparkSubmitOptionParser

callbacks).

335
SparkSubmitCommandBuilder Command Builder

Table 2. handle Method

Command-Line Option Property / Behaviour
--master master

--deploy-mode deployMode

--properties-file propertiesFile

--driver-memory Sets spark.driver.memory (in conf )

--driver-java-options
Sets spark.driver.extraJavaOptions (in
conf )

--driver-library-path
Sets spark.driver.extraLibraryPath (in
conf )

--driver-class-path
Sets spark.driver.extraClassPath (in
conf )

--conf Expects a key=value pair that it puts in

conf

Sets mainClass (in conf ).

It may also set allowsMixedArguments and
--class
appResource if the execution is for one of
the special classes, i.e. spark-shell,
SparkSQLCLIDriver , or HiveThriftServer2.

Disables isAppResourceReq and adds

--kill | --status
itself with the value to sparkArgs .

Disables isAppResourceReq and adds

--help | --usage-error
itself to sparkArgs .

--version
Disables isAppResourceReq and adds
itself to sparkArgs .

anything else Adds an element to sparkArgs

OptionParser’s handleUnknown Method

boolean handleUnknown(String opt)

336
SparkSubmitCommandBuilder Command Builder

If allowsMixedArguments is enabled, handleUnknown simply adds the input opt to appArgs

and allows for further parsing of the argument list.

Caution FIXME Where’s allowsMixedArguments enabled?

If isExample is enabled, handleUnknown sets mainClass to be org.apache.spark.examples.

[opt] (unless the input opt has already the package prefix) and stops further parsing of

the argument list.

Caution FIXME Where’s isExample enabled?

Otherwise, handleUnknown sets appResource and stops further parsing of the argument list.

OptionParser’s handleExtraArgs Method

void handleExtraArgs(List<String> extra)

handleExtraArgs adds all the extra arguments to appArgs .

337
spark-class shell script

spark-class shell script

spark-class shell script is the Spark application command-line launcher that is responsible

for setting up JVM environment and executing a Spark application.

Note Ultimately, any shell script in Spark, e.g. spark-submit, calls spark-class script.

You can find spark-class script in bin directory of the Spark distribution.

When started, spark-class first loads $SPARK_HOME/bin/load-spark-env.sh , collects the

Spark assembly jars, and executes org.apache.spark.launcher.Main.

Depending on the Spark distribution (or rather lack thereof), i.e. whether RELEASE file exists
or not, it sets SPARK_JARS_DIR environment variable to [SPARK_HOME]/jars or
[SPARK_HOME]/assembly/target/scala-[SPARK_SCALA_VERSION]/jars , respectively (with the latter

being a local build).

If SPARK_JARS_DIR does not exist, spark-class prints the following error message and exits
with the code 1 .

Failed to find Spark jars directory ([SPARK_JARS_DIR]).

You need to build Spark with the target "package" before running this program.

spark-class sets LAUNCH_CLASSPATH environment variable to include all the jars under

SPARK_JARS_DIR .

If SPARK_PREPEND_CLASSES is enabled, [SPARK_HOME]/launcher/target/scala-

[SPARK_SCALA_VERSION]/classes directory is added to LAUNCH_CLASSPATH as the first entry.

Use SPARK_PREPEND_CLASSES to have the Spark launcher classes (from

[SPARK_HOME]/launcher/target/scala-[SPARK_SCALA_VERSION]/classes ) to appear
Note
before the other Spark assembly jars. It is useful for development so your
changes don’t require rebuilding Spark again.

SPARK_TESTING and SPARK_SQL_TESTING environment variables enable test special mode.

Caution FIXME What’s so special about the env vars?

spark-class uses org.apache.spark.launcher.Main command-line application to compute

the Spark command to launch. The Main class programmatically computes the command
that spark-class executes afterwards.

Tip Use JAVA_HOME to point at the JVM to use.

338
spark-class shell script

Launching org.apache.spark.launcher.Main Standalone

Application
org.apache.spark.launcher.Main is a Scala standalone application used in spark-class to

prepare the Spark command to execute.

Main expects that the first parameter is the class name that is the "operation mode":

1. org.apache.spark.deploy.SparkSubmit  —  Main uses SparkSubmitCommandBuilder to

parse command-line arguments. This is the mode spark-submit uses.

2. anything —  Main uses SparkClassCommandBuilder to parse command-line arguments.

$ ./bin/spark-class org.apache.spark.launcher.Main
Exception in thread "main" java.lang.IllegalArgumentException: Not enough arguments: m
issing class name.
at org.apache.spark.launcher.CommandBuilderUtils.checkArgument(CommandBuilderU
tils.java:241)
at org.apache.spark.launcher.Main.main(Main.java:51)

Main uses buildCommand method on the builder to build a Spark command.

If SPARK_PRINT_LAUNCH_COMMAND environment variable is enabled, Main prints the final Spark

command to standard error.

Spark Command: [cmd]

========================================

If on Windows it calls prepareWindowsCommand while on non-Windows OSes

prepareBashCommand with tokens separated by \0 .

Caution FIXME What’s prepareWindowsCommand ? prepareBashCommand ?

Main uses the following environment variables:

SPARK_DAEMON_JAVA_OPTS and SPARK_MASTER_OPTS to be added to the command line of

the command.

SPARK_DAEMON_MEMORY (default: 1g ) for -Xms and -Xmx .

339
AbstractCommandBuilder

AbstractCommandBuilder
AbstractCommandBuilder is the base command builder for SparkSubmitCommandBuilder

and SparkClassCommandBuilder specialized command builders.

AbstractCommandBuilder expects that command builders define buildCommand .

Table 1. AbstractCommandBuilder Methods

Method Description
buildCommand The only abstract method that subclasses have to define.

buildJavaCommand

getConfDir

Loads the configuration file for a Spark application, be it

loadPropertiesFile the user-specified properties file or spark-defaults.conf
file under the Spark configuration directory.

buildJavaCommand Internal Method

List<String> buildJavaCommand(String extraClassPath)

buildJavaCommand builds the Java command for a Spark application (which is a collection of

elements with the path to java executable, JVM options from java-opts file, and a class
path).

If javaHome is set, buildJavaCommand adds [javaHome]/bin/java to the result Java

command. Otherwise, it uses JAVA_HOME or, when no earlier checks succeeded, falls
through to java.home Java’s system property.

Caution FIXME Who sets javaHome internal property and when?

buildJavaCommand loads extra Java options from the java-opts file in configuration

directory if the file exists and adds them to the result Java command.

Eventually, buildJavaCommand builds the class path (with the extra class path if non-empty)
and adds it as -cp to the result Java command.

buildClassPath method

340
AbstractCommandBuilder

List<String> buildClassPath(String appClassPath)

buildClassPath builds the classpath for a Spark application.

Directories always end up with the OS-specific file separator at the end of their
Note
paths.

buildClassPath adds the following in that order:

1. SPARK_CLASSPATH environment variable

2. The input appClassPath

3. The configuration directory

4. (only with SPARK_PREPEND_CLASSES set or SPARK_TESTING being 1 ) Locally compiled

Spark classes in classes , test-classes and Core’s jars.

Caution FIXME Elaborate on "locally compiled Spark classes".

5. (only with SPARK_SQL_TESTING being 1 ) …​

Caution FIXME Elaborate on the SQL testing case

6. HADOOP_CONF_DIR environment variable

7. YARN_CONF_DIR environment variable

8. SPARK_DIST_CLASSPATH environment variable

childEnv is queried first before System properties. It is always empty for

Note
AbstractCommandBuilder (and SparkSubmitCommandBuilder , too).

Loading Properties File —  loadPropertiesFile Internal

Method

Properties loadPropertiesFile()

loadPropertiesFile is part of AbstractCommandBuilder private API that loads Spark settings

from a properties file (when specified on the command line) or spark-defaults.conf in the
configuration directory.

It loads the settings from the following files starting from the first and checking every location
until the first properties file is found:

341
AbstractCommandBuilder

1. propertiesFile (if specified using --properties-file command-line option or set by

AbstractCommandBuilder.setPropertiesFile ).

2. [SPARK_CONF_DIR]/spark-defaults.conf

3. [SPARK_HOME]/conf/spark-defaults.conf

Note loadPropertiesFile reads a properties file using UTF-8 .

Spark’s Configuration Directory —  getConfDir Internal

Method
AbstractCommandBuilder uses getConfDir to compute the current configuration directory of

a Spark application.

It uses SPARK_CONF_DIR (from childEnv which is always empty anyway or as a environment

variable) and falls through to [SPARK_HOME]/conf (with SPARK_HOME from getSparkHome
internal method).

Spark’s Home Directory —  getSparkHome Internal

Method
AbstractCommandBuilder uses getSparkHome to compute Spark’s home directory for a Spark

application.

It uses SPARK_HOME (from childEnv which is always empty anyway or as a environment

variable).

If SPARK_HOME is not set, Spark throws a IllegalStateException :

Spark home not found; set it explicitly or use the SPARK_HOME environment variable.

342
SparkLauncher — Launching Spark Applications Programmatically

SparkLauncher  — Launching Spark

Applications Programmatically
SparkLauncher is an interface to launch Spark applications programmatically, i.e. from a

code (not spark-submit directly). It uses a builder pattern to configure a Spark application
and launch it as a child process using spark-submit.

SparkLauncher belongs to org.apache.spark.launcher Scala package in spark-launcher

build module.

SparkLauncher uses SparkSubmitCommandBuilder to build the Spark command of a Spark

application to launch.

Table 1. SparkLauncher 's Builder Methods to Set Up Invocation of Spark Application

Setter Description

addAppArgs(String…​ args)
Adds command line arguments for a
Spark application.

addFile(String file)
Adds a file to be submitted with a Spark
application.

addJar(String jar)
Adds a jar file to be submitted with the
application.

addPyFile(String file)
Adds a python file / zip / egg to be
submitted with a Spark application.

addSparkArg(String arg)
Adds a no-value argument to the Spark
invocation.

Adds an argument with a value to the

Spark invocation. It recognizes known
addSparkArg(String name, String value) command-line arguments, i.e. --master ,
--properties-file , --conf , --class , -
-jars , --files , and --py-files .

directory(File dir)
Sets the working directory of spark-
submit.

redirectError() Redirects stderr to stdout.

redirectError(File errFile)
Redirects error output to the specified
errFile file.

Redirects error output to the specified to

343
SparkLauncher — Launching Spark Applications Programmatically

redirectError(ProcessBuilder.Redirect Redirects error output to the specified to

to)
Redirect.

redirectOutput(File outFile)
Redirects output to the specified outFile
file.

redirectOutput(ProcessBuilder.Redirect Redirects standard output to the specified

to) to Redirect.

Sets all output to be logged and

redirectToLog(String loggerName) redirected to a logger with the specified
name.

setAppName(String appName) Sets the name of an Spark application

Sets the main application resource, i.e.

setAppResource(String resource) the location of a jar file for Scala/Java
applications.

setConf(String key, String value)

Sets a Spark property. Expects key
starting with spark. prefix.

setDeployMode(String mode) Sets the deploy mode.

setJavaHome(String javaHome) Sets a custom JAVA_HOME .

setMainClass(String mainClass) Sets the main class.

setMaster(String master) Sets the master URL.

Sets the internal propertiesFile .

setPropertiesFile(String path)
See loadPropertiesFile Internal Method.

setSparkHome(String sparkHome) Sets a custom SPARK_HOME .

setVerbose(boolean verbose)
Enables verbose reporting for
SparkSubmit.

After the invocation of a Spark application is set up, use launch() method to launch a sub-
process that will start the configured Spark application. It is however recommended to use
startApplication method instead.

344
SparkLauncher — Launching Spark Applications Programmatically

import org.apache.spark.launcher.SparkLauncher

val command = new SparkLauncher()

.setAppResource("SparkPi")
.setVerbose(true)

val appHandle = command.startApplication()

345
Spark Architecture

Spark Architecture
Spark uses a master/worker architecture. There is a driver that talks to a single
coordinator called master that manages workers in which executors run.

Figure 1. Spark architecture

The driver and the executors run in their own Java processes. You can run them all on the
same (horizontal cluster) or separate machines (vertical cluster) or in a mixed machine
configuration.

346
Spark Architecture

Figure 2. Spark architecture in detail

Physical machines are called hosts or nodes.

347
Driver

Driver
A Spark driver (aka an application’s driver process) is a JVM process that hosts
SparkContext for a Spark application. It is the master node in a Spark application.

It is the cockpit of jobs and tasks execution (using DAGScheduler and Task Scheduler). It
hosts Web UI for the environment.

Figure 1. Driver with the services

It splits a Spark application into tasks and schedules them to run on executors.

A driver is where the task scheduler lives and spawns tasks across workers.

A driver coordinates workers and overall execution of tasks.

Spark shell is a Spark application and the driver. It creates a SparkContext that
Note
is available as sc .

348
Driver

Driver requires the additional services (beside the common ones like ShuffleManager,
MemoryManager, BlockTransferService, BroadcastManager, CacheManager):

Listener Bus

RPC Environment

MapOutputTrackerMaster with the name MapOutputTracker

BlockManagerMaster with the name BlockManagerMaster

HttpFileServer

MetricsSystem with the name driver

OutputCommitCoordinator with the endpoint’s name OutputCommitCoordinator

FIXME Diagram of RpcEnv for a driver (and later executors). Perhaps it

Caution
should be in the notes about RpcEnv?

High-level control flow of work

Your Spark application runs as long as the Spark driver.

Once the driver terminates, so does your Spark application.

Creates SparkContext , `RDD’s, and executes transformations and actions

Launches tasks

Driver’s Memory
It can be set first using spark-submit’s --driver-memory command-line option or
spark.driver.memory and falls back to SPARK_DRIVER_MEMORY if not set earlier.

Note It is printed out to the standard error output in spark-submit’s verbose mode.

Driver’s Cores
It can be set first using spark-submit’s --driver-cores command-line option for cluster
deploy mode.

In client deploy mode the driver’s memory corresponds to the memory of the
Note
JVM process the Spark application runs on.

Note It is printed out to the standard error output in spark-submit’s verbose mode.

349
Driver

Settings
Table 1. Spark Properties
Spark Property Default Value Description
Port to use for the
BlockManager on the driver.

More precisely,
spark.driver.blockManager.port spark.blockManager.port spark.driver.blockManager.port
is used when
NettyBlockTransferService
created (while SparkEnv
created for the driver).

The address of the node where

the driver runs on.
spark.driver.host localHostName
Set when SparkContext
created

The port the driver listens to. It

is first set to 0 in the driver
when SparkContext is
initialized.

spark.driver.port 0 Set to the port of RpcEnv

driver (in SparkEnv.create
when client-mode
ApplicationMaster connected
to the driver (in Spark on
YARN).

The driver’s memory size (in

spark.driver.memory 1g MiBs).
Refer to Driver’s Memory

The number of CPU cores

assigned to the driver in
deploy mode.
NOTE: When Client is created
spark.driver.cores 1 (for Spark on YARN in cluster
mode only), it sets the number
of cores for ApplicationManager
using spark.driver.cores

Refer to Driver’s Cores.

spark.driver.extraLibraryPath

350
Driver

spark.driver.extraJavaOptions Additional JVM options for the

driver.

spark.driver.appUIAddress

spark.driver.appUIAddress is
used exclusively in Spark on
YARN. It is set when spark.driver.libraryPath
YarnClientSchedulerBackend
starts to run ExecutorLauncher
(and register ApplicationMaster
for the Spark application).

spark.driver.extraClassPath
spark.driver.extraClassPath system property sets the additional classpath entries (e.g. jars

and directories) that should be added to the driver’s classpath in cluster deploy mode.

For client deploy mode you can use a properties file or command line to set
spark.driver.extraClassPath .

Do not use SparkConf since it is too late for client deploy mode given the
Note JVM has already been set up to start a Spark application.
Refer to buildSparkSubmitCommand Internal Method for the very low-level details
of how it is handled internally.

spark.driver.extraClassPath uses a OS-specific path separator.

Use spark-submit 's --driver-class-path command-line option on command

Note
line to override spark.driver.extraClassPath from a Spark properties file.

351
Executor

Executor
Executor is a distributed agent that is responsible for executing tasks.

Executor is created when:

CoarseGrainedExecutorBackend receives RegisteredExecutor message (for Spark

Standalone and YARN)

Spark on Mesos’s MesosExecutorBackend does registered

LocalEndpoint is created (for local mode)

Executor typically runs for the entire lifetime of a Spark application which is called static

allocation of executors (but you could also opt in for dynamic allocation).

Note Executors are managed exclusively by executor backends.

Executors reports heartbeat and partial metrics for active tasks to HeartbeatReceiver RPC
Endpoint on the driver.

Figure 1. HeartbeatReceiver’s Heartbeat Message Handler

Executors provide in-memory storage for RDDs that are cached in Spark applications (via
Block Manager).

When an executor starts it first registers with the driver and communicates directly to
execute tasks.

352
Executor

Figure 2. Launching tasks on executor using TaskRunners

Executor offers are described by executor id and the host on which an executor runs (see
Resource Offers in this document).

Executors can run multiple tasks over its lifetime, both in parallel and sequentially. They
track running tasks (by their task ids in runningTasks internal registry). Consult Launching
Tasks section.

Executors use a Executor task launch worker thread pool for launching tasks.

Executors send metrics (and heartbeats) using the internal heartbeater - Heartbeat Sender
Thread.

It is recommended to have as many executors as data nodes and as many cores as you can
get from the cluster.

Executors are described by their id, hostname, environment (as SparkEnv ), and
classpath (and, less importantly, and more for internal optimization, whether they run in
local or cluster mode).

Caution FIXME How many cores are assigned per executor?

Table 1. Executor’s Internal Properties

Name Initial Value Description

executorSource ExecutorSource FIXME

353
Executor

Table 2. Executor’s Internal Registries and Counters

Name Description
heartbeatFailures

RPC endpoint reference to HeartbeatReceiver on the

driver (available on spark.driver.host at spark.driver.port
port).
heartbeatReceiverRef Set when Executor is created.
Used exclusively when Executor reports heartbeats and
partial metrics for active tasks to the driver (that happens
every spark.executor.heartbeatInterval interval).

maxDirectResultSize

maxResultSize

runningTasks Lookup table of TaskRunners per…​FIXME

Enable INFO or DEBUG logging level for org.apache.spark.executor.Executor

logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.executor.Executor=DEBUG

Refer to Logging.

updateDependencies Internal Method

updateDependencies(newFiles: Map[String, Long], newJars: Map[String, Long]): Unit

updateDependencies …​FIXME

updateDependencies is used exclusively when TaskRunner is started to run a

Note
task.

createClassLoader Method

Caution FIXME

addReplClassLoaderIfNeeded Method

354
Executor

Caution FIXME

Creating Executor Instance

Executor takes the following when created:

Executor ID

Executor’s host name

SparkEnv

Collection of user-defined JARs (to add to tasks' class path). Empty by default

Flag that says whether the executor runs in local or cluster mode (default: false , i.e.
cluster mode is preferred)

Java’s UncaughtExceptionHandler (default: SparkUncaughtExceptionHandler )

User-defined JARs are defined using --user-class-path command-line option of

Note CoarseGrainedExecutorBackend that can be set using
spark.executor.extraClassPath property.

Note isLocal is enabled exclusively for LocalEndpoint (for Spark in local mode).

When created, you should see the following INFO messages in the logs:

INFO Executor: Starting executor ID [executorId] on host [executorHostname]

(only for non-local modes) Executor sets SparkUncaughtExceptionHandler as the default

handler invoked when a thread abruptly terminates due to an uncaught exception.

(only for non-local modes) Executor requests the BlockManager to initialize (with the Spark
application id of the SparkConf).

Note Spark application id corresponds to the value of spark.app.id Spark property.

(only for non-local modes) Executor requests the MetricsSystem to register the
ExecutorSource and shuffleMetricsSource of the BlockManager.

Executor uses SparkEnv to access the local MetricsSystem and

Note
BlockManager.

Executor creates a task class loader (optionally with REPL support) that the current

Serializer is requested to use (when deserializing task later).

355
Executor

Note Executor uses SparkEnv to access the local Serializer .

Executor starts sending heartbeats and active tasks metrics.

Executor initializes the internal registries and counters in the meantime (not necessarily at

the very end).

Launching Task —  launchTask Method

launchTask(
context: ExecutorBackend,
taskId: Long,
attemptNumber: Int,
taskName: String,
serializedTask: ByteBuffer): Unit

launchTask executes the input serializedTask task concurrently.

Internally, launchTask creates a TaskRunner, registers it in runningTasks internal registry

(by taskId ), and finally executes it on "Executor task launch worker" thread pool.

Figure 3. Launching tasks on executor using TaskRunners

launchTask is called by CoarseGrainedExecutorBackend (when it handles
Note
LaunchTask message), MesosExecutorBackend, and LocalEndpoint.

Sending Heartbeats and Active Tasks Metrics 

—  startDriverHeartbeater Method
Executors keep sending metrics for active tasks to the driver every
spark.executor.heartbeatInterval (defaults to 10s with some random initial delay so the
heartbeats from different executors do not pile up on the driver).

356
Executor

Figure 4. Executors use HeartbeatReceiver endpoint to report task metrics

An executor sends heartbeats using the internal heartbeater — Heartbeat Sender Thread.

Figure 5. HeartbeatReceiver’s Heartbeat Message Handler

For each task in TaskRunner (in runningTasks internal registry), the task’s metrics are
computed (i.e. mergeShuffleReadMetrics and setJvmGCTime ) that become part of the
heartbeat (with accumulators).

FIXME How do mergeShuffleReadMetrics and setJvmGCTime influence

Caution
accumulators ?

Executors track the TaskRunner that run tasks. A task might not be assigned to
Note
a TaskRunner yet when the executor sends a heartbeat.

A blocking Heartbeat message that holds the executor id, all accumulator updates (per task
id), and BlockManagerId is sent to HeartbeatReceiver RPC endpoint (with
spark.executor.heartbeatInterval timeout).

Caution FIXME When is heartbeatReceiverRef created?

If the response requests to reregister BlockManager, you should see the following INFO
message in the logs:

INFO Executor: Told to re-register on heartbeat

357
Executor

The BlockManager is reregistered.

The internal heartbeatFailures counter is reset (i.e. becomes 0 ).

If there are any issues with communicating with the driver, you should see the following
WARN message in the logs:

WARN Executor: Issue communicating with driver in heartbeater

The internal heartbeatFailures is incremented and checked to be less than the acceptable
number of failures (i.e. spark.executor.heartbeat.maxFailures Spark property). If the number
is greater, the following ERROR is printed out to the logs:

ERROR Executor: Exit as unable to send heartbeats to driver more than [HEARTBEAT_MAX_F
AILURES] times

The executor exits (using System.exit and exit code 56).

Tip Read about TaskMetrics in TaskMetrics.

Reporting Heartbeat and Partial Metrics for Active Tasks to

Driver —  reportHeartBeat Internal Method

reportHeartBeat(): Unit

reportHeartBeat collects TaskRunners for currently running tasks (aka active tasks) with

their tasks deserialized (i.e. either ready for execution or already started).

Note TaskRunner has task deserialized when it runs the task.

For every running task, reportHeartBeat takes its TaskMetrics and:

Requests ShuffleRead metrics to be merged

Sets jvmGCTime metrics

reportHeartBeat then records the latest values of internal and external accumulators for

every task.

Internal accumulators are a task’s metrics while external accumulators are a

Note
Spark application’s accumulators that a user has created.

358
Executor

reportHeartBeat sends a blocking Heartbeat message to HeartbeatReceiver endpoint

(running on the driver). reportHeartBeat uses spark.executor.heartbeatInterval for the RPC

timeout.

A Heartbeat message contains the executor identifier, the accumulator

Note
updates, and the identifier of the BlockManager.

Note reportHeartBeat uses SparkEnv to access the current BlockManager .

If the response (from HeartbeatReceiver endpoint) is to re-register the BlockManager , you

should see the following INFO message in the logs and reportHeartBeat requests
BlockManager to re-register (which will register the blocks the BlockManager manages with

the driver).

INFO Told to re-register on heartbeat

HeartbeatResponse requests BlockManager to re-register when either

Note
TaskScheduler or HeartbeatReceiver know nothing about the executor.

When posting the Heartbeat was successful, reportHeartBeat resets heartbeatFailures

internal counter.

In case of a non-fatal exception, you should see the following WARN message in the logs
(followed by the stack trace).

WARN Issue communicating with driver in heartbeater

Every failure reportHeartBeat increments heartbeat failures up to

spark.executor.heartbeat.maxFailures Spark property. When the heartbeat failures reaches
the maximum, you should see the following ERROR message in the logs and the executor
terminates with the error code: 56 .

ERROR Exit as unable to send heartbeats to driver more than [HEARTBEAT_MAX_FAILURES] t

imes

reportHeartBeat is used when Executor schedules reporting heartbeat and

Note partial metrics for active tasks to the driver (that happens every
spark.executor.heartbeatInterval Spark property).

heartbeater — Heartbeat Sender Thread

heartbeater is a daemon ScheduledThreadPoolExecutor with a single thread.

359
Executor

The name of the thread pool is driver-heartbeater.

Coarse-Grained Executors
Coarse-grained executors are executors that use CoarseGrainedExecutorBackend for task
scheduling.

Resource Offers
Read resourceOffers in TaskSchedulerImpl and resourceOffer in TaskSetManager.

"Executor task launch worker" Thread Pool 

—  threadPool Property
Executor uses threadPool daemon cached thread pool with the name Executor task

launch worker-[ID] (with ID being the task id) for launching tasks.

threadPool is created when Executor is created and shut down when it stops.

Executor Memory —  spark.executor.memory or

SPARK_EXECUTOR_MEMORY settings
You can control the amount of memory per executor using spark.executor.memory setting. It
sets the available memory equally for all executors per application.

The amount of memory per executor is looked up when SparkContext is

Note
created.

You can change the assigned memory per executor per node in standalone cluster using
SPARK_EXECUTOR_MEMORY environment variable.

You can find the value displayed as Memory per Node in web UI for standalone Master (as
depicted in the figure below).

360
Executor

Figure 6. Memory per Node in Spark Standalone’s web UI

The above figure shows the result of running Spark shell with the amount of memory per
executor defined explicitly (on command line), i.e.

./bin/spark-shell --master spark://localhost:7077 -c spark.executor.memory=2g

Metrics
Every executor registers its own ExecutorSource to report metrics.

Stopping Executor —  stop Method

stop(): Unit

stop requests MetricsSystem for a report.

Note stop uses SparkEnv to access the current MetricsSystem .

stop shuts driver-heartbeater thread down (and waits at most 10 seconds).

stop shuts Executor task launch worker thread pool down.

(only when not local) stop requests SparkEnv to stop.

361
Executor

stop is used when CoarseGrainedExecutorBackend and LocalEndpoint are

Note
requested to stop their managed executors.

Settings
Table 3. Spark Properties
Default
Spark Property Description
Value

spark.executor.cores
Number of cores for an
executor.

List of URLs representing user-

defined class path entries that
are added to an executor’s class
path.
spark.executor.extraClassPath (empty) Each entry is separated by
system-dependent path
separator, i.e. : on
Unix/MacOS systems and
on Microsoft Windows.

Extra Java options for

executors.
spark.executor.extraJavaOptions Used to prepare the command
to launch
CoarseGrainedExecutorBackend
in a YARN container.

Extra library paths separated by

system-dependent path
separator, i.e. : on
Unix/MacOS systems and
spark.executor.extraLibraryPath on Microsoft Windows.
Used to prepare the command
to launch
CoarseGrainedExecutorBackend
in a YARN container.

Number of times an executor will

try to send heartbeats to the
driver before it gives up and
exits (with exit code 56 ).
spark.executor.heartbeat.maxFailures 60
NOTE: It was introduced in
SPARK-13522 Executor should
kill itself when it’s unable to
heartbeat to the driver more
than N times.

362
Executor

Interval after which an executor

reports heartbeat and metrics for
active tasks to the driver.
spark.executor.heartbeatInterval 10s
Refer to Sending heartbeats and
partial metrics for active tasks
this document.

spark.executor.id

spark.executor.instances 0 Number of executors to use.

spark.executor.logs.rolling.maxSize

spark.executor.logs.rolling.maxRetainedFiles

spark.executor.logs.rolling.strategy

spark.executor.logs.rolling.time.interval

Amount of memory to use per

executor process.

Equivalent to
SPARK_EXECUTOR_MEMORY
spark.executor.memory 1g environment variable.

Refer to Executor Memory — 

spark.executor.memory or
SPARK_EXECUTOR_MEMORY
settings in this document.

spark.executor.port

spark.executor.port

Flag to control whether to load

spark.executor.userClassPathFirst false classes in user jars before those
in Spark jars.

spark.executor.uri Equivalent to
SPARK_EXECUTOR_URI

spark.task.maxDirectResultSize 1048576B

363
TaskRunner

TaskRunner
TaskRunner is a thread of execution of a single task.

TaskRunner is created exclusively when Executor is requested to launch a task.

Figure 1. Executor creates TaskRunner and runs (almost) immediately

TaskRunner can be run or killed that simply means running or killing the task this

TaskRunner object manages, respectively.

364
TaskRunner

Table 1. TaskRunner’s Internal Registries and Counters

Name Description

FIXME
taskId
Used when…​FIXME

FIXME
threadName
Used when…​FIXME

FIXME
taskName
Used when…​FIXME

FIXME
finished
Used when…​FIXME

FIXME
killed
Used when…​FIXME

FIXME
threadId
Used when…​FIXME

FIXME
startGCTime
Used when…​FIXME

FIXME
task
Used when…​FIXME

FIXME
replClassLoader
Used when…​FIXME

Enable INFO or DEBUG logging level for org.apache.spark.executor.Executor

logger to see what happens inside TaskRunner (since TaskRunner is an internal
class of Executor ).

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.executor.Executor=DEBUG

Refer to Logging.

365
TaskRunner

Creating TaskRunner Instance

TaskRunner takes the following when created:

ExecutorBackend

TaskDescription

TaskRunner initializes the internal registries and counters.

computeTotalGcTime Method

Caution FIXME

updateDependencies Method

Caution FIXME

setTaskFinishedAndClearInterruptStatus Method

Caution FIXME

Lifecycle

Caution FIXME Image with state changes

A TaskRunner object is created when an executor is requested to launch a task.

It is created with an ExecutorBackend (to send the task’s status updates to), task and
attempt ids, task name, and serialized version of the task (as ByteBuffer ).

Running Task —  run Method

run(): Unit

Note run is part of Java’s java.lang.Runnable contract.

When executed, run initializes threadId as the current thread identifier (using Java’s
Thread)

run then sets the name of the current thread as threadName (using Java’s Thread).

366
TaskRunner

run creates a TaskMemoryManager (using the current MemoryManager and taskId).

Note run uses SparkEnv to access the current MemoryManager .

run starts tracking the time to deserialize a task.

run sets the current thread’s context classloader (with replClassLoader).

run creates a closure Serializer .

Note run uses SparkEnv to access the current closure Serializer .

You should see the following INFO message in the logs:

INFO Executor: Running [taskName] (TID [taskId])

run notifies ExecutorBackend that taskId is in TaskState.RUNNING state.

Note run uses ExecutorBackend that was specified when TaskRunner was created.

run computes startGCTime .

run updates dependencies.

Note run uses TaskDescription that is specified when TaskRunner is created.

run deserializes the task (using the context class loader) and sets its localProperties and

TaskMemoryManager . run sets the task internal reference to hold the deserialized task.

Note run uses TaskDescription to access serialized task.

If killed flag is enabled, run throws a TaskKilledException .

You should see the following DEBUG message in the logs:

DEBUG Executor: Task [taskId]'s epoch is [task.epoch]

run notifies MapOutputTracker about the epoch of the task.

Note run uses SparkEnv to access the current MapOutputTracker .

run records the current time as the task’s start time (as taskStart ).

run runs the task (with taskAttemptId as taskId, attemptNumber from TaskDescription ,

and metricsSystem as the current MetricsSystem).

367
TaskRunner

Note run uses SparkEnv to access the current MetricsSystem .

The task runs inside a "monitored" block (i.e. try-finally block) to detect any
Note memory and lock leaks after the task’s run finishes regardless of the final
outcome - the computed value or an exception thrown.

After the task’s run has finished (inside the "finally" block of the "monitored" block), run
requests BlockManager to release all locks of the task (for the task’s taskId). The locks are
later used for lock leak detection.

run then requests TaskMemoryManager to clean up allocated memory (that helps finding

memory leaks).

If run detects memory leak of the managed memory (i.e. the memory freed is greater than
0 ) and spark.unsafe.exceptionOnMemoryLeak Spark property is enabled (it is not by

default) and no exception was reported while the task ran, run reports a SparkException :

Managed memory leak detected; size = [freedMemory] bytes, TID = [taskId]

Otherwise, if spark.unsafe.exceptionOnMemoryLeak is disabled, you should see the

following ERROR message in the logs instead:

ERROR Executor: Managed memory leak detected; size = [freedMemory] bytes, TID = [taskI
d]

If run detects a memory leak, it leads to a SparkException or ERROR

Note
message in the logs.

If run detects lock leaking (i.e. the number of locks released) and
spark.storage.exceptionOnPinLeak Spark property is enabled (it is not by default) and no
exception was reported while the task ran, run reports a SparkException :

[releasedLocks] block locks were not released by TID = [taskId]:

[releasedLocks separated by comma]

Otherwise, if spark.storage.exceptionOnPinLeak is disabled or the task reported an

exception, you should see the following INFO message in the logs instead:

INFO Executor: [releasedLocks] block locks were not released by TID = [taskId]:
[releasedLocks separated by comma]

368
TaskRunner

If run detects any lock leak, it leads to a SparkException or INFO message in

Note
the logs.

Rigth after the "monitored" block, run records the current time as the task’s finish time (as
taskFinish ).

If the task was killed (while it was running), run reports a TaskKilledException (and the
TaskRunner exits).

run creates a Serializer and serializes the task’s result. run measures the time to

serialize the result.

run uses SparkEnv to access the current Serializer . SparkEnv was

Note
specified when the owning Executor was created.

This is when TaskExecutor serializes the computed value of a task to be

Important
sent back to the driver.

run records the task metrics:

executorDeserializeTime

executorDeserializeCpuTime

executorRunTime

executorCpuTime

jvmGCTime

resultSerializationTime

run collects the latest values of internal and external accumulators used in the task.

run creates a DirectTaskResult (with the serialized result and the latest values of

accumulators).

run serializes the DirectTaskResult and gets the byte buffer’s limit.

Note A serialized DirectTaskResult is Java’s java.nio.ByteBuffer.

run selects the proper serialized version of the result before sending it to ExecutorBackend .

run branches off based on the serialized DirectTaskResult byte buffer’s limit.

When maxResultSize is greater than 0 and the serialized DirectTaskResult buffer limit
exceeds it, the following WARN message is displayed in the logs:

369
TaskRunner

WARN Executor: Finished [taskName] (TID [taskId]). Result is larger than maxResultSize
([resultSize] > [maxResultSize]), dropping it.

Tip Read about spark.driver.maxResultSize.

$ ./bin/spark-shell -c spark.driver.maxResultSize=1m

scala> sc.version
res0: String = 2.0.0-SNAPSHOT

scala> sc.getConf.get("spark.driver.maxResultSize")
res1: String = 1m

scala> sc.range(0, 1024 * 1024 + 10, 1).collect

WARN Executor: Finished task 4.0 in stage 0.0 (TID 4). Result is larger than maxResult
Size (1031.4 KB > 1024.0 KB), dropping it.
...
ERROR TaskSetManager: Total size of serialized results of 1 tasks (1031.4 KB) is bigge
r than spark.driver.maxResultSize (1024.0 KB)
...
org.apache.spark.SparkException: Job aborted due to stage failure: Total size of seria
lized results of 1 tasks (1031.4 KB) is bigger than spark.driver.maxResultSize (1024.0
KB)
at org.apache.spark.scheduler.DAGScheduler.org$apache$spark$scheduler$DAGScheduler$$
failJobAndIndependentStages(DAGScheduler.scala:1448)
...

In this case, run creates a IndirectTaskResult (with a TaskResultBlockId for the task’s
taskId and resultSize ) and serializes it.

When maxResultSize is not positive or resultSize is smaller than maxResultSize but

greater than maxDirectResultSize, run creates a TaskResultBlockId for the task’s taskId
and stores the serialized DirectTaskResult in BlockManager (as the TaskResultBlockId
with MEMORY_AND_DISK_SER storage level).

You should see the following INFO message in the logs:

INFO Executor: Finished [taskName] (TID [taskId]). [resultSize] bytes result sent via
BlockManager)

In this case, run creates a IndirectTaskResult (with a TaskResultBlockId for the task’s
taskId and resultSize ) and serializes it.

The difference between the two above cases is that the result is dropped or
Note
stored in BlockManager with MEMORY_AND_DISK_SER storage level.

370
TaskRunner

When the two cases above do not hold, you should see the following INFO message in the
logs:

INFO Executor: Finished [taskName] (TID [taskId]). [resultSize] bytes result sent to d
river

run uses the serialized DirectTaskResult byte buffer as the final serializedResult .

The final serializedResult is either a IndirectTaskResult (possibly with the

Note
block stored in BlockManager ) or a DirectTaskResult.

run notifies ExecutorBackend that taskId is in TaskState.FINISHED state with the serialized

result and removes taskId from the owning executor’s runningTasks registry.

Note run uses ExecutorBackend that is specified when TaskRunner is created.

TaskRunner is Java’s Runnable and the contract requires that once a

Note
TaskRunner has completed execution it must not be restarted.

When run catches a exception while executing the task, run acts according to its type (as
presented in the following "run’s Exception Cases" table and the following sections linked
from the table).

Table 2. run’s Exception Cases, TaskState and Serialized ByteBuffer

Exception Type TaskState Serialized ByteBuffer
FetchFailedException FAILED TaskFailedReason

TaskKilledException KILLED TaskKilled

InterruptedException KILLED TaskKilled

CommitDeniedException FAILED TaskFailedReason

Throwable FAILED ExceptionFailure

FetchFailedException
When FetchFailedException is reported while running a task, run
setTaskFinishedAndClearInterruptStatus.

run requests FetchFailedException for the TaskFailedReason , serializes it and notifies

ExecutorBackend that the task has failed (with taskId, TaskState.FAILED , and a serialized

reason).

371
TaskRunner

Note ExecutorBackend was specified when TaskRunner was created.

run uses a closure Serializer to serialize the failure reason. The Serializer
Note
was created before run ran the task.

TaskKilledException
When TaskKilledException is reported while running a task, you should see the following
INFO message in the logs:

INFO Executor killed [taskName] (TID [taskId])

run then setTaskFinishedAndClearInterruptStatus and notifies ExecutorBackend that the

task has been killed (with taskId, TaskState.KILLED , and a serialized TaskKilled object).

InterruptedException (with Task Killed)

When InterruptedException is reported while running a task, and the task has been killed,
you should see the following INFO message in the logs:

INFO Executor interrupted and killed [taskName] (TID [taskId])

run then setTaskFinishedAndClearInterruptStatus and notifies ExecutorBackend that the

task has been killed (with taskId, TaskState.KILLED , and a serialized TaskKilled object).

The difference between this InterruptedException and TaskKilledException is

Note
the INFO message in the logs.

CommitDeniedException
When CommitDeniedException is reported while running a task, run
setTaskFinishedAndClearInterruptStatus and notifies ExecutorBackend that the task has
failed (with taskId, TaskState.FAILED , and a serialized TaskKilled object).

The difference between this CommitDeniedException and FetchFailedException

Note
is just the reason being sent to ExecutorBackend .

Throwable
When run catches a Throwable , you should see the following ERROR message in the
logs (followed by the exception).

372
TaskRunner

ERROR Exception in [taskName] (TID [taskId])

run then records the following task metrics (only when Task is available):

executorRunTime

jvmGCTime

run then collects the latest values of internal and external accumulators (with taskFailed

flag enabled to inform that the collection is for a failed task).

Otherwise, when Task is not available, the accumulator collection is empty.

run converts the task accumulators to collection of AccumulableInfo , creates a

ExceptionFailure (with the accumulators), and serializes them.

Note run uses a closure Serializer to serialize the ExceptionFailure .

FIXME Why does run create new ExceptionFailure(t,

Caution
accUpdates).withAccums(accums) , i.e. accumulators occur twice in the object.

run setTaskFinishedAndClearInterruptStatus and notifies ExecutorBackend that the task

has failed (with taskId, TaskState.FAILED , and the serialized ExceptionFailure ).

run may also trigger SparkUncaughtExceptionHandler.uncaughtException(t) if this is a fatal

error.

The difference between this most Throwable case and other FAILED cases
Note (i.e. FetchFailedException and CommitDeniedException) is just the serialized
ExceptionFailure vs a reason being sent to ExecutorBackend , respectively.

Killing Task —  kill Method

kill(interruptThread: Boolean): Unit

kill marks the TaskRunner as killed and kills the task (if available and not finished

already).

Note kill passes the input interruptThread on to the task itself while killing it.

When executed, you should see the following INFO message in the logs:

INFO TaskRunner: Executor is trying to kill [taskName] (TID [taskId])

373
TaskRunner

killed flag is checked periodically in run to stop executing the task. Once killed,
Note
the task will eventually stop.

Settings
Table 3. Spark Properties
Spark Property Default Value Description
spark.unsafe.exceptionOnMemoryLeak false FIXME

spark.storage.exceptionOnPinLeak false FIXME

374
ExecutorSource

ExecutorSource
ExecutorSource is a metrics source of an Executor. It uses an executor’s threadPool for

calculating the gauges.

Every executor has its own separate ExecutorSource that is registered when
Note
CoarseGrainedExecutorBackend receives a RegisteredExecutor .

The name of a ExecutorSource is executor.

Figure 1. ExecutorSource in JConsole (using Spark Standalone)

375
ExecutorSource

Table 1. ExecutorSource Gauges

Gauge Description

Approximate number of threads that are actively

threadpool.activeTasks executing tasks.
Uses ThreadPoolExecutor.getActiveCount().

Approximate total number of tasks that have

threadpool.completeTasks completed execution.
Uses ThreadPoolExecutor.getCompletedTaskCount().

Current number of threads in the pool.

threadpool.currentPool_size
Uses ThreadPoolExecutor.getPoolSize().

Maximum allowed number of threads that have ever

threadpool.maxPool_size simultaneously been in the pool
Uses ThreadPoolExecutor.getMaximumPoolSize().

Uses Hadoop’s FileSystem.getAllStatistics() and

filesystem.hdfs.read_bytes
getBytesRead() .

Uses Hadoop’s FileSystem.getAllStatistics() and

filesystem.hdfs.write_bytes
getBytesWritten() .

filesystem.hdfs.read_ops Uses Hadoop’s FileSystem.getAllStatistics() and

getReadOps()

Uses Hadoop’s FileSystem.getAllStatistics() and

filesystem.hdfs.largeRead_ops
getLargeReadOps() .

Uses Hadoop’s FileSystem.getAllStatistics() and

filesystem.hdfs.write_ops
getWriteOps() .

filesystem.file.read_bytes The same as hdfs but for file scheme.

filesystem.file.write_bytes The same as hdfs but for file scheme.

filesystem.file.read_ops The same as hdfs but for file scheme.

filesystem.file.largeRead_ops The same as hdfs but for file scheme.

filesystem.file.write_ops The same as hdfs but for file scheme.

376
ExecutorSource

377
Master

Master
A master is a running Spark instance that connects to a cluster manager for resources.

The master acquires cluster nodes to run executors.

Caution FIXME Add it to the Spark architecture figure above.

378
Workers

Workers
Workers (aka slaves) are running Spark instances where executors live to execute tasks.
They are the compute nodes in Spark.

Caution FIXME Are workers perhaps part of Spark Standalone only?

Caution FIXME How many executors are spawned per worker?

A worker receives serialized tasks that it runs in a thread pool.

It hosts a local Block Manager that serves blocks to other workers in a Spark cluster.
Workers communicate among themselves using their Block Manager instances.

Caution FIXME Diagram of a driver with workers as boxes.

Explain task execution in Spark and understand Spark’s underlying execution model.

New vocabulary often faced in Spark UI

When you create SparkContext, each worker starts an executor. This is a separate process
(JVM), and it loads your jar, too. The executors connect back to your driver program. Now
the driver can send them commands, like flatMap , map and reduceByKey . When the
driver quits, the executors shut down.

A new process is not started for each step. A new process is started on each worker when
the SparkContext is constructed.

The executor deserializes the command (this is possible because it has loaded your jar),
and executes it on a partition.

Shortly speaking, an application in Spark is executed in three steps:

1. Create RDD graph, i.e. DAG (directed acyclic graph) of RDDs to represent entire
computation.

2. Create stage graph, i.e. a DAG of stages that is a logical execution plan based on the
RDD graph. Stages are created by breaking the RDD graph at shuffle boundaries.

3. Based on the plan, schedule and execute tasks on workers.

In the WordCount example, the RDD graph is as follows:

file → lines → words → per-word count → global word count → output

379
Workers

Based on this graph, two stages are created. The stage creation rule is based on the idea of
pipelining as many narrow transformations as possible. RDD operations with "narrow"
dependencies, like map() and filter() , are pipelined together into one set of tasks in
each stage.

In the end, every stage will only have shuffle dependencies on other stages, and may
compute multiple operations inside it.

In the WordCount example, the narrow transformation finishes at per-word count. Therefore,
you get two stages:

file → lines → words → per-word count

global word count → output

Once stages are defined, Spark will generate tasks from stages. The first stage will create
ShuffleMapTasks with the last stage creating ResultTasks because in the last stage, one
action operation is included to produce results.

The number of tasks to be generated depends on how your files are distributed. Suppose
that you have 3 three different files in three different nodes, the first stage will generate 3
tasks: one task per partition.

Therefore, you should not map your steps to tasks directly. A task belongs to a stage, and is
related to a partition.

The number of tasks being generated in each stage will be equal to the number of partitions.

Cleanup

Caution FIXME

Settings
spark.worker.cleanup.enabled (default: false ) Cleanup enabled.

380
Anatomy of Spark Application

Anatomy of Spark Application

Every Spark application starts from creating SparkContext.

Note Without SparkContext no computation (as a Spark job) can be started.

A Spark application is an instance of SparkContext. Or, put it differently, a Spark

Note
context constitutes a Spark application.

A Spark application is uniquely identified by a pair of the application and application attempt
ids.

For it to work, you have to create a Spark configuration using SparkConf or use a custom
SparkContext constructor.

package pl.japila.spark

import org.apache.spark.{SparkContext, SparkConf}

object SparkMeApp {
def main(args: Array[String]) {

val masterURL = "local[*]" (1)

val conf = new SparkConf() (2)

.setAppName("SparkMe Application")
.setMaster(masterURL)

val sc = new SparkContext(conf) (3)

val fileName = util.Try(args(0)).getOrElse("build.sbt")

val lines = sc.textFile(fileName).cache() (4)

val c = lines.count() (5)

println(s"There are $c lines in $fileName")
}
}

1. Master URL to connect the application to

2. Create Spark configuration

3. Create Spark context

4. Create lines RDD

381
Anatomy of Spark Application

5. Execute count action

Tip Spark shell creates a Spark context and SQL context for you at startup.

When a Spark application starts (using spark-submit script or as a standalone application), it

connects to Spark master as described by master URL. It is part of Spark context’s
initialization.

Figure 1. Submitting Spark application to master using master URL

Your Spark application can run locally or on the cluster which is based on the
Note cluster manager and the deploy mode ( --deploy-mode ). Refer to Deployment
Modes.

You can then create RDDs, transform them to other RDDs and ultimately execute actions.
You can also cache interim RDDs to speed up data processing.

After all the data processing is completed, the Spark application finishes by stopping the
Spark context.

382
SparkConf — Programmable Configuration for Spark Applications

SparkConf — Spark Application’s Configuration

Refer to Spark Configuration in the official documentation for an extensive
Tip
coverage of how to configure Spark and user programs.

TODO
Describe SparkConf object for the application configuration.
Caution
the default configs

system properties

There are three ways to configure Spark and user programs:

Spark Properties - use Web UI to learn the current properties.

…​

setIfMissing Method

Caution FIXME

isExecutorStartupConf Method

Caution FIXME

set Method

Caution FIXME

Mandatory Settings - spark.master and spark.app.name

There are two mandatory settings of any Spark application that have to be defined before
this Spark application could be run — spark.master and spark.app.name.

Spark Properties
Every user program starts with creating an instance of SparkConf that holds the master
URL to connect to ( spark.master ), the name for your Spark application (that is later
displayed in web UI and becomes spark.app.name ) and other Spark properties required for

383
SparkConf — Programmable Configuration for Spark Applications

proper runs. The instance of SparkConf can be used to create SparkContext.

Start Spark shell with --conf spark.logConf=true to log the effective Spark
configuration as INFO when SparkContext is started.

$ ./bin/spark-shell --conf spark.logConf=true

...
15/10/19 17:13:49 INFO SparkContext: Running Spark version 1.6.0-SNAPSHOT
15/10/19 17:13:49 INFO SparkContext: Spark configuration:
spark.app.name=Spark shell
spark.home=/Users/jacek/dev/oss/spark
Tip spark.jars=
spark.logConf=true
spark.master=local[*]
spark.repl.class.uri=http://10.5.10.20:64055
spark.submit.deployMode=client
...

Use sc.getConf.toDebugString to have a richer output once SparkContext has

finished initializing.

You can query for the values of Spark properties in Spark shell as follows:

scala> sc.getConf.getOption("spark.local.dir")
res0: Option[String] = None

scala> sc.getConf.getOption("spark.app.name")
res1: Option[String] = Some(Spark shell)

scala> sc.getConf.get("spark.master")
res2: String = local[*]

Setting up Spark Properties

There are the following places where a Spark application looks for Spark properties (in the
order of importance from the least important to the most important):

conf/spark-defaults.conf - the configuration file with the default Spark properties.

Read spark-defaults.conf.

--conf or -c - the command-line option used by spark-submit (and other shell scripts

that use spark-submit or spark-class under the covers, e.g. spark-shell )

SparkConf

Default Configuration
The default Spark configuration is created when you execute the following code:

384
SparkConf — Programmable Configuration for Spark Applications

import org.apache.spark.SparkConf
val conf = new SparkConf

It simply loads spark.* system properties.

You can use conf.toDebugString or conf.getAll to have the spark.* system properties
loaded printed out.

scala> conf.getAll
res0: Array[(String, String)] = Array((spark.app.name,Spark shell), (spark.jars,""), (
spark.master,local[*]), (spark.submit.deployMode,client))

scala> conf.toDebugString
res1: String =
spark.app.name=Spark shell
spark.jars=
spark.master=local[*]
spark.submit.deployMode=client

scala> println(conf.toDebugString)
spark.app.name=Spark shell
spark.jars=
spark.master=local[*]
spark.submit.deployMode=client

Unique Identifier of Spark Application —  getAppId

Method

getAppId: String

getAppId gives spark.app.id Spark property or reports NoSuchElementException if not set.

getAppId is used when:

NettyBlockTransferService is initialized (and creates a

Note NettyBlockRpcServer as well as saves the identifier for later use).

Executor is created (in non-local mode and requests BlockManager to
initialize).

Settings

385
SparkConf — Programmable Configuration for Spark Applications

Table 1. Spark Properties

Spark Property Default Value Description
spark.master Master URL

Unique identifier of a Spark

application that Spark uses to
uniquely identify metric sources.
spark.app.id TaskScheduler.applicationId() Set when SparkContext is
created (right after
TaskScheduler is started that
actually gives the identifier).

spark.app.name Application Name

386
Spark Properties and spark-defaults.conf Properties File

Spark Properties and spark-defaults.conf

Properties File
Spark properties are the means of tuning the execution environment for your Spark
applications.

The default Spark properties file is $SPARK_HOME/conf/spark-defaults.conf that could be

overriden using spark-submit with --properties-file command-line option.

Table 1. Environment Variables

Environment Variable Default Value Description
Spark’s configuration
SPARK_CONF_DIR ${SPARK_HOME}/conf directory (with spark-
defaults.conf )

Tip Read the official documentation of Apache Spark on Spark Configuration.

Table 2. Spark Application’s Properties

Property Name Default Description
Comma-separated list of directories that
are used as a temporary storage for
"scratch" space, including map output files
and RDDs that get stored on disk.
spark.local.dir /tmp
This should be on a fast, local disk in your
system. It can also be a comma-
separated list of multiple directories on
different disks.

spark-defaults.conf  — Default Spark Properties File

spark-defaults.conf (under SPARK_CONF_DIR or $SPARK_HOME/conf ) is the default properties

file with the Spark properties of your Spark applications.

spark-defaults.conf is loaded by AbstractCommandBuilder’s

Note
loadPropertiesFile internal method.

Calculating Path of Default Spark Properties 

—  Utils.getDefaultPropertiesFile method

387
Spark Properties and spark-defaults.conf Properties File

getDefaultPropertiesFile(env: Map[String, String] = sys.env): String

getDefaultPropertiesFile calculates the absolute path to spark-defaults.conf properties

file that can be either in directory specified by SPARK_CONF_DIR environment variable or

$SPARK_HOME/conf directory.

getDefaultPropertiesFile is part of private[spark]

Note
org.apache.spark.util.Utils object.

388
Deploy Mode

Deploy Mode
Deploy mode specifies the location of where driver executes in the deployment
environment.

Deploy mode can be one of the following options:

client (default) - the driver runs on the machine that the Spark application was

launched.

cluster - the driver runs on a random node in a cluster.

Note cluster deploy mode is only available for non-local cluster deployments.

You can control the deploy mode of a Spark application using spark-submit’s --deploy-mode
command-line option or spark.submit.deployMode Spark property.

Note spark.submit.deployMode setting can be client or cluster .

Client Deploy Mode

Caution FIXME

Cluster Deploy Mode

Caution FIXME

spark.submit.deployMode
spark.submit.deployMode (default: client ) can be client or cluster .

389
SparkContext

SparkContext — Entry Point to Spark Core

SparkContext (aka Spark context) is the heart of a Spark application.

Note You could also assume that a SparkContext instance is a Spark application.

Spark context sets up internal services and establishes a connection to a Spark execution
environment.

Once a SparkContext is created you can use it to create RDDs, accumulators and
broadcast variables, access Spark services and run jobs (until SparkContext is stopped).

A Spark context is essentially a client of Spark’s execution environment and acts as the
master of your Spark application (don’t get confused with the other meaning of Master in
Spark, though).

Figure 1. Spark context acts as the master of your Spark application

SparkContext offers the following functions:

Getting current status of a Spark application

SparkEnv

SparkConf

deployment environment (as master URL)

390
SparkContext

application name

unique identifier of execution attempt

deploy mode

default level of parallelism that specifies the number of partitions in RDDs when
they are created without specifying the number explicitly by a user.

Spark user

the time (in milliseconds) when SparkContext was created

URL of web UI

Spark version

Storage status

Setting Configuration

master URL

Local Properties — Creating Logical Job Groups

Setting Local Properties to Group Spark Jobs

Default Logging Level

Creating Distributed Entities

RDDs

Accumulators

Broadcast variables

Accessing services, e.g. AppStatusStore, TaskScheduler, LiveListenerBus,

BlockManager, SchedulerBackends, ShuffleManager and the optional ContextCleaner.

Running jobs synchronously

Submitting jobs asynchronously

Cancelling a job

Cancelling a stage

Assigning custom Scheduler Backend, TaskScheduler and DAGScheduler

Closure cleaning

391
SparkContext

Accessing persistent RDDs

Unpersisting RDDs, i.e. marking RDDs as non-persistent

Registering SparkListener

Programmable Dynamic Allocation

Table 1. SparkContext’s Internal Registries and Counters

Name Description

Lookup table of persistent/cached RDDs per their ids.

Used when SparkContext is requested to:

persistRDD
persistentRdds
getRDDStorageInfo
getPersistentRDDs
unpersistRDD

Table 2. SparkContext’s Internal Properties

Name Initial Value Description
_taskScheduler (uninitialized) TaskScheduler

Tip Read the scaladoc of org.apache.spark.SparkContext.

Enable INFO logging level for org.apache.spark.SparkContext logger to see what

happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.SparkContext=INFO

Refer to Logging.

addFile Method

addFile(path: String): Unit (1)

addFile(path: String, recursive: Boolean): Unit

1. recursive flag is off

addFile adds the path file to be downloaded…​FIXME

392
SparkContext

addFile is used when:

SparkContext is initialized (and files were defined)

Note
Spark SQL’s AddFileCommand is executed
Spark SQL’s SessionResourceLoader is requested to load a file resource

Removing RDD Blocks from BlockManagerMaster 

—  unpersistRDD Internal Method

unpersistRDD(rddId: Int, blocking: Boolean = true): Unit

unpersistRDD requests BlockManagerMaster to remove the blocks for the RDD (given

rddId ).

unpersistRDD uses SparkEnv to access the current BlockManager that is in

Note
turn used to access the current BlockManagerMaster .

unpersistRDD removes rddId from persistentRdds registry.

In the end, unpersistRDD posts a SparkListenerUnpersistRDD (with rddId ) to

LiveListenerBus Event Bus.

unpersistRDD is used when:

Note ContextCleaner does doCleanupRDD

SparkContext unpersists an RDD (i.e. marks an RDD as non-persistent)

Unique Identifier of Spark Application —  applicationId

Method

Caution FIXME

postApplicationStart Internal Method

Caution FIXME

postApplicationEnd Method

Caution FIXME

393
SparkContext

clearActiveContext Method

Caution FIXME

Accessing persistent RDDs —  getPersistentRDDs

Method

getPersistentRDDs: Map[Int, RDD[_]]

getPersistentRDDs returns the collection of RDDs that have marked themselves as

persistent via cache.

Internally, getPersistentRDDs returns persistentRdds internal registry.

Cancelling Job —  cancelJob Method

cancelJob(jobId: Int)

cancelJob requests DAGScheduler to cancel a Spark job.

Cancelling Stage —  cancelStage Methods

cancelStage(stageId: Int): Unit

cancelStage(stageId: Int, reason: String): Unit

cancelStage simply requests DAGScheduler to cancel a Spark stage (with an optional

reason ).

cancelStage is used when StagesTab handles a kill request (from a user in

Note
web UI).

Programmable Dynamic Allocation

SparkContext offers the following methods as the developer API for dynamic allocation of

executors:

requestExecutors

killExecutors

requestTotalExecutors

394
SparkContext

(private!) getExecutorIds

Requesting New Executors —  requestExecutors Method

requestExecutors(numAdditionalExecutors: Int): Boolean

requestExecutors requests numAdditionalExecutors executors from

CoarseGrainedSchedulerBackend.

Requesting to Kill Executors —  killExecutors Method

killExecutors(executorIds: Seq[String]): Boolean

Caution FIXME

Requesting Total Executors —  requestTotalExecutors

Method

requestTotalExecutors(
numExecutors: Int,
localityAwareTasks: Int,
hostToLocalTaskCount: Map[String, Int]): Boolean

requestTotalExecutors is a private[spark] method that requests the exact number of

executors from a coarse-grained scheduler backend.

Note It works for coarse-grained scheduler backends only.

When called for other scheduler backends you should see the following WARN message in
the logs:

WARN Requesting executors is only supported in coarse-grained mode

Getting Executor Ids —  getExecutorIds Method

getExecutorIds is a private[spark] method that is part of ExecutorAllocationClient

contract. It simply passes the call on to the current coarse-grained scheduler backend, i.e.
calls getExecutorIds .

395
SparkContext

Note It works for coarse-grained scheduler backends only.

When called for other scheduler backends you should see the following WARN message in
the logs:

WARN Requesting executors is only supported in coarse-grained mode

FIXME Why does SparkContext implement the method for coarse-grained

Caution scheduler backends? Why doesn’t SparkContext throw an exception when
the method is called? Nobody seems to be using it (!)

Creating SparkContext Instance

You can create a SparkContext instance with or without creating a SparkConf object first.

You may want to read Inside Creating SparkContext to learn what happens
Note
behind the scenes when SparkContext is created.

Getting Existing or Creating New SparkContext 

—  getOrCreate Methods

getOrCreate(): SparkContext
getOrCreate(conf: SparkConf): SparkContext

getOrCreate methods allow you to get the existing SparkContext or create a new one.

import org.apache.spark.SparkContext
val sc = SparkContext.getOrCreate()

// Using an explicit SparkConf object

import org.apache.spark.SparkConf
val conf = new SparkConf()
.setMaster("local[*]")
.setAppName("SparkMe App")
val sc = SparkContext.getOrCreate(conf)

The no-param getOrCreate method requires that the two mandatory Spark settings - master
and application name - are specified using spark-submit.

Constructors

396
SparkContext

SparkContext()
SparkContext(conf: SparkConf)
SparkContext(master: String, appName: String, conf: SparkConf)
SparkContext(
master: String,
appName: String,
sparkHome: String = null,
jars: Seq[String] = Nil,
environment: Map[String, String] = Map())

You can create a SparkContext instance using the four constructors.

import org.apache.spark.SparkConf
val conf = new SparkConf()
.setMaster("local[*]")
.setAppName("SparkMe App")

import org.apache.spark.SparkContext
val sc = new SparkContext(conf)

When a Spark context starts up you should see the following INFO in the logs (amongst the
other messages that come from the Spark services):

INFO SparkContext: Running Spark version 2.0.0-SNAPSHOT

Only one SparkContext may be running in a single JVM (check out SPARK-
2243 Support multiple SparkContexts in the same JVM). Sharing access to a
Note
SparkContext in the JVM is the solution to share data within Spark (without
relying on other means of data sharing using external data stores).

Accessing Current SparkEnv —  env Method

Caution FIXME

Getting Current SparkConf —  getConf Method

getConf: SparkConf

getConf returns the current SparkConf.

Changing the SparkConf object does not change the current configuration (as
Note
the method returns a copy).

397
SparkContext

Deployment Environment —  master Method

master: String

master method returns the current value of spark.master which is the deployment

environment in use.

Application Name —  appName Method

appName: String

appName gives the value of the mandatory spark.app.name setting.

appName is used when SparkDeploySchedulerBackend starts, SparkUI creates a

Note web UI, when postApplicationStart is executed, and for Mesos and
checkpointing in Spark Streaming.

Unique Identifier of Execution Attempt 

—  applicationAttemptId Method

applicationAttemptId: Option[String]

applicationAttemptId gives the unique identifier of the execution attempt of a Spark

application.

applicationAttemptId is used when:

Note ShuffleMapTask and ResultTask are created

SparkContext announces that a Spark application has started

Storage Status (of All BlockManagers) 

—  getExecutorStorageStatus Method

getExecutorStorageStatus: Array[StorageStatus]

getExecutorStorageStatus requests BlockManagerMaster for storage status (of all

BlockManagers).

Note getExecutorStorageStatus is a developer API.

398
SparkContext

getExecutorStorageStatus is used when:

Note SparkContext is requested for storage status of cached RDDs

SparkStatusTracker is requested for information about all known executors

Deploy Mode —  deployMode Method

deployMode: String

deployMode returns the current value of spark.submit.deployMode setting or client if not

set.

Scheduling Mode —  getSchedulingMode Method

getSchedulingMode: SchedulingMode.SchedulingMode

getSchedulingMode returns the current Scheduling Mode.

Schedulable (Pool) by Name —  getPoolForName Method

getPoolForName(pool: String): Option[Schedulable]

getPoolForName returns a Schedulable by the pool name, if one exists.

Note getPoolForName is part of the Developer’s API and may change in the future.

Internally, it requests the TaskScheduler for the root pool and looks up the Schedulable by
the pool name.

It is exclusively used to show pool details in web UI (for a stage).

All Pools —  getAllPools Method

getAllPools: Seq[Schedulable]

getAllPools collects the Pools in TaskScheduler.rootPool.

Note TaskScheduler.rootPool is part of the TaskScheduler Contract.

399
SparkContext

Note getAllPools is part of the Developer’s API.

Caution FIXME Where is the method used?

getAllPools is used to calculate pool names for Stages tab in web UI with
Note
FAIR scheduling mode used.

Default Level of Parallelism

defaultParallelism: Int

defaultParallelism requests TaskScheduler for the default level of parallelism.

Default level of parallelism specifies the number of partitions in RDDs when

Note
created without specifying them explicitly by a user.

defaultParallelism is used in SparkContext.parallelize, SparkContext.range

and SparkContext.makeRDD (as well as Spark Streaming’s
DStream.countByValue and DStream.countByValueAndWindow et al.).
Note
defaultParallelism is also used to instantiate HashPartitioner and for the
minimum number of partitions in HadoopRDDs.

Current Spark Scheduler (aka TaskScheduler) 

—  taskScheduler Property

taskScheduler: TaskScheduler
taskScheduler_=(ts: TaskScheduler): Unit

taskScheduler manages (i.e. reads or writes) _taskScheduler internal property.

Getting Spark Version —  version Property

version: String

version returns the Spark version this SparkContext uses.

makeRDD Method

Caution FIXME

400
SparkContext

Submitting Jobs Asynchronously —  submitJob Method

submitJob[T, U, R](
rdd: RDD[T],
processPartition: Iterator[T] => U,
partitions: Seq[Int],
resultHandler: (Int, U) => Unit,
resultFunc: => R): SimpleFutureAction[R]

submitJob submits a job in an asynchronous, non-blocking way to DAGScheduler.

It cleans the processPartition input function argument and returns an instance of

SimpleFutureAction that holds the JobWaiter instance.

Caution FIXME What are resultFunc ?

It is used in:

AsyncRDDActions methods

Spark Streaming for ReceiverTrackerEndpoint.startReceiver

Spark Configuration

Caution FIXME

SparkContext and RDDs

You use a Spark context to create RDDs (see Creating RDD).

When an RDD is created, it belongs to and is completely owned by the Spark context it
originated from. RDDs can’t by design be shared between SparkContexts.

401
SparkContext

Figure 2. A Spark context creates a living space for RDDs.

Creating RDD —  parallelize Method

SparkContext allows you to create many different RDDs from input sources like:

Scala’s collections, i.e. sc.parallelize(0 to 100)

local or remote filesystems, i.e. sc.textFile("README.md")

Any Hadoop InputSource using sc.newAPIHadoopFile

Read Creating RDDs in RDD - Resilient Distributed Dataset.

Unpersisting RDD (Marking RDD as Non-Persistent) 

—  unpersist Method

Caution FIXME

unpersist removes an RDD from the master’s Block Manager (calls removeRdd(rddId: Int,

blocking: Boolean) ) and the internal persistentRdds mapping.

It finally posts SparkListenerUnpersistRDD message to listenerBus .

Setting Checkpoint Directory —  setCheckpointDir

Method

402
SparkContext

setCheckpointDir(directory: String)

setCheckpointDir method is used to set up the checkpoint directory…​FIXME

Caution FIXME

Registering Accumulator —  register Methods

register(acc: AccumulatorV2[_, _]): Unit

register(acc: AccumulatorV2[_, _], name: String): Unit

register registers the acc accumulator. You can optionally give an accumulator a name .

You can create built-in accumulators for longs, doubles, and collection types
Tip
using specialized methods.

Internally, register registers acc accumulator (with the current SparkContext ).

Creating Built-In Accumulators

longAccumulator: LongAccumulator
longAccumulator(name: String): LongAccumulator
doubleAccumulator: DoubleAccumulator
doubleAccumulator(name: String): DoubleAccumulator
collectionAccumulator[T]: CollectionAccumulator[T]
collectionAccumulator[T](name: String): CollectionAccumulator[T]

You can use longAccumulator , doubleAccumulator or collectionAccumulator to create and

register accumulators for simple and collection values.

longAccumulator returns LongAccumulator with the zero value 0 .

doubleAccumulator returns DoubleAccumulator with the zero value 0.0 .

collectionAccumulator returns CollectionAccumulator with the zero value

java.util.List[T] .

403
SparkContext

scala> val acc = sc.longAccumulator

acc: org.apache.spark.util.LongAccumulator = LongAccumulator(id: 0, name: None, value:
0)

scala> val counter = sc.longAccumulator("counter")

counter: org.apache.spark.util.LongAccumulator = LongAccumulator(id: 1, name: Some(cou
nter), value: 0)

scala> counter.value
res0: Long = 0

scala> sc.parallelize(0 to 9).foreach(n => counter.add(n))

scala> counter.value
res3: Long = 45

The name input parameter allows you to give a name to an accumulator and have it
displayed in Spark UI (under Stages tab for a given stage).

Figure 3. Accumulators in the Spark UI

Tip You can register custom accumulators using register methods.

Creating Broadcast Variable —  broadcast Method

broadcast[T](value: T): Broadcast[T]

broadcast method creates a broadcast variable. It is a shared memory with value (as

broadcast blocks) on the driver and later on all Spark executors.

404
SparkContext

val sc: SparkContext = ???

scala> val hello = sc.broadcast("hello")
hello: org.apache.spark.broadcast.Broadcast[String] = Broadcast(0)

Spark transfers the value to Spark executors once, and tasks can share it without incurring
repetitive network transmissions when the broadcast variable is used multiple times.

Figure 4. Broadcasting a value to executors

Internally, broadcast requests the current BroadcastManager to create a new broadcast
variable.

The current BroadcastManager is available using SparkEnv.broadcastManager

Note attribute and is always BroadcastManager (with few internal configuration
changes to reflect where it runs, i.e. inside the driver or executors).

You should see the following INFO message in the logs:

INFO SparkContext: Created broadcast [id] from [callSite]

If ContextCleaner is defined, the new broadcast variable is registered for cleanup.

405
SparkContext

Spark does not support broadcasting RDDs.

scala> sc.broadcast(sc.range(0, 10))

java.lang.IllegalArgumentException: requirement failed: Can not directly broadcast RDDs; in
Note at scala.Predef$.require(Predef.scala:224)
at org.apache.spark.SparkContext.broadcast(SparkContext.scala:1392)
... 48 elided

Once created, the broadcast variable (and other blocks) are displayed per executor and the
driver in web UI (under Executors tab).

Figure 5. Broadcast Variables In web UI’s Executors Tab

Distribute JARs to workers

The jar you specify with SparkContext.addJar will be copied to all the worker nodes.

The configuration setting spark.jars is a comma-separated list of jar paths to be included

in all tasks executed from this SparkContext. A path can either be a local file, a file in HDFS
(or other Hadoop-supported filesystems), an HTTP, HTTPS or FTP URI, or local:/path for
a file on every worker node.

scala> sc.addJar("build.sbt")
15/11/11 21:54:54 INFO SparkContext: Added JAR build.sbt at http://192.168.1.4:49427/j
ars/build.sbt with timestamp 1447275294457

Caution FIXME Why is HttpFileServer used for addJar?

SparkContext as Application-Wide Counter

SparkContext keeps track of:

406
SparkContext

shuffle ids using nextShuffleId internal counter for registering shuffle dependencies to
Shuffle Service.

Running Job Synchronously —  runJob Methods

RDD actions run jobs using one of runJob methods.

runJob[T, U](
rdd: RDD[T],
func: (TaskContext, Iterator[T]) => U,
partitions: Seq[Int],
resultHandler: (Int, U) => Unit): Unit
runJob[T, U](
rdd: RDD[T],
func: (TaskContext, Iterator[T]) => U,
partitions: Seq[Int]): Array[U]
runJob[T, U](
rdd: RDD[T],
func: Iterator[T] => U,
partitions: Seq[Int]): Array[U]
runJob[T, U](rdd: RDD[T], func: (TaskContext, Iterator[T]) => U): Array[U]
runJob[T, U](rdd: RDD[T], func: Iterator[T] => U): Array[U]
runJob[T, U](
rdd: RDD[T],
processPartition: (TaskContext, Iterator[T]) => U,
resultHandler: (Int, U) => Unit)
runJob[T, U: ClassTag](
rdd: RDD[T],
processPartition: Iterator[T] => U,
resultHandler: (Int, U) => Unit)

runJob executes a function on one or many partitions of a RDD (in a SparkContext space)

to produce a collection of values per partition.

Note runJob can only work when a SparkContext is not stopped.

Internally, runJob first makes sure that the SparkContext is not stopped. If it is, you should
see the following IllegalStateException exception in the logs:

java.lang.IllegalStateException: SparkContext has been shutdown

at org.apache.spark.SparkContext.runJob(SparkContext.scala:1893)
at org.apache.spark.SparkContext.runJob(SparkContext.scala:1914)
at org.apache.spark.SparkContext.runJob(SparkContext.scala:1934)
... 48 elided

runJob then calculates the call site and cleans a func closure.

407
SparkContext

You should see the following INFO message in the logs:

INFO SparkContext: Starting job: [callSite]

With spark.logLineage enabled (which is not by default), you should see the following INFO
message with toDebugString (executed on rdd ):

INFO SparkContext: RDD's recursive dependencies:

[toDebugString]

runJob requests DAGScheduler to run a job.

Tip runJob just prepares input parameters for DAGScheduler to run a job.

After DAGScheduler is done and the job has finished, runJob stops ConsoleProgressBar
and performs RDD checkpointing of rdd .

For some actions, e.g. first() and lookup() , there is no need to compute all
Tip
the partitions of the RDD in a job. And Spark knows it.

// RDD to work with

val lines = sc.parallelize(Seq("hello world", "nice to see you"))

import org.apache.spark.TaskContext
scala> sc.runJob(lines, (t: TaskContext, i: Iterator[String]) => 1) (1)
res0: Array[Int] = Array(1, 1) (2)

1. Run a job using runJob on lines RDD with a function that returns 1 for every partition
(of lines RDD).

2. What can you say about the number of partitions of the lines RDD? Is your result
res0 different than mine? Why?

Tip Read TaskContext.

Running a job is essentially executing a func function on all or a subset of partitions in an

rdd RDD and returning the result as an array (with elements being the results per

partition).

408
SparkContext

Figure 6. Executing action

Stopping SparkContext  —  stop Method

stop(): Unit

stop stops the SparkContext .

Internally, stop enables stopped internal flag. If already stopped, you should see the
following INFO message in the logs:

INFO SparkContext: SparkContext already stopped.

stop then does the following:

1. Removes _shutdownHookRef from ShutdownHookManager

2. Posts a SparkListenerApplicationEnd (to LiveListenerBus Event Bus)

3. Stops web UI

4. Requests MetricSystem to report metrics (from all registered sinks)

5. Stops ContextCleaner

6. Requests ExecutorAllocationManager to stop

409
SparkContext

7. If LiveListenerBus was started, requests LiveListenerBus to stop

8. Requests EventLoggingListener to stop

9. Requests DAGScheduler to stop

10. Requests RpcEnv to stop HeartbeatReceiver endpoint

11. Requests ConsoleProgressBar to stop

12. Clears the reference to TaskScheduler , i.e. _taskScheduler is null

13. Requests SparkEnv to stop and clears SparkEnv

14. Clears SPARK_YARN_MODE flag

15. Clears an active SparkContext

Ultimately, you should see the following INFO message in the logs:

INFO SparkContext: Successfully stopped SparkContext

Registering SparkListener —  addSparkListener Method

addSparkListener(listener: SparkListenerInterface): Unit

You can register a custom SparkListenerInterface using addSparkListener method

Note You can also register custom listeners using spark.extraListeners setting.

Custom SchedulerBackend, TaskScheduler and

DAGScheduler
By default, SparkContext uses ( private[spark] class)
org.apache.spark.scheduler.DAGScheduler , but you can develop your own custom

DAGScheduler implementation, and use ( private[spark] ) SparkContext.dagScheduler_=(ds:

DAGScheduler) method to assign yours.

It is also applicable to SchedulerBackend and TaskScheduler using schedulerBackend_=(sb:

SchedulerBackend) and taskScheduler_=(ts: TaskScheduler) methods, respectively.

Caution FIXME Make it an advanced exercise.

Events

410
SparkContext

When a Spark context starts, it triggers SparkListenerEnvironmentUpdate and

SparkListenerApplicationStart messages.

Refer to the section SparkContext’s initialization.

Setting Default Logging Level —  setLogLevel Method

setLogLevel(logLevel: String)

setLogLevel allows you to set the root logging level in a Spark application, e.g. Spark shell.

Internally, setLogLevel calls org.apache.log4j.Level.toLevel(logLevel) that it then uses to set

using org.apache.log4j.LogManager.getRootLogger().setLevel(level).

You can directly set the logging level using

org.apache.log4j.LogManager.getLogger().
Tip
LogManager.getLogger("org").setLevel(Level.OFF)

Closure Cleaning —  clean Method

clean(f: F, checkSerializable: Boolean = true): F

Every time an action is called, Spark cleans up the closure, i.e. the body of the action, before
it is serialized and sent over the wire to executors.

SparkContext comes with clean(f: F, checkSerializable: Boolean = true) method that

does this. It in turn calls ClosureCleaner.clean method.

Not only does ClosureCleaner.clean method clean the closure, but also does it transitively,
i.e. referenced closures are cleaned transitively.

A closure is considered serializable as long as it does not explicitly reference unserializable

objects. It does so by traversing the hierarchy of enclosing closures and null out any
references that are not actually used by the starting closure.

411
SparkContext

Enable DEBUG logging level for org.apache.spark.util.ClosureCleaner logger to

see what happens inside the class.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.util.ClosureCleaner=DEBUG

Refer to Logging.

With DEBUG logging level you should see the following messages in the logs:

+++ Cleaning closure [func] ([func.getClass.getName]) +++

+ declared fields: [declaredFields.size]
[field]
...
+++ closure [func] ([func.getClass.getName]) is now cleaned +++

Serialization is verified using a new instance of Serializer (as closure Serializer). Refer to
Serialization.

Caution FIXME an example, please.

Hadoop Configuration
While a SparkContext is being created, so is a Hadoop configuration (as an instance of
org.apache.hadoop.conf.Configuration that is available as _hadoopConfiguration ).

Note SparkHadoopUtil.get.newConfiguration is used.

If a SparkConf is provided it is used to build the configuration as described. Otherwise, the

default Configuration object is returned.

If AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are both available, the following settings

are set for the Hadoop configuration:

fs.s3.awsAccessKeyId , fs.s3n.awsAccessKeyId , fs.s3a.access.key are set to the value

of AWS_ACCESS_KEY_ID

fs.s3.awsSecretAccessKey , fs.s3n.awsSecretAccessKey , and fs.s3a.secret.key are set

to the value of AWS_SECRET_ACCESS_KEY

Every spark.hadoop. setting becomes a setting of the configuration with the prefix
spark.hadoop. removed for the key.

412
SparkContext

The value of spark.buffer.size (default: 65536 ) is used as the value of

io.file.buffer.size .

listenerBus  —  LiveListenerBus Event Bus

listenerBus is a LiveListenerBus object that acts as a mechanism to announce events to

other services on the driver.

It is created and started when SparkContext starts and, since it is a single-JVM

Note
event bus, is exclusively used on the driver.

Note listenerBus is a private[spark] value in SparkContext .

Time when SparkContext was Created —  startTime

Property

startTime: Long

startTime is the time in milliseconds when SparkContext was created.

scala> sc.startTime
res0: Long = 1464425605653

Spark User —  sparkUser Property

sparkUser: String

sparkUser is the user who started the SparkContext instance.

Note It is computed when SparkContext is created using Utils.getCurrentUserName.

Submitting ShuffleDependency for Execution 

—  submitMapStage Internal Method

submitMapStage[K, V, C](
dependency: ShuffleDependency[K, V, C]): SimpleFutureAction[MapOutputStatistics]

submitMapStage submits the input ShuffleDependency to DAGScheduler for execution and

returns a SimpleFutureAction .

413
SparkContext

Internally, submitMapStage calculates the call site first and submits it with localProperties .

Interestingly, submitMapStage is used exclusively when Spark SQL’s

Note
ShuffleExchange physical operator is executed.

submitMapStage seems related to Adaptive Query Planning / Adaptive

Note
Scheduling.

Calculating Call Site —  getCallSite Method

Caution FIXME

Cancelling Job Group —  cancelJobGroup Method

cancelJobGroup(groupId: String)

cancelJobGroup requests DAGScheduler to cancel a group of active Spark jobs.

cancelJobGroup is used exclusively when SparkExecuteStatementOperation

Note
does cancel .

Cancelling All Running and Scheduled Jobs 

—  cancelAllJobs Method

Caution FIXME

cancelAllJobs is used when spark-shell is terminated (e.g. using Ctrl+C, so it

Note
can in turn terminate all active Spark jobs) or SparkSQLCLIDriver is terminated.

Setting Local Properties to Group Spark Jobs 

—  setJobGroup Method

setJobGroup(
groupId: String,
description: String,
interruptOnCancel: Boolean = false): Unit

setJobGroup sets local properties:

spark.jobGroup.id as groupId

spark.job.description as description

414
SparkContext

spark.job.interruptOnCancel as interruptOnCancel

setJobGroup is used when:

Note Spark Thrift Server’s SparkExecuteStatementOperation runs a query

Structured Streaming’s StreamExecution runs batches

cleaner Method

cleaner: Option[ContextCleaner]

cleaner is a private[spark] method to get the optional application-wide ContextCleaner.

ContextCleaner is created when SparkContext is created with

Note spark.cleaner.referenceTracking Spark property enabled (which it is by
default).

Finding Preferred Locations (Placement Preferences) for

RDD Partition —  getPreferredLocs Method

getPreferredLocs(rdd: RDD[_], partition: Int): Seq[TaskLocation]

getPreferredLocs simply requests DAGScheduler for the preferred locations for partition .

Preferred locations of a partition of a RDD are also called placement

Note
preferences or locality preferences.

getPreferredLocs is used in CoalescedRDDPartition ,

Note
DefaultPartitionCoalescer and PartitionerAwareUnionRDD .

Registering RDD in persistentRdds Internal Registry 

—  persistRDD Internal Method

persistRDD(rdd: RDD[_]): Unit

persistRDD registers rdd in persistentRdds internal registry.

Note persistRDD is used exclusively when RDD is persisted or locally checkpointed.

415
SparkContext

Getting Storage Status of Cached RDDs (as RDDInfos) 

—  getRDDStorageInfo Methods

getRDDStorageInfo: Array[RDDInfo] (1)

getRDDStorageInfo(filter: RDD[_] => Boolean): Array[RDDInfo] (2)

1. Part of Spark’s Developer API that uses <2> filtering no RDDs

getRDDStorageInfo takes all the RDDs (from persistentRdds registry) that match filter

and creates a collection of RDDInfo instances.

getRDDStorageInfo then updates the RDDInfos with the current status of all BlockManagers

(in a Spark application).

In the end, getRDDStorageInfo gives only the RDD that are cached (i.e. the sum of memory
and disk sizes as well as the number of partitions cached are greater than 0 ).

Note getRDDStorageInfo is used when RDD is requested for RDD lineage graph.

Settings

spark.driver.allowMultipleContexts
Quoting the scaladoc of org.apache.spark.SparkContext:

Only one SparkContext may be active per JVM. You must stop() the active
SparkContext before creating a new one.

You can however control the behaviour using spark.driver.allowMultipleContexts flag.

It is disabled, i.e. false , by default.

If enabled (i.e. true ), Spark prints the following WARN message to the logs:

WARN Multiple running SparkContexts detected in the same JVM!

If disabled (default), it will throw an SparkException exception:

Only one SparkContext may be running in this JVM (see SPARK-2243). To ignore this erro
r, set spark.driver.allowMultipleContexts = true. The currently running SparkContext w
as created at:
[ctx.creationSite.longForm]

416
SparkContext

When creating an instance of SparkContext , Spark marks the current thread as having it
being created (very early in the instantiation process).

It’s not guaranteed that Spark will work properly with two or more
Caution
SparkContexts. Consider the feature a work in progress.

Accessing AppStatusStore —  statusStore Method

statusStore: AppStatusStore

statusStore gives the current AppStatusStore.

statusStore is used when:

ConsoleProgressBar is requested to refresh

Note
Spark SQL’s SharedState is requested for a SQLAppStatusStore (as
statusStore )

Requesting URL of web UI —  uiWebUrl Method

uiWebUrl: Option[String]

uiWebUrl requests the SparkUI for webUrl.

Environment Variables
Table 3. Environment Variables
Environment Variable Default Value Description

Amount of memory to allocate for a

SPARK_EXECUTOR_MEMORY 1024 Spark executor in MB.
See Executor Memory.

The user who is running

SPARK_USER SparkContext . Available later as
sparkUser.

417
HeartbeatReceiver RPC Endpoint

HeartbeatReceiver RPC Endpoint

HeartbeatReceiver is a ThreadSafeRpcEndpoint registered on the driver under the name

HeartbeatReceiver.

HeartbeatReceiver receives Heartbeat messages from executors that Spark uses as the

mechanism to receive accumulator updates (with task metrics and a Spark application’s
accumulators) and pass them along to TaskScheduler .

Figure 1. HeartbeatReceiver RPC Endpoint and Heartbeats from Executors

HeartbeatReceiver is registered immediately after a Spark application is
Note
started, i.e. when SparkContext is created.

HeartbeatReceiver is a SparkListener to get notified when a new executor is added to or no

longer available in a Spark application. HeartbeatReceiver tracks executors (in

executorLastSeen registry) to handle Heartbeat and ExpireDeadHosts messages from
executors that are assigned to the Spark application.

418
HeartbeatReceiver RPC Endpoint

Table 1. HeartbeatReceiver RPC Endpoint’s Messages (in alphabetical order)

Message Description

Posted when HeartbeatReceiver is notified that an

ExecutorRemoved
executor is no longer available (to a Spark application).

Posted when HeartbeatReceiver is notified that a new

ExecutorRegistered
executor has been registered (with a Spark application).

ExpireDeadHosts FIXME

Posted when Executor informs that it is alive and reports

Heartbeat
task metrics.

Posted when SparkContext informs that TaskScheduler

TaskSchedulerIsSet
is available.

Table 2. HeartbeatReceiver’s Internal Registries and Counters

Name Description

executorLastSeen
Executor ids and the timestamps of when the last
heartbeat was received.

scheduler TaskScheduler

Enable DEBUG or TRACE logging levels for org.apache.spark.HeartbeatReceiver

to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.HeartbeatReceiver=TRACE

Refer to Logging.

Creating HeartbeatReceiver Instance

HeartbeatReceiver takes the following when created:

SparkContext

Clock

HeartbeatReceiver registers itself as a SparkListener .

HeartbeatReceiver initializes the internal registries and counters.

419
HeartbeatReceiver RPC Endpoint

Starting HeartbeatReceiver RPC Endpoint —  onStart

Method

Note onStart is part of the RpcEndpoint Contract

When called, HeartbeatReceiver sends a blocking ExpireDeadHosts every

spark.network.timeoutInterval on eventLoopThread - Heartbeat Receiver Event Loop
Thread.

ExecutorRegistered

ExecutorRegistered(executorId: String)

When received, HeartbeatReceiver registers the executorId executor and the current time
(in executorLastSeen internal registry).

Note HeartbeatReceiver uses the internal Clock to know the current time.

ExecutorRemoved

ExecutorRemoved(executorId: String)

When ExecutorRemoved arrives, HeartbeatReceiver removes executorId from

executorLastSeen internal registry.

ExpireDeadHosts

ExpireDeadHosts

When ExpireDeadHosts arrives the following TRACE is printed out to the logs:

TRACE HeartbeatReceiver: Checking for hosts with no recent heartbeats in HeartbeatRece

iver.

Each executor (in executorLastSeen registry) is checked whether the time it was last seen is
not longer than spark.network.timeout.

For any such executor, the following WARN message is printed out to the logs:

420
HeartbeatReceiver RPC Endpoint

WARN HeartbeatReceiver: Removing executor [executorId] with no recent heartbeats: [tim

e] ms exceeds timeout [timeout] ms

TaskScheduler.executorLost is called (with SlaveLost("Executor heartbeat timed out after

[timeout] ms" ).

SparkContext.killAndReplaceExecutor is asynchronously called for the executor (i.e. on

killExecutorThread).

The executor is removed from executorLastSeen.

Heartbeat

Heartbeat(executorId: String,
accumUpdates: Array[(Long, Seq[AccumulatorV2[_, _]])],
blockManagerId: BlockManagerId)

When received, HeartbeatReceiver finds the executorId executor (in executorLastSeen

registry).

When the executor is found, HeartbeatReceiver updates the time the heartbeat was
received (in executorLastSeen).

Note HeartbeatReceiver uses the internal Clock to know the current time.

HeartbeatReceiver then submits an asynchronous task to notify TaskScheduler that the

heartbeat was received from the executor (using TaskScheduler internal reference).
HeartbeatReceiver posts a HeartbeatResponse back to the executor (with the response from

TaskScheduler whether the executor has been registered already or not so it may eventually

need to re-register).

If however the executor was not found (in executorLastSeen registry), i.e. the executor was
not registered before, you should see the following DEBUG message in the logs and the
response is to notify the executor to re-register.

DEBUG Received heartbeat from unknown executor [executorId]

In a very rare case, when TaskScheduler is not yet assigned to HeartbeatReceiver , you
should see the following WARN message in the logs and the response is to notify the
executor to re-register.

WARN Dropping [heartbeat] because TaskScheduler is not ready yet

421
HeartbeatReceiver RPC Endpoint

TaskScheduler can be unassigned when no TaskSchedulerIsSet has not been

Note
received yet.

Heartbeats messages are the mechanism of executors to inform the Spark

Note
application that they are alive and update about the state of active tasks.

TaskSchedulerIsSet

TaskSchedulerIsSet

When received, HeartbeatReceiver sets the internal reference to TaskScheduler.

HeartbeatReceiver uses SparkContext that is given when HeartbeatReceiver is

Note
created.

onExecutorAdded Method

onExecutorAdded(executorAdded: SparkListenerExecutorAdded): Unit

onExecutorAdded simply sends a ExecutorRegistered message to itself (that in turn

registers an executor).

onExecutorAdded is part of SparkListener contract to announce that a new

Note
executor was registered with a Spark application.

Sending ExecutorRegistered Message to Itself 

—  addExecutor Internal Method

addExecutor(executorId: String): Option[Future[Boolean]]

addExecutor sends a ExecutorRegistered message (to register executorId executor).

addExecutor is used when HeartbeatReceiver is notified that a new executor

Note
was added.

onExecutorRemoved Method

onExecutorRemoved(executorRemoved: SparkListenerExecutorRemoved): Unit

422
HeartbeatReceiver RPC Endpoint

onExecutorRemoved simply passes the call to removeExecutor (that in turn unregisters an

executor).

onExecutorRemoved is part of SparkListener contract to announce that an

Note
executor is no longer available for a Spark application.

Sending ExecutorRemoved Message to Itself 

—  removeExecutor Method

removeExecutor(executorId: String): Option[Future[Boolean]]

removeExecutor sends a ExecutorRemoved message to itself (passing in executorId ).

removeExecutor is used when HeartbeatReceiver is notified that an executor is

Note
no longer available.

Stopping HeartbeatReceiver RPC Endpoint —  onStop

Method

Note onStop is part of the RpcEndpoint Contract

When called, HeartbeatReceiver cancels the checking task (that sends a blocking
ExpireDeadHosts every spark.network.timeoutInterval on eventLoopThread - Heartbeat
Receiver Event Loop Thread - see Starting (onStart method)) and shuts down
eventLoopThread and killExecutorThread executors.

killExecutorThread  — Kill Executor Thread

killExecutorThread is a daemon ScheduledThreadPoolExecutor with a single thread.

The name of the thread pool is kill-executor-thread.

Note It is used to request SparkContext to kill the executor.

eventLoopThread  — Heartbeat Receiver Event Loop

Thread
eventLoopThread is a daemon ScheduledThreadPoolExecutor with a single thread.

The name of the thread pool is heartbeat-receiver-event-loop-thread.

423
HeartbeatReceiver RPC Endpoint

expireDeadHosts Internal Method

expireDeadHosts(): Unit

Caution FIXME

expireDeadHosts is used when HeartbeatReceiver receives a ExpireDeadHosts

Note
message.

Settings
Table 3. Spark Properties
Spark Property Default Value
spark.storage.blockManagerTimeoutIntervalMs 60s

spark.storage.blockManagerSlaveTimeoutMs 120s

spark.network.timeout spark.storage.blockManagerSlaveTimeoutMs

spark.network.timeoutInterval spark.storage.blockManagerTimeoutIntervalMs

424
Inside Creating SparkContext

Inside Creating SparkContext

This document describes what happens when you create a new SparkContext.

import org.apache.spark.{SparkConf, SparkContext}

// 1. Create Spark configuration

val conf = new SparkConf()
.setAppName("SparkMe Application")
.setMaster("local[*]") // local mode

// 2. Create Spark context

val sc = new SparkContext(conf)

The example uses Spark in local mode, but the initialization with the other
Note
cluster modes would follow similar steps.

Creating SparkContext instance starts by setting the internal allowMultipleContexts field

with the value of spark.driver.allowMultipleContexts and marking this SparkContext instance
as partially constructed. It makes sure that no other thread is creating a SparkContext
instance in this JVM. It does so by synchronizing on SPARK_CONTEXT_CONSTRUCTOR_LOCK and
using the internal atomic reference activeContext (that eventually has a fully-created
SparkContext instance).

The entire code of SparkContext that creates a fully-working SparkContext

instance is between two statements:

SparkContext.markPartiallyConstructed(this, allowMultipleContexts)
Note
// the SparkContext code goes here

SparkContext.setActiveContext(this, allowMultipleContexts)

startTime is set to the current time in milliseconds.

stopped internal flag is set to false .

The very first information printed out is the version of Spark as an INFO message:

INFO SparkContext: Running Spark version 2.0.0-SNAPSHOT

You can use version method to learn about the current Spark version or
Tip
org.apache.spark.SPARK_VERSION value.

425
Inside Creating SparkContext

A LiveListenerBus instance is created (as listenerBus ).

The current user name is computed.

Caution FIXME Where is sparkUser used?

It saves the input SparkConf (as _conf ).

Caution FIXME Review _conf.validateSettings()

It ensures that the first mandatory setting - spark.master is defined. SparkException is

thrown if not.

A master URL must be set in your configuration

It ensures that the other mandatory setting - spark.app.name is defined. SparkException is

thrown if not.

An application name must be set in your configuration

For Spark on YARN in cluster deploy mode, it checks existence of spark.yarn.app.id .

SparkException is thrown if it does not exist.

Detected yarn cluster mode, but isn't running on a cluster. Deployment to YARN is not
supported directly by SparkContext. Please use spark-submit.

Caution FIXME How to "trigger" the exception? What are the steps?

When spark.logConf is enabled SparkConf.toDebugString is called.

SparkConf.toDebugString is called very early in the initialization process and

Note other settings configured afterwards are not included. Use
sc.getConf.toDebugString once SparkContext is initialized.

The driver’s host and port are set if missing. spark.driver.host becomes the value of
Utils.localHostName (or an exception is thrown) while spark.driver.port is set to 0 .

spark.driver.host and spark.driver.port are expected to be set on the driver. It is

Note
later asserted by SparkEnv.

spark.executor.id setting is set to driver .

Use sc.getConf.get("spark.executor.id") to know where the code is executed 

Tip
— driver or executors.

426
Inside Creating SparkContext

It sets the jars and files based on spark.jars and spark.files , respectively. These are
files that are required for proper task execution on executors.

If event logging is enabled, i.e. spark.eventLog.enabled flag is true , the internal field
_eventLogDir is set to the value of spark.eventLog.dir setting or the default value

/tmp/spark-events .

Also, if spark.eventLog.compress is enabled (it is not by default), the short name of the
CompressionCodec is assigned to _eventLogCodec . The config key is
spark.io.compression.codec (default: lz4 ).

Tip Read about compression codecs in Compression.

Creating LiveListenerBus
SparkContext creates a LiveListenerBus.

Creating Live AppStatusStore

SparkContext requests AppStatusStore to create a live store (i.e. the AppStatusStore for a

live Spark application) and requests LiveListenerBus to add the AppStatusListener to the
status queue.

The current AppStatusStore is available as statusStore property of the

Note
SparkContext .

Creating SparkEnv
SparkContext creates a SparkEnv and requests SparkEnv to use the instance as the

default SparkEnv.

Caution FIXME Describe the following steps.

MetadataCleaner is created.

Caution FIXME What’s MetadataCleaner?

Creating SparkStatusTracker
SparkContext creates a SparkStatusTracker (with itself and the AppStatusStore).

Creating ConsoleProgressBar

427
Inside Creating SparkContext

SparkContext creates the optional ConsoleProgressBar when

spark.ui.showConsoleProgress property is enabled and the INFO logging level for

SparkContext is disabled.

Creating SparkUI
SparkContext creates a SparkUI when spark.ui.enabled configuration property is enabled

(i.e. true ) with the following:

AppStatusStore

Name of the Spark application that is exactly the value of spark.app.name configuration
property

Empty base path

Note spark.ui.enabled Spark property is assumed enabled when undefined.

Caution FIXME Where’s _ui used?

A Hadoop configuration is created. See Hadoop Configuration.

If there are jars given through the SparkContext constructor, they are added using addJar .

If there were files specified, they are added using addFile.

At this point in time, the amount of memory to allocate to each executor (as
_executorMemory ) is calculated. It is the value of spark.executor.memory setting, or

SPARK_EXECUTOR_MEMORY environment variable (or currently-deprecated SPARK_MEM ),

or defaults to 1024 .

_executorMemory is later available as sc.executorMemory and used for

LOCAL_CLUSTER_REGEX, Spark Standalone’s SparkDeploySchedulerBackend, to set

executorEnvs("SPARK_EXECUTOR_MEMORY") , MesosSchedulerBackend,

CoarseMesosSchedulerBackend.

The value of SPARK_PREPEND_CLASSES environment variable is included in executorEnvs .

FIXME

What’s _executorMemory ?
What’s the unit of the value of _executorMemory exactly?
Caution
What are "SPARK_TESTING", "spark.testing"? How do they contribute
to executorEnvs ?

What’s executorEnvs ?

428
Inside Creating SparkContext

The Mesos scheduler backend’s configuration is included in executorEnvs , i.e.

SPARK_EXECUTOR_MEMORY, _conf.getExecutorEnv , and SPARK_USER .

SparkContext registers HeartbeatReceiver RPC endpoint.

SparkContext.createTaskScheduler is executed (using the master URL) and the result

becomes the internal _schedulerBackend and _taskScheduler .

The internal _schedulerBackend and _taskScheduler are used by

Note
schedulerBackend and taskScheduler methods, respectively.

DAGScheduler is created (as _dagScheduler ).

SparkContext sends a blocking TaskSchedulerIsSet message to HeartbeatReceiver RPC

endpoint (to inform that the TaskScheduler is now available).

Starting TaskScheduler
SparkContext starts TaskScheduler .

Setting Spark Application’s and Execution Attempt’s IDs 

—  _applicationId and _applicationAttemptId
SparkContext sets the internal fields —  _applicationId and _applicationAttemptId  — 

(using applicationId and applicationAttemptId methods from the TaskScheduler

Contract).

SparkContext requests TaskScheduler for the unique identifier of a Spark

Note application (that is currently only implemented by TaskSchedulerImpl that uses
SchedulerBackend to request the identifier).

The unique identifier of a Spark application is used to initialize SparkUI and

Note
BlockManager.

_applicationAttemptId is used when SparkContext is requested for the unique

Note identifier of execution attempt of a Spark application and when
EventLoggingListener is created.

Setting spark.app.id Spark Property in SparkConf

SparkContext sets spark.app.id property to be the unique identifier of a Spark application

and, if enabled, passes it on to SparkUI .

Initializing BlockManager

429
Inside Creating SparkContext

The BlockManager (for the driver) is initialized (with _applicationId ).

Starting MetricsSystem
SparkContext requests the MetricsSystem to start.

SparkContext starts MetricsSystem after setting spark.app.id Spark property

Note
as MetricsSystem uses it to build unique identifiers fo metrics sources.

Requesting JSON Servlet Handler

SparkContext requests the MetricsSystem for a JSON servlet handler and requests the

SparkUI to attach it.

_eventLogger is created and started if isEventLogEnabled . It uses EventLoggingListener

that gets registered to LiveListenerBus.

FIXME Why is _eventLogger required to be the internal field of

Caution
SparkContext? Where is this used?

If dynamic allocation is enabled, ExecutorAllocationManager is created (as

_executorAllocationManager ) and immediately started.

_executorAllocationManager is exposed (as a method) to YARN scheduler

Note
backends to reset their state to the initial state.

If spark.cleaner.referenceTracking Spark property is enabled (i.e. true ), SparkContext

creates ContextCleaner (as _cleaner ) and started immediately. Otherwise, _cleaner is
empty.

Note spark.cleaner.referenceTracking Spark property is enabled by default.

FIXME It’d be quite useful to have all the properties with their default values
Caution in sc.getConf.toDebugString , so when a configuration is not included but
does change Spark runtime configuration, it should be added to _conf .

It registers user-defined listeners and starts SparkListenerEvent event delivery to the

listeners.

postEnvironmentUpdate is called that posts SparkListenerEnvironmentUpdate message on

LiveListenerBus with information about Task Scheduler’s scheduling mode, added jar and
file paths, and other environmental details. They are displayed in web UI’s Environment tab.

SparkListenerApplicationStart message is posted to LiveListenerBus (using the internal

postApplicationStart method).

430
Inside Creating SparkContext

TaskScheduler is notified that SparkContext is almost fully initialized.

TaskScheduler.postStartHook does nothing by default, but custom

implementations offer more advanced features, i.e. TaskSchedulerImpl blocks
Note
the current thread until SchedulerBackend is ready. There is also
YarnClusterScheduler for Spark on YARN in cluster deploy mode.

Registering Metrics Sources

SparkContext requests MetricsSystem to register metrics sources for the following services:

1. DAGScheduler

2. BlockManager

3. ExecutorAllocationManager (if dynamic allocation is enabled)

Adding Shutdown Hook

SparkContext adds a shutdown hook (using ShutdownHookManager.addShutdownHook() ).

You should see the following DEBUG message in the logs:

DEBUG Adding shutdown hook

Caution FIXME ShutdownHookManager.addShutdownHook()

Any non-fatal Exception leads to termination of the Spark context instance.

Caution FIXME What does NonFatal represent in Scala?

Caution FIXME Finish me

Initializing nextShuffleId and nextRddId Internal Counters

nextShuffleId and nextRddId start with 0 .

Caution FIXME Where are nextShuffleId and nextRddId used?

A new instance of Spark context is created and ready for operation.

Creating SchedulerBackend and TaskScheduler 

—  createTaskScheduler Internal Method

431
Inside Creating SparkContext

createTaskScheduler(
sc: SparkContext,
master: String,
deployMode: String): (SchedulerBackend, TaskScheduler)

createTaskScheduler is executed as part of creating an instance of SparkContext to create

TaskScheduler and SchedulerBackend objects.

createTaskScheduler uses the master URL to select the requested implementation.

Figure 1. SparkContext creates Task Scheduler and Scheduler Backend

createTaskScheduler understands the following master URLs:

local - local mode with 1 thread only

local[n] or local[*] - local mode with n threads.

local[n, m] or local[*, m]  — local mode with n threads and m number of failures.

spark://hostname:port for Spark Standalone.

local-cluster[n, m, z]  — local cluster with n workers, m cores per worker, and z

memory per worker.

mesos://hostname:port for Spark on Apache Mesos.

any other URL is passed to getClusterManager to load an external cluster manager.

Caution FIXME

Loading External Cluster Manager for URL

(getClusterManager method)

getClusterManager(url: String): Option[ExternalClusterManager]

432
Inside Creating SparkContext

getClusterManager loads ExternalClusterManager that can handle the input url .

If there are two or more external cluster managers that could handle url , a
SparkException is thrown:

Multiple Cluster Managers ([serviceLoaders]) registered for the url [url].

Note getClusterManager uses Java’s ServiceLoader.load method.

getClusterManager is used to find a cluster manager for a master URL when

Note
creating a SchedulerBackend and a TaskScheduler for the driver.

setupAndStartListenerBus

setupAndStartListenerBus(): Unit

setupAndStartListenerBus is an internal method that reads spark.extraListeners setting from

the current SparkConf to create and register SparkListenerInterface listeners.

It expects that the class name represents a SparkListenerInterface listener with one of the
following constructors (in this order):

a single-argument constructor that accepts SparkConf

a zero-argument constructor

setupAndStartListenerBus registers every listener class.

You should see the following INFO message in the logs:

INFO Registered listener [className]

It starts LiveListenerBus and records it in the internal _listenerBusStarted .

When no single- SparkConf or zero-argument constructor could be found for a class name in
spark.extraListeners setting, a SparkException is thrown with the message:

[className] did not have a zero-argument constructor or a single-argument constructor

that accepts SparkConf. Note: if the class is defined inside of another Scala class, t
hen its constructors may accept an implicit parameter that references the enclosing cl
ass; in this case, you must define the listener as a top-level class in order to preve
nt this extra parameter from breaking Spark's ability to find a valid constructor.

433
Inside Creating SparkContext

Any exception while registering a SparkListenerInterface listener stops the SparkContext

and a SparkException is thrown and the source exception’s message.

Exception when registering SparkListener

Set INFO on org.apache.spark.SparkContext logger to see the extra listeners

being registered.
Tip
INFO SparkContext: Registered listener pl.japila.spark.CustomSparkListener

Creating SparkEnv for Driver —  createSparkEnv

Method

createSparkEnv(
conf: SparkConf,
isLocal: Boolean,
listenerBus: LiveListenerBus): SparkEnv

createSparkEnv simply delegates the call to SparkEnv to create a SparkEnv for the driver.

It calculates the number of cores to 1 for local master URL, the number of processors
available for JVM for * or the exact number in the master URL, or 0 for the cluster
master URLs.

Utils.getCurrentUserName Method

getCurrentUserName(): String

getCurrentUserName computes the user name who has started the SparkContext instance.

Note It is later available as SparkContext.sparkUser.

Internally, it reads SPARK_USER environment variable and, if not set, reverts to Hadoop
Security API’s UserGroupInformation.getCurrentUser().getShortUserName() .

Note It is another place where Spark relies on Hadoop API for its operation.

Utils.localHostName Method
localHostName computes the local host name.

434
Inside Creating SparkContext

It starts by checking SPARK_LOCAL_HOSTNAME environment variable for the value. If it is not

defined, it uses SPARK_LOCAL_IP to find the name (using InetAddress.getByName ). If it is not
defined either, it calls InetAddress.getLocalHost for the name.

Utils.localHostName is executed while SparkContext is created and also to

Note
compute the default value of spark.driver.host Spark property.

Caution FIXME Review the rest.

stopped Flag

Caution FIXME Where is this used?

435
ConsoleProgressBar

ConsoleProgressBar
ConsoleProgressBar shows the progress of active stages to standard error, i.e. stderr . It

uses SparkStatusTracker to poll the status of stages periodically and print out active stages
with more than one task. It keeps overwriting itself to hold in one line for at most 3 first
concurrent stages at a time.

[Stage 0:====> (316 + 4) / 1000][Stage 1:> (0 + 0) / 1000][Sta

ge 2:> (0 + 0) / 1000]]]

The progress includes the stage id, the number of completed, active, and total tasks.

ConsoleProgressBar may be useful when you ssh to workers and want to see
Tip
the progress of active stages.

ConsoleProgressBar is created when SparkContext starts with

spark.ui.showConsoleProgress enabled and the logging level of

org.apache.spark.SparkContext logger as WARN or higher (i.e. less messages are printed
out and so there is a "space" for ConsoleProgressBar ).

import org.apache.log4j._
Logger.getLogger("org.apache.spark.SparkContext").setLevel(Level.WARN)

To print the progress nicely ConsoleProgressBar uses COLUMNS environment variable to

know the width of the terminal. It assumes 80 columns.

The progress bar prints out the status after a stage has ran at least 500 milliseconds every
spark.ui.consoleProgress.update.interval milliseconds.

The initial delay of 500 milliseconds before ConsoleProgressBar show the

Note
progress is not configurable.

See the progress bar in Spark shell with the following:

436
ConsoleProgressBar

$ ./bin/spark-shell --conf spark.ui.showConsoleProgress=true (1)

scala> sc.setLogLevel("OFF") (2)

import org.apache.log4j._
scala> Logger.getLogger("org.apache.spark.SparkContext").setLevel(Level.WARN) (3)

scala> sc.parallelize(1 to 4, 4).map { n => Thread.sleep(500 + 200 * n); n }.count (4

)
[Stage 2:> (0 + 4) / 4]
[Stage 2:==============> (1 + 3) / 4]
[Stage 2:=============================> (2 + 2) / 4]
[Stage 2:============================================> (3 + 1) / 4]

1. Make sure spark.ui.showConsoleProgress is true . It is by default.

2. Disable ( OFF ) the root logger (that includes Spark’s logger)

3. Make sure org.apache.spark.SparkContext logger is at least WARN .

4. Run a job with 4 tasks with 500ms initial sleep and 200ms sleep chunks to see the
progress bar.

Tip Watch the short video that show ConsoleProgressBar in action.

You may want to use the following example to see the progress bar in full glory - all 3
concurrent stages in console (borrowed from a comment to [SPARK-4017] show progress
bar in console #3029):

> ./bin/spark-shell
scala> val a = sc.makeRDD(1 to 1000, 10000).map(x => (x, x)).reduceByKey(_ + _)
scala> val b = sc.makeRDD(1 to 1000, 10000).map(x => (x, x)).reduceByKey(_ + _)
scala> a.union(b).count()

Creating ConsoleProgressBar Instance

ConsoleProgressBar requires a SparkContext.

When being created, ConsoleProgressBar reads spark.ui.consoleProgress.update.interval

configuration property to set up the update interval and COLUMNS environment variable for
the terminal width (or assumes 80 columns).

ConsoleProgressBar starts the internal timer refresh progress that does refresh and shows

progress.

437
ConsoleProgressBar

ConsoleProgressBar is created when SparkContext starts,

spark.ui.showConsoleProgress configuration property is enabled, and the
Note logging level of org.apache.spark.SparkContext logger is WARN or higher (i.e.
less messages are printed out and so there is a "space" for
ConsoleProgressBar ).

Note Once created, ConsoleProgressBar is available internally as _progressBar .

finishAll Method

Caution FIXME

stop Method

stop(): Unit

stop cancels (stops) the internal timer.

Note stop is executed when SparkContext stops.

refresh Internal Method

refresh(): Unit

refresh …​FIXME

Note refresh is used when…​FIXME

438
SparkStatusTracker

SparkStatusTracker
SparkStatusTracker is…​FIXME

SparkStatusTracker is created when SparkContext is created.

Creating SparkStatusTracker Instance

SparkStatusTracker takes the following when created:

SparkContext

AppStatusStore

439
Local Properties — Creating Logical Job Groups

Local Properties — Creating Logical Job

Groups
The purpose of local properties concept is to create logical groups of jobs by means of
properties that (regardless of the threads used to submit the jobs) makes the separate jobs
launched from different threads belong to a single logical group.

You can set a local property that will affect Spark jobs submitted from a thread, such as the
Spark fair scheduler pool. You can use your own custom properties. The properties are
propagated through to worker tasks and can be accessed there via
TaskContext.getLocalProperty.

Propagating local properties to workers starts when SparkContext is requested

Note
to run or submit a Spark job that in turn passes them along to DAGScheduler .

Local properties is used to group jobs into pools in FAIR job scheduler by
Note spark.scheduler.pool per-thread property and in
SQLExecution.withNewExecutionId Helper Methods

A common use case for the local property concept is to set a local property in a thread, say
spark.scheduler.pool, after which all jobs submitted within the thread will be grouped, say
into a pool by FAIR job scheduler.

val rdd = sc.parallelize(0 to 9)

sc.setLocalProperty("spark.scheduler.pool", "myPool")

// these two jobs (one per action) will run in the myPool pool
rdd.count
rdd.collect

sc.setLocalProperty("spark.scheduler.pool", null)

// this job will run in the default pool

rdd.count

Local Properties —  localProperties Property

localProperties: InheritableThreadLocal[Properties]

localProperties is a protected[spark] property of a SparkContext that are the properties

through which you can create logical job groups.

440
Local Properties — Creating Logical Job Groups

Tip Read up on Java’s java.lang.InheritableThreadLocal.

Setting Local Property —  setLocalProperty Method

setLocalProperty(key: String, value: String): Unit

setLocalProperty sets key local property to value .

Tip When value is null the key property is removed from localProperties.

Getting Local Property —  getLocalProperty Method

getLocalProperty(key: String): String

getLocalProperty gets a local property by key in this thread. It returns null if key is

missing.

Getting Local Properties —  getLocalProperties

Method

getLocalProperties: Properties

getLocalProperties is a private[spark] method that gives access to localProperties.

setLocalProperties Method

setLocalProperties(props: Properties): Unit

setLocalProperties is a private[spark] method that sets props as localProperties.

441
RDD — Resilient Distributed Dataset

RDD — Resilient Distributed Dataset

Resilient Distributed Dataset (aka RDD) is the primary data abstraction in Apache Spark
and the core of Spark (that I often refer to as "Spark Core").

The origins of RDD

The original paper that gave birth to the concept of RDD is Resilient Distributed Datasets: A
Fault-Tolerant Abstraction for In-Memory Cluster Computing by Matei Zaharia, et al.

A RDD is a resilient and distributed collection of records spread over one or many partitions.

One could compare RDDs to collections in Scala, i.e. a RDD is computed on

Note
many JVMs while a Scala collection lives on a single JVM.

Using RDD Spark hides data partitioning and so distribution that in turn allowed them to
design parallel computational framework with a higher-level programming interface (API) for
four mainstream programming languages.

The features of RDDs (decomposing the name):

Resilient, i.e. fault-tolerant with the help of RDD lineage graph and so able to
recompute missing or damaged partitions due to node failures.

Distributed with data residing on multiple nodes in a cluster.

Dataset is a collection of partitioned data with primitive values or values of values, e.g.
tuples or other objects (that represent records of the data you work with).

Figure 1. RDDs

442
RDD — Resilient Distributed Dataset

From the scaladoc of org.apache.spark.rdd.RDD:

A Resilient Distributed Dataset (RDD), the basic abstraction in Spark. Represents an

immutable, partitioned collection of elements that can be operated on in parallel.

From the original paper about RDD - Resilient Distributed Datasets: A Fault-Tolerant
Abstraction for In-Memory Cluster Computing:

Resilient Distributed Datasets (RDDs) are a distributed memory abstraction that lets
programmers perform in-memory computations on large clusters in a fault-tolerant
manner.

Beside the above traits (that are directly embedded in the name of the data abstraction -
RDD) it has the following additional traits:

In-Memory, i.e. data inside RDD is stored in memory as much (size) and long (time) as
possible.

Immutable or Read-Only, i.e. it does not change once created and can only be
transformed using transformations to new RDDs.

Lazy evaluated, i.e. the data inside RDD is not available or transformed until an action
is executed that triggers the execution.

Cacheable, i.e. you can hold all the data in a persistent "storage" like memory (default
and the most preferred) or disk (the least preferred due to access speed).

Parallel, i.e. process data in parallel.

Typed — RDD records have types, e.g. Long in RDD[Long] or (Int, String) in

RDD[(Int, String)] .

Partitioned — records are partitioned (split into logical partitions) and distributed across
nodes in a cluster.

Location-Stickiness —  RDD can define placement preferences to compute partitions

(as close to the records as possible).

Preferred location (aka locality preferences or placement preferences or

locality info) is information about the locations of RDD records (that Spark’s
Note
DAGScheduler uses to place computing partitions on to have the tasks as close
to the data as possible).

Computing partitions in a RDD is a distributed process by design and to achieve even data
distribution as well as leverage data locality (in distributed systems like HDFS or
Cassandra in which data is partitioned by default), they are partitioned to a fixed number of

443
RDD — Resilient Distributed Dataset

partitions - logical chunks (parts) of data. The logical division is for processing only and
internally it is not divided whatsoever. Each partition comprises of records.

Figure 2. RDDs
Partitions are the units of parallelism. You can control the number of partitions of a RDD
using repartition or coalesce transformations. Spark tries to be as close to data as possible
without wasting time to send data across network by means of RDD shuffling, and creates
as many partitions as required to follow the storage layout and thus optimize data access. It
leads to a one-to-one mapping between (physical) data in distributed data storage, e.g.
HDFS or Cassandra, and partitions.

RDDs support two kinds of operations:

transformations - lazy operations that return another RDD.

actions - operations that trigger computation and return values.

The motivation to create RDD were (after the authors) two types of applications that current
computing frameworks handle inefficiently:

iterative algorithms in machine learning and graph computations.

interactive data mining tools as ad-hoc queries on the same dataset.

The goal is to reuse intermediate in-memory results across multiple data-intensive

workloads with no need for copying large amounts of data over the network.

Technically, RDDs follow the contract defined by the five main intrinsic properties:

List of parent RDDs that are the dependencies of the RDD.

An array of partitions that a dataset is divided to.

A compute function to do a computation on partitions.

444
RDD — Resilient Distributed Dataset

An optional Partitioner that defines how keys are hashed, and the pairs partitioned (for
key-value RDDs)

Optional preferred locations (aka locality info), i.e. hosts for a partition where the
records live or are the closest to read from.

This RDD abstraction supports an expressive set of operations without having to modify
scheduler for each one.

An RDD is a named (by name ) and uniquely identified (by id ) entity in a SparkContext
(available as context property).

RDDs live in one and only one SparkContext that creates a logical boundary.

RDDs cannot be shared between SparkContexts (see SparkContext and

Note
RDDs).

An RDD can optionally have a friendly name accessible using name that can be changed
using = :

scala> val ns = sc.parallelize(0 to 10)

ns: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[2] at parallelize at <consol
e>:24

scala> ns.id
res0: Int = 2

scala> ns.name
res1: String = null

scala> ns.name = "Friendly name"

ns.name: String = Friendly name

scala> ns.name
res2: String = Friendly name

scala> ns.toDebugString
res3: String = (8) Friendly name ParallelCollectionRDD[2] at parallelize at <console>:
24 []

RDDs are a container of instructions on how to materialize big (arrays of) distributed data,
and how to split it into partitions so Spark (using executors) can hold some of them.

In general data distribution can help executing processing in parallel so a task processes a
chunk of data that it could eventually keep in memory.

Spark does jobs in parallel, and RDDs are split into partitions to be processed and written in
parallel. Inside a partition, data is processed sequentially.

445
RDD — Resilient Distributed Dataset

Saving partitions results in part-files instead of one single file (unless there is a single
partition).

checkpointRDD Internal Method

Caution FIXME

isCheckpointedAndMaterialized Method

Caution FIXME

getNarrowAncestors Method

Caution FIXME

toLocalIterator Method

Caution FIXME

cache Method

Caution FIXME

persist Methods

persist(): this.type
persist(newLevel: StorageLevel): this.type

Refer to Persisting RDD —  persist Methods.

persist Internal Method

persist(newLevel: StorageLevel, allowOverride: Boolean): this.type

Caution FIXME

persist is used when RDD is requested to persist itself and marks itself for
Note
local checkpointing.

446
RDD — Resilient Distributed Dataset

unpersist Method

Caution FIXME

localCheckpoint Method

localCheckpoint(): this.type

Refer to Marking RDD for Local Checkpointing —  localCheckpoint Method.

RDD Contract

abstract class RDD[T] {

def compute(split: Partition, context: TaskContext): Iterator[T]
def getPartitions: Array[Partition]
def getDependencies: Seq[Dependency[_]]
def getPreferredLocations(split: Partition): Seq[String] = Nil
val partitioner: Option[Partitioner] = None
}

Note RDD is an abstract class in Scala.

Table 1. RDD Contract

Method Description
Used exclusively when RDD computes a partition
compute
(possibly by reading from a checkpoint).

getPartitions
Used exclusively when RDD is requested for its partitions
(called only once as the value is cached).

getDependencies
Used when RDD is requested for its dependencies
(called only once as the value is cached).

Defines placement preferences of a partition.

getPreferredLocations
Used exclusively when RDD is requested for the
preferred locations of a partition.

partitioner Defines the Partitioner of a RDD .

Types of RDDs

447
RDD — Resilient Distributed Dataset

There are some of the most interesting types of RDDs:

ParallelCollectionRDD

CoGroupedRDD

HadoopRDD is an RDD that provides core functionality for reading data stored in HDFS
using the older MapReduce API. The most notable use case is the return RDD of
SparkContext.textFile .

MapPartitionsRDD - a result of calling operations like map , flatMap , filter ,

mapPartitions, etc.

CoalescedRDD - a result of repartition or coalesce transformations.

ShuffledRDD - a result of shuffling, e.g. after repartition or coalesce transformations.

PipedRDD - an RDD created by piping elements to a forked external process.

PairRDD (implicit conversion by PairRDDFunctions) that is an RDD of key-value pairs

that is a result of groupByKey and join operations.

DoubleRDD (implicit conversion as org.apache.spark.rdd.DoubleRDDFunctions ) that is

an RDD of Double type.

SequenceFileRDD (implicit conversion as

org.apache.spark.rdd.SequenceFileRDDFunctions ) that is an RDD that can be saved as a

SequenceFile .

Appropriate operations of a given RDD type are automatically available on a RDD of the
right type, e.g. RDD[(Int, Int)] , through implicit conversion in Scala.

Transformations
A transformation is a lazy operation on a RDD that returns another RDD, like map ,
flatMap , filter , reduceByKey , join , cogroup , etc.

Tip Go in-depth in the section Transformations.

Actions
An action is an operation that triggers execution of RDD transformations and returns a value
(to a Spark driver - the user program).

Tip Go in-depth in the section Actions.

448
RDD — Resilient Distributed Dataset

Creating RDDs

SparkContext.parallelize
One way to create a RDD is with SparkContext.parallelize method. It accepts a collection
of elements as shown below ( sc is a SparkContext instance):

scala> val rdd = sc.parallelize(1 to 1000)

rdd: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[0] at parallelize at <conso
le>:25

You may also want to randomize the sample data:

scala> val data = Seq.fill(10)(util.Random.nextInt)

data: Seq[Int] = List(-964985204, 1662791, -1820544313, -383666422, -111039198, 310967
683, 1114081267, 1244509086, 1797452433, 124035586)

scala> val rdd = sc.parallelize(data)

rdd: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[0] at parallelize at <conso
le>:29

Given the reason to use Spark to process more data than your own laptop could handle,
SparkContext.parallelize is mainly used to learn Spark in the Spark shell.

SparkContext.parallelize requires all the data to be available on a single machine - the

Spark driver - that eventually hits the limits of your laptop.

SparkContext.makeRDD
Caution FIXME What’s the use case for makeRDD ?

scala> sc.makeRDD(0 to 1000)

res0: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[1] at makeRDD at <console>
:25

SparkContext.textFile
One of the easiest ways to create an RDD is to use SparkContext.textFile to read files.

You can use the local README.md file (and then flatMap over the lines inside to have an
RDD of words):

449
RDD — Resilient Distributed Dataset

scala> val words = sc.textFile("README.md").flatMap(_.split("\\W+")).cache

words: org.apache.spark.rdd.RDD[String] = MapPartitionsRDD[27] at flatMap at <console>
:24

You cache it so the computation is not performed every time you work with
Note
words .

Creating RDDs from Input

Refer to Using Input and Output (I/O) to learn about the IO API to create RDDs.

Transformations
RDD transformations by definition transform an RDD into another RDD and hence are the
way to create new ones.

Refer to Transformations section to learn more.

RDDs in Web UI
It is quite informative to look at RDDs in the Web UI that is at http://localhost:4040 for Spark
shell.

Execute the following Spark application (type all the lines in spark-shell ):

val ints = sc.parallelize(1 to 100) (1)

ints.setName("Hundred ints") (2)
ints.cache (3)
ints.count (4)

1. Creates an RDD with hundred of numbers (with as many partitions as possible)

2. Sets the name of the RDD

3. Caches the RDD for performance reasons that also makes it visible in Storage tab in
the web UI

4. Executes action (and materializes the RDD)

With the above executed, you should see the following in the Web UI:

450
RDD — Resilient Distributed Dataset

Figure 3. RDD with custom name

Click the name of the RDD (under RDD Name) and you will get the details of how the RDD
is cached.

Figure 4. RDD Storage Info

Execute the following Spark job and you will see how the number of partitions decreases.

ints.repartition(2).count

451
RDD — Resilient Distributed Dataset

Figure 5. Number of tasks after repartition

Accessing RDD Partitions —  partitions Final Method

partitions: Array[Partition]

partitions returns the Partitions of a RDD .

partitions requests CheckpointRDD for partitions (if the RDD is checkpointed) or finds

them itself and cache (in partitions_ internal registry that is used next time).

Partitions have the property that their internal index should be equal to their
Note
position in the owning RDD.

Defining Placement Preferences of RDD Partition 

—  preferredLocations Final Method

preferredLocations(split: Partition): Seq[String]

preferredLocations requests CheckpointRDD for placement preferences (if the RDD is

checkpointed) or calculates them itself.

preferredLocations is a template method that uses getPreferredLocations that

custom RDDs can override to specify placement preferences for a partition.
Note
getPreferredLocations defines no placement preferences by default.

452
RDD — Resilient Distributed Dataset

preferredLocations is mainly used when DAGScheduler is requested to

compute the preferred locations for missing partitions.

The other usages are to define the locations by custom RDDs, e.g.
BlockRDD, CoalescedRDD , HadoopRDD, NewHadoopRDD,
Note ParallelCollectionRDD, ReliableCheckpointRDD , ShuffledRDD
Spark SQL’s KafkaSourceRDD , ShuffledRowRDD , FileScanRDD ,
StateStoreRDD

Spark Streaming’s KafkaRDD , WriteAheadLogBackedBlockRDD

Getting Number of Partitions —  getNumPartitions

Method

getNumPartitions: Int

getNumPartitions gives the number of partitions of a RDD.

scala> sc.textFile("README.md").getNumPartitions
res0: Int = 2

scala> sc.textFile("README.md", 5).getNumPartitions

res1: Int = 5

Computing Partition (Possibly by Reading From

Checkpoint) —  computeOrReadCheckpoint Method

computeOrReadCheckpoint(split: Partition, context: TaskContext): Iterator[T]

computeOrReadCheckpoint reads split partition from a checkpoint (if available already) or

computes it yourself.

Note computeOrReadCheckpoint is a private[spark] method.

computeOrReadCheckpoint is used when RDD computes records for a partition or

Note
getOrCompute.

Accessing Records For Partition Lazily —  iterator

Final Method

453
RDD — Resilient Distributed Dataset

iterator(split: Partition, context: TaskContext): Iterator[T]

iterator gets or computes the split partition when cached or computes it (possibly by

reading from checkpoint).

iterator is a final method that, despite being public, considered private and
Note
only available for implementing custom RDDs.

RDD Dependencies —  dependencies Final Template

Method

dependencies: Seq[Dependency[_]]

dependencies returns the dependencies of a RDD.

Note dependencies is a final method that no class in Spark can ever override.

Internally, dependencies checks out whether the RDD is checkpointed and acts accordingly.

For a RDD being checkpointed, dependencies returns a single-element collection with a

OneToOneDependency.

For a non-checkpointed RDD, dependencies collection is computed using getDependencies

method.

getDependencies method is an abstract method that custom RDDs are required

Note
to provide.

454
RDD

RDD
RDD is a description of a distributed computation over dataset of records of type T .

RDD is identified by a unique identifier (aka RDD ID) that is unique among all RDDs in a

SparkContext.

id: Int

RDD has a storage level that…​FIXME

storageLevel: StorageLevel

The storage level of an RDD is StorageLevel.NONE by default which is…​FIXME

Getting Or Computing RDD Partition —  getOrCompute

Method

getOrCompute(partition: Partition, context: TaskContext): Iterator[T]

getOrCompute creates a RDDBlockId for the RDD id and the partition index.

getOrCompute requests the BlockManager to getOrElseUpdate for the block ID (with the

storage level and the makeIterator function).

Note getOrCompute uses SparkEnv to access the current BlockManager.

getOrCompute records whether…​FIXME (readCachedBlock)

getOrCompute branches off per the response from the BlockManager and whether the

internal readCachedBlock flag is now on or still off. In either case, getOrCompute creates an
InterruptibleIterator.

InterruptibleIterator simply delegates to a wrapped internal Iterator , but

Note
allows for task killing functionality.

For a BlockResult available and readCachedBlock flag on, getOrCompute …​FIXME

For a BlockResult available and readCachedBlock flag off, getOrCompute …​FIXME

455
RDD

The BlockResult could be found in a local block manager or fetched from a

remote block manager. It may also have been stored (persisted) just now. In
Note
either case, the BlockResult is available (and BlockManager.getOrElseUpdate
gives a Left value with the BlockResult ).

For Right(iter) (regardless of the value of readCachedBlock flag since…​FIXME),

getOrCompute …​FIXME

BlockManager.getOrElseUpdate gives a Right(iter) value to indicate an error

Note
with a block.

Note getOrCompute is used on Spark executors.

getOrCompute is a private[spark] method that is exclusively used when

Note
iterating over partition when a RDD is cached.

Computing Partition (in TaskContext) —  compute Method

compute(split: Partition, context: TaskContext): Iterator[T]

The abstract compute method computes the input split partition in the TaskContext to
produce a collection of values (of type T ).

compute is implemented by any type of RDD in Spark and is called every time the records

are requested unless RDD is cached or checkpointed (and the records can be read from an
external storage, but this time closer to the compute node).

When an RDD is cached, for specified storage levels (i.e. all but NONE ) CacheManager is
requested to get or compute partitions.

Note compute method runs on the driver.

456
RDD Lineage — Logical Execution Plan

RDD Lineage — Logical Execution Plan

RDD Lineage (aka RDD operator graph or RDD dependency graph) is a graph of all the
parent RDDs of a RDD. It is built as a result of applying transformations to the RDD and
creates a logical execution plan.

Note The execution DAG or physical execution plan is the DAG of stages.

The following diagram uses cartesian or zip for learning purposes only. You
Note
may use other operators to build a RDD graph.

Figure 1. RDD lineage

The above RDD graph could be the result of the following series of transformations:

val r00 = sc.parallelize(0 to 9)

val r01 = sc.parallelize(0 to 90 by 10)
val r10 = r00 cartesian r01
val r11 = r00.map(n => (n, n))
val r12 = r00 zip r01
val r13 = r01.keyBy(_ / 20)
val r20 = Seq(r11, r12, r13).foldLeft(r10)(_ union _)

A RDD lineage graph is hence a graph of what transformations need to be executed after an
action has been called.

You can learn about a RDD lineage graph using RDD.toDebugString method.

Logical Execution Plan

Logical Execution Plan starts with the earliest RDDs (those with no dependencies on other
RDDs or reference cached data) and ends with the RDD that produces the result of the
action that has been called to execute.

457
RDD Lineage — Logical Execution Plan

A logical plan, i.e. a DAG, is materialized and executed when SparkContext is

Note
requested to run a Spark job.

Getting RDD Lineage Graph —  toDebugString Method

toDebugString: String

You can learn about a RDD lineage graph using toDebugString method.

scala> val wordCount = sc.textFile("README.md").flatMap(_.split("\\s+")).map((_, 1)).r

educeByKey(_ + _)
wordCount: org.apache.spark.rdd.RDD[(String, Int)] = ShuffledRDD[21] at reduceByKey at
<console>:24

scala> wordCount.toDebugString
res13: String =
(2) ShuffledRDD[21] at reduceByKey at <console>:24 []
+-(2) MapPartitionsRDD[20] at map at <console>:24 []
| MapPartitionsRDD[19] at flatMap at <console>:24 []
| README.md MapPartitionsRDD[18] at textFile at <console>:24 []
| README.md HadoopRDD[17] at textFile at <console>:24 []

toDebugString uses indentations to indicate a shuffle boundary.

The numbers in round brackets show the level of parallelism at each stage, e.g. (2) in the
above output.

scala> wordCount.getNumPartitions
res14: Int = 2

With spark.logLineage property enabled, toDebugString is included when executing an

action.

$ ./bin/spark-shell --conf spark.logLineage=true

scala> sc.textFile("README.md", 4).count

...
15/10/17 14:46:42 INFO SparkContext: Starting job: count at <console>:25
15/10/17 14:46:42 INFO SparkContext: RDD's recursive dependencies:
(4) MapPartitionsRDD[1] at textFile at <console>:25 []
| README.md HadoopRDD[0] at textFile at <console>:25 []

Settings

458
RDD Lineage — Logical Execution Plan

Table 1. Spark Properties

Spark Property Default Value Description

When enabled (i.e. true ), executing an

spark.logLineage false
action (and hence running a job) will also
print out the RDD lineage graph using
RDD.toDebugString.

459
TaskLocation

TaskLocation
TaskLocation is a location where a task should run.

TaskLocation can either be a host alone or a (host, executorID) pair (as

ExecutorCacheTaskLocation).

With ExecutorCacheTaskLocation the Spark scheduler prefers to launch the task on the given
executor, but the next level of preference is any executor on the same host if this is not
possible.

TaskLocation is a Scala private[spark] sealed trait (i.e. all the available

Note
implementations of TaskLocation trait are in a single Scala file).

Table 1. Available TaskLocations

Name Description
HostTaskLocation A location on a host.

ExecutorCacheTaskLocation
A location that includes both a host and an executor id
on that host.

A location on a host that is cached by Hadoop HDFS.

HDFSCacheTaskLocation Used exclusively when HadoopRDD and
NewHadoopRDD are requested for their placement
preferences (aka preferred locations).

460
ParallelCollectionRDD

ParallelCollectionRDD
ParallelCollectionRDD is an RDD of a collection of elements with numSlices partitions and
optional locationPrefs .

ParallelCollectionRDD is the result of SparkContext.parallelize and SparkContext.makeRDD

methods.

The data collection is split on to numSlices slices.

It uses ParallelCollectionPartition .

461
MapPartitionsRDD

MapPartitionsRDD
MapPartitionsRDD is an RDD that applies the provided function f to every partition of the
parent RDD.

By default, it does not preserve partitioning — the last input parameter

preservesPartitioning is false . If it is true , it retains the original RDD’s partitioning.

MapPartitionsRDD is the result of the following transformations:

map

flatMap

filter

glom

mapPartitions

mapPartitionsWithIndex

PairRDDFunctions.mapValues

PairRDDFunctions.flatMapValues

462
OrderedRDDFunctions

OrderedRDDFunctions
repartitionAndSortWithinPartitions Operator

Caution FIXME

sortByKey Operator

Caution FIXME

463
CoGroupedRDD

CoGroupedRDD
A RDD that cogroups its pair RDD parents. For each key k in parent RDDs, the resulting
RDD contains a tuple with the list of values for that key.

Use RDD.cogroup(…​) to create one.

getDependencies Method

Caution FIXME

Computing Partition (in TaskContext) —  compute Method

compute(s: Partition, context: TaskContext): Iterator[(K, Array[Iterable[_]])]

Note compute is part of RDD Contract to compute a partition (in a TaskContext).

compute …​FIXME

464
SubtractedRDD

SubtractedRDD
Caution FIXME

Computing Partition (in TaskContext) —  compute Method

compute(p: Partition, context: TaskContext): Iterator[(K, V)]

Note compute is part of RDD Contract to compute a partition (in a TaskContext).

compute …​FIXME

getDependencies Method

Caution FIXME

465
HadoopRDD

HadoopRDD
HadoopRDD is an RDD that provides core functionality for reading data stored in HDFS, a
local file system (available on all nodes), or any Hadoop-supported file system URI using the
older MapReduce API (org.apache.hadoop.mapred).

HadoopRDD is created as a result of calling the following methods in SparkContext:

hadoopFile

textFile (the most often used in examples!)

sequenceFile

Partitions are of type HadoopPartition .

When an HadoopRDD is computed, i.e. an action is called, you should see the INFO
message Input split: in the logs.

scala> sc.textFile("README.md").count
...
15/10/10 18:03:21 INFO HadoopRDD: Input split: file:/Users/jacek/dev/oss/spark/README.
md:0+1784
15/10/10 18:03:21 INFO HadoopRDD: Input split: file:/Users/jacek/dev/oss/spark/README.
md:1784+1784
...

The following properties are set upon partition execution:

mapred.tip.id - task id of this task’s attempt

mapred.task.id - task attempt’s id

mapred.task.is.map as true

mapred.task.partition - split id

mapred.job.id

Spark settings for HadoopRDD :

spark.hadoop.cloneConf (default: false ) - shouldCloneJobConf - should a Hadoop

job configuration JobConf object be cloned before spawning a Hadoop job. Refer to
[SPARK-2546] Configuration object thread safety issue. When true , you should see a
DEBUG message Cloning Hadoop Configuration .

You can register callbacks on TaskContext.

466
HadoopRDD

HadoopRDDs are not checkpointed. They do nothing when checkpoint() is called.

FIXME

What are InputMetrics ?

What is JobConf ?
What are the InputSplits: FileSplit and CombineFileSplit ? * What
Caution are InputFormat and Configurable subtypes?

What’s InputFormat’s RecordReader? It creates a key and a value.

What are they?

What’s Hadoop Split? input splits for Hadoop reads? See

InputFormat.getSplits

getPreferredLocations Method

Caution FIXME

getPartitions Method
The number of partition for HadoopRDD, i.e. the return value of getPartitions , is
calculated using InputFormat.getSplits(jobConf, minPartitions) where minPartitions is
only a hint of how many partitions one may want at minimum. As a hint it does not mean the
number of partitions will be exactly the number given.

For SparkContext.textFile the input format class is

org.apache.hadoop.mapred.TextInputFormat.

The javadoc of org.apache.hadoop.mapred.FileInputFormat says:

FileInputFormat is the base class for all file-based InputFormats. This provides a
generic implementation of getSplits(JobConf, int). Subclasses of FileInputFormat can
also override the isSplitable(FileSystem, Path) method to ensure input-files are not
split-up and are processed as a whole by Mappers.

You may find the sources of

Tip
org.apache.hadoop.mapred.FileInputFormat.getSplits enlightening.

467
NewHadoopRDD

NewHadoopRDD
NewHadoopRDD is an RDD of K keys and V values.

NewHadoopRDD is created when:

SparkContext.newAPIHadoopFile

SparkContext.newAPIHadoopRDD

(indirectly) SparkContext.binaryFiles

(indirectly) SparkContext.wholeTextFiles

Note NewHadoopRDD is the base RDD of BinaryFileRDD and WholeTextFileRDD .

getPreferredLocations Method

Caution FIXME

Creating NewHadoopRDD Instance

NewHadoopRDD takes the following when created:

SparkContext

HDFS' InputFormat[K, V]

K class name

V class name

transient HDFS' Configuration

NewHadoopRDD initializes the internal registries and counters.

468
ShuffledRDD

ShuffledRDD
ShuffledRDD is an RDD of key-value pairs that represents the shuffle step in a RDD

lineage. It uses custom ShuffledRDDPartition partitions.

A ShuffledRDD is created for RDD transformations that trigger a data shuffling:

1. coalesce transformation (with shuffle flag enabled).

2. PairRDDFunctions 's combineByKeyWithClassTag and partitionBy (when the parent

RDD’s and specified Partitioners are different).

3. OrderedRDDFunctions 's sortByKey and repartitionAndSortWithinPartitions ordered

operators.

scala> val rdd = sc.parallelize(0 to 9)

rdd: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[0] at parallelize at <conso
le>:24

scala> rdd.getNumPartitions
res0: Int = 8

// ShuffledRDD and coalesce Example

scala> rdd.coalesce(numPartitions = 4, shuffle = true).toDebugString

res1: String =
(4) MapPartitionsRDD[4] at coalesce at <console>:27 []
| CoalescedRDD[3] at coalesce at <console>:27 []
| ShuffledRDD[2] at coalesce at <console>:27 []
+-(8) MapPartitionsRDD[1] at coalesce at <console>:27 []
| ParallelCollectionRDD[0] at parallelize at <console>:24 []

// ShuffledRDD and sortByKey Example

scala> val grouped = rdd.groupBy(_ % 2)

grouped: org.apache.spark.rdd.RDD[(Int, Iterable[Int])] = ShuffledRDD[6] at groupBy at
<console>:26

scala> grouped.sortByKey(numPartitions = 2).toDebugString

res2: String =
(2) ShuffledRDD[9] at sortByKey at <console>:29 []
+-(8) ShuffledRDD[6] at groupBy at <console>:26 []
+-(8) MapPartitionsRDD[5] at groupBy at <console>:26 []
| ParallelCollectionRDD[0] at parallelize at <console>:24 []

ShuffledRDD takes a parent RDD and a Partitioner when created.

469
ShuffledRDD

getDependencies returns a single-element collection of RDD dependencies with a

ShuffleDependency (with the Serializer according to map-side combine internal flag).

Map-Side Combine mapSideCombine Internal Flag

mapSideCombine: Boolean

mapSideCombine internal flag is used to select the Serializer (for shuffling) when

ShuffleDependency is created (which is the one and only Dependency of a ShuffledRDD ).

mapSideCombine is only used when userSpecifiedSerializer optional

Note
Serializer is not specified explicitly (which is the default).

Note mapSideCombine uses SparkEnv to access the current SerializerManager .

If enabled (i.e. true ), mapSideCombine directs to find the Serializer for the types K and
C . Otherwise, getDependencies finds the Serializer for the types K and V .

Note The types K , C and V are specified when ShuffledRDD is created.

mapSideCombine is disabled (i.e. false ) when ShuffledRDD is created and can

be set using setMapSideCombine method.
Note
setMapSideCombine method is only used in the experimental
PairRDDFunctions.combineByKeyWithClassTag transformations.

Computing Partition (in TaskContext) —  compute Method

compute(split: Partition, context: TaskContext): Iterator[(K, C)]

Note compute is part of RDD Contract to compute a partition (in a TaskContext).

Internally, compute makes sure that the input split is a ShuffleDependency. It then
requests ShuffleManager for a ShuffleReader to read key-value pairs (as Iterator[(K,
C)] ) for the split .

Note compute uses SparkEnv to access the current ShuffleManager .

A Partition has the index property to specify startPartition and

Note
endPartition partition offsets.

470
ShuffledRDD

Getting Placement Preferences of Partition 

—  getPreferredLocations Method

getPreferredLocations(partition: Partition): Seq[String]

getPreferredLocations is part of RDD contract to specify placement

Note preferences (aka preferred task locations), i.e. where tasks should be executed
to be as close to the data as possible.

Internally, getPreferredLocations requests MapOutputTrackerMaster for the preferred

locations, i.e. BlockManagers with the most map outputs, for the input partition (of the
one and only ShuffleDependency).

getPreferredLocations uses SparkEnv to access the current

Note
MapOutputTrackerMaster (which runs on the driver).

ShuffledRDDPartition
ShuffledRDDPartition gets an index when it is created (that in turn is the index of

partitions as calculated by the Partitioner of a ShuffledRDD).

471
Operators

Operators - Transformations and Actions

RDDs have two types of operations: transformations and actions.

Note Operators are also called operations.

Gotchas - things to watch for

Even if you don’t access it explicitly it cannot be referenced inside a closure as it is serialized
and carried around across executors.

See https://issues.apache.org/jira/browse/SPARK-5063

472
Transformations

Transformations
Transformations are lazy operations on a RDD that create one or many new RDDs, e.g.
map , filter , reduceByKey , join , cogroup , randomSplit .

transformation: RDD => RDD

transformation: RDD => Seq[RDD]

In other words, transformations are functions that take a RDD as the input and produce one
or many RDDs as the output. They do not change the input RDD (since RDDs are
immutable and hence cannot be modified), but always produce one or more new RDDs by
applying the computations they represent.

By applying transformations you incrementally build a RDD lineage with all the parent RDDs
of the final RDD(s).

Transformations are lazy, i.e. are not executed immediately. Only after calling an action are
transformations executed.

After executing a transformation, the result RDD(s) will always be different from their parents
and can be smaller (e.g. filter , count , distinct , sample ), bigger (e.g. flatMap ,
union , cartesian ) or the same size (e.g. map ).

There are transformations that may trigger jobs, e.g. sortBy , zipWithIndex,
Caution
etc.

473
Transformations

Figure 1. From SparkContext by transformations to the result

Certain transformations can be pipelined which is an optimization that Spark uses to
improve performance of computations.

474
Transformations

scala> val file = sc.textFile("README.md")

file: org.apache.spark.rdd.RDD[String] = MapPartitionsRDD[54] at textFile at <console>:
24

scala> val allWords = file.flatMap(_.split("\\W+"))

allWords: org.apache.spark.rdd.RDD[String] = MapPartitionsRDD[55] at flatMap at <conso
le>:26

scala> val words = allWords.filter(!_.isEmpty)

words: org.apache.spark.rdd.RDD[String] = MapPartitionsRDD[56] at filter at <console>:
28

scala> val pairs = words.map((_,1))

pairs: org.apache.spark.rdd.RDD[(String, Int)] = MapPartitionsRDD[57] at map at <conso
le>:30

scala> val reducedByKey = pairs.reduceByKey(_ + _)

reducedByKey: org.apache.spark.rdd.RDD[(String, Int)] = ShuffledRDD[59] at reduceByKey
at <console>:32

scala> val top10words = reducedByKey.takeOrdered(10)(Ordering[Int].reverse.on(_._2))

INFO SparkContext: Starting job: takeOrdered at <console>:34
...
INFO DAGScheduler: Job 18 finished: takeOrdered at <console>:34, took 0.074386 s
top10words: Array[(String, Int)] = Array((the,21), (to,14), (Spark,13), (for,11), (and,
10), (##,8), (a,8), (run,7), (can,6), (is,6))

There are two kinds of transformations:

narrow transformations

wide transformations

Narrow Transformations
Narrow transformations are the result of map , filter and such that is from the data from
a single partition only, i.e. it is self-sustained.

An output RDD has partitions with records that originate from a single partition in the parent
RDD. Only a limited subset of partitions used to calculate the result.

Spark groups narrow transformations as a stage which is called pipelining.

Wide Transformations
Wide transformations are the result of groupByKey and reduceByKey . The data required to
compute the records in a single partition may reside in many partitions of the parent RDD.

475
Transformations

Wide transformations are also called shuffle transformations as they may or

Note
may not depend on a shuffle.

All of the tuples with the same key must end up in the same partition, processed by the
same task. To satisfy these operations, Spark must execute RDD shuffle, which transfers
data across cluster and results in a new stage with a new set of partitions.

map
Caution FIXME

flatMap

Caution FIXME

filter

Caution FIXME

randomSplit
Caution FIXME

mapPartitions

Caution FIXME

Using an external key-value store (like HBase, Redis, Cassandra) and performing
lookups/updates inside of your mappers (creating a connection within a mapPartitions code
block to avoid the connection setup/teardown overhead) might be a better solution.

If hbase is used as the external key value store, atomicity is guaranteed

zipWithIndex

zipWithIndex(): RDD[(T, Long)]

zipWithIndex zips this RDD[T] with its element indices.

476
Transformations

If the number of partitions of the source RDD is greater than 1, it will submit
an additional job to calculate start indices.

val onePartition = sc.parallelize(0 to 9, 1)

scala> onePartition.partitions.length
res0: Int = 1

// no job submitted
onePartition.zipWithIndex

val eightPartitions = sc.parallelize(0 to 9, 8)

scala> eightPartitions.partitions.length
res1: Int = 8

// submits a job
Caution eightPartitions.zipWithIndex

Figure 2. Spark job submitted by zipWithIndex transformation

477
PairRDDFunctions

PairRDDFunctions
Tip Read up the scaladoc of PairRDDFunctions.

PairRDDFunctions are available in RDDs of key-value pairs via Scala’s implicit conversion.

Partitioning is an advanced feature that is directly linked to (or inferred by) use
Tip
of PairRDDFunctions . Read up about it in Partitions and Partitioning.

countApproxDistinctByKey Transformation

Caution FIXME

foldByKey Transformation

Caution FIXME

aggregateByKey Transformation

Caution FIXME

combineByKey Transformation

Caution FIXME

partitionBy Operator

partitionBy(partitioner: Partitioner): RDD[(K, V)]

Caution FIXME

groupByKey and reduceByKey Transformations

reduceByKey is sort of a particular case of aggregateByKey.

You may want to look at the number of partitions from another angle.

478
PairRDDFunctions

It may often not be important to have a given number of partitions upfront (at RDD creation
time upon loading data from data sources), so only "regrouping" the data by key after it is an
RDD might be…​the key (pun not intended).

You can use groupByKey or another PairRDDFunctions method to have a key in one
processing flow.

You could use partitionBy that is available for RDDs to be RDDs of tuples, i.e. PairRDD :

rdd.keyBy(_.kind)
.partitionBy(new HashPartitioner(PARTITIONS))
.foreachPartition(...)

Think of situations where kind has low cardinality or highly skewed distribution and using
the technique for partitioning might be not an optimal solution.

You could do as follows:

rdd.keyBy(_.kind).reduceByKey(....)

or mapValues or plenty of other solutions. FIXME, man.

mapValues, flatMapValues

Caution FIXME

combineByKeyWithClassTag Transformations

combineByKeyWithClassTag[C](
createCombiner: V => C,
mergeValue: (C, V) => C,
mergeCombiners: (C, C) => C)(implicit ct: ClassTag[C]): RDD[(K, C)] (1)
combineByKeyWithClassTag[C](
createCombiner: V => C,
mergeValue: (C, V) => C,
mergeCombiners: (C, C) => C,
numPartitions: Int)(implicit ct: ClassTag[C]): RDD[(K, C)] (2)
combineByKeyWithClassTag[C](
createCombiner: V => C,
mergeValue: (C, V) => C,
mergeCombiners: (C, C) => C,
partitioner: Partitioner,
mapSideCombine: Boolean = true,
serializer: Serializer = null)(implicit ct: ClassTag[C]): RDD[(K, C)]

479
PairRDDFunctions

1. FIXME

2. FIXME too

combineByKeyWithClassTag transformations use mapSideCombine enabled (i.e. true ) by

default. They create a ShuffledRDD with the value of mapSideCombine when the input
partitioner is different from the current one in an RDD.

combineByKeyWithClassTag is a base transformation for combineByKey-based

Note transformations, aggregateByKey, foldByKey, reduceByKey,
countApproxDistinctByKey, and groupByKey.

480
Actions

Actions
Actions are RDD operations that produce non-RDD values. They materialize a value in a
Spark program. In other words, a RDD operation that returns a value of any type but
RDD[T] is an action.

action: RDD => a value

Actions are synchronous. You can use AsyncRDDActions to release a calling

Note
thread while calling actions.

They trigger execution of RDD transformations to return values. Simply put, an action
evaluates the RDD lineage graph.

You can think of actions as a valve and until action is fired, the data to be processed is not
even in the pipes, i.e. transformations. Only actions can materialize the entire processing
pipeline with real data.

Actions are one of two ways to send data from executors to the driver (the other being
accumulators).

Actions in org.apache.spark.rdd.RDD:

aggregate

collect

count

countApprox*

countByValue*

first

fold

foreach

foreachPartition

max

min

reduce

481
Actions

saveAs* actions, e.g. saveAsTextFile , saveAsHadoopFile

take

takeOrdered

takeSample

toLocalIterator

top

treeAggregate

treeReduce

Actions run jobs using SparkContext.runJob or directly DAGScheduler.runJob.

scala> words.count (1)

res0: Long = 502

1. words is an RDD of String .

You should cache RDDs you work with when you want to execute two or more
Tip
actions on it for a better performance. Refer to RDD Caching and Persistence.

Before calling an action, Spark does closure/function cleaning (using SparkContext.clean )

to make it ready for serialization and sending over the wire to executors. Cleaning can throw
a SparkException if the computation cannot be cleaned.

Note Spark uses ClosureCleaner to clean closures.

AsyncRDDActions
AsyncRDDActions class offers asynchronous actions that you can use on RDDs (thanks to

the implicit conversion rddToAsyncRDDActions in RDD class). The methods return a

FutureAction.

The following asynchronous methods are available:

countAsync

collectAsync

takeAsync

foreachAsync

482
Actions

foreachPartitionAsync

FutureActions
Caution FIXME

483
Caching and Persistence

RDD Caching and Persistence

Caching or persistence are optimisation techniques for (iterative and interactive) Spark
computations. They help saving interim partial results so they can be reused in subsequent
stages. These interim results as RDDs are thus kept in memory (default) or more solid
storages like disk and/or replicated.

RDDs can be cached using cache operation. They can also be persisted using persist
operation.

The difference between cache and persist operations is purely syntactic. cache is a
synonym of persist or persist(MEMORY_ONLY) , i.e. cache is merely persist with the
default storage level MEMORY_ONLY .

Due to the very small and purely syntactic difference between caching and
Note persistence of RDDs the two terms are often used interchangeably and I will
follow the "pattern" here.

RDDs can also be unpersisted to remove RDD from a permanent storage like memory
and/or disk.

Caching RDD —  cache Method

cache(): this.type = persist()

cache is a synonym of persist with MEMORY_ONLY storage level.

Persisting RDD —  persist Methods

persist(): this.type
persist(newLevel: StorageLevel): this.type

persist marks a RDD for persistence using newLevel storage level.

You can only change the storage level once or persist reports an
UnsupportedOperationException :

Cannot change storage level of an RDD after it was already assigned a level

484
Caching and Persistence

You can pretend to change the storage level of an RDD with already-assigned
Note
storage level only if the storage level is the same as it is currently assigned.

If the RDD is marked as persistent the first time, the RDD is registered to ContextCleaner (if
available) and SparkContext .

The internal storageLevel attribute is set to the input newLevel storage level.

Unpersisting RDDs (Clearing Blocks) —  unpersist

Method

unpersist(blocking: Boolean = true): this.type

When called, unpersist prints the following INFO message to the logs:

INFO [RddName]: Removing RDD [id] from persistence list

It then calls SparkContext.unpersistRDD(id, blocking) and sets NONE storage level as the
current storage level.

485
StorageLevel

StorageLevel
StorageLevel describes how an RDD is persisted (and addresses the following concerns):

Does RDD use disk?

Does RDD use memory to store data?

How much of RDD is in memory?

Does RDD use off-heap memory?

Should an RDD be serialized or not (while storing the data)?

How many replicas (default: 1 ) to use (can only be less than 40 )?

There are the following StorageLevel (number _2 in the name denotes 2 replicas):

NONE (default)

DISK_ONLY

DISK_ONLY_2

MEMORY_ONLY (default for cache operation for RDDs)

MEMORY_ONLY_2

MEMORY_ONLY_SER

MEMORY_ONLY_SER_2

MEMORY_AND_DISK

MEMORY_AND_DISK_2

MEMORY_AND_DISK_SER

MEMORY_AND_DISK_SER_2

OFF_HEAP

You can check out the storage level using getStorageLevel() operation.

val lines = sc.textFile("README.md")

scala> lines.getStorageLevel
res0: org.apache.spark.storage.StorageLevel = StorageLevel(disk=false, memory=false, o
ffheap=false, deserialized=false, replication=1)

486
StorageLevel

StorageLevel can indicate to use memory for data storage using useMemory flag.

useMemory: Boolean

StorageLevel can indicate to use disk for data storage using useDisk flag.

useDisk: Boolean

StorageLevel can indicate to store data in deserialized format using deserialized flag.

deserialized: Boolean

StorageLevel can indicate to replicate the data to other block managers using replication

property.

replication: Int

487
Partitions and Partitioning

Partitions and Partitioning

Introduction
Depending on how you look at Spark (programmer, devop, admin), an RDD is about the
content (developer’s and data scientist’s perspective) or how it gets spread out over a
cluster (performance), i.e. how many partitions an RDD represents.

A partition (aka split) is a logical chunk of a large distributed data set.

FIXME
1. How does the number of partitions map to the number of tasks? How to
Caution verify it?
2. How does the mapping between partitions and tasks correspond to data
locality if any?

Spark manages data using partitions that helps parallelize distributed data processing with
minimal network traffic for sending data between executors.

By default, Spark tries to read data into an RDD from the nodes that are close to it. Since
Spark usually accesses distributed partitioned data, to optimize transformation operations it
creates partitions to hold the data chunks.

There is a one-to-one correspondence between how data is laid out in data storage like
HDFS or Cassandra (it is partitioned for the same reasons).

Features:

size

number

partitioning scheme

node distribution

repartitioning

Read the following documentations to learn what experts say on the topic:

Tip How Many Partitions Does An RDD Have?

Tuning Spark (the official documentation of Spark)

488
Partitions and Partitioning

By default, a partition is created for each HDFS partition, which by default is 64MB (from
Spark’s Programming Guide).

RDDs get partitioned automatically without programmer intervention. However, there are
times when you’d like to adjust the size and number of partitions or the partitioning scheme
according to the needs of your application.

You use def getPartitions: Array[Partition] method on a RDD to know the set of
partitions in this RDD.

As noted in View Task Execution Against Partitions Using the UI:

When a stage executes, you can see the number of partitions for a given stage in the
Spark UI.

Start spark-shell and see it yourself!

scala> sc.parallelize(1 to 100).count

res0: Long = 100

When you execute the Spark job, i.e. sc.parallelize(1 to 100).count , you should see the
following in Spark shell application UI.

Figure 1. The number of partition as Total tasks in UI

The reason for 8 Tasks in Total is that I’m on a 8-core laptop and by default the number of
partitions is the number of all available cores.

$ sysctl -n hw.ncpu
8

You can request for the minimum number of partitions, using the second input parameter to
many transformations.

scala> sc.parallelize(1 to 100, 2).count

res1: Long = 100

489
Partitions and Partitioning

Figure 2. Total tasks in UI shows 2 partitions

You can always ask for the number of partitions using partitions method of a RDD:

scala> val ints = sc.parallelize(1 to 100, 4)

ints: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[1] at parallelize at <cons
ole>:24

scala> ints.partitions.size
res2: Int = 4

In general, smaller/more numerous partitions allow work to be distributed among more

workers, but larger/fewer partitions allow work to be done in larger chunks, which may result
in the work getting done more quickly as long as all workers are kept busy, due to reduced
overhead.

Increasing partitions count will make each partition to have less data (or not at all!)

Spark can only run 1 concurrent task for every partition of an RDD, up to the number of
cores in your cluster. So if you have a cluster with 50 cores, you want your RDDs to at least
have 50 partitions (and probably 2-3x times that).

As far as choosing a "good" number of partitions, you generally want at least as many as the
number of executors for parallelism. You can get this computed value by calling
sc.defaultParallelism .

Also, the number of partitions determines how many files get generated by actions that save
RDDs to files.

The maximum size of a partition is ultimately limited by the available memory of an executor.

In the first RDD transformation, e.g. reading from a file using sc.textFile(path, partition) ,
the partition parameter will be applied to all further transformations and actions on this
RDD.

490
Partitions and Partitioning

Partitions get redistributed among nodes whenever shuffle occurs. Repartitioning may
cause shuffle to occur in some situations, but it is not guaranteed to occur in all cases.
And it usually happens during action stage.

When creating an RDD by reading a file using rdd = SparkContext().textFile("hdfs://…​

/file.txt") the number of partitions may be smaller. Ideally, you would get the same

number of blocks as you see in HDFS, but if the lines in your file are too long (longer than
the block size), there will be fewer partitions.

Preferred way to set up the number of partitions for an RDD is to directly pass it as the
second input parameter in the call like rdd = sc.textFile("hdfs://…​/file.txt", 400) , where
400 is the number of partitions. In this case, the partitioning makes for 400 splits that would

be done by the Hadoop’s TextInputFormat , not Spark and it would work much faster. It’s
also that the code spawns 400 concurrent tasks to try to load file.txt directly into 400
partitions.

It will only work as described for uncompressed files.

When using textFile with compressed files ( file.txt.gz not file.txt or similar), Spark
disables splitting that makes for an RDD with only 1 partition (as reads against gzipped files
cannot be parallelized). In this case, to change the number of partitions you should do
repartitioning.

Some operations, e.g. map , flatMap , filter , don’t preserve partitioning.

map , flatMap , filter operations apply a function to every partition.

Repartitioning RDD —  repartition Transformation

repartition(numPartitions: Int)(implicit ord: Ordering[T] = null): RDD[T]

repartition is coalesce with numPartitions and shuffle enabled.

With the following computation you can see that repartition(5) causes 5 tasks to be
started using NODE_LOCAL data locality.

491
Partitions and Partitioning

scala> lines.repartition(5).count
...
15/10/07 08:10:00 INFO DAGScheduler: Submitting 5 missing tasks from ResultStage 7 (Ma
pPartitionsRDD[19] at repartition at <console>:27)
15/10/07 08:10:00 INFO TaskSchedulerImpl: Adding task set 7.0 with 5 tasks
15/10/07 08:10:00 INFO TaskSetManager: Starting task 0.0 in stage 7.0 (TID 17, localho
st, partition 0,NODE_LOCAL, 2089 bytes)
15/10/07 08:10:00 INFO TaskSetManager: Starting task 1.0 in stage 7.0 (TID 18, localho
st, partition 1,NODE_LOCAL, 2089 bytes)
15/10/07 08:10:00 INFO TaskSetManager: Starting task 2.0 in stage 7.0 (TID 19, localho
st, partition 2,NODE_LOCAL, 2089 bytes)
15/10/07 08:10:00 INFO TaskSetManager: Starting task 3.0 in stage 7.0 (TID 20, localho
st, partition 3,NODE_LOCAL, 2089 bytes)
15/10/07 08:10:00 INFO TaskSetManager: Starting task 4.0 in stage 7.0 (TID 21, localho
st, partition 4,NODE_LOCAL, 2089 bytes)
...

You can see a change after executing repartition(1) causes 2 tasks to be started using
PROCESS_LOCAL data locality.

scala> lines.repartition(1).count
...
15/10/07 08:14:09 INFO DAGScheduler: Submitting 2 missing tasks from ShuffleMapStage 8
(MapPartitionsRDD[20] at repartition at <console>:27)
15/10/07 08:14:09 INFO TaskSchedulerImpl: Adding task set 8.0 with 2 tasks
15/10/07 08:14:09 INFO TaskSetManager: Starting task 0.0 in stage 8.0 (TID 22, localho
st, partition 0,PROCESS_LOCAL, 2058 bytes)
15/10/07 08:14:09 INFO TaskSetManager: Starting task 1.0 in stage 8.0 (TID 23, localho
st, partition 1,PROCESS_LOCAL, 2058 bytes)
...

Please note that Spark disables splitting for compressed files and creates RDDs with only 1
partition. In such cases, it’s helpful to use sc.textFile('demo.gz') and do repartitioning
using rdd.repartition(100) as follows:

rdd = sc.textFile('demo.gz')
rdd = rdd.repartition(100)

With the lines, you end up with rdd to be exactly 100 partitions of roughly equal in size.

rdd.repartition(N) does a shuffle to split data to match N

partitioning is done on round robin basis

If partitioning scheme doesn’t work for you, you can write your own custom
Tip
partitioner.

492
Partitions and Partitioning

Tip It’s useful to get familiar with Hadoop’s TextInputFormat.

coalesce Transformation

coalesce(numPartitions: Int, shuffle: Boolean = false)(implicit ord: Ordering[T] = null

): RDD[T]

The coalesce transformation is used to change the number of partitions. It can trigger RDD
shuffling depending on the shuffle flag (disabled by default, i.e. false ).

In the following sample, you parallelize a local 10-number sequence and coalesce it first
without and then with shuffling (note the shuffle parameter being false and true ,
respectively).

Tip Use toDebugString to check out the RDD lineage graph.

scala> val rdd = sc.parallelize(0 to 10, 8)

rdd: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[0] at parallelize at <conso
le>:24

scala> rdd.partitions.size
res0: Int = 8

scala> rdd.coalesce(numPartitions=8, shuffle=false) (1)

res1: org.apache.spark.rdd.RDD[Int] = CoalescedRDD[1] at coalesce at <console>:27

scala> res1.toDebugString
res2: String =
(8) CoalescedRDD[1] at coalesce at <console>:27 []
| ParallelCollectionRDD[0] at parallelize at <console>:24 []

scala> rdd.coalesce(numPartitions=8, shuffle=true)

res3: org.apache.spark.rdd.RDD[Int] = MapPartitionsRDD[5] at coalesce at <console>:27

scala> res3.toDebugString
res4: String =
(8) MapPartitionsRDD[5] at coalesce at <console>:27 []
| CoalescedRDD[4] at coalesce at <console>:27 []
| ShuffledRDD[3] at coalesce at <console>:27 []
+-(8) MapPartitionsRDD[2] at coalesce at <console>:27 []
| ParallelCollectionRDD[0] at parallelize at <console>:24 []

1. shuffle is false by default and it’s explicitly used here for demo purposes. Note the

number of partitions that remains the same as the number of partitions in the source
RDD rdd .

493
Partitions and Partitioning

Settings
Table 1. Spark Properties
Default
Spark Property Description
Value
Sets up the number of partitions to use
for HashPartitioner. It corresponds to
default parallelism of a scheduler
backend.
More specifically,
spark.default.parallelism
(varies per corresponds to:
spark.default.parallelism deployment
The number of threads for
environment)
LocalSchedulerBackend.
the number of CPU cores in Spark
on Mesos and defaults to 8 .
Maximum of totalCoreCount and
2 in
CoarseGrainedSchedulerBackend.

494
Partition

Partition
Partition is a contract of a partition index of a RDD.

Note A partition is missing when it has not be computed yet.

Partition is identified by an partition index that is a unique identifier of a partition of a

RDD.

index: Int

495
Partitioner

Partitioner
Caution FIXME

Partitioner captures data distribution at the output. A scheduler can optimize future

operations based on this.

val partitioner: Option[Partitioner] specifies how the RDD is partitioned.

The contract of partitioner ensures that records for a given key have to reside on a single
partition.

numPartitions Method

Caution FIXME

getPartition Method

Caution FIXME

496
HashPartitioner

HashPartitioner
HashPartitioner is a Partitioner that uses partitions configurable number of partitions

to shuffle data around.

Table 1. HashPartitioner Attributes and Method

Property Description
numPartitions Exactly partitions number of partitions

0 for null keys and Java’s Object.hashCode for non- null

getPartition keys (modulo partitions number of partitions or 0 for
negative hashes).

true for HashPartitioner s with partitions number of

equals
partitions. Otherwise, false .

hashCode Exactly partitions number of partitions

HashPartitioner is the default Partitioner for coalesce transformation with

Note
shuffle enabled, e.g. calling repartition.

It is possible to re-shuffle data despite all the records for the key k being already on a
single Spark executor (i.e. BlockManager to be precise). When HashPartitioner 's result for
k1 is 3 the key k1 will go to the third executor.

497
Shuffling

RDD shuffling
Read the official documentation about the topic Shuffle operations. It is still better
Tip
than this page.

Shuffling is a process of redistributing data across partitions (aka repartitioning) that may or
may not cause moving data across JVM processes or even over the wire (between
executors on separate machines).

Shuffling is the process of data transfer between stages.

Avoid shuffling at all cost. Think about ways to leverage existing partitions.
Tip
Leverage partial aggregation to reduce data transfer.

By default, shuffling doesn’t change the number of partitions, but their content.

Avoid groupByKey and use reduceByKey or combineByKey instead.

groupByKey shuffles all the data, which is slow.

reduceByKey shuffles only the results of sub-aggregations in each partition of the

data.

Example - join
PairRDD offers join transformation that (quoting the official documentation):

When called on datasets of type (K, V) and (K, W), returns a dataset of (K, (V, W)) pairs
with all pairs of elements for each key.

Let’s have a look at an example and see how it works under the covers:

498
Shuffling

scala> val kv = (0 to 5) zip Stream.continually(5)

kv: scala.collection.immutable.IndexedSeq[(Int, Int)] = Vector((0,5), (1,5), (2,5), (3
,5), (4,5), (5,5))

scala> val kw = (0 to 5) zip Stream.continually(10)

kw: scala.collection.immutable.IndexedSeq[(Int, Int)] = Vector((0,10), (1,10), (2,10),
(3,10), (4,10), (5,10))

scala> val kvR = sc.parallelize(kv)

kvR: org.apache.spark.rdd.RDD[(Int, Int)] = ParallelCollectionRDD[3] at parallelize at
<console>:26

scala> val kwR = sc.parallelize(kw)

kwR: org.apache.spark.rdd.RDD[(Int, Int)] = ParallelCollectionRDD[4] at parallelize at
<console>:26

scala> val joined = kvR join kwR

joined: org.apache.spark.rdd.RDD[(Int, (Int, Int))] = MapPartitionsRDD[10] at join at
<console>:32

scala> joined.toDebugString
res7: String =
(8) MapPartitionsRDD[10] at join at <console>:32 []
| MapPartitionsRDD[9] at join at <console>:32 []
| CoGroupedRDD[8] at join at <console>:32 []
+-(8) ParallelCollectionRDD[3] at parallelize at <console>:26 []
+-(8) ParallelCollectionRDD[4] at parallelize at <console>:26 []

It doesn’t look good when there is an "angle" between "nodes" in an operation graph. It
appears before the join operation so shuffle is expected.

Here is how the job of executing joined.count looks in Web UI.

Figure 1. Executing joined.count

The screenshot of Web UI shows 3 stages with two parallelize to Shuffle Write and
count to Shuffle Read. It means shuffling has indeed happened.

499
Shuffling

FIXME Just learnt about sc.range(0, 5) as a shorter version of

Caution
sc.parallelize(0 to 5)

join operation is one of the cogroup operations that uses defaultPartitioner , i.e. walks

through the RDD lineage graph (sorted by the number of partitions decreasing) and picks
the partitioner with positive number of output partitions. Otherwise, it checks
spark.default.parallelism property and if defined picks HashPartitioner with the default
parallelism of the SchedulerBackend.

join is almost CoGroupedRDD.mapValues .

Caution FIXME the default parallelism of scheduler backend

500
Checkpointing

Checkpointing
Checkpointing is a process of truncating RDD lineage graph and saving it to a reliable
distributed (HDFS) or local file system.

There are two types of checkpointing:

reliable - in Spark (core), RDD checkpointing that saves the actual intermediate RDD
data to a reliable distributed file system, e.g. HDFS.

local - in Spark Streaming or GraphX - RDD checkpointing that truncates RDD lineage
graph.

It’s up to a Spark application developer to decide when and how to checkpoint using
RDD.checkpoint() method.

Before checkpointing is used, a Spark developer has to set the checkpoint directory using
SparkContext.setCheckpointDir(directory: String) method.

Reliable Checkpointing
You call SparkContext.setCheckpointDir(directory: String) to set the checkpoint directory
- the directory where RDDs are checkpointed. The directory must be a HDFS path if
running on a cluster. The reason is that the driver may attempt to reconstruct the
checkpointed RDD from its own local file system, which is incorrect because the checkpoint
files are actually on the executor machines.

You mark an RDD for checkpointing by calling RDD.checkpoint() . The RDD will be saved to
a file inside the checkpoint directory and all references to its parent RDDs will be removed.
This function has to be called before any job has been executed on this RDD.

It is strongly recommended that a checkpointed RDD is persisted in memory,

Note
otherwise saving it on a file will require recomputation.

When an action is called on a checkpointed RDD, the following INFO message is printed out
in the logs:

15/10/10 21:08:57 INFO ReliableRDDCheckpointData: Done checkpointing RDD 5 to file:/Us

ers/jacek/dev/oss/spark/checkpoints/91514c29-d44b-4d95-ba02-480027b7c174/rdd-5, new pa
rent is RDD 6

ReliableRDDCheckpointData

501
Checkpointing

When RDD.checkpoint() operation is called, all the information related to RDD

checkpointing are in ReliableRDDCheckpointData .

ReliableCheckpointRDD
After RDD.checkpoint the RDD has ReliableCheckpointRDD as the new parent with the exact
number of partitions as the RDD.

Marking RDD for Local Checkpointing 

—  localCheckpoint Method

localCheckpoint(): this.type

localCheckpoint marks a RDD for local checkpointing using Spark’s caching layer.

localCheckpoint is for users who wish to truncate RDD lineage graph while skipping the

expensive step of replicating the materialized data in a reliable distributed file system. This is
useful for RDDs with long lineages that need to be truncated periodically, e.g. GraphX.

Local checkpointing trades fault-tolerance for performance.

The checkpoint directory set through SparkContext.setCheckpointDir is not

Note
used.

LocalRDDCheckpointData
FIXME

LocalCheckpointRDD
FIXME

doCheckpoint Method

Caution FIXME

502
CheckpointRDD

CheckpointRDD
Caution FIXME

503
RDD Dependencies

RDD Dependencies
Dependency class is the base (abstract) class to model a dependency relationship between

two or more RDDs.

Dependency has a single method rdd to access the RDD that is behind a dependency.

def rdd: RDD[T]

Whenever you apply a transformation (e.g. map , flatMap ) to a RDD you build the so-
called RDD lineage graph. Dependency -ies represent the edges in a lineage graph.

NarrowDependency and ShuffleDependency are the two top-level subclasses of

Note
Dependency abstract class.

Table 1. Kinds of Dependencies

Name Description
NarrowDependency

ShuffleDependency

OneToOneDependency

PruneDependency

RangeDependency

504
RDD Dependencies

The dependencies of a RDD are available using dependencies method.

// A demo RDD
scala> val myRdd = sc.parallelize(0 to 9).groupBy(_ % 2)
myRdd: org.apache.spark.rdd.RDD[(Int, Iterable[Int])] = ShuffledRDD[8] at groupBy at <conso

scala> myRdd.foreach(println)
(0,CompactBuffer(0, 2, 4, 6, 8))
(1,CompactBuffer(1, 3, 5, 7, 9))

scala> myRdd.dependencies
res5: Seq[org.apache.spark.Dependency[_]] = List(org.apache.spark.ShuffleDependency@27ace61

// Access all RDDs in the demo RDD lineage

Note scala> myRdd.dependencies.map(_.rdd).foreach(println)
MapPartitionsRDD[7] at groupBy at <console>:24

You use toDebugString method to print out the RDD lineage in a user-friendly way.

scala> myRdd.toDebugString
res6: String =
(8) ShuffledRDD[8] at groupBy at <console>:24 []
+-(8) MapPartitionsRDD[7] at groupBy at <console>:24 []
| ParallelCollectionRDD[6] at parallelize at <console>:24 []

505
NarrowDependency — Narrow Dependencies

NarrowDependency — Narrow Dependencies
NarrowDependency is a base (abstract) Dependency with narrow (limited) number of

partitions of the parent RDD that are required to compute a partition of the child RDD.

Note Narrow dependencies allow for pipelined execution.

Table 1. Concrete NarrowDependency -ies

Name Description
OneToOneDependency

PruneDependency

RangeDependency

NarrowDependency Contract
NarrowDependency contract assumes that extensions implement getParents method.

def getParents(partitionId: Int): Seq[Int]

getParents returns the partitions of the parent RDD that the input partitionId depends

on.

OneToOneDependency
OneToOneDependency is a narrow dependency that represents a one-to-one dependency

between partitions of the parent and child RDDs.

506
NarrowDependency — Narrow Dependencies

scala> val r1 = sc.parallelize(0 to 9)

r1: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[13] at parallelize at <conso
le>:18

scala> val r3 = r1.map((_, 1))

r3: org.apache.spark.rdd.RDD[(Int, Int)] = MapPartitionsRDD[19] at map at <console>:20

scala> r3.dependencies
res32: Seq[org.apache.spark.Dependency[_]] = List(org.apache.spark.OneToOneDependency@
7353a0fb)

scala> r3.toDebugString
res33: String =
(8) MapPartitionsRDD[19] at map at <console>:20 []
| ParallelCollectionRDD[13] at parallelize at <console>:18 []

PruneDependency
PruneDependency is a narrow dependency that represents a dependency between the

PartitionPruningRDD and its parent RDD.

RangeDependency
RangeDependency is a narrow dependency that represents a one-to-one dependency

between ranges of partitions in the parent and child RDDs.

It is used in UnionRDD for SparkContext.union , RDD.union transformation to list only a few.

scala> val r1 = sc.parallelize(0 to 9)

r1: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[13] at parallelize at <conso
le>:18

scala> val r2 = sc.parallelize(10 to 19)

r2: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[14] at parallelize at <conso
le>:18

scala> val unioned = sc.union(r1, r2)

unioned: org.apache.spark.rdd.RDD[Int] = UnionRDD[16] at union at <console>:22

scala> unioned.dependencies
res19: Seq[org.apache.spark.Dependency[_]] = ArrayBuffer(org.apache.spark.RangeDepende
ncy@28408ad7, org.apache.spark.RangeDependency@6e1d2e9f)

scala> unioned.toDebugString
res18: String =
(16) UnionRDD[16] at union at <console>:22 []
| ParallelCollectionRDD[13] at parallelize at <console>:18 []
| ParallelCollectionRDD[14] at parallelize at <console>:18 []

507
NarrowDependency — Narrow Dependencies

508
ShuffleDependency — Shuffle Dependencies

ShuffleDependency — Shuffle Dependency
ShuffleDependency is a RDD Dependency on the output of a ShuffleMapStage for a key-

value pair RDD.

ShuffleDependency uses the RDD to know the number of (map-side/pre-shuffle) partitions

and the Partitioner for the number of (reduce-size/post-shuffle) partitions.

ShuffleDependency is a dependency of ShuffledRDD as well as CoGroupedRDD and

SubtractedRDD but only when partitioners (of the RDD’s and after transformations) are
different.

A ShuffleDependency is created for a key-value pair RDD, i.e. RDD[Product2[K, V]] with K
and V being the types of keys and values, respectively.

Tip Use dependencies method on an RDD to know the dependencies.

scala> val rdd = sc.parallelize(0 to 8).groupBy(_ % 3)

rdd: org.apache.spark.rdd.RDD[(Int, Iterable[Int])] = ShuffledRDD[2] at groupBy at <co
nsole>:24

scala> rdd.dependencies
res0: Seq[org.apache.spark.Dependency[_]] = List(org.apache.spark.ShuffleDependency@45
4f6cc5)

Every ShuffleDependency has a unique application-wide shuffleId number that is assigned

when ShuffleDependency is created (and is used throughout Spark’s code to reference a
ShuffleDependency ).

Note Shuffle ids are tracked by SparkContext .

keyOrdering Property

Caution FIXME

serializer Property

Caution FIXME

Creating ShuffleDependency Instance

509
ShuffleDependency — Shuffle Dependencies

ShuffleDependency takes the following when created:

1. A single key-value pair RDD, i.e. RDD[Product2[K, V]] ,

2. Partitioner (available as partitioner property),

3. Serializer,

4. Optional key ordering (of Scala’s scala.math.Ordering type),

5. Optional Aggregator,

6. mapSideCombine flag which is disabled (i.e. false ) by default.

Note ShuffleDependency uses SparkEnv to access the current Serializer .

When created, ShuffleDependency gets shuffle id (as shuffleId ).

ShuffleDependency uses the input RDD to access SparkContext and so the

Note
shuffleId .

ShuffleDependency registers itself with ShuffleManager and gets a ShuffleHandle

(available as shuffleHandle property).

Note ShuffleDependency accesses ShuffleManager using SparkEnv .

In the end, ShuffleDependency registers itself for cleanup with ContextCleaner .

ShuffleDependency accesses the optional ContextCleaner through

Note
SparkContext .

ShuffleDependency is created when ShuffledRDD, CoGroupedRDD, and

Note
SubtractedRDD return their RDD dependencies.

rdd Property

rdd: RDD[Product2[K, V]]

rdd returns a key-value pair RDD this ShuffleDependency was created for.

510
ShuffleDependency — Shuffle Dependencies

rdd is used when:

1. MapOutputTrackerMaster finds preferred BlockManagers with most map

outputs for a ShuffleDependency ,
2. DAGScheduler finds or creates new ShuffleMapStage stages for a
ShuffleDependency ,
Note
3. DAGScheduler creates a ShuffleMapStage for a ShuffleDependency and a
ActiveJob ,

4. DAGScheduler finds missing ShuffleDependencies for a RDD,

5. DAGScheduler submits a ShuffleDependency for execution.

partitioner Property
partitioner property is a Partitioner that is used to partition the shuffle output.

partitioner is specified when ShuffleDependency is created.

partitioner is used when:

1. MapOutputTracker computes the statistics for a ShuffleDependency (and is

the size of the array with the total sizes of shuffle blocks),
2. MapOutputTrackerMaster finds preferred BlockManagers with most map
outputs for a ShuffleDependency ,
Note
3. ShuffledRowRDD.adoc#numPreShufflePartitions,
4. SortShuffleManager checks if SerializedShuffleHandle can be used (for a
ShuffleHandle ).

5. FIXME

shuffleHandle Property

shuffleHandle: ShuffleHandle

shuffleHandle is the ShuffleHandle of a ShuffleDependency as assigned eagerly when

ShuffleDependency was created.

shuffleHandle is used to compute CoGroupedRDDs, ShuffledRDD,

SubtractedRDD, and ShuffledRowRDD (to get a ShuffleReader for a
Note
ShuffleDependency ) and when a ShuffleMapTask runs (to get a ShuffleWriter
for a ShuffleDependency ).

511
ShuffleDependency — Shuffle Dependencies

Map-Size Combine Flag —  mapSideCombine Attribute

mapSideCombine is a flag to control whether to use partial aggregation (aka map-side

combine).

mapSideCombine is by default disabled (i.e. false ) when creating a ShuffleDependency .

When enabled, SortShuffleWriter and BlockStoreShuffleReader assume that an Aggregator

is also defined.

mapSideCombine is exclusively set (and hence can be enabled) when

Note
ShuffledRDD returns the dependencies (which is a single ShuffleDependency ).

aggregator Property

aggregator: Option[Aggregator[K, V, C]] = None

aggregator is a map/reduce-side Aggregator (for a RDD’s shuffle).

aggregator is by default undefined (i.e. None ) when ShuffleDependency is created.

aggregator is used when SortShuffleWriter writes records and

Note
BlockStoreShuffleReader reads combined key-values for a reduce task.

Usage
The places where ShuffleDependency is used:

ShuffledRDD and ShuffledRowRDD that are RDDs from a shuffle

The RDD operations that may or may not use the above RDDs and hence shuffling:

coalesce

repartition

cogroup

intersection

subtractByKey

subtract

sortByKey

sortBy

512
ShuffleDependency — Shuffle Dependencies

repartitionAndSortWithinPartitions

combineByKeyWithClassTag

combineByKey

aggregateByKey

foldByKey

reduceByKey

countApproxDistinctByKey

groupByKey

partitionBy

Note There may be other dependent methods that use the above.

513
Map/Reduce-side Aggregator

Map/Reduce-side Aggregator
Aggregator is a set of functions used to aggregate distributed data sets:

createCombiner: V => C
mergeValue: (C, V) => C
mergeCombiners: (C, C) => C

Aggregator is created in combineByKeyWithClassTag transformations to create

Note ShuffledRDDs and is eventually passed on to ShuffleDependency. It is also
used in ExternalSorter.

updateMetrics Internal Method

Caution FIXME

combineValuesByKey Method

Caution FIXME

combineCombinersByKey Method

Caution FIXME

514
AppStatusStore

AppStatusStore
AppStatusStore is…​FIXME

Figure 1. AppStatusStore in Spark Application

AppStatusStore is created when:

SparkContext is created (that triggers creating a live store (i.e. an AppStatusStore for

an active Spark application))

FsHistoryProvider is requested to create a LoadedAppUI

When created for a live Spark application, AppStatusStore creates a AppStatusListener that
is later used to get the active stages.

streamBlocksList Method

streamBlocksList(): Seq[StreamBlockData]

streamBlocksList …​FIXME

Note streamBlocksList is used when…​FIXME

activeStages Method

activeStages(): Seq[v1.StageData]

activeStages …​FIXME

515
AppStatusStore

Note activeStages is used when…​FIXME

Creating AppStatusStore Instance

AppStatusStore takes the following when created:

KVStore

Optional AppStatusListener (default: None )

Creating Live Store (AppStatusStore For Active Spark

Application) —  createLiveStore Factory Method

createLiveStore(conf: SparkConf): AppStatusStore

createLiveStore creates a fully-initialized AppStatusStore .

Internally, createLiveStore creates a ElementTrackingStore (with a new InMemoryStore

and the input SparkConf).

createLiveStore creates a AppStatusListener (with the ElementTrackingStore created, the

input SparkConf and the live flag enabled).

In the end, createLiveStore creates an AppStatusStore (with the ElementTrackingStore

and AppStatusListener just created).

Note createLiveStore is used exclusively when SparkContext is created.

Closing AppStatusStore —  close Method

close(): Unit

close simply requests KVStore to close.

Note close is used when…​FIXME

rddList Method

rddList(cachedOnly: Boolean = true): Seq[v1.RDDStorageInfo]

rddList requests the KVStore for a view over RDDStorageInfoWrapper entities.

516
AppStatusStore

In the end, rddList takes RDDStorageInfos with at least one partition cached (when
cachedOnly flag is on) or all RDDStorageInfos (when cachedOnly flag is off).

Note cachedOnly flag is on and therefore rddList gives RDDs cached only.

rddList is used when:

StoragePage is requested to render itself

Note
AbstractApplicationResource is requested to handle storage/rdd REST API

StagePagedTable is requested to makeDescription

517
AppStatusPlugin

AppStatusPlugin — Contract for
AppStatusPlugin is the contract for…​FIXME

package org.apache.spark.status

trait AppStatusPlugin {
def setupListeners(
conf: SparkConf,
store: KVStore,
addListenerFn: SparkListener => Unit,
live: Boolean): Unit

def setupUI(ui: SparkUI): Unit

}

Note AppStatusPlugin is a private[spark] Scala trait.

Table 1. AppStatusPlugin Contract

Method Description
setupListeners

setupUI

loadPlugins Method

loadPlugins(): Iterable[AppStatusPlugin]

loadPlugins …​FIXME

loadPlugins is used when:

1. SparkContext is created (and creates a web UI)

Note
2. FsHistoryProvider creates a web UI

3. AppStatusStore creates an in-memory store for a live Spark application

518
AppStatusListener

AppStatusListener
AppStatusListener is a SparkListener that AppStatusStore uses to…​FIXME

AppStatusListener is created when:

AppStatusStore is requested to createLiveStore (with the live flag enabled)

FsHistoryProvider is requested to rebuildAppStore (with the live flag disabled)

Table 1. AppStatusListener’s Event Handlers

Event Handler
SparkListenerApplicationStart onApplicationStart

SparkListenerApplicationEnd onApplicationEnd

SparkListenerBlockManagerAdded onBlockManagerAdded

SparkListenerBlockManagerRemoved onBlockManagerRemoved

SparkListenerBlockUpdated onBlockUpdated

SparkListenerEnvironmentUpdate onEnvironmentUpdate

SparkListenerEvent onOtherEvent

SparkListenerExecutorAdded onExecutorAdded

SparkListenerExecutorBlacklisted onExecutorBlacklisted

SparkListenerExecutorMetricsUpdate onExecutorMetricsUpdate

SparkListenerExecutorRemoved onExecutorRemoved

SparkListenerExecutorUnblacklisted onExecutorUnblacklisted

SparkListenerJobStart onJobStart

SparkListenerJobEnd onJobEnd

SparkListenerNodeBlacklisted onNodeBlacklisted

SparkListenerNodeUnblacklisted onNodeUnblacklisted

519
AppStatusListener

SparkListenerStageCompleted onStageCompleted

SparkListenerStageSubmitted onStageSubmitted

SparkListenerTaskEnd onTaskEnd

SparkListenerTaskGettingResult onTaskGettingResult

SparkListenerTaskStart onTaskStart

SparkListenerUnpersistRDD onUnpersistRDD

Table 2. AppStatusListener’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
appInfo v1.ApplicationInfo

appSummary AppSummary

liveUpdatePeriodNs

coresPerTask
Default: 1

liveRDDs LiveRDDs by RDD ID

liveStages LiveStages by (Int, Int)

liveTasks LiveTask by task ID

liveJobs LiveJob by job ID

liveExecutors LiveExecutor by executor ID

pools SchedulerPool by FIXME

activeExecutorCount Number of active executors

onStageSubmitted Method

onStageSubmitted(event: SparkListenerStageSubmitted): Unit

Note onStageSubmitted is part of SparkListener Contract to…​FIXME.

520
AppStatusListener

onStageSubmitted …​FIXME

update Internal Method

update(entity: LiveEntity, now: Long, last: Boolean = false): Unit

update simply requests the LiveEntity to write (with the ElementTrackingStore as the

store and the last flag as checkTriggers flag).

update is used in event handlers (i.e. onApplicationStart ,

Note onExecutorRemoved , onJobEnd , onStageSubmitted , onTaskEnd ,
onStageCompleted ), liveUpdate, maybeUpdate, flush and updateRDDBlock.

flush Internal Method

flush(): Unit

flush …​FIXME

Note flush is used when…​FIXME

maybeUpdate Internal Method

maybeUpdate(entity: LiveEntity, now: Long): Unit

maybeUpdate …​FIXME

Note maybeUpdate is used when…​FIXME

liveUpdate Internal Method

liveUpdate(entity: LiveEntity, now: Long): Unit

liveUpdate …​FIXME

Note liveUpdate is used when…​FIXME

updateStreamBlock Internal Method

521
AppStatusListener

updateStreamBlock(event: SparkListenerBlockUpdated, stream: StreamBlockId): Unit

updateStreamBlock …​FIXME

updateStreamBlock is used exclusively when AppStatusListener is requested

Note
to handle a SparkListenerBlockUpdated event (for a StreamBlockId).

Intercepting SparkListenerBlockUpdated Events 

—  onBlockUpdated Handler Method

onBlockUpdated(event: SparkListenerBlockUpdated): Unit

Note onBlockUpdated is part of SparkListener Contract to…​FIXME.

onBlockUpdated simply dispatches to the following event-specific handlers (per BlockId

type):

updateRDDBlock for RDDBlockIds

updateStreamBlock for StreamBlockIds

Ignores (swallows) the SparkListenerBlockUpdated event for the other types

Creating AppStatusListener Instance

AppStatusListener takes the following when created:

ElementTrackingStore

SparkConf

live flag

Optional lastUpdateTime (default: None )

AppStatusListener initializes the internal registries and counters.

updateRDDBlock Internal Method

updateRDDBlock(event: SparkListenerBlockUpdated, block: RDDBlockId): Unit

updateRDDBlock …​FIXME

522
AppStatusListener

updateRDDBlock is used exclusively when AppStatusListener is requested to

Note
handle a SparkListenerBlockUpdated event (for a RDDBlockId).

523
KVStore

KVStore
KVStore is the contract of…​FIXME

package org.apache.spark.util.kvstore;

public interface KVStore extends Closeable {

long count(Class<?> type) throws Exception;
long count(Class<?> type, String index, Object indexedValue) throws Exception;
void delete(Class<?> type, Object naturalKey) throws Exception;
<T> T getMetadata(Class<T> klass) throws Exception;
<T> T read(Class<T> klass, Object naturalKey) throws Exception;
void setMetadata(Object value) throws Exception;
<T> KVStoreView<T> view(Class<T> type) throws Exception;
void write(Object value) throws Exception;
}

KVStore is a @Private contract that is to mark a Java interface as if it were

Note
private[spark] .

Table 1. KVStore Contract

Method Description
view Used when…​FIXME

Table 2. KVStores
KVStore Description

ElementTrackingStore

InMemoryStore

LevelDB

524
KVStoreView

KVStoreView
KVStoreView …​FIXME

index Method

KVStoreView<T> index(String name)

index …​FIXME

Note index is used when…​FIXME

525
ElementTrackingStore

ElementTrackingStore
ElementTrackingStore is a KVStore that…​FIXME

ElementTrackingStore is created when…​FIXME

Table 1. ElementTrackingStore’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description

Triggers per class

triggers
Used when…​FIXME

Functions that…​FIXME
flushTriggers
Used when…​FIXME

Java ExecutorService that…​FIXME

executor
Used when…​FIXME

stopped flag to control…​FIXME

stopped
Used when…​FIXME

write Method

write(value: Any, checkTriggers: Boolean): Unit

Note write is part of HERE Contract to…​FIXME.

write …​FIXME

Note write is used when…​FIXME

Trigger
Trigger is…​FIXME

Creating ElementTrackingStore Instance

ElementTrackingStore takes the following when created:

526
ElementTrackingStore

KVStore

SparkConf

ElementTrackingStore initializes the internal registries and counters.

527
InMemoryStore

InMemoryStore
InMemoryStore is…​FIXME

InMemoryStore takes no arguments when created.

528
LevelDB

LevelDB
LevelDB is…​FIXME

529
InterruptibleIterator — Iterator With Support For Task Cancellation

InterruptibleIterator — Iterator With Support For

Task Cancellation
InterruptibleIterator is a custom Scala Iterator that supports task cancellation, i.e. stops

iteration when a task was interrupted (cancelled).

Quoting the official Scala Iterator documentation:

Iterators are data structures that allow to iterate over a sequence of elements. They
have a hasNext method for checking if there is a next element available, and a next
method which returns the next element and discards it from the iterator.

InterruptibleIterator is created when:

RDD is requested to get or compute a RDD partition

CoGroupedRDD, HadoopRDD, NewHadoopRDD, ParallelCollectionRDD are requested

to compute a partition

BlockStoreShuffleReader is requested to read combined key-value records for a reduce

task

PairRDDFunctions is requested to combineByKeyWithClassTag

Spark SQL’s DataSourceRDD and JDBCRDD are requested to compute a partition

Spark SQL’s RangeExec physical operator is requested to doExecute

PySpark’s BasePythonRunner is requested to compute

InterruptibleIterator takes the following when created:

TaskContext

Scala Iterator[T]

InterruptibleIterator is a Developer API which is a lower-level, unstable API

Note intended for Spark developers that may change or be removed in minor
versions of Apache Spark.

hasNext Method

hasNext: Boolean

530
InterruptibleIterator — Iterator With Support For Task Cancellation

hasNext is part of Iterator Contract to test whether this iterator can provide
Note
another element.

hasNext requests the TaskContext to kill the task if interrupted (that simply throws a

TaskKilledException that in turn breaks the task execution).

In the end, hasNext requests the delegate Iterator to hasNext .

next Method

next(): T

Note next is part of Iterator Contract to produce the next element of this iterator.

next simply requests the delegate Iterator to next .

531
Broadcast variables

Broadcast Variables
From the official documentation about Broadcast Variables:

Broadcast variables allow the programmer to keep a read-only variable cached on each
machine rather than shipping a copy of it with tasks.

And later in the document:

Explicitly creating broadcast variables is only useful when tasks across multiple stages
need the same data or when caching the data in deserialized form is important.

Figure 1. Broadcasting a value to executors

To use a broadcast value in a Spark transformation you have to create it first using
SparkContext.broadcast and then use value method to access the shared value. Learn it in
Introductory Example section.

The Broadcast feature in Spark uses SparkContext to create broadcast values and
BroadcastManager and ContextCleaner to manage their lifecycle.

532
Broadcast variables

Figure 2. SparkContext to broadcast using BroadcastManager and ContextCleaner

Not only can Spark developers use broadcast variables for efficient data
distribution, but Spark itself uses them quite often. A very notable use case is
Tip
when Spark distributes tasks to executors for their execution. That does change
my perspective on the role of broadcast variables in Spark.

Broadcast Spark Developer-Facing Contract

The developer-facing Broadcast contract allows Spark developers to use it in their
applications.

Table 1. Broadcast API

Method Name Description
id The unique identifier

value The value

Asynchronously deletes cached copies of this broadcast

unpersist
on the executors.

Destroys all data and metadata related to this broadcast

destroy
variable.

toString The string representation

Lifecycle of Broadcast Variable

You can create a broadcast variable of type T using SparkContext.broadcast method.

533
Broadcast variables

scala> val b = sc.broadcast(1)

b: org.apache.spark.broadcast.Broadcast[Int] = Broadcast(0)

Enable DEBUG logging level for org.apache.spark.storage.BlockManager logger to

debug broadcast method.
Tip
Read BlockManager to find out how to enable the logging level.

With DEBUG logging level enabled, you should see the following messages in the logs:

DEBUG BlockManager: Put block broadcast_0 locally took 430 ms

DEBUG BlockManager: Putting block broadcast_0 without replication took 431 ms
DEBUG BlockManager: Told master about block broadcast_0_piece0
DEBUG BlockManager: Put block broadcast_0_piece0 locally took 4 ms
DEBUG BlockManager: Putting block broadcast_0_piece0 without replication took 4 ms

After creating an instance of a broadcast variable, you can then reference the value using
value method.

scala> b.value
res0: Int = 1

Note value method is the only way to access the value of a broadcast variable.

With DEBUG logging level enabled, you should see the following messages in the logs:

DEBUG BlockManager: Getting local block broadcast_0

DEBUG BlockManager: Level for block broadcast_0 is StorageLevel(disk, memory, deserial
ized, 1 replicas)

When you are done with a broadcast variable, you should destroy it to release memory.

scala> b.destroy

With DEBUG logging level enabled, you should see the following messages in the logs:

DEBUG BlockManager: Removing broadcast 0

DEBUG BlockManager: Removing block broadcast_0_piece0
DEBUG BlockManager: Told master about block broadcast_0_piece0
DEBUG BlockManager: Removing block broadcast_0

Before destroying a broadcast variable, you may want to unpersist it.

534
Broadcast variables

scala> b.unpersist

Getting the Value of Broadcast Variable —  value Method

value: T

value returns the value of a broadcast variable. You can only access the value until it is

destroyed after which you will see the following SparkException exception in the logs:

org.apache.spark.SparkException: Attempted to use Broadcast(0) after it was destroyed

(destroy at <console>:27)
at org.apache.spark.broadcast.Broadcast.assertValid(Broadcast.scala:144)
at org.apache.spark.broadcast.Broadcast.value(Broadcast.scala:69)
... 48 elided

Internally, value makes sure that the broadcast variable is valid, i.e. destroy was not
called, and, if so, calls the abstract getValue method.

getValue is abstracted and broadcast variable implementations are supposed

to provide a concrete behaviour.
Note
Refer to TorrentBroadcast.

Unpersisting Broadcast Variable —  unpersist Methods

unpersist(): Unit
unpersist(blocking: Boolean): Unit

Destroying Broadcast Variable —  destroy Method

destroy(): Unit

destroy removes a broadcast variable.

Note Once a broadcast variable has been destroyed, it cannot be used again.

If you try to destroy a broadcast variable more than once, you will see the following
SparkException exception in the logs:

535
Broadcast variables

scala> b.destroy
org.apache.spark.SparkException: Attempted to use Broadcast(0) after it was destroyed
(destroy at <console>:27)
at org.apache.spark.broadcast.Broadcast.assertValid(Broadcast.scala:144)
at org.apache.spark.broadcast.Broadcast.destroy(Broadcast.scala:107)
at org.apache.spark.broadcast.Broadcast.destroy(Broadcast.scala:98)
... 48 elided

Internally, destroy executes the internal destroy (with blocking enabled).

Removing Persisted Data of Broadcast Variable 

—  destroy Internal Method

destroy(blocking: Boolean): Unit

destroy destroys all data and metadata of a broadcast variable.

Note destroy is a private[spark] method.

Internally, destroy marks a broadcast variable destroyed, i.e. the internal _isValid flag is
disabled.

You should see the following INFO message in the logs:

INFO TorrentBroadcast: Destroying Broadcast([id]) (from [destroySite])

In the end, doDestroy method is executed (that broadcast implementations are supposed to
provide).

doDestroy is part of the Broadcast contract for broadcast implementations so

Note
they can provide their own custom behaviour.

Introductory Example
Let’s start with an introductory example to check out how to use broadcast variables and
build your initial understanding.

You’re going to use a static mapping of interesting projects with their websites, i.e.
Map[String, String] that the tasks, i.e. closures (anonymous functions) in transformations,

use.

536
Broadcast variables

scala> val pws = Map("Apache Spark" -> "http://spark.apache.org/", "Scala" -> "http://
www.scala-lang.org/")
pws: scala.collection.immutable.Map[String,String] = Map(Apache Spark -> http://spark.
apache.org/, Scala -> http://www.scala-lang.org/)

scala> val websites = sc.parallelize(Seq("Apache Spark", "Scala")).map(pws).collect

...
websites: Array[String] = Array(http://spark.apache.org/, http://www.scala-lang.org/)

It works, but is very ineffective as the pws map is sent over the wire to executors while it
could have been there already. If there were more tasks that need the pws map, you could
improve their performance by minimizing the number of bytes that are going to be sent over
the network for task execution.

Enter broadcast variables.

val pwsB = sc.broadcast(pws)

val websites = sc.parallelize(Seq("Apache Spark", "Scala")).map(pwsB.value).collect
// websites: Array[String] = Array(http://spark.apache.org/, http://www.scala-lang.org
/)

Semantically, the two computations - with and without the broadcast value - are exactly the
same, but the broadcast-based one wins performance-wise when there are more executors
spawned to execute many tasks that use pws map.

Introduction
Broadcast is part of Spark that is responsible for broadcasting information across nodes in
a cluster.

You use broadcast variable to implement map-side join, i.e. a join using a map . For this,
lookup tables are distributed across nodes in a cluster using broadcast and then looked up
inside map (to do the join implicitly).

When you broadcast a value, it is copied to executors only once (while it is copied multiple
times for tasks otherwise). It means that broadcast can help to get your Spark application
faster if you have a large value to use in tasks or there are more tasks than executors.

It appears that a Spark idiom emerges that uses broadcast with collectAsMap to create a
Map for broadcast. When an RDD is map over to a smaller dataset (column-wise not

record-wise), collectAsMap , and broadcast , using the very big RDD to map its elements to
the broadcast RDDs is computationally faster.

537
Broadcast variables

val acMap = sc.broadcast(myRDD.map { case (a,b,c,b) => (a, c) }.collectAsMap)

val otherMap = sc.broadcast(myOtherRDD.collectAsMap)

myBigRDD.map { case (a, b, c, d) =>

(acMap.value.get(a).get, otherMap.value.get(c).get)
}.collect

Use large broadcasted HashMaps over RDDs whenever possible and leave RDDs with a
key to lookup necessary data as demonstrated above.

Spark comes with a BitTorrent implementation.

It is not enabled by default.

Broadcast Contract
The Broadcast contract is made up of the following methods that custom Broadcast
implementations are supposed to provide:

1. getValue

2. doUnpersist

3. doDestroy

Note TorrentBroadcast is the only implementation of the Broadcast contract.

Broadcast Spark Developer-Facing Contract is the developer-facing

Note
Broadcast contract that allows Spark developers to use it in their applications.

Further Reading or Watching

Map-Side Join in Spark

538
Accumulators

Accumulators
Accumulators are variables that are "added" to through an associative and commutative
"add" operation. They act as a container for accumulating partial values across multiple
tasks (running on executors). They are designed to be used safely and efficiently in parallel
and distributed Spark computations and are meant for distributed counters and sums (e.g.
task metrics).

You can create built-in accumulators for longs, doubles, or collections or register custom
accumulators using the SparkContext.register methods. You can create accumulators with
or without a name, but only named accumulators are displayed in web UI (under Stages tab
for a given stage).

Figure 1. Accumulators in the Spark UI

Accumulator are write-only variables for executors. They can be added to by executors and
read by the driver only.

executor1: accumulator.add(incByExecutor1)
executor2: accumulator.add(incByExecutor2)

driver: println(accumulator.value)

Accumulators are not thread-safe. They do not really have to since the
DAGScheduler.updateAccumulators method that the driver uses to update the values of
accumulators after a task completes (successfully or with a failure) is only executed on a
single thread that runs scheduling loop. Beside that, they are write-only data structures for
workers that have their own local accumulator reference whereas accessing the value of an
accumulator is only allowed by the driver.

539
Accumulators

Accumulators are serializable so they can safely be referenced in the code executed in
executors and then safely send over the wire for execution.

val counter = sc.longAccumulator("counter")

sc.parallelize(1 to 9).foreach(x => counter.add(x))

Internally, longAccumulator, doubleAccumulator, and collectionAccumulator methods create

the built-in typed accumulators and call SparkContext.register.

Tip Read the official documentation about Accumulators.

Table 1. AccumulatorV2’s Internal Registries and Counters

Name Description
AccumulatorMetadata
metadata
Used when…​FIXME

Flag whether…​FIXME
atDriverSide
Used when…​FIXME

merge Method

Caution FIXME

AccumulatorV2

abstract class AccumulatorV2[IN, OUT]

AccumulatorV2 parameterized class represents an accumulator that accumulates IN

values to produce OUT result.

Registering Accumulator —  register Method

register(
sc: SparkContext,
name: Option[String] = None,
countFailedValues: Boolean = false): Unit

register creates a AccumulatorMetadata metadata object for the accumulator (with a new

unique identifier) that is then used to register the accumulator with.

540
Accumulators

In the end, register registers the accumulator for cleanup (only when ContextCleaner is
defined in the SparkContext ).

register reports a IllegalStateException if metadata is already defined (which means

that register was called already).

Cannot register an Accumulator twice.

Note register is a private[spark] method.

register is used when:

SparkContext registers accumulators

Note
TaskMetrics registers the internal accumulators

SQLMetrics creates metrics.

AccumulatorMetadata
AccumulatorMetadata is a container object with the metadata of an accumulator:

Accumulator ID

(optional) name

Flag whether to include the latest value of an accumulator on failure

countFailedValues is used exclusively when Task collects the latest values of

Note
accumulators (irrespective of task status — a success or a failure).

Named Accumulators
An accumulator can have an optional name that you can specify when creating an
accumulator.

val counter = sc.longAccumulator("counter")

AccumulableInfo
AccumulableInfo contains information about a task’s local updates to an Accumulable.

id of the accumulator

optional name of the accumulator

541
Accumulators

optional partial update to the accumulator from a task

value

whether or not it is internal

whether or not to countFailedValues to the final value of the accumulator for failed
tasks

optional metadata

AccumulableInfo is used to transfer accumulator updates from executors to the driver every

executor heartbeat or when a task finishes.

Create an representation of this with the provided values.

When are Accumulators Updated?

Examples

Example: Distributed Counter

Imagine you are requested to write a distributed counter. What do you think about the
following solutions? What are the pros and cons of using it?

val ints = sc.parallelize(0 to 9, 3)

var counter = 0
ints.foreach { n =>
println(s"int: $n")
counter = counter + 1
}
println(s"The number of elements is $counter")

How would you go about doing the calculation using accumulators?

Example: Using Accumulators in Transformations and

Guarantee Exactly-Once Update

FIXME Code with failing transformations (tasks) that update accumulator

Caution
( Map ) with TaskContext info.

Example: Custom Accumulator

542
Accumulators

Caution FIXME Improve the earlier example

Example: Distributed Stopwatch

Note This is almost a raw copy of org.apache.spark.ml.util.DistributedStopwatch.

class DistributedStopwatch(sc: SparkContext, val name: String) {

val elapsedTime: Accumulator[Long] = sc.accumulator(0L, s"DistributedStopwatch($name

)")

override def elapsed(): Long = elapsedTime.value

override protected def add(duration: Long): Unit = {

elapsedTime += duration
}
}

Further reading or watching

Performance and Scalability of Broadcast in Spark

543
AccumulatorContext

AccumulatorContext
AccumulatorContext is a private[spark] internal object used to track accumulators by

Spark itself using an internal originals lookup table. Spark uses the AccumulatorContext
object to register and unregister accumulators.

The originals lookup table maps accumulator identifier to the accumulator itself.

Every accumulator has its own unique accumulator id that is assigned using the internal
nextId counter.

register Method

Caution FIXME

newId Method

Caution FIXME

AccumulatorContext.SQL_ACCUM_IDENTIFIER
AccumulatorContext.SQL_ACCUM_IDENTIFIER is an internal identifier for Spark SQL’s internal

accumulators. The value is sql and Spark uses it to distinguish Spark SQL metrics from
others.

544
SerializerManager

SerializerManager
Caution FIXME

When SparkEnv is created (either for the driver or executors), it instantiates

SerializerManager that is then used to create a BlockManager.

SerializerManager automatically selects the "best" serializer for shuffle blocks that could

either be KryoSerializer when a RDD’s types are known to be compatible with Kryo or the
default Serializer .

The common idiom in Spark’s code is to access the current SerializerManager using
SparkEnv.

SparkEnv.get.serializerManager

Note SerializerManager was introduced in SPARK-13926.

Creating SerializerManager Instance

Caution FIXME

wrapStream Method

Caution FIXME

dataDeserializeStream Method

Caution FIXME

Automatic Selection of Best Serializer

Caution FIXME

SerializerManager will automatically pick a Kryo serializer for ShuffledRDDs whose key,

value, and/or combiner types are primitives, arrays of primitives, or strings.

Selecting "Best" Serializer  —  getSerializer

545
SerializerManager

Selecting "Best" Serializer  —  getSerializer

Method

getSerializer(keyClassTag: ClassTag[_], valueClassTag: ClassTag[_]): Serializer

getSerializer selects the "best" Serializer given the input types for keys and values (in a

RDD).

getSerializer returns KryoSerializer when the types of keys and values are compatible

with Kryo or the default Serializer .

Note The default Serializer is defined when SerializerManager is created.

getSerializer is used when ShuffledRDD returns the single-element

Note
dependency list (with ShuffleDependency ).

Settings
Table 1. Spark Properties
Default
Name Description
value
The flag to control
spark.shuffle.compress true
whether to compress
shuffle output when
stored

The flag to control

spark.rdd.compress false
whether to compress
RDD partitions when
stored serialized.

The flag to control

whether to compress
spark.shuffle.spill.compress true shuffle output
temporarily spilled to
disk.

spark.block.failures.beforeLocationRefresh 5

spark.io.encryption.enabled false
The flag to enable IO
encryption

546
SerializerManager

547
MemoryManager — Memory Management

MemoryManager — Memory Management
System
MemoryManager is the base of memory managers that manage shared memory for task

execution and block storage.

package org.apache.spark.memory

abstract class MemoryManager(...) {

// only required methods that have no implementation
// the others follow
def acquireExecutionMemory(
numBytes: Long,
taskAttemptId: Long,
memoryMode: MemoryMode): Long
def acquireStorageMemory(blockId: BlockId, numBytes: Long, memoryMode: MemoryMode):
Boolean
def acquireUnrollMemory(blockId: BlockId, numBytes: Long, memoryMode: MemoryMode): B
oolean
def maxOffHeapStorageMemory: Long
def maxOnHeapStorageMemory: Long
}

Note MemoryManager is a private[spark] contract.

548
MemoryManager — Memory Management

Table 1. (Subset of) MemoryManager Contract

Method Description

acquireExecutionMemory
Used exclusively when TaskMemoryManager is requested
to acquireExecutionMemory

Used when:

UnifiedMemoryManager is requested to
acquireStorageMemory acquireUnrollMemory
MemoryStore is requested to putBytes,
putIteratorAsValues and putIteratorAsBytes

acquireUnrollMemory
Used exclusively when MemoryStore is requested to
reserveUnrollMemoryForThisTask

Used when:

UnifiedMemoryManager is requested to
acquireStorageMemory
maxOffHeapStorageMemory
BlockManager is created

MemoryStore is requested for the total amount of

memory available for storage (in bytes)

Used when:
BlockManager is created

UnifiedMemoryManager is requested to

maxOnHeapStorageMemory
acquireStorageMemory
MemoryStore is requested for the total amount of
memory available for storage (in bytes)

(legacy) StaticMemoryManager is created, is

requested to acquireStorageMemory

MemoryManager is created along with SparkEnv.

MemoryManager is a Scala abstract class and cannot be created directly, but

Note
only as one of the implementations.

Execution memory is used for computation in shuffles, joins, sorts and aggregations.

Storage memory is used for caching and propagating internal data across the nodes in a
cluster.

549
MemoryManager — Memory Management

Table 2. MemoryManagers
MemoryManager Description

StaticMemoryManager (legacy)

UnifiedMemoryManager The default memory manager

Table 3. MemoryManager’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
FIXME
onHeapStorageMemoryPool
Used when…​FIXME

FIXME
offHeapStorageMemoryPool
Used when…​FIXME

FIXME
pageSizeBytes
Used when…​FIXME

FIXME
Used when…​FIXME
tungstenMemoryAllocator
tungstenMemoryAllocator is a Scala final
Note val and cannot be changed by custom
MemoryManagers.

Creating MemoryManager Instance

MemoryManager takes the following when created:

SparkConf

Number of CPU cores

onHeapStorageMemory

onHeapExecutionMemory

MemoryManager initializes the internal registries and counters.

MemoryManager is a Scala abstract class and cannot be created directly, but

Note
only as one of the implementations.

releaseExecutionMemory Method

550
MemoryManager — Memory Management

releaseExecutionMemory(
numBytes: Long,
taskAttemptId: Long,
memoryMode: MemoryMode): Unit

releaseExecutionMemory …​FIXME

releaseExecutionMemory is used when TaskMemoryManager is requested to

Note
releaseExecutionMemory and cleanUpAllAllocatedMemory

releaseAllExecutionMemoryForTask Method

releaseAllExecutionMemoryForTask(taskAttemptId: Long): Long

releaseAllExecutionMemoryForTask …​FIXME

releaseAllExecutionMemoryForTask is used exclusively when TaskRunner is

Note
requested to run (and cleans up after itself).

tungstenMemoryMode Flag

tungstenMemoryMode: MemoryMode

tungstenMemoryMode returns OFF_HEAP only when the following are all met:

spark.memory.offHeap.enabled configuration property is enabled (it is not by default)

spark.memory.offHeap.size configuration property is greater than 0 (it is 0 by

default)

JVM supports unaligned memory access (aka unaligned Unsafe, i.e. sun.misc.Unsafe
package is available and the underlying system has unaligned-access capability)

Otherwise, tungstenMemoryMode returns ON_HEAP .

Given that spark.memory.offHeap.enabled configuration property is disabled

( false ) by default and spark.memory.offHeap.size configuration property is 0
Note
by default, Spark seems to encourage using Tungsten memory allocated on the
JVM heap ( ON_HEAP ).

tungstenMemoryMode is a Scala final val and cannot be changed by custom

Note
MemoryManagers.

551
MemoryManager — Memory Management

tungstenMemoryMode is used when:

TaskMemoryManager is created
Note
MemoryManager is created (and initializes the pageSizeBytes and
tungstenMemoryAllocator internal properties)

freePage Method

void freePage(MemoryBlock page)

freePage …​FIXME

Note freePage is used when…​FIXME

552
UnifiedMemoryManager — Spark’s Memory Manager

UnifiedMemoryManager — Spark’s Memory
Manager
UnifiedMemoryManager is the default MemoryManager with onHeapStorageMemory being ???

and onHeapExecutionMemory being ???

Calculate Maximum Memory to Use —  getMaxMemory

Method

getMaxMemory(conf: SparkConf): Long

getMaxMemory calculates the maximum memory to use for execution and storage.

// local mode with --conf spark.driver.memory=2g

scala> sc.getConf.getSizeAsBytes("spark.driver.memory")
res0: Long = 2147483648

scala> val systemMemory = Runtime.getRuntime.maxMemory

// fixed amount of memory for non-storage, non-execution purposes

val reservedMemory = 300 * 1024 * 1024

// minimum system memory required

val minSystemMemory = (reservedMemory * 1.5).ceil.toLong

val usableMemory = systemMemory - reservedMemory

val memoryFraction = sc.getConf.getDouble("spark.memory.fraction", 0.6)

scala> val maxMemory = (usableMemory * memoryFraction).toLong
maxMemory: Long = 956615884

import org.apache.spark.network.util.JavaUtils
scala> JavaUtils.byteStringAsMb(maxMemory + "b")
res1: Long = 912

getMaxMemory reads the maximum amount of memory that the Java virtual machine will

attempt to use and decrements it by reserved system memory (for non-storage and non-
execution purposes).

getMaxMemory makes sure that the following requirements are met:

1. System memory is not smaller than about 1,5 of the reserved system memory.

2. spark.executor.memory is not smaller than about 1,5 of the reserved system memory.

553
UnifiedMemoryManager — Spark’s Memory Manager

Ultimately, getMaxMemory returns spark.memory.fraction of the maximum amount of memory

for the JVM (minus the reserved system memory).

Caution FIXME omnigraffle it.

Creating UnifiedMemoryManager Instance

class UnifiedMemoryManager(
conf: SparkConf,
val maxHeapMemory: Long,
onHeapStorageRegionSize: Long,
numCores: Int)

UnifiedMemoryManager requires a SparkConf and the following values:

maxHeapMemory  — the maximum on-heap memory to manage. It is assumed that

onHeapExecutionMemoryPool with onHeapStorageMemoryPool is exactly maxHeapMemory .

onHeapStorageRegionSize

numCores

UnifiedMemoryManager makes sure that the sum of offHeapExecutionMemoryPool and

offHeapStorageMemoryPool pool sizes is exactly maxOffHeapMemory .

Caution FIXME Describe the pools

apply Factory Method

apply(conf: SparkConf, numCores: Int): UnifiedMemoryManager

apply factory method creates an instance of UnifiedMemoryManager .

Internally, apply calculates the maximum memory to use (given conf ). It then creates a
UnifiedMemoryManager with the following values:

1. maxHeapMemory being the maximum memory just calculated.

2. onHeapStorageRegionSize being spark.memory.storageFraction of maximum memory.

3. numCores as configured.

Note apply is used when SparkEnv is created.

554
UnifiedMemoryManager — Spark’s Memory Manager

acquireStorageMemory Method

acquireStorageMemory(
blockId: BlockId,
numBytes: Long,
memoryMode: MemoryMode): Boolean

Note acquireStorageMemory is part of the MemoryManager Contract to…​FIXME

acquireStorageMemory has two modes of operation per memoryMode , i.e.

MemoryMode.ON_HEAP or MemoryMode.OFF_HEAP , for execution and storage pools, and the

maximum amount of memory to use.

Caution FIXME Where are they used?

In MemoryMode.ON_HEAP , onHeapExecutionMemoryPool , onHeapStorageMemoryPool , and

maxOnHeapStorageMemory are used.

In MemoryMode.OFF_HEAP , offHeapExecutionMemoryPool , offHeapStorageMemoryPool , and

maxOffHeapMemory are used.

Caution FIXME What is the difference between them?

It makes sure that the requested number of bytes numBytes (for a block to store) fits the
available memory. If it is not the case, you should see the following INFO message in the
logs and the method returns false .

INFO Will not store [blockId] as the required space ([numBytes] bytes) exceeds our mem
ory limit ([maxMemory] bytes)

If the requested number of bytes numBytes is greater than memoryFree in the storage pool,
acquireStorageMemory will attempt to use the free memory from the execution pool.

Note The storage pool can use the free memory from the execution pool.

It will take as much memory as required to fit numBytes from memoryFree in the execution
pool (up to the whole free memory in the pool).

Ultimately, acquireStorageMemory requests the storage pool for numBytes for blockId .

acquireStorageMemory is used when MemoryStore acquires storage memory to

putBytes or putIteratorAsValues and putIteratorAsBytes.
Note
It is also used internally when UnifiedMemoryManager acquires unroll memory.

555
UnifiedMemoryManager — Spark’s Memory Manager

acquireUnrollMemory Method

Note acquireUnrollMemory is part of the MemoryManager Contract.

acquireUnrollMemory simply forwards all the calls to acquireStorageMemory.

acquireExecutionMemory Method

acquireExecutionMemory(
numBytes: Long,
taskAttemptId: Long,
memoryMode: MemoryMode): Long

acquireExecutionMemory does…​FIXME

Internally, acquireExecutionMemory varies per MemoryMode , i.e. ON_HEAP and OFF_HEAP .

Table 1. acquireExecutionMemory and MemoryMode

ON_HEAP OFF_HEAP
executionPool onHeapExecutionMemoryPool offHeapExecutionMemoryPool

storagePool onHeapStorageMemoryPool offHeapStorageMemoryPool

onHeapStorageRegionSize
storageRegionSize offHeapStorageMemory
<1>

maxMemory maxHeapMemory <2> maxOffHeapMemory

1. Defined when UnifiedMemoryManager is created.

2. Defined when UnifiedMemoryManager is created.

Note acquireExecutionMemory is part of the MemoryManager Contract.

Caution FIXME

maxOnHeapStorageMemory Method

maxOnHeapStorageMemory: Long

maxOnHeapStorageMemory is the difference between maxHeapMemory of the

UnifiedMemoryManager and the memory currently in use in onHeapExecutionMemoryPool

execution memory pool.

556
UnifiedMemoryManager — Spark’s Memory Manager

Note maxOnHeapStorageMemory is part of the MemoryManager Contract.

Settings
Table 2. Spark Properties
Spark Property Default Value Description
Fraction of JVM
heap space
spark.memory.fraction 0.6 used for
execution and
storage.

spark.memory.storageFraction 0.5

Java’s
spark.testing.memory System memory
Runtime.getRuntime.maxMemory

300M or 0 (with spark.testing

spark.testing.reservedMemory
enabled)

557
StaticMemoryManager — Legacy Memory Manager

StaticMemoryManager — Legacy Memory
Manager
StaticMemoryManager is…​FIXME

acquireUnrollMemory Method

acquireUnrollMemory(
blockId: BlockId,
numBytes: Long,
memoryMode: MemoryMode): Boolean

Note acquireUnrollMemory is part of MemoryManager Contract to…​FIXME.

acquireUnrollMemory …​FIXME

acquireStorageMemory Method

acquireStorageMemory(
blockId: BlockId,
numBytes: Long,
memoryMode: MemoryMode): Boolean

Note acquireStorageMemory is part of MemoryManager Contract to…​FIXME.

acquireStorageMemory …​FIXME

558
MemoryManager Configuration Properties

MemoryManager Configuration Properties

The page describes the memory-related configuration properties of Apache Spark
(mostly MemoryManager and "relatives").

Note It may be that the page should be somewhere else. Any suggestions?

Use the following idiom to set the configuration properties.

import org.apache.spark.internal.config._
import org.apache.spark.SparkConf
// all properties are private[spark], sorry
// the following won't work unless the code is under org.apache.spark package
val sparkConf = new SparkConf().set(MEMORY_OFFHEAP_ENABLED.key, "false")

import org.apache.spark.SparkConf
val sparkConf = new SparkConf()
scala> println(sparkConf.getOption("spark.memory.offHeap.enabled"))
None

// Using ConfigEntry-based SparkConf.set that is also private[spark]

// Use :pa -raw in spark-shell to paste the following snippet
// BEGIN
package org.apache.spark.japila

object Config {
import org.apache.spark.SparkConf
import org.apache.spark.internal.config._
def with_MEMORY_OFFHEAP_ENABLED(sparkConf: SparkConf = new SparkConf()): SparkConf =
{
sparkConf.set(MEMORY_OFFHEAP_ENABLED, true)
}
}
// END

import org.apache.spark.japila.Config
val sparkConf_OffHeap = Config.with_MEMORY_OFFHEAP_ENABLED(sparkConf)

scala> println(sparkConf_OffHeap.get("spark.memory.offHeap.enabled"))
true

559
MemoryManager Configuration Properties

Table 1. Memory-Related Configuration Properties

Default
Name Description
Value

Controls whether Spark will attempt to use

off-heap memory for certain operations
( true ) or not ( false ).
Tracks whether Tungsten memory will be
allocated on the JVM heap or off-heap
(using sun.misc.Unsafe ).
If enabled, spark.memory.offHeap.size has
spark.memory.offHeap.enabled false
to be greater than 0.
Used exclusively when MemoryManager is
requested for tungstenMemoryMode.

Before Apache Spark 1.6,

spark.memory.offHeap.enabled
Note was known as
spark.unsafe.offHeap .

spark.memory.offHeap.size

560
SparkEnv — Spark Runtime Environment

SparkEnv — Spark Runtime Environment

Spark Runtime Environment ( SparkEnv ) is the runtime environment with Spark’s public
services that interact with each other to establish a distributed computing platform for a
Spark application.

Spark Runtime Environment is represented by a SparkEnv object that holds all the required
runtime services for a running Spark application with separate environments for the driver
and executors.

The idiomatic way in Spark to access the current SparkEnv when on the driver or executors
is to use get method.

import org.apache.spark._
scala> SparkEnv.get
res0: org.apache.spark.SparkEnv = org.apache.spark.SparkEnv@49322d04

561
SparkEnv — Spark Runtime Environment

Table 1. SparkEnv Services

Property Service Description

rpcEnv RpcEnv

serializer Serializer

closureSerializer Serializer

serializerManager SerializerManager

mapOutputTracker MapOutputTracker

shuffleManager ShuffleManager

broadcastManager BroadcastManager

blockManager BlockManager

securityManager SecurityManager

metricsSystem MetricsSystem

memoryManager MemoryManager

outputCommitCoordinator OutputCommitCoordinator

Table 2. SparkEnv’s Internal Properties

Name Initial Value Description

isStopped Disabled, i.e. Used to mark SparkEnv stopped. FIXME

false

driverTmpDir

Enable INFO or DEBUG logging level for org.apache.spark.SparkEnv logger to

see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.SparkEnv=DEBUG

Refer to Logging.

562
SparkEnv — Spark Runtime Environment

SparkEnv Factory Object

Creating "Base" SparkEnv  —  create Method

create(
conf: SparkConf,
executorId: String,
hostname: String,
port: Int,
isDriver: Boolean,
isLocal: Boolean,
numUsableCores: Int,
listenerBus: LiveListenerBus = null,
mockOutputCommitCoordinator: Option[OutputCommitCoordinator] = None): SparkEnv

create is a internal helper method to create a "base" SparkEnv (for a driver or an

executor).

Table 3. create’s Input Arguments and Their Usage

Input Argument Usage
bindAddress Used to create RpcEnv and NettyBlockTransferService.

advertiseAddress Used to create RpcEnv and NettyBlockTransferService.

numUsableCores
Used to create MemoryManager,
NettyBlockTransferService and BlockManager.

When executed, create creates a Serializer (based on spark.serializer setting). You

should see the following DEBUG message in the logs:

DEBUG SparkEnv: Using serializer: [serializer]

create creates a closure Serializer (based on spark.closure.serializer).

create creates a ShuffleManager based on spark.shuffle.manager Spark property.

create creates a MemoryManager based on spark.memory.useLegacyMode setting (with

UnifiedMemoryManager being the default and numCores the input numUsableCores ).

create creates a NettyBlockTransferService with the following ports:

spark.driver.blockManager.port for the driver (default: 0 )

spark.blockManager.port for an executor (default: 0 )

563
SparkEnv — Spark Runtime Environment

Note create uses the NettyBlockTransferService to create a BlockManager.

FIXME A picture with SparkEnv , NettyBlockTransferService and the ports

Caution
"armed".

create creates a BlockManagerMaster object with the BlockManagerMaster RPC endpoint

reference (by registering or looking it up by name and BlockManagerMasterEndpoint), the

input SparkConf, and the input isDriver flag.

Figure 1. Creating BlockManager for the Driver

create registers the BlockManagerMaster RPC endpoint for the driver and
Note
looks it up for executors.

564
SparkEnv — Spark Runtime Environment

Figure 2. Creating BlockManager for Executor

create creates a BlockManager (using the above BlockManagerMaster,

NettyBlockTransferService and other services).

create creates a BroadcastManager.

create creates a MapOutputTrackerMaster or MapOutputTrackerWorker for the driver and

executors, respectively.

The choice of the real implementation of MapOutputTracker is based on

Note
whether the input executorId is driver or not.

create registers or looks up RpcEndpoint as MapOutputTracker. It registers

MapOutputTrackerMasterEndpoint on the driver and creates a RPC endpoint reference on

executors. The RPC endpoint reference gets assigned as the MapOutputTracker RPC
endpoint.

Caution FIXME

It creates a CacheManager.

It creates a MetricsSystem for a driver and a worker separately.

It initializes userFiles temporary directory used for downloading dependencies for a driver
while this is the executor’s current working directory for an executor.

An OutputCommitCoordinator is created.

create is used when SparkEnv is requested for the SparkEnv for the driver
Note
and executors.

565
SparkEnv — Spark Runtime Environment

Registering or Looking up RPC Endpoint by Name 

—  registerOrLookupEndpoint Method

registerOrLookupEndpoint(name: String, endpointCreator: => RpcEndpoint)

registerOrLookupEndpoint registers or looks up a RPC endpoint by name .

If called from the driver, you should see the following INFO message in the logs:

INFO SparkEnv: Registering [name]

And the RPC endpoint is registered in the RPC environment.

Otherwise, it obtains a RPC endpoint reference by name .

Creating SparkEnv for Driver —  createDriverEnv

Method

createDriverEnv(
conf: SparkConf,
isLocal: Boolean,
listenerBus: LiveListenerBus,
numCores: Int,
mockOutputCommitCoordinator: Option[OutputCommitCoordinator] = None): SparkEnv

createDriverEnv creates a SparkEnv execution environment for the driver.

566
SparkEnv — Spark Runtime Environment

Figure 3. Spark Environment for driver

createDriverEnv accepts an instance of SparkConf, whether it runs in local mode or not,

LiveListenerBus, the number of cores to use for execution in local mode or 0 otherwise,
and a OutputCommitCoordinator (default: none).

createDriverEnv ensures that spark.driver.host and spark.driver.port settings are defined.

It then passes the call straight on to the create helper method (with driver executor id,
isDriver enabled, and the input parameters).

createDriverEnv is exclusively used by SparkContext to create a SparkEnv

Note
(while a SparkContext is being created for the driver).

Creating SparkEnv for Executor —  createExecutorEnv

Method

createExecutorEnv(
conf: SparkConf,
executorId: String,
hostname: String,
port: Int,
numCores: Int,
ioEncryptionKey: Option[Array[Byte]],
isLocal: Boolean): SparkEnv

createExecutorEnv creates an executor’s (execution) environment that is the Spark

execution environment for an executor.

567
SparkEnv — Spark Runtime Environment

Figure 4. Spark Environment for executor

Note createExecutorEnv is a private[spark] method.

createExecutorEnv simply creates the base SparkEnv (passing in all the input parameters)

and sets it as the current SparkEnv .

The number of cores numCores is configured using --cores command-line

Note
option of CoarseGrainedExecutorBackend and is specific to a cluster manager.

createExecutorEnv is used when CoarseGrainedExecutorBackend runs and

Note
MesosExecutorBackend registers a Spark executor.

Getting Current SparkEnv —  get Method

get: SparkEnv

get returns the current SparkEnv .

import org.apache.spark._
scala> SparkEnv.get
res0: org.apache.spark.SparkEnv = org.apache.spark.SparkEnv@49322d04

568
SparkEnv — Spark Runtime Environment

Stopping SparkEnv —  stop Method

stop(): Unit

stop checks isStopped internal flag and does nothing when enabled.

Note stop is a private[spark] method.

Otherwise, stop turns isStopped flag on, stops all pythonWorkers and requests the
following services to stop:

1. MapOutputTracker

2. ShuffleManager

3. BroadcastManager

4. BlockManager

5. BlockManagerMaster

6. MetricsSystem

7. OutputCommitCoordinator

stop requests RpcEnv to shut down and waits till it terminates.

Only on the driver, stop deletes the temporary directory. You can see the following WARN
message in the logs if the deletion fails.

WARN Exception while deleting Spark temp dir: [path]

Note stop is used when SparkContext stops (on the driver) and Executor stops.

set Method

set(e: SparkEnv): Unit

set saves the input SparkEnv to env internal registry (as the default SparkEnv ).

Note set is used when…​FIXME

Settings

569
SparkEnv — Spark Runtime Environment

Table 4. Spark Properties

Spark Property Default Value Description

Serializer
TIP: Enable DEBUG
logging level for
org.apache.spark.Spar
spark.serializer org.apache.spark.serializer.JavaSerializer
logger to see the curre
value.
` DEBUG SparkEnv: Usi
serializer: [serialize

spark.closure.serializer org.apache.spark.serializer.JavaSerializer Serializer

Controls what type of

MemoryManager
When enabled (i.e.
spark.memory.useLegacyMode false it is the legacy
StaticMemoryManager
UnifiedMemoryManag
otherwise (i.e.

570
DAGScheduler — Stage-Oriented Scheduler

DAGScheduler — Stage-Oriented Scheduler
The introduction that follows was highly influenced by the scaladoc of
org.apache.spark.scheduler.DAGScheduler. As DAGScheduler is a private
class it does not appear in the official API documentation. You are strongly
Note encouraged to read the sources and only then read this and the related pages
afterwards.
"Reading the sources", I say?! Yes, I am kidding!

Introduction
DAGScheduler is the scheduling layer of Apache Spark that implements stage-oriented
scheduling. It transforms a logical execution plan (i.e. RDD lineage of dependencies built
using RDD transformations) to a physical execution plan (using stages).

Figure 1. DAGScheduler Transforming RDD Lineage Into Stage DAG

571
DAGScheduler — Stage-Oriented Scheduler

After an action has been called, SparkContext hands over a logical plan to DAGScheduler
that it in turn translates to a set of stages that are submitted as TaskSets for execution (see
Execution Model).

Figure 2. Executing action leads to new ResultStage and ActiveJob in DAGScheduler

The fundamental concepts of DAGScheduler are jobs and stages (refer to Jobs and Stages
respectively) that it tracks through internal registries and counters.

DAGScheduler works solely on the driver and is created as part of SparkContext’s

initialization (right after TaskScheduler and SchedulerBackend are ready).

572
DAGScheduler — Stage-Oriented Scheduler

Figure 3. DAGScheduler as created by SparkContext with other services

DAGScheduler does three things in Spark (thorough explanations follow):

Computes an execution DAG, i.e. DAG of stages, for a job.

Determines the preferred locations to run each task on.

Handles failures due to shuffle output files being lost.

DAGScheduler computes a directed acyclic graph (DAG) of stages for each job, keeps track

of which RDDs and stage outputs are materialized, and finds a minimal schedule to run jobs.
It then submits stages to TaskScheduler.

In addition to coming up with the execution DAG, DAGScheduler also determines the
preferred locations to run each task on, based on the current cache status, and passes the
information to TaskScheduler.

DAGScheduler tracks which RDDs are cached (or persisted) to avoid "recomputing" them,

i.e. redoing the map side of a shuffle. DAGScheduler remembers what ShuffleMapStages
have already produced output files (that are stored in BlockManagers).

DAGScheduler is only interested in cache location coordinates, i.e. host and executor id, per
partition of a RDD.

Caution FIXME: A diagram, please

573
DAGScheduler — Stage-Oriented Scheduler

Furthermore, it handles failures due to shuffle output files being lost, in which case old
stages may need to be resubmitted. Failures within a stage that are not caused by shuffle
file loss are handled by the TaskScheduler itself, which will retry each task a small number of
times before cancelling the whole stage.

DAGScheduler uses an event queue architecture in which a thread can post

DAGSchedulerEvent events, e.g. a new job or stage being submitted, that DAGScheduler

reads and executes sequentially. See the section Internal Event Loop - dag-scheduler-event-
loop.

DAGScheduler runs stages in topological order.

Table 1. DAGScheduler’s Internal Properties

Name Initial Value Description
metricsSource DAGSchedulerSource FIXME

Table 2. DAGScheduler’s Internal Registries and Counters

Name Description
activeJobs ActiveJob instances

Block locations per RDD and partition.

Uses TaskLocation that includes a host name and an

executor id on that host (as ExecutorCacheTaskLocation ).
The keys are RDDs (their ids) and the values are arrays
indexed by partition numbers.
cacheLocs
Each entry is a set of block locations where a RDD
partition is cached, i.e. the BlockManagers of the blocks.
Initialized empty when DAGScheduler is created.
Used when DAGScheduler is requested for the locations
of the cache blocks of a RDD or clear them.

failedEpoch
The lookup table of lost executors and the epoch of the
event.

failedStages
Stages that failed due to fetch failures (when a task fails
with FetchFailed exception).

jobIdToActiveJob The lookup table of ActiveJob s per job id.

jobIdToStageIds The lookup table of all stages per ActiveJob id

The next job id counting from 0 .

574
DAGScheduler — Stage-Oriented Scheduler

Used when DAGScheduler submits a job and a map

stage, and runs an approximate job.

The next stage id counting from 0 .

nextStageId
Used when DAGScheduler creates a shuffle map stage
and a result stage. It is the key in stageIdToStage.

The set of stages that are currently "running".

runningStages A stage is added when submitMissingTasks gets
executed (without first checking if the stage has not
already been added).

shuffleIdToMapStage
The lookup table of ShuffleMapStages per
ShuffleDependency.

The lookup table for stages per their ids.

Used when DAGScheduler creates a shuffle map stage,
creates a result stage, cleans up job state and
independent stages, is informed that a task is started, a
stageIdToStage
taskset has failed, a job is submitted (to compute a
ResultStage ), a map stage was submitted, a task has
completed or a stage was cancelled, updates
accumulators, aborts a stage and fails a job and
independent stages.

waitingStages The stages with parents to be computed

Enable INFO , DEBUG or TRACE logging levels for

org.apache.spark.scheduler.DAGSchedule logger to see what happens inside
DAGScheduler .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.scheduler.DAGScheduler=TRACE

Refer to Logging.

DAGScheduler uses SparkContext, TaskScheduler, LiveListenerBus, MapOutputTracker

and BlockManager for its services. However, at the very minimum, DAGScheduler takes a
SparkContext only (and requests SparkContext for the other services).

DAGScheduler reports metrics about its execution (refer to the section Metrics).

575
DAGScheduler — Stage-Oriented Scheduler

When DAGScheduler schedules a job as a result of executing an action on a RDD or calling

SparkContext.runJob() method directly, it spawns parallel tasks to compute (partial) results
per partition.

Running Approximate Job —  runApproximateJob

Method
Caution FIXME

createResultStage Internal Method

createResultStage(
rdd: RDD[_],
func: (TaskContext, Iterator[_]) => _,
partitions: Array[Int],
jobId: Int,
callSite: CallSite): ResultStage

Caution FIXME

updateJobIdStageIdMaps Method

Caution FIXME

Creating DAGScheduler Instance

DAGScheduler takes the following when created:

SparkContext

TaskScheduler

LiveListenerBus

MapOutputTrackerMaster

BlockManagerMaster

SparkEnv

Clock (defaults to SystemClock )

DAGScheduler initializes the internal registries and counters.

576
DAGScheduler — Stage-Oriented Scheduler

DAGScheduler sets itself in the given TaskScheduler and in the end starts DAGScheduler

Event Bus.

DAGScheduler can reference all the services through a single SparkContext with
Note
or without specifying explicit TaskScheduler.

LiveListenerBus Event Bus for SparkListenerEvents 

—  listenerBus Property

listenerBus: LiveListenerBus

listenerBus is a LiveListenerBus to post scheduling events and is passed in when

DAGScheduler is created.

executorHeartbeatReceived Method

executorHeartbeatReceived(
execId: String,
accumUpdates: Array[(Long, Int, Int, Seq[AccumulableInfo])],
blockManagerId: BlockManagerId): Boolean

executorHeartbeatReceived posts a SparkListenerExecutorMetricsUpdate (to listenerBus)

and informs BlockManagerMaster that blockManagerId block manager is alive (by posting
BlockManagerHeartbeat).

executorHeartbeatReceived is called when TaskSchedulerImpl handles

Note
executorHeartbeatReceived .

Cleaning Up After ActiveJob and Independent Stages 

—  cleanupStateForJobAndIndependentStages
Method

cleanupStateForJobAndIndependentStages(job: ActiveJob): Unit

cleanupStateForJobAndIndependentStages cleans up the state for job and any stages that

are not part of any other job.

cleanupStateForJobAndIndependentStages looks the job up in the internal jobIdToStageIds

registry.

If no stages are found, the following ERROR is printed out to the logs:

577
DAGScheduler — Stage-Oriented Scheduler

ERROR No stages registered for job [jobId]

Oterwise, cleanupStateForJobAndIndependentStages uses stageIdToStage registry to find the

stages (the real objects not ids!).

For each stage, cleanupStateForJobAndIndependentStages reads the jobs the stage belongs
to.

If the job does not belong to the jobs of the stage, the following ERROR is printed out to
the logs:

ERROR Job [jobId] not registered for stage [stageId] even though that stage was regist
ered for the job

If the job was the only job for the stage, the stage (and the stage id) gets cleaned up from
the registries, i.e. runningStages, shuffleIdToMapStage, waitingStages, failedStages and
stageIdToStage.

While removing from runningStages, you should see the following DEBUG message in the
logs:

DEBUG Removing running stage [stageId]

While removing from waitingStages, you should see the following DEBUG message in the
logs:

DEBUG Removing stage [stageId] from waiting set.

While removing from failedStages, you should see the following DEBUG message in the
logs:

DEBUG Removing stage [stageId] from failed set.

After all cleaning (using stageIdToStage as the source registry), if the stage belonged to the
one and only job , you should see the following DEBUG message in the logs:

DEBUG After removal of stage [stageId], remaining stages = [stageIdToStage.size]

The job is removed from jobIdToStageIds, jobIdToActiveJob, activeJobs registries.

The final stage of the job is removed, i.e. ResultStage or ShuffleMapStage.

578
DAGScheduler — Stage-Oriented Scheduler

cleanupStateForJobAndIndependentStages is used in handleTaskCompletion when

Note a ResultTask has completed successfully, failJobAndIndependentStages and
markMapStageJobAsFinished.

Marking ShuffleMapStage Job Finished 

—  markMapStageJobAsFinished Method

markMapStageJobAsFinished(job: ActiveJob, stats: MapOutputStatistics): Unit

markMapStageJobAsFinished marks the active job finished and notifies Spark listeners.

Internally, markMapStageJobAsFinished marks the zeroth partition finished and increases the
number of tasks finished in job .

The job listener is notified about the 0th task succeeded.

The state of the job and independent stages are cleaned up.

Ultimately, SparkListenerJobEnd is posted to LiveListenerBus (as listenerBus) for the job ,

the current time (in millis) and JobSucceeded job result.

markMapStageJobAsFinished is used in handleMapStageSubmitted and

Note
handleTaskCompletion.

Submitting Job —  submitJob method

submitJob[T, U](
rdd: RDD[T],
func: (TaskContext, Iterator[T]) => U,
partitions: Seq[Int],
callSite: CallSite,
resultHandler: (Int, U) => Unit,
properties: Properties): JobWaiter[U]

submitJob creates a JobWaiter and posts a JobSubmitted event.

579
DAGScheduler — Stage-Oriented Scheduler

Figure 4. DAGScheduler.submitJob
Internally, submitJob does the following:

1. Checks whether partitions reference available partitions of the input rdd .

2. Increments nextJobId internal job counter.

3. Returns a 0-task JobWaiter when the number of partitions is zero.

4. Posts a JobSubmitted event and returns a JobWaiter .

You may see a IllegalArgumentException thrown when the input partitions references
partitions not in the input rdd :

Attempting to access a non-existent partition: [p]. Total number of partitions: [maxPa

rtitions]

submitJob is called when SparkContext submits a job and DAGScheduler runs

Note
a job.

submitJob assumes that the partitions of a RDD are indexed from 0 onwards in
Note
sequential order.

Submitting ShuffleDependency for Execution 

—  submitMapStage Method

580
DAGScheduler — Stage-Oriented Scheduler

submitMapStage[K, V, C](
dependency: ShuffleDependency[K, V, C],
callback: MapOutputStatistics => Unit,
callSite: CallSite,
properties: Properties): JobWaiter[MapOutputStatistics]

submitMapStage creates a JobWaiter (that it eventually returns) and posts a

MapStageSubmitted event to DAGScheduler Event Bus).

Internally, submitMapStage increments nextJobId internal counter to get the job id.

submitMapStage then creates a JobWaiter (with the job id and with one artificial task that will

however get completed only when the entire stage finishes).

submitMapStage announces the map stage submission application-wide (by posting a

MapStageSubmitted to LiveListenerBus).

A MapStageSubmitted holds the newly-created job id and JobWaiter with the

Note
input dependency , callSite and properties parameters.

submitMapStage returns the JobWaiter .

If the number of partition to compute is 0 , submitMapStage throws a SparkException :

Can't run submitMapStage on RDD with 0 partitions

submitMapStage is used when SparkContext submits a map stage for

Note
execution.

Relaying Stage Cancellation From SparkContext (by

Posting StageCancelled to DAGScheduler Event Bus) 
—  cancelStage Method

cancelStage(stageId: Int)

cancelJobGroup merely posts a StageCancelled event to the DAGScheduler Event Bus.

Note cancelStage is used exclusively when SparkContext cancels a stage.

Relaying Job Group Cancellation From SparkContext (by

Posting JobGroupCancelled to DAGScheduler Event Bus) 
—  cancelJobGroup Method

581
DAGScheduler — Stage-Oriented Scheduler

cancelJobGroup(groupId: String): Unit

cancelJobGroup prints the following INFO message to the logs followed by posting a

JobGroupCancelled event to the DAGScheduler Event Bus.

INFO Asked to cancel job group [groupId]

Note cancelJobGroup is used exclusively when SparkContext cancels a job group.

Relaying All Jobs Cancellation From SparkContext (by

Posting AllJobsCancelled to DAGScheduler Event Bus) 
—  cancelAllJobs Method

cancelAllJobs(): Unit

cancelAllJobs merely posts a AllJobsCancelled event to the DAGScheduler Event Bus.

cancelAllJobs is used exclusively when SparkContext cancels all running or

Note
scheduled Spark jobs.

Relaying Task Started From TaskSetManager (by Posting

BeginEvent to DAGScheduler Event Bus) 
—  taskStarted Method

taskStarted(task: Task[_], taskInfo: TaskInfo)

taskStarted merely posts a BeginEvent event to the DAGScheduler Event Bus.

Note taskStarted is used exclusively when a TaskSetManager starts a task.

Relaying Task Fetching/Getting Result From

TaskSetManager (by Posting GettingResultEvent to
DAGScheduler Event Bus) —  taskGettingResult
Method

taskGettingResult(taskInfo: TaskInfo)

582
DAGScheduler — Stage-Oriented Scheduler

taskGettingResult merely posts a GettingResultEvent event to the DAGScheduler Event

Bus.

taskGettingResult is used exclusively when a TaskSetManager gets notified

Note
about a task fetching result.

Relaying Task End From TaskSetManager (by Posting

CompletionEvent to DAGScheduler Event Bus) 
—  taskEnded Method

taskEnded(
task: Task[_],
reason: TaskEndReason,
result: Any,
accumUpdates: Map[Long, Any],
taskInfo: TaskInfo,
taskMetrics: TaskMetrics): Unit

taskEnded simply posts a CompletionEvent event to the DAGScheduler Event Bus.

taskEnded is used exclusively when a TaskSetManager reports task

Note
completions, i.e. success or failure.

Tip Read TaskMetrics.

Relaying TaskSet Failed From TaskSetManager (by Posting

TaskSetFailed to DAGScheduler Event Bus) 
—  taskSetFailed Method

taskSetFailed(
taskSet: TaskSet,
reason: String,
exception: Option[Throwable]): Unit

taskSetFailed simply posts a TaskSetFailed to DAGScheduler Event Bus.

The input arguments of taskSetFailed are exactly the arguments of

Note
TaskSetFailed.

Note taskSetFailed is used exclusively when a TaskSetManager is aborted.

583
DAGScheduler — Stage-Oriented Scheduler

Relaying Executor Lost From TaskSchedulerImpl (by

Posting ExecutorLost to DAGScheduler Event Bus) 
—  executorLost Method

executorLost(execId: String, reason: ExecutorLossReason): Unit

executorLost simply posts a ExecutorLost event to DAGScheduler Event Bus.

executorLost is used when TaskSchedulerImpl gets task status update (and a

Note task gets lost which is used to indicate that the executor got broken and hence
should be considered lost) or executorLost.

Relaying Executor Added From TaskSchedulerImpl (by

Posting ExecutorAdded to DAGScheduler Event Bus) 
—  executorAdded Method

executorAdded(execId: String, host: String): Unit

executorAdded simply posts a ExecutorAdded event to DAGScheduler Event Bus.

executorAdded is used exclusively when TaskSchedulerImpl is offered

Note
resources on executors (and a new executor is found in the resource offers).

Relaying Job Cancellation From SparkContext or JobWaiter

(by Posting JobCancelled to DAGScheduler Event Bus) 
—  cancelJob Method

cancelJob(jobId: Int): Unit

cancelJob prints the following INFO message and posts a JobCancelled to DAGScheduler

Event Bus.

INFO DAGScheduler: Asked to cancel job [id]

Note cancelJob is used when SparkContext or JobWaiter cancel a Spark job.

584
DAGScheduler — Stage-Oriented Scheduler

Finding Or Creating Missing Direct Parent

ShuffleMapStages (For ShuffleDependencies of Input RDD) 
—  getOrCreateParentStages Internal Method

getOrCreateParentStages(rdd: RDD[_], firstJobId: Int): List[Stage]

getOrCreateParentStages finds all direct parent ShuffleDependencies of the input rdd and

then finds ShuffleMapStage stages for each ShuffleDependency.

getOrCreateParentStages is used when DAGScheduler createShuffleMapStage

Note
and createResultStage.

Marking Stage Finished —  markStageAsFinished

Internal Method

markStageAsFinished(stage: Stage, errorMessage: Option[String] = None): Unit

Caution FIXME

Running Job —  runJob Method

runJob[T, U](
rdd: RDD[T],
func: (TaskContext, Iterator[T]) => U,
partitions: Seq[Int],
callSite: CallSite,
resultHandler: (Int, U) => Unit,
properties: Properties): Unit

runJob submits an action job to the DAGScheduler and waits for a result.

Internally, runJob executes submitJob and then waits until a result comes using JobWaiter.

When the job succeeds, you should see the following INFO message in the logs:

INFO Job [jobId] finished: [callSite], took [time] s

When the job fails, you should see the following INFO message in the logs and the
exception (that led to the failure) is thrown.

585
DAGScheduler — Stage-Oriented Scheduler

INFO Job [jobId] failed: [callSite], took [time] s

Note runJob is used when SparkContext runs a job.

Finding or Creating New ShuffleMapStages for

ShuffleDependency —  getOrCreateShuffleMapStage
Internal Method

getOrCreateShuffleMapStage(
shuffleDep: ShuffleDependency[_, _, _],
firstJobId: Int): ShuffleMapStage

getOrCreateShuffleMapStage finds or creates the ShuffleMapStage for the input

ShuffleDependency.

Internally, getOrCreateShuffleMapStage finds the ShuffleDependency in shuffleIdToMapStage

internal registry and returns one when found.

If no ShuffleDependency was available, getOrCreateShuffleMapStage finds all the missing

shuffle dependencies and creates corresponding ShuffleMapStage stages (including one for
the input shuffleDep ).

Note All the new ShuffleMapStage stages are associated with the input firstJobId .

getOrCreateShuffleMapStage is used when DAGScheduler finds or creates

missing direct parent ShuffleMapStages (for ShuffleDependencies of given
Note
RDD), getMissingParentStages (for ShuffleDependencies), is notified that
ShuffleDependency was submitted, and checks if a stage depends on another.

Creating ShuffleMapStage for ShuffleDependency (Copying

Shuffle Map Output Locations From Previous Jobs) 
—  createShuffleMapStage Method

createShuffleMapStage(
shuffleDep: ShuffleDependency[_, _, _],
jobId: Int): ShuffleMapStage

createShuffleMapStage creates a ShuffleMapStage for the input ShuffleDependency and

jobId (of a ActiveJob) possibly copying shuffle map output locations from previous jobs to

avoid recomputing records.

586
DAGScheduler — Stage-Oriented Scheduler

When a ShuffleMapStage is created, the id is generated (using nextStageId

internal counter), rdd is from ShuffleDependency , numTasks is the number of
Note partitions in the RDD, all parents are looked up (and possibly created), the
jobId is given, callSite is the creationSite of the RDD, and shuffleDep is
the input ShuffleDependency .

Internally, createShuffleMapStage first finds or creates missing parent ShuffleMapStage

stages of the associated RDD.

Note ShuffleDependency is associated with exactly one RDD[Product2[K, V]] .

createShuffleMapStage creates a ShuffleMapStage (with the stage id from nextStageId

internal counter).

Note The RDD of the new ShuffleMapStage is from the input ShuffleDependency.

createShuffleMapStage registers the ShuffleMapStage in stageIdToStage and

shuffleIdToMapStage internal registries.

createShuffleMapStage calls updateJobIdStageIdMaps.

If MapOutputTrackerMaster tracks the input ShuffleDependency (because other jobs have

already computed it), createShuffleMapStage requests the serialized ShuffleMapStage
outputs, deserializes them and registers with the new ShuffleMapStage .

Note MapOutputTrackerMaster was defined when DAGScheduler was created.

Figure 5. DAGScheduler Asks MapOutputTrackerMaster Whether Shuffle Map Output Is

Already Tracked
If however MapOutputTrackerMaster does not track the input ShuffleDependency , you should
see the following INFO message in the logs and createShuffleMapStage registers the
ShuffleDependency with MapOutputTrackerMaster .

INFO Registering RDD [id] ([creationSite])

587
DAGScheduler — Stage-Oriented Scheduler

createShuffleMapStage returns the new ShuffleMapStage .

createShuffleMapStage is executed only when DAGScheduler finds or creates

Note
parent ShuffleMapStage stages for a ShuffleDependency .

Clearing Cache of RDD Block Locations 

—  clearCacheLocs Internal Method

clearCacheLocs(): Unit

clearCacheLocs clears the internal registry of the partition locations per RDD.

DAGScheduler clears the cache while resubmitting failed stages, and as a result
Note
of JobSubmitted, MapStageSubmitted, CompletionEvent, ExecutorLost events.

Finding Missing ShuffleDependencies For RDD 

—  getMissingAncestorShuffleDependencies
Internal Method

getMissingAncestorShuffleDependencies(rdd: RDD[_]): Stack[ShuffleDependency[_, _, _]]

getMissingAncestorShuffleDependencies finds all missing shuffle dependencies for the given

RDD traversing its dependency chain (aka RDD lineage).

A missing shuffle dependency of a RDD is a dependency not registered in

Note
shuffleIdToMapStage internal registry.

Internally, getMissingAncestorShuffleDependencies finds direct parent shuffle dependencies 

of the input RDD and collects the ones that are not registered in shuffleIdToMapStage
internal registry. It repeats the process for the RDDs of the parent shuffle dependencies.

getMissingAncestorShuffleDependencies is used when DAGScheduler finds all

Note
ShuffleMapStage stages for a ShuffleDependency .

Finding Direct Parent Shuffle Dependencies of RDD 

—  getShuffleDependencies Internal Method

getShuffleDependencies(rdd: RDD[_]): HashSet[ShuffleDependency[_, _, _]]

getShuffleDependencies finds direct parent shuffle dependencies for the given RDD.

588
DAGScheduler — Stage-Oriented Scheduler

Figure 6. getShuffleDependencies Finds Direct Parent ShuffleDependencies (shuffle1 and

shuffle2)
Internally, getShuffleDependencies takes the direct shuffle dependencies of the input RDD
and direct shuffle dependencies of all the parent non- ShuffleDependencies in the
dependency chain (aka RDD lineage).

getShuffleDependencies is used when DAGScheduler finds or creates missing

Note direct parent ShuffleMapStages (for ShuffleDependencies of given RDD) and
finds all missing shuffle dependencies for a given RDD.

Failing Job and Independent Single-Job Stages 

—  failJobAndIndependentStages Internal Method

failJobAndIndependentStages(
job: ActiveJob,
failureReason: String,
exception: Option[Throwable] = None): Unit

The internal failJobAndIndependentStages method fails the input job and all the stages that
are only used by the job.

Internally, failJobAndIndependentStages uses jobIdToStageIds internal registry to look up

the stages registered for the job.

If no stages could be found, you should see the following ERROR message in the logs:

ERROR No stages registered for job [id]

Otherwise, for every stage, failJobAndIndependentStages finds the job ids the stage belongs
to.

If no stages could be found or the job is not referenced by the stages, you should see the
following ERROR message in the logs:

589
DAGScheduler — Stage-Oriented Scheduler

ERROR Job [id] not registered for stage [id] even though that stage was registered for
the job

Only when there is exactly one job registered for the stage and the stage is in RUNNING
state (in runningStages internal registry), TaskScheduler is requested to cancel the stage’s
tasks and marks the stage finished.

failJobAndIndependentStages is called from handleJobCancellation and

Note
abortStage .

failJobAndIndependentStages uses jobIdToStageIds, stageIdToStage, and

Note
runningStages internal registries.

Aborting Stage —  abortStage Internal Method

abortStage(
failedStage: Stage,
reason: String,
exception: Option[Throwable]): Unit

abortStage is an internal method that finds all the active jobs that depend on the

failedStage stage and fails them.

Internally, abortStage looks the failedStage stage up in the internal stageIdToStage

registry and exits if there the stage was not registered earlier.

If it was, abortStage finds all the active jobs (in the internal activeJobs registry) with the
final stage depending on the failedStage stage.

At this time, the completionTime property (of the failed stage’s StageInfo) is assigned to the
current time (millis).

All the active jobs that depend on the failed stage (as calculated above) and the stages that
do not belong to other jobs (aka independent stages) are failed (with the failure reason being
"Job aborted due to stage failure: [reason]" and the input exception ).

If there are no jobs depending on the failed stage, you should see the following INFO
message in the logs:

INFO Ignoring failure of [failedStage] because all jobs depending on it are done

abortStage is used to handle TaskSetFailed event, when submitting a stage

Note
with no active job

590
DAGScheduler — Stage-Oriented Scheduler

Checking Out Stage Dependency on Given Stage 

—  stageDependsOn Method

stageDependsOn(stage: Stage, target: Stage): Boolean

stageDependsOn compares two stages and returns whether the stage depends on target

stage (i.e. true ) or not (i.e. false ).

Note A stage A depends on stage B if B is among the ancestors of A .

Internally, stageDependsOn walks through the graph of RDDs of the input stage . For every
RDD in the RDD’s dependencies (using RDD.dependencies ) stageDependsOn adds the RDD
of a NarrowDependency to a stack of RDDs to visit while for a ShuffleDependency it finds
ShuffleMapStage stages for a ShuffleDependency for the dependency and the stage 's first

job id that it later adds to a stack of RDDs to visit if the map stage is ready, i.e. all the
partitions have shuffle outputs.

After all the RDDs of the input stage are visited, stageDependsOn checks if the target 's
RDD is among the RDDs of the stage , i.e. whether the stage depends on target stage.

dag-scheduler-event-loop — DAGScheduler Event Bus

eventProcessLoop is DAGScheduler’s event bus to which Spark (by submitJob) posts jobs to

schedule their execution. Later on, TaskSetManager talks back to DAGScheduler to inform
about the status of the tasks using the same "communication channel".

It allows Spark to release the current thread when posting happens and let the event loop
handle events on a separate thread - asynchronously.

…​IMAGE…​FIXME

Caution FIXME statistics? MapOutputStatistics ?

Submitting Waiting Child Stages for Execution 

—  submitWaitingChildStages Internal Method

submitWaitingChildStages(parent: Stage): Unit

submitWaitingChildStages submits for execution all waiting stages for which the input

parent Stage is the direct parent.

591
DAGScheduler — Stage-Oriented Scheduler

Note Waiting stages are the stages registered in waitingStages internal registry.

When executed, you should see the following TRACE messages in the logs:

TRACE DAGScheduler: Checking if any dependencies of [parent] are now runnable

TRACE DAGScheduler: running: [runningStages]
TRACE DAGScheduler: waiting: [waitingStages]
TRACE DAGScheduler: failed: [failedStages]

submitWaitingChildStages finds child stages of the input parent stage, removes them from

waitingStages internal registry, and submits one by one sorted by their job ids.

submitWaitingChildStages is executed when DAGScheduler submits missing

Note
tasks for stage and handles successful ShuffleMapTask completion.

Submitting Stage or Its Missing Parents for Execution 

—  submitStage Internal Method

submitStage(stage: Stage)

submitStage is an internal method that DAGScheduler uses to submit the input stage or its

missing parents (if there any stages not computed yet before the input stage could).

Note submitStage is also used to resubmit failed stages.

submitStage recursively submits any missing parents of the stage .

Internally, submitStage first finds the earliest-created job id that needs the stage .

A stage itself tracks the jobs (their ids) it belongs to (using the internal jobIds
Note
registry).

The following steps depend on whether there is a job or not.

If there are no jobs that require the stage , submitStage aborts it with the reason:

No active job for stage [id]

If however there is a job for the stage , you should see the following DEBUG message in
the logs:

DEBUG DAGScheduler: submitStage([stage])

592
DAGScheduler — Stage-Oriented Scheduler

submitStage checks the status of the stage and continues when it was not recorded in

waiting, running or failed internal registries. It simply exits otherwise.

With the stage ready for submission, submitStage calculates the list of missing parent
stages of the stage (sorted by their job ids). You should see the following DEBUG message
in the logs:

DEBUG DAGScheduler: missing: [missing]

When the stage has no parent stages missing, you should see the following INFO
message in the logs:

INFO DAGScheduler: Submitting [stage] ([stage.rdd]), which has no missing parents

submitStage submits the stage (with the earliest-created job id) and finishes.

If however there are missing parent stages for the stage , submitStage submits all the
parent stages, and the stage is recorded in the internal waitingStages registry.

submitStage is executed when DAGScheduler submits missing parent map

Note stages (of a stage) recursively or waiting child stages, resubmits failed stages,
and handles JobSubmitted, MapStageSubmitted, or CompletionEvent events.

Fault recovery - stage attempts

A single stage can be re-executed in multiple attempts due to fault recovery. The number of
attempts is configured (FIXME).

If TaskScheduler reports that a task failed because a map output file from a previous stage
was lost, the DAGScheduler resubmits the lost stage. This is detected through a
CompletionEvent with FetchFailed , or an ExecutorLost event. DAGScheduler will wait a

small amount of time to see whether other nodes or tasks fail, then resubmit TaskSets for
any lost stage(s) that compute the missing tasks.

Please note that tasks from the old attempts of a stage could still be running.

A stage object tracks multiple StageInfo objects to pass to Spark listeners or the web UI.

The latest StageInfo for the most recent attempt for a stage is accessible through
latestInfo .

Preferred Locations

593
DAGScheduler — Stage-Oriented Scheduler

DAGScheduler computes where to run each task in a stage based on the preferred locations

of its underlying RDDs, or the location of cached or shuffle data.

Adaptive Query Planning / Adaptive Scheduling

See SPARK-9850 Adaptive execution in Spark for the design document. The work is
currently in progress.

DAGScheduler.submitMapStage method is used for adaptive query planning, to run map

stages and look at statistics about their outputs before submitting downstream stages.

ScheduledExecutorService daemon services

DAGScheduler uses the following ScheduledThreadPoolExecutors (with the policy of
removing cancelled tasks from a work queue at time of cancellation):

dag-scheduler-message - a daemon thread pool using

j.u.c.ScheduledThreadPoolExecutor with core pool size 1 . It is used to post a

ResubmitFailedStages event when FetchFailed is reported.

They are created using ThreadUtils.newDaemonSingleThreadScheduledExecutor method that

uses Guava DSL to instantiate a ThreadFactory.

Finding Missing Parent ShuffleMapStages For Stage 

—  getMissingParentStages Internal Method

getMissingParentStages(stage: Stage): List[Stage]

getMissingParentStages finds missing parent ShuffleMapStages in the dependency graph of

the input stage (using the breadth-first search algorithm).

Internally, getMissingParentStages starts with the stage 's RDD and walks up the tree of all
parent RDDs to find uncached partitions.

Note A Stage tracks the associated RDD using rdd property.

An uncached partition of a RDD is a partition that has Nil in the internal

Note registry of partition locations per RDD (which results in no RDD blocks in any of
the active BlockManagers on executors).

getMissingParentStages traverses the parent dependencies of the RDD and acts according

to their type, i.e. ShuffleDependency or NarrowDependency.

594
DAGScheduler — Stage-Oriented Scheduler

ShuffleDependency and NarrowDependency are the main top-level

Note
Dependencies.

For each NarrowDependency , getMissingParentStages simply marks the corresponding RDD

to visit and moves on to a next dependency of a RDD or works on another unvisited parent
RDD.

Note NarrowDependency is a RDD dependency that allows for pipelined execution.

getMissingParentStages focuses on ShuffleDependency dependencies.

ShuffleDependency is a RDD dependency that represents a dependency on the

Note
output of a ShuffleMapStage, i.e. shuffle map stage.

For each ShuffleDependency , getMissingParentStages finds ShuffleMapStage stages. If the

ShuffleMapStage is not available, it is added to the set of missing (map) stages.

A ShuffleMapStage is available when all its partitions are computed, i.e. results
Note
are available (as blocks).

Caution FIXME…​IMAGE with ShuffleDependencies queried

getMissingParentStages is used when DAGScheduler submits missing parent

Note ShuffleMapStage s (of a stage) and handles JobSubmitted and
MapStageSubmitted events.

Submitting Missing Tasks of Stage (in a Spark Job) 

—  submitMissingTasks Internal Method

submitMissingTasks(stage: Stage, jobId: Int): Unit

submitMissingTasks …​FIXME

Caution FIXME

When executed, you should see the following DEBUG message in the logs:

DEBUG DAGScheduler: submitMissingTasks([stage])

The input stage 's pendingPartitions internal field is cleared (it is later filled out with the
partitions to run tasks for).

595
DAGScheduler — Stage-Oriented Scheduler

submitMissingTasks requests the stage for missing partitions, i.e. the indices of the

partitions to compute.

submitMissingTasks marks the stage as running (i.e. adds it to runningStages internal

registry).

submitMissingTasks notifies OutputCommitCoordinator that the stage is started.

The input maxPartitionId argument handed over to OutputCommitCoordinator

depends on the type of the stage, i.e. ShuffleMapStage or ResultStage .
Note
ShuffleMapStage tracks the number of partitions itself (as numPartitions
property) while ResultStage uses the internal RDD to find out the number.

For the missing partitions, submitMissingTasks computes their task locality preferences,
i.e. pairs of missing partition ids and their task locality information. HERE NOTE: The locality
information of a RDD is called preferred locations.

In case of non-fatal exceptions at this time (while getting the locality information),
submitMissingTasks creates a new stage attempt.

Note A stage attempt is an internal property of a stage.

Despite the failure to submit any tasks, submitMissingTasks does announce that at least
there was an attempt on LiveListenerBus by posting a SparkListenerStageSubmitted
message.

The Spark application’s LiveListenerBus is given when DAGScheduler is

Note
created.

submitMissingTasks then aborts the stage (with the reason being "Task creation failed"

followed by the exception).

The stage is removed from the internal runningStages collection of stages and
submitMissingTasks exits.

When no exception was thrown (while computing the locality information for tasks),
submitMissingTasks creates a new stage attempt and announces it on LiveListenerBus by

posting a SparkListenerStageSubmitted message.

Yes, that is correct. Whether there was a task submission failure or not,
Note submitMissingTasks creates a new stage attempt and posts a
SparkListenerStageSubmitted . That makes sense, doesn’t it?

At that time, submitMissingTasks serializes the RDD (of the stage for which tasks are
submitted for) and, depending on the type of the stage, the ShuffleDependency (for
ShuffleMapStage ) or the function (for ResultStage ).

596
DAGScheduler — Stage-Oriented Scheduler

submitMissingTasks uses a closure Serializer that DAGScheduler creates for

Note the entire lifetime when it is created. The closure serializer is available through
SparkEnv.

The serialized so-called task binary bytes are "wrapped" as a broadcast variable (to make it
available for executors to execute later on).

That exact moment should make clear how important broadcast variables are
Note for Spark itself that you, a Spark developer, can use, too, to distribute data
across the nodes in a Spark application in a very efficient way.

Any NotSerializableException exceptions lead to aborting the stage (with the reason being
"Task not serializable: [exception]") and removing the stage from the internal runningStages
collection of stages. submitMissingTasks exits.

Any non-fatal exceptions lead to aborting the stage (with the reason being "Task serialization
failed" followed by the exception) and removing the stage from the internal runningStages
collection of stages. submitMissingTasks exits.

With no exceptions along the way, submitMissingTasks computes a collection of tasks to

execute for the missing partitions (of the stage ).

submitMissingTasks creates a ShuffleMapTask or ResultTask for every missing partition of

the stage being ShuffleMapStage or ResultStage, respectively. submitMissingTasks uses

the preferred locations (computed earlier) per partition.

Caution FIXME Image with creating tasks for partitions in the stage.

Any non-fatal exceptions lead to aborting the stage (with the reason being "Task creation
failed" followed by the exception) and removing the stage from the internal runningStages
collection of stages. submitMissingTasks exits.

If there are tasks to submit for execution (i.e. there are missing partitions in the stage), you
should see the following INFO message in the logs:

INFO DAGScheduler: Submitting [size] missing tasks from [stage] ([rdd])

submitMissingTasks records the partitions (of the tasks) in the stage 's pendingPartitions

property.

pendingPartitions property of the stage was cleared when

Note
submitMissingTasks started.

You should see the following DEBUG message in the logs:

597
DAGScheduler — Stage-Oriented Scheduler

DEBUG DAGScheduler: New pending partitions: [pendingPartitions]

submitMissingTasks submits the tasks to TaskScheduler for execution (with the id of the

stage , attempt id, the input jobId , and the properties of the ActiveJob with jobId ).

Note A TaskScheduler was given when DAGScheduler was created.

Caution FIXME What are the ActiveJob properties for? Where are they used?

submitMissingTasks records the submission time in the stage’s StageInfo and exits.

If however there are no tasks to submit for execution, submitMissingTasks marks the stage
as finished (with no errorMessage ).

You should see a DEBUG message that varies per the type of the input stage which are:

DEBUG DAGScheduler: Stage [stage] is actually done; (available: [isAvailable],availabl

e outputs: [numAvailableOutputs],partitions: [numPartitions])

or

DEBUG DAGScheduler: Stage [stage] is actually done; (partitions: [numPartitions])

for ShuffleMapStage and ResultStage , respectively.

In the end, with no tasks to submit for execution, submitMissingTasks submits waiting child
stages for execution and exits.

submitMissingTasks is called when DAGScheduler submits a stage for

Note
execution.

Computing Preferred Locations for Missing Partitions 

—  getPreferredLocs Method

getPreferredLocs(rdd: RDD[_], partition: Int): Seq[TaskLocation]

getPreferredLocs is simply an alias for the internal (recursive) getPreferredLocsInternal.

getPreferredLocs is used when SparkContext gets the locality information for

Note
a RDD partition and DAGScheduler submits missing tasks for a stage.

598
DAGScheduler — Stage-Oriented Scheduler

Finding BlockManagers (Executors) for Cached RDD

Partitions (aka Block Location Discovery) 
—  getCacheLocs Internal Method

getCacheLocs(rdd: RDD[_]): IndexedSeq[Seq[TaskLocation]]

getCacheLocs gives TaskLocations (block locations) for the partitions of the input rdd .

getCacheLocs caches lookup results in cacheLocs internal registry.

The size of the collection from getCacheLocs is exactly the number of partitions
Note
in rdd RDD.

The size of every TaskLocation collection (i.e. every entry in the result of
Note getCacheLocs ) is exactly the number of blocks managed using BlockManagers
on executors.

Internally, getCacheLocs finds rdd in the cacheLocs internal registry (of partition locations
per RDD).

If rdd is not in cacheLocs internal registry, getCacheLocs branches per its storage level.

For NONE storage level (i.e. no caching), the result is an empty locations (i.e. no location
preference).

For other non- NONE storage levels, getCacheLocs requests BlockManagerMaster for block
locations that are then mapped to TaskLocations with the hostname of the owning
BlockManager for a block (of a partition) and the executor id.

getCacheLocs uses BlockManagerMaster that was defined when DAGScheduler

Note
was created.

getCacheLocs records the computed block locations per partition (as TaskLocation) in

cacheLocs internal registry.

getCacheLocs requests locations from BlockManagerMaster using RDDBlockId

Note with the RDD id and the partition indices (which implies that the order of the
partitions matters to request proper blocks).

DAGScheduler uses TaskLocations (with host and executor) while

Note BlockManagerMaster uses BlockManagerId (to track similar information, i.e.
block locations).

getCacheLocs is used when DAGScheduler finds missing parent MapStages

Note
and getPreferredLocsInternal.

599
DAGScheduler — Stage-Oriented Scheduler

Finding Placement Preferences for RDD Partition

(recursively) —  getPreferredLocsInternal Internal
Method

getPreferredLocsInternal(
rdd: RDD[_],
partition: Int,
visited: HashSet[(RDD[_], Int)]): Seq[TaskLocation]

getPreferredLocsInternal first finds the TaskLocations for the partition of the rdd

(using cacheLocs internal cache) and returns them.

Otherwise, if not found, getPreferredLocsInternal requests rdd for the preferred locations
of partition and returns them.

Preferred locations of the partitions of a RDD are also called placement

Note
preferences or locality preferences.

Otherwise, if not found, getPreferredLocsInternal finds the first parent NarrowDependency

and (recursively) finds TaskLocations .

If all the attempts fail to yield any non-empty result, getPreferredLocsInternal returns an
empty collection of TaskLocations.

getPreferredLocsInternal is used exclusively when DAGScheduler computes

Note
preferred locations for missing partitions.

Stopping DAGScheduler —  stop Method

stop(): Unit

stop stops the internal dag-scheduler-message thread pool, dag-scheduler-event-loop, and

TaskScheduler.

Updating Accumulators with Partial Values from Completed

Tasks —  updateAccumulators Internal Method

updateAccumulators(event: CompletionEvent): Unit

The private updateAccumulators method merges the partial values of accumulators from a
completed task into their "source" accumulators on the driver.

600
DAGScheduler — Stage-Oriented Scheduler

Note It is called by handleTaskCompletion.

For each AccumulableInfo in the CompletionEvent , a partial value from a task is obtained
(from AccumulableInfo.update ) and added to the driver’s accumulator (using
Accumulable.++= method).

For named accumulators with the update value being a non-zero value, i.e. not
Accumulable.zero :

stage.latestInfo.accumulables for the AccumulableInfo.id is set

CompletionEvent.taskInfo.accumulables has a new AccumulableInfo added.

FIXME Where are Stage.latestInfo.accumulables and

Caution
CompletionEvent.taskInfo.accumulables used?

Settings
Table 3. Spark Properties
Spark Property Default Value Description
When enabled (i.e. true ), task
spark.test.noStageRetry false
failures with FetchFailed exceptions
will not cause stage retries, in order to
surface the problem. Used for testing.

601
Jobs

ActiveJob
A job (aka action job or active job) is a top-level work item (computation) submitted to
DAGScheduler to compute the result of an action (or for Adaptive Query Planning / Adaptive
Scheduling).

Figure 1. RDD actions submit jobs to DAGScheduler

Computing a job is equivalent to computing the partitions of the RDD the action has been
executed upon. The number of partitions in a job depends on the type of a stage -
ResultStage or ShuffleMapStage.

A job starts with a single target RDD, but can ultimately include other RDDs that are all part
of the target RDD’s lineage graph.

The parent stages are the instances of ShuffleMapStage.

Figure 2. Computing a job is computing the partitions of an RDD

Note that not all partitions have always to be computed for ResultStages for
Note
actions like first() and lookup() .

Internally, a job is represented by an instance of private[spark] class

org.apache.spark.scheduler.ActiveJob.

602
Jobs

FIXME
Caution
Where are instances of ActiveJob used?

A job can be one of two logical types (that are only distinguished by an internal finalStage
field of ActiveJob ):

Map-stage job that computes the map output files for a ShuffleMapStage (for
submitMapStage ) before any downstream stages are submitted.

It is also used for Adaptive Query Planning / Adaptive Scheduling, to look at map output
statistics before submitting later stages.

Result job that computes a ResultStage to execute an action.

Jobs track how many partitions have already been computed (using finished array of
Boolean elements).

603
Stage — Physical Unit Of Execution

Stage — Physical Unit Of Execution

A stage is a physical unit of execution. It is a step in a physical execution plan.

A stage is a set of parallel tasks — one task per partition (of an RDD that computes partial
results of a function executed as part of a Spark job).

Figure 1. Stage, tasks and submitting a job

In other words, a Spark job is a computation with that computation sliced into stages.

A stage is uniquely identified by id . When a stage is created, DAGScheduler increments

internal counter nextStageId to track the number of stage submissions.

A stage can only work on the partitions of a single RDD (identified by rdd ), but can be
associated with many other dependent parent stages (via internal field parents ), with the
boundary of a stage marked by shuffle dependencies.

Submitting a stage can therefore trigger execution of a series of dependent parent stages
(refer to RDDs, Job Execution, Stages, and Partitions).

Figure 2. Submitting a job triggers execution of the stage and its parent stages
Finally, every stage has a firstJobId that is the id of the job that submitted the stage.

There are two types of stages:

604
Stage — Physical Unit Of Execution

ShuffleMapStage is an intermediate stage (in the execution DAG) that produces data for
other stage(s). It writes map output files for a shuffle. It can also be the final stage in a
job in Adaptive Query Planning / Adaptive Scheduling.

ResultStage is the final stage that executes a Spark action in a user program by running
a function on an RDD.

When a job is submitted, a new stage is created with the parent ShuffleMapStage linked — 
they can be created from scratch or linked to, i.e. shared, if other jobs use them already.

Figure 3. DAGScheduler and Stages for a job

A stage tracks the jobs (their ids) it belongs to (using the internal jobIds registry).

DAGScheduler splits up a job into a collection of stages. Each stage contains a sequence of
narrow transformations that can be completed without shuffling the entire data set,
separated at shuffle boundaries, i.e. where shuffle occurs. Stages are thus a result of
breaking the RDD graph at shuffle boundaries.

605
Stage — Physical Unit Of Execution

Figure 4. Graph of Stages

Shuffle boundaries introduce a barrier where stages/tasks must wait for the previous stage
to finish before they fetch map outputs.

Figure 5. DAGScheduler splits a job into stages

RDD operations with narrow dependencies, like map() and filter() , are pipelined
together into one set of tasks in each stage, but operations with shuffle dependencies
require multiple stages, i.e. one to write a set of map output files, and another to read those
files after a barrier.

In the end, every stage will have only shuffle dependencies on other stages, and may
compute multiple operations inside it. The actual pipelining of these operations happens in
the RDD.compute() functions of various RDDs, e.g. MappedRDD , FilteredRDD , etc.

606
Stage — Physical Unit Of Execution

At some point of time in a stage’s life, every partition of the stage gets transformed into a
task - ShuffleMapTask or ResultTask for ShuffleMapStage and ResultStage, respectively.

Partitions are computed in jobs, and result stages may not always need to compute all
partitions in their target RDD, e.g. for actions like first() and lookup() .

DAGScheduler prints the following INFO message when there are tasks to submit:

INFO DAGScheduler: Submitting 1 missing tasks from ResultStage 36 (ShuffledRDD[86] at

reduceByKey at <console>:24)

There is also the following DEBUG message with pending partitions:

DEBUG DAGScheduler: New pending partitions: Set(0)

Tasks are later submitted to Task Scheduler (via taskScheduler.submitTasks ).

When no tasks in a stage can be submitted, the following DEBUG message shows in the
logs:

FIXME

607
Stage — Physical Unit Of Execution

Table 1. Stage’s Internal Registries and Counters

Name Description

Long description of the stage

details
Used when…​FIXME

FIXME
fetchFailedAttemptIds
Used when…​FIXME

Set of jobs the stage belongs to.

jobIds
Used when…​FIXME

Name of the stage

name
Used when…​FIXME

The ID for the next attempt of the stage.

nextAttemptId
Used when…​FIXME

Number of partitions
numPartitions
Used when…​FIXME

Set of pending partitions

pendingPartitions
Used when…​FIXME

Internal cache with…​FIXME

_latestInfo
Used when…​FIXME

Stage Contract

abstract class Stage {

def findMissingPartitions(): Seq[Int]
}

Note Stage is a private[scheduler] abstract contract.

Table 2. Stage Contract

Method Description
findMissingPartitions Used when…​

608
Stage — Physical Unit Of Execution

findMissingPartitions Method
Stage.findMissingPartitions() calculates the ids of the missing partitions, i.e. partitions for

which the ActiveJob knows they are not finished (and so they are missing).

A ResultStage stage knows it by querying the active job about partition ids ( numPartitions )
that are not finished (using ActiveJob.finished array of booleans).

Figure 6. ResultStage.findMissingPartitions and ActiveJob

In the above figure, partitions 1 and 2 are not finished ( F is false while T is true).

failedOnFetchAndShouldAbort Method
Stage.failedOnFetchAndShouldAbort(stageAttemptId: Int): Boolean checks whether the

number of fetch failed attempts (using fetchFailedAttemptIds ) exceeds the number of

consecutive failures allowed for a given stage (that should then be aborted)

Note The number of consecutive failures for a stage is not configurable.

Getting StageInfo For Most Recent Attempt 

—  latestInfo Method

latestInfo: StageInfo

latestInfo simply returns the most recent StageInfo (i.e. makes it accessible).

Creating New Stage Attempt (as StageInfo) 

—  makeNewStageAttempt Method

makeNewStageAttempt(
numPartitionsToCompute: Int,
taskLocalityPreferences: Seq[Seq[TaskLocation]] = Seq.empty): Unit

609
Stage — Physical Unit Of Execution

makeNewStageAttempt creates a new TaskMetrics and registers the internal accumulators

(using the RDD’s SparkContext ).

Note makeNewStageAttempt uses rdd that was defined when Stage was created.

makeNewStageAttempt sets _latestInfo to be a StageInfo from the current stage (with

nextAttemptId, numPartitionsToCompute , and taskLocalityPreferences ).

makeNewStageAttempt increments nextAttemptId counter.

makeNewStageAttempt is used exclusively when DAGScheduler submits missing

Note
tasks for a stage.

610
ShuffleMapStage — Intermediate Stage in Execution DAG

ShuffleMapStage — Intermediate Stage in
Execution DAG
ShuffleMapStage (aka shuffle map stage or simply map stage) is an intermediate stage in

the physical execution DAG that corresponds to a ShuffleDependency.

ShuffleMapStage can also be submitted independently as a Spark job for

Note
Adaptive Query Planning / Adaptive Scheduling.

Note The logical DAG or logical execution plan is the RDD lineage.

When executed, a ShuffleMapStage saves map output files that can later be fetched by
reduce tasks. When all map outputs are available, the ShuffleMapStage is considered
available (or ready).

Output locations can be missing, i.e. partitions have not been calculated or are lost.

ShuffleMapStage uses outputLocs and _numAvailableOutputs internal registries to track

how many shuffle map outputs are available.

ShuffleMapStage is an input for the other following stages in the DAG of stages and is also

called a shuffle dependency’s map side.

A ShuffleMapStage may contain multiple pipelined operations, e.g. map and filter ,
before shuffle operation.

A single ShuffleMapStage can be shared across different jobs.

611
ShuffleMapStage — Intermediate Stage in Execution DAG

Table 1. ShuffleMapStage Internal Registries and Counters

Name Description

ActiveJobs associated with the ShuffleMapStage .

_mapStageJobs
A new ActiveJob can be registered and deregistered.
The list of ActiveJobs registered are available using
mapStageJobs.

Tracks MapStatuses for each partition.

There could be many MapStatus entries per partition due
to Speculative Execution of Tasks.
outputLocs
When ShuffleMapStage is created, outputLocs is empty,
i.e. all elements are empty lists.
The size of outputLocs is exactly the number of
partitions of the RDD the stage runs on.

The number of available outputs for the partitions of the

ShuffleMapStage .

_numAvailableOutputs is incremented when the first

MapStatus is registered for a partition (that could be
_numAvailableOutputs more tasks per partition) and decrements when the last
MapStatus is removed for a partition.

_numAvailableOutputs should not be greater than the

number of partitions (and hence the number of
MapStatus collections in outputLocs internal registry).

Creating ShuffleMapStage Instance

ShuffleMapStage takes the following when created:

1. id identifier

2. rdd  — the RDD of ShuffleDependency

3. numTasks  — the number of tasks (that is exactly the number of partitions in the rdd )

4. parents  — the collection of parent Stages

5. firstJobId  — the ActiveJob that created it

6. callSite  — the creationSite of the RDD

7. shuffleDep  — ShuffleDependency (from the logical execution plan)

ShuffleMapStage initializes the internal registries and counters.

612
ShuffleMapStage — Intermediate Stage in Execution DAG

Note DAGScheduler tracks the number of ShuffleMapStage created so far.

ShuffleMapStage is created only when DAGScheduler creates one for a

Note
ShuffleDependency .

Registering MapStatus For Partition —  addOutputLoc

Method

addOutputLoc(partition: Int, status: MapStatus): Unit

addOutputLoc adds the input status to the output locations for the input partition .

addOutputLoc increments _numAvailableOutputs internal counter if the input MapStatus is

the first result for the partition .

addOutputLoc is used when DAGScheduler creates a ShuffleMapStage for a

ShuffleDependency and a ActiveJob (and MapOutputTrackerMaster tracks
Note
some output locations of the ShuffleDependency ) and when ShuffleMapTask
has finished.

Removing MapStatus For Partition And BlockManager 

—  removeOutputLoc Method

removeOutputLoc(partition: Int, bmAddress: BlockManagerId): Unit

removeOutputLoc removes the MapStatus for the input partition and bmAddress

BlockManager from the output locations.

removeOutputLoc decrements _numAvailableOutputs internal counter if the the removed

MapStatus was the last result for the partition .

removeOutputLoc is exclusively used when a Task has failed with

Note
FetchFailed exception.

Finding Missing Partitions —  findMissingPartitions

Method

findMissingPartitions(): Seq[Int]

613
ShuffleMapStage — Intermediate Stage in Execution DAG

findMissingPartitions is part of Stage contract that returns the partitions that

Note
are missing, i.e. are yet to be computed.

Internally, findMissingPartitions uses outputLocs internal registry to find indices with

empty lists of MapStatus .

ShuffleMapStage Sharing
A ShuffleMapStage can be shared across multiple jobs, if these jobs reuse the same RDDs.

When a ShuffleMapStage is submitted to DAGScheduler to execute, getShuffleMapStage is

called.

scala> val rdd = sc.parallelize(0 to 5).map((_,1)).sortByKey() (1)

scala> rdd.count (2)

scala> rdd.count (3)

1. Shuffle at sortByKey()

2. Submits a job with two stages with two being executed

3. Intentionally repeat the last action that submits a new job with two stages with one being
shared as already-being-computed

Figure 1. Skipped Stages are already-computed ShuffleMapStages

Returning Number of Available Shuffle Map Outputs 

—  numAvailableOutputs Method

614
ShuffleMapStage — Intermediate Stage in Execution DAG

numAvailableOutputs: Int

numAvailableOutputs returns _numAvailableOutputs internal registry.

numAvailableOutputs is used exclusively when DAGScheduler submits missing

Note tasks for ShuffleMapStage (and only to print a DEBUG message when the
ShuffleMapStage is finished).

Returning Collection of Active Jobs —  mapStageJobs

Method

mapStageJobs: Seq[ActiveJob]

mapStageJobs returns _mapStageJobs internal registry.

mapStageJobs is used exclusively when DAGScheduler is notified that a

Note ShuffleMapTask has finished successfully (and the task made ShuffleMapStage
completed and so marks any map-stage jobs waiting on this stage as finished).

Registering Job (that Computes ShuffleDependency) 

—  addActiveJob Method

addActiveJob(job: ActiveJob): Unit

addActiveJob registers the input ActiveJob in _mapStageJobs internal registry.

Note The ActiveJob is added as the first element in _mapStageJobs .

addActiveJob is used exclusively when DAGScheduler is notified that a

Note ShuffleDependency was submitted (and so a new ActiveJob is created to
compute it).

Deregistering Job —  removeActiveJob Method

removeActiveJob(job: ActiveJob): Unit

removeActiveJob removes a ActiveJob from _mapStageJobs internal registry.

removeActiveJob is used exclusively when DAGScheduler cleans up after

Note
ActiveJob has finished (regardless of the outcome).

615
ShuffleMapStage — Intermediate Stage in Execution DAG

Removing All Shuffle Outputs Registered for Lost Executor 

—  removeOutputsOnExecutor Method

removeOutputsOnExecutor(execId: String): Unit

removeOutputsOnExecutor removes all MapStatuses with the input execId executor from the

outputLocs internal registry (of MapStatuses per partition).

If the input execId had the last registered MapStatus for a partition,
removeOutputsOnExecutor decrements _numAvailableOutputs counter and you should see

the following INFO message in the logs:

INFO [stage] is now unavailable on executor [execId] ([_numAvailableOutputs]/[numParti

tions], [isAvailable])

removeOutputsOnExecutor is used exclusively when DAGScheduler cleans up

Note
after a lost executor.

Preparing Shuffle Map Outputs in MapOutputTracker

Format —  outputLocInMapOutputTrackerFormat
Method

outputLocInMapOutputTrackerFormat(): Array[MapStatus]

outputLocInMapOutputTrackerFormat returns the first (if available) element for every partition

from outputLocs internal registry. If there is no entry for a partition, that position is filled with
null .

outputLocInMapOutputTrackerFormat is used when DAGScheduler is notified that

a ShuffleMapTask has finished successfully (and the corresponding
ShuffleMapStage is complete) and cleans up after a lost executor.
Note
In both cases, outputLocInMapOutputTrackerFormat is used to register the shuffle
map outputs (of the ShuffleDependency ) with MapOutputTrackerMaster .

616
ResultStage — Final Stage in Job

ResultStage  — Final Stage in Job

A ResultStage is the final stage in a job that applies a function on one or many partitions of
the target RDD to compute the result of an action.

Figure 1. Job creates ResultStage as the first stage

The partitions are given as a collection of partition ids ( partitions ) and the function func:
(TaskContext, Iterator[_]) ⇒ _ .

Figure 2. ResultStage and partitions

Tip Read about TaskContext in TaskContext.

617
ResultStage — Final Stage in Job

func Property

Caution FIXME

setActiveJob Method

Caution FIXME

removeActiveJob Method

Caution FIXME

activeJob Method

activeJob: Option[ActiveJob]

activeJob returns the optional ActiveJob associated with a ResultStage .

Caution FIXME When/why would that be NONE (empty)?

618
StageInfo

StageInfo
Caution FIXME

fromStage Method

Caution FIXME

619
DAGSchedulerSource — Metrics Source for DAGScheduler

DAGSchedulerSource — Metrics Source for

DAGScheduler
DAGSchedulerSource is…​FIXME

DAGScheduler uses Spark Metrics System to report metrics about internal status.

The name of the source is DAGScheduler.

It emits the following numbers:

stage.failedStages - the number of failed stages

stage.runningStages - the number of running stages

stage.waitingStages - the number of waiting stages

job.allJobs - the number of all jobs

job.activeJobs - the number of active jobs

620
DAGScheduler Event Bus

DAGSchedulerEventProcessLoop — 
DAGScheduler Event Bus
DAGSchedulerEventProcessLoop (dag-scheduler-event-loop) is an EventLoop single

"business logic" thread for processing DAGSchedulerEvent events.

The purpose of the DAGSchedulerEventProcessLoop is to have a separate thread

Note to process events asynchronously and serially, i.e. one by one, and let
DAGScheduler do its work on the main thread.

Table 1. DAGSchedulerEvents and Event Handlers (in alphabetical order)

DAGSchedulerEvent Event Handler Trigger
DAGScheduler was requested
AllJobsCancelled to cancel all running or waiting
jobs.

TaskSetManager informs
BeginEvent handleBeginEvent DAGScheduler that a task is
starting (through taskStarted).

Posted to inform
DAGScheduler that a task has
completed (successfully or
not).
CompletionEvent conveys the
following information:

1. Completed Task instance

CompletionEvent handleTaskCompletion (as task )
2. TaskEndReason (as
reason )

3. Result of the task (as

result )

4. Accumulator updates
5. TaskInfo

DAGScheduler was informed

(through executorAdded) that
ExecutorAdded handleExecutorAdded
an executor was spun up on a
host.

Posted to notify DAGScheduler

that an executor was lost.

621
DAGScheduler Event Bus

ExecutorLost conveys the

following information:
1. execId

2. ExecutorLossReason
NOTE: The input filesLost
for handleExecutorLost is
ExecutorLost handleExecutorLost
enabled when
ExecutorLossReason is
SlaveLost with workerLost
enabled (it is disabled by
default).

NOTE: handleExecutorLost is
also called when
DAGScheduler is informed that
a task has failed due to
FetchFailed exception.

TaskSetManager informs
DAGScheduler (through
GettingResultEvent taskGettingResult) that a task
has completed and results are
being fetched remotely.

DAGScheduler was requested

JobCancelled handleJobCancellation
to cancel a job.

DAGScheduler was requested

JobGroupCancelled handleJobGroupCancelled
to cancel a job group.

Posted when DAGScheduler is

requested to submit a job or
run an approximate job.
JobSubmitted conveys the
following information:

1. A job identifier (as jobId )

2. A RDD (as finalRDD )
3. The function to execute (as
JobSubmitted handleJobSubmitted func: (TaskContext,
Iterator[_]) ⇒ _ )

4. The partitions to compute

(as partitions )

5. A CallSite (as callSite )

6. The JobListener to inform
about the status of the stage.

622
DAGScheduler Event Bus

7. Properties of the
execution

Posted to inform
DAGScheduler that
SparkContext submitted a
MapStage for execution
(through submitMapStage).

MapStageSubmitted conveys
the following information:
MapStageSubmitted handleMapStageSubmitted 1. A job identifier (as jobId )
2. The ShuffleDependency
3. A CallSite (as callSite )
4. The JobListener to inform
about the status of the stage.
5. Properties of the
execution

DAGScheduler was informed

ResubmitFailedStages resubmitFailedStages that a task has failed due to
FetchFailed exception.

DAGScheduler was requested

StageCancelled handleStageCancellation
to cancel a stage.

DAGScheduler was requested

TaskSetFailed handleTaskSetFailed
to cancel a TaskSet

When created, DAGSchedulerEventProcessLoop gets the reference to the owning

DAGScheduler that it uses to call event handler methods on.

DAGSchedulerEventProcessLoop uses java.util.concurrent.LinkedBlockingDeque

Note
blocking deque that grows indefinitely, i.e. up to Integer.MAX_VALUE events.

AllJobsCancelled Event and…​

Caution FIXME

GettingResultEvent Event and

handleGetTaskResult Handler

623
DAGScheduler Event Bus

GettingResultEvent(taskInfo: TaskInfo) extends DAGSchedulerEvent

GettingResultEvent is a DAGSchedulerEvent that triggers handleGetTaskResult (on a

separate thread).

GettingResultEvent is posted to inform DAGScheduler (through

Note
taskGettingResult) that a task fetches results.

handleGetTaskResult Handler

handleGetTaskResult(taskInfo: TaskInfo): Unit

handleGetTaskResult merely posts SparkListenerTaskGettingResult (to LiveListenerBus

Event Bus).

BeginEvent Event and handleBeginEvent Handler

BeginEvent(task: Task[_], taskInfo: TaskInfo) extends DAGSchedulerEvent

BeginEvent is a DAGSchedulerEvent that triggers handleBeginEvent (on a separate thread).

BeginEvent is posted to inform DAGScheduler (through taskStarted) that a

Note
TaskSetManager starts a task.

handleBeginEvent Handler

handleBeginEvent(task: Task[_], taskInfo: TaskInfo): Unit

handleBeginEvent looks the stage of task up in stageIdToStage internal registry to

compute the last attempt id (or -1 if not available) and posts SparkListenerTaskStart (to
listenerBus event bus).

JobGroupCancelled Event and

handleJobGroupCancelled Handler

JobGroupCancelled(groupId: String) extends DAGSchedulerEvent

624
DAGScheduler Event Bus

JobGroupCancelled is a DAGSchedulerEvent that triggers handleJobGroupCancelled (on a

separate thread).

JobGroupCancelled is posted when DAGScheduler is informed (through

Note
cancelJobGroup) that SparkContext was requested to cancel a job group.

handleJobGroupCancelled Handler

handleJobGroupCancelled(groupId: String): Unit

handleJobGroupCancelled finds active jobs in a group and cancels them.

Internally, handleJobGroupCancelled computes all the active jobs (registered in the internal
collection of active jobs) that have spark.jobGroup.id scheduling property set to groupId .

handleJobGroupCancelled then cancels every active job in the group one by one and the

cancellation reason: "part of cancelled job group [groupId]".

Getting Notified that ShuffleDependency Was Submitted 

—  handleMapStageSubmitted Handler

handleMapStageSubmitted(
jobId: Int,
dependency: ShuffleDependency[_, _, _],
callSite: CallSite,
listener: JobListener,
properties: Properties): Unit

Figure 1. MapStageSubmitted Event Handling

handleMapStageSubmitted finds or creates a new ShuffleMapStage for the input

ShuffleDependency and jobId .

625
DAGScheduler Event Bus

handleMapStageSubmitted creates an ActiveJob (with the input jobId , callSite , listener

and properties , and the ShuffleMapStage ).

handleMapStageSubmitted clears the internal cache of RDD partition locations.

Caution FIXME Why is this clearing here so important?

You should see the following INFO messages in the logs:

INFO DAGScheduler: Got map stage job [id] ([callSite]) with [number] output partitions
INFO DAGScheduler: Final stage: [stage] ([name])
INFO DAGScheduler: Parents of final stage: [parents]
INFO DAGScheduler: Missing parents: [missingStages]

handleMapStageSubmitted registers the new job in jobIdToActiveJob and activeJobs internal

registries, and with the final ShuffleMapStage .

Note ShuffleMapStage can have multiple ActiveJob s registered.

handleMapStageSubmitted finds all the registered stages for the input jobId and collects

their latest StageInfo .

Ultimately, handleMapStageSubmitted posts SparkListenerJobStart message to

LiveListenerBus and submits the ShuffleMapStage .

In case the ShuffleMapStage could be available already, handleMapStageSubmitted marks

the job finished.

DAGScheduler requests MapOutputTrackerMaster for statistics for

Note
ShuffleDependency that it uses for handleMapStageSubmitted .

Note MapOutputTrackerMaster is passed in when DAGScheduler is created.

When handleMapStageSubmitted could not find or create a ShuffleMapStage , you should see
the following WARN message in the logs.

WARN Creating new stage failed due to exception - job: [id]

handleMapStageSubmitted notifies listener about the job failure and exits.

Note MapStageSubmitted event processing is very similar to JobSubmitted events.

626
DAGScheduler Event Bus

The difference between handleMapStageSubmitted and handleJobSubmitted:

handleMapStageSubmitted has a ShuffleDependency among the input parameters

while handleJobSubmitted has finalRDD , func , and partitions .
handleMapStageSubmitted initializes finalStage as
getShuffleMapStage(dependency, jobId) while handleJobSubmitted as finalStage
= newResultStage(finalRDD, func, partitions, jobId, callSite)

handleMapStageSubmitted INFO logs Got map stage job %s (%s) with %d output
partitions with dependency.rdd.partitions.length while handleJobSubmitted
does Got job %s (%s) with %d output partitions with partitions.length .
Tip FIXME: Could the above be cut to ActiveJob.numPartitions ?
handleMapStageSubmitted adds a new job with finalStage.addActiveJob(job)
while handleJobSubmitted sets with finalStage.setActiveJob(job) .

handleMapStageSubmitted checks if the final stage has already finished, tells the
listener and removes it using the code:

if (finalStage.isAvailable) {
markMapStageJobAsFinished(job, mapOutputTracker.getStatistics(dependency))
}

TaskSetFailed Event and handleTaskSetFailed

Handler

TaskSetFailed(
taskSet: TaskSet,
reason: String,
exception: Option[Throwable])
extends DAGSchedulerEvent

TaskSetFailed is a DAGSchedulerEvent that triggers handleTaskSetFailed method.

TaskSetFailed is posted when DAGScheduler is requested to cancel a

Note
TaskSet .

handleTaskSetFailed Handler

handleTaskSetFailed(
taskSet: TaskSet,
reason: String,
exception: Option[Throwable]): Unit

627
DAGScheduler Event Bus

handleTaskSetFailed looks the stage (of the input taskSet ) up in the internal

stageIdToStage registry and aborts it.

ResubmitFailedStages Event and

resubmitFailedStages Handler

ResubmitFailedStages extends DAGSchedulerEvent

ResubmitFailedStages is a DAGSchedulerEvent that triggers resubmitFailedStages method.

ResubmitFailedStages is posted for FetchFailed case in

Note
handleTaskCompletion .

resubmitFailedStages Handler

resubmitFailedStages(): Unit

resubmitFailedStages iterates over the internal collection of failed stages and submits them.

Note resubmitFailedStages does nothing when there are no failed stages reported.

You should see the following INFO message in the logs:

INFO Resubmitting failed stages

resubmitFailedStages clears the internal cache of RDD partition locations first. It then

makes a copy of the collection of failed stages so DAGScheduler can track failed stages
afresh.

Note At this point DAGScheduler has no failed stages reported.

The previously-reported failed stages are sorted by the corresponding job ids in incremental
order and resubmitted.

Getting Notified that Executor Is Lost 

—  handleExecutorLost Handler

628
DAGScheduler Event Bus

handleExecutorLost(
execId: String,
filesLost: Boolean,
maybeEpoch: Option[Long] = None): Unit

handleExecutorLost checks whether the input optional maybeEpoch is defined and if not

requests the current epoch from MapOutputTrackerMaster .

MapOutputTrackerMaster is passed in (as mapOutputTracker ) when

Note
DAGScheduler is created.

Caution FIXME When is maybeEpoch passed in?

Figure 2. DAGScheduler.handleExecutorLost
Recurring ExecutorLost events lead to the following repeating DEBUG message in the
logs:

DEBUG Additional executor lost message for [execId] (epoch [currentEpoch])

handleExecutorLost handler uses DAGScheduler 's failedEpoch and FIXME

Note
internal registries.

Otherwise, when the executor execId is not in the list of executor lost or the executor
failure’s epoch is smaller than the input maybeEpoch , the executor’s lost event is recorded in
failedEpoch internal registry.

FIXME Describe the case above in simpler non-technical words. Perhaps

Caution
change the order, too.

You should see the following INFO message in the logs:

INFO Executor lost: [execId] (epoch [epoch])

629
DAGScheduler Event Bus

BlockManagerMaster is requested to remove the lost executor execId .

Caution FIXME Review what’s filesLost .

handleExecutorLost exits unless the ExecutorLost event was for a map output fetch

operation (and the input filesLost is true ) or external shuffle service is not used.

In such a case, you should see the following INFO message in the logs:

INFO Shuffle files lost for executor: [execId] (epoch [epoch])

handleExecutorLost walks over all ShuffleMapStages in DAGScheduler’s

shuffleToMapStage internal registry and do the following (in order):

1. ShuffleMapStage.removeOutputsOnExecutor(execId) is called

2. MapOutputTrackerMaster.registerMapOutputs(shuffleId,
stage.outputLocInMapOutputTrackerFormat(), changeEpoch = true) is called.

In case DAGScheduler’s shuffleToMapStage internal registry has no shuffles registered,

MapOutputTrackerMaster is requested to increment epoch.

Ultimatelly, DAGScheduler clears the internal cache of RDD partition locations.

JobCancelled Event and handleJobCancellation

Handler

JobCancelled(jobId: Int) extends DAGSchedulerEvent

JobCancelled is a DAGSchedulerEvent that triggers handleJobCancellation method (on a

separate thread).

Note JobCancelled is posted when DAGScheduler is requested to cancel a job.

handleJobCancellation Handler

handleJobCancellation(jobId: Int, reason: String = "")

handleJobCancellation first makes sure that the input jobId has been registered earlier

(using jobIdToStageIds internal registry).

If the input jobId is not known to DAGScheduler , you should see the following DEBUG
message in the logs:

630
DAGScheduler Event Bus

DEBUG DAGScheduler: Trying to cancel unregistered job [jobId]

Otherwise, handleJobCancellation fails the active job and all independent stages (by looking
up the active job using jobIdToActiveJob) with failure reason:

Job [jobId] cancelled [reason]

Getting Notified That Task Has Finished 

—  handleTaskCompletion Handler

handleTaskCompletion(event: CompletionEvent): Unit

Figure 3. DAGScheduler and CompletionEvent

Note CompletionEvent holds contextual information about the completed task.

Table 2. CompletionEvent Properties

Property Description

task
Completed Task instance for a stage, partition and stage
attempt.

reason TaskEndReason …​FIXME

result Result of the task

accumUpdates Accumulators with…​FIXME

taskInfo TaskInfo

handleTaskCompletion starts by notifying OutputCommitCoordinator that a task completed.

631
DAGScheduler Event Bus

handleTaskCompletion re-creates TaskMetrics (using accumUpdates accumulators of the

input event ).

Note TaskMetrics can be empty when the task has failed.

handleTaskCompletion announces task completion application-wide (by posting a

SparkListenerTaskEnd to LiveListenerBus).

handleTaskCompletion checks the stage of the task out in the stageIdToStage internal

registry and if not found, it simply exits.

handleTaskCompletion branches off per TaskEndReason (as event.reason ).

Table 3. handleTaskCompletion Branches per TaskEndReason

TaskEndReason Description
Acts according to the type of the task that completed, i.e.
Success
ShuffleMapTask and ResultTask.

Resubmitted

FetchFailed

ExceptionFailure Updates accumulators (with partial values from the task).

ExecutorLostFailure Does nothing

TaskCommitDenied Does nothing

TaskKilled Does nothing

TaskResultLost Does nothing

UnknownReason Does nothing

Handling Successful Task Completion

When a task has finished successfully (i.e. Success end reason), handleTaskCompletion
marks the partition as no longer pending (i.e. the partition the task worked on is removed
from pendingPartitions of the stage).

Note A Stage tracks its own pending partitions using pendingPartitions property.

handleTaskCompletion branches off given the type of the task that completed, i.e.

ShuffleMapTask and ResultTask.

632
DAGScheduler Event Bus

Handling Successful ResultTask Completion

For ResultTask, the stage is assumed a ResultStage.

handleTaskCompletion finds the ActiveJob associated with the ResultStage .

ResultStage tracks the optional ActiveJob as activeJob property. There could

Note
only be one active job for a ResultStage .

If there is no job for the ResultStage , you should see the following INFO message in the
logs:

INFO DAGScheduler: Ignoring result from [task] because its job has finished

Otherwise, when the ResultStage has a ActiveJob , handleTaskCompletion checks the

status of the partition output for the partition the ResultTask ran for.

ActiveJob tracks task completions in finished property with flags for every
partition in a stage. When the flag for a partition is enabled (i.e. true ), it is
Note
assumed that the partition has been computed (and no results from any
ResultTask are expected and hence simply ignored).

Caution FIXME Describe why could a partition has more ResultTask running.

handleTaskCompletion ignores the CompletionEvent when the partition has already been

marked as completed for the stage and simply exits.

handleTaskCompletion updates accumulators.

The partition for the ActiveJob (of the ResultStage ) is marked as computed and the
number of partitions calculated increased.

ActiveJob tracks what partitions have already been computed and their
Note
number.

If the ActiveJob has finished (when the number of partitions computed is exactly the
number of partitions in a stage) handleTaskCompletion does the following (in order):

1. Marks ResultStage computed.

2. Cleans up after ActiveJob and independent stages.

3. Announces the job completion application-wide (by posting a SparkListenerJobEnd to

LiveListenerBus).

In the end, handleTaskCompletion notifies JobListener of the ActiveJob that the task
succeeded.

633
DAGScheduler Event Bus

Note A task succeeded notification holds the output index and the result.

When the notification throws an exception (because it runs user code),

handleTaskCompletion notifies JobListener about the failure (wrapping it inside a

SparkDriverExecutionException exception).

Handling Successful ShuffleMapTask Completion

For ShuffleMapTask, the stage is assumed a ShuffleMapStage.

handleTaskCompletion updates accumulators.

The task’s result is assumed MapStatus that knows the executor where the task has
finished.

You should see the following DEBUG message in the logs:

DEBUG DAGScheduler: ShuffleMapTask finished on [execId]

If the executor is registered in failedEpoch internal registry and the epoch of the completed
task is not greater than that of the executor (as in failedEpoch registry), you should see the
following INFO message in the logs:

INFO DAGScheduler: Ignoring possibly bogus [task] completion from executor [executorId]

Otherwise, handleTaskCompletion registers the MapStatus result for the partition with the
stage (of the completed task).

handleTaskCompletion does more processing only if the ShuffleMapStage is registered as

still running (in runningStages internal registry) and the ShuffleMapStage stage has no
pending partitions to compute.

The ShuffleMapStage is marked as finished.

You should see the following INFO messages in the logs:

INFO DAGScheduler: looking for newly runnable stages

INFO DAGScheduler: running: [runningStages]
INFO DAGScheduler: waiting: [waitingStages]
INFO DAGScheduler: failed: [failedStages]

handleTaskCompletion registers the shuffle map outputs of the ShuffleDependency with

MapOutputTrackerMaster (with the epoch incremented) and clears internal cache of the

stage’s RDD block locations.

634
DAGScheduler Event Bus

Note MapOutputTrackerMaster is given when DAGScheduler is created.

If the ShuffleMapStage stage is ready, all active jobs of the stage (aka map-stage jobs) are
marked as finished (with MapOutputStatistics from MapOutputTrackerMaster for the
ShuffleDependency ).

A ShuffleMapStage stage is ready (aka available) when all partitions have

Note
shuffle outputs, i.e. when their tasks have completed.

Eventually, handleTaskCompletion submits waiting child stages (of the ready

ShuffleMapStage ).

If however the ShuffleMapStage is not ready, you should see the following INFO message in
the logs:

INFO DAGScheduler: Resubmitting [shuffleStage] ([shuffleStage.name]) because some of i

ts tasks had failed: [missingPartitions]

In the end, handleTaskCompletion submits the ShuffleMapStage for execution.

TaskEndReason: Resubmitted
For Resubmitted case, you should see the following INFO message in the logs:

INFO Resubmitted [task], so marking it as still running

The task (by task.partitionId ) is added to the collection of pending partitions of the stage
(using stage.pendingPartitions ).

A stage knows how many partitions are yet to be calculated. A task knows about
Tip
the partition id for which it was launched.

Task Failed with FetchFailed Exception — 

TaskEndReason: FetchFailed

FetchFailed(
bmAddress: BlockManagerId,
shuffleId: Int,
mapId: Int,
reduceId: Int,
message: String)
extends TaskFailedReason

635
DAGScheduler Event Bus

Table 4. FetchFailed Properties

Name Description
bmAddress BlockManagerId

shuffleId Used when…​

mapId Used when…​

reduceId Used when…​

failureMessage Used when…​

Note A task knows about the id of the stage it belongs to.

When FetchFailed happens, stageIdToStage is used to access the failed stage (using
task.stageId and the task is available in event in handleTaskCompletion(event:

CompletionEvent) ). shuffleToMapStage is used to access the map stage (using shuffleId ).

If failedStage.latestInfo.attemptId != task.stageAttemptId , you should see the following

INFO in the logs:

INFO Ignoring fetch failure from [task] as it's from [failedStage] attempt [task.stage
AttemptId] and there is a more recent attempt for that stage (attempt ID [failedStage.
latestInfo.attemptId]) running

FIXME What does failedStage.latestInfo.attemptId != task.stageAttemptId

Caution
mean?

And the case finishes. Otherwise, the case continues.

If the failed stage is in runningStages , the following INFO message shows in the logs:

INFO Marking [failedStage] ([failedStage.name]) as failed due to a fetch failure from

[mapStage] ([mapStage.name])

markStageAsFinished(failedStage, Some(failureMessage)) is called.

Caution FIXME What does markStageAsFinished do?

If the failed stage is not in runningStages , the following DEBUG message shows in the logs:

DEBUG Received fetch failure from [task], but its from [failedStage] which is no longe
r running

636
DAGScheduler Event Bus

When disallowStageRetryForTest is set, abortStage(failedStage, "Fetch failure will not

retry stage due to testing config", None) is called.

Caution FIXME Describe disallowStageRetryForTest and abortStage .

If the number of fetch failed attempts for the stage exceeds the allowed number, the failed
stage is aborted with the reason:

[failedStage] ([name]) has failed the maximum allowable number of times: 4. Most recen
t failure reason: [failureMessage]

If there are no failed stages reported (DAGScheduler.failedStages is empty), the following

INFO shows in the logs:

INFO Resubmitting [mapStage] ([mapStage.name]) and [failedStage] ([failedStage.name])

due to fetch failure

And the following code is executed:

messageScheduler.schedule(
new Runnable {
override def run(): Unit = eventProcessLoop.post(ResubmitFailedStages)
}, DAGScheduler.RESUBMIT_TIMEOUT, TimeUnit.MILLISECONDS)

Caution FIXME What does the above code do?

For all the cases, the failed stage and map stages are both added to the internal registry of
failed stages.

If mapId (in the FetchFailed object for the case) is provided, the map stage output is
cleaned up (as it is broken) using mapStage.removeOutputLoc(mapId, bmAddress) and
MapOutputTrackerMaster.unregisterMapOutput(shuffleId, mapId, bmAddress) methods.

Caution FIXME What does mapStage.removeOutputLoc do?

If BlockManagerId (as bmAddress in the FetchFailed object) is defined,

handleTaskCompletion notifies DAGScheduler that an executor was lost (with filesLost

enabled and maybeEpoch from the Task that completed).

StageCancelled Event and

handleStageCancellation Handler

637
DAGScheduler Event Bus

StageCancelled(stageId: Int) extends DAGSchedulerEvent

StageCancelled is a DAGSchedulerEvent that triggers handleStageCancellation (on a

separate thread).

handleStageCancellation Handler

handleStageCancellation(stageId: Int): Unit

handleStageCancellation checks if the input stageId was registered earlier (in the internal

stageIdToStage registry) and if it was attempts to cancel the associated jobs (with "because
Stage [stageId] was cancelled" cancellation reason).

Note A stage tracks the jobs it belongs to using jobIds property.

If the stage stageId was not registered earlier, you should see the following INFO message
in the logs:

INFO No active jobs to kill for Stage [stageId]

handleStageCancellation is the result of executing

Note SparkContext.cancelStage(stageId: Int) that is called from the web UI
(controlled by spark.ui.killEnabled configuration property).

handleJobSubmitted Handler

handleJobSubmitted(
jobId: Int,
finalRDD: RDD[_],
func: (TaskContext, Iterator[_]) => _,
partitions: Array[Int],
callSite: CallSite,
listener: JobListener,
properties: Properties)

handleJobSubmitted creates a new ResultStage (as finalStage in the picture below) given

the input finalRDD , func , partitions , jobId and callSite .

638
DAGScheduler Event Bus

Figure 4. DAGScheduler.handleJobSubmitted Method

handleJobSubmitted creates an ActiveJob (with the input jobId , callSite , listener ,

properties , and the ResultStage).

handleJobSubmitted clears the internal cache of RDD partition locations.

Caution FIXME Why is this clearing here so important?

You should see the following INFO messages in the logs:

INFO DAGScheduler: Got job [id] ([callSite]) with [number] output partitions
INFO DAGScheduler: Final stage: [stage] ([name])
INFO DAGScheduler: Parents of final stage: [parents]
INFO DAGScheduler: Missing parents: [missingStages]

handleJobSubmitted then registers the new job in jobIdToActiveJob and activeJobs internal

registries, and with the final ResultStage .

Note ResultStage can only have one ActiveJob registered.

handleJobSubmitted finds all the registered stages for the input jobId and collects their

latest StageInfo .

Ultimately, handleJobSubmitted posts SparkListenerJobStart message to LiveListenerBus

and submits the stage.

639
DAGScheduler Event Bus

ExecutorAdded Event and handleExecutorAdded

Handler

ExecutorAdded(execId: String, host: String) extends DAGSchedulerEvent

ExecutorAdded is a DAGSchedulerEvent that triggers handleExecutorAdded method (on a

separate thread).

Removing Executor From failedEpoch Registry 

—  handleExecutorAdded Handler

handleExecutorAdded(execId: String, host: String)

handleExecutorAdded checks if the input execId executor was registered in failedEpoch

and, if it was, removes it from the failedEpoch registry.

You should see the following INFO message in the logs:

INFO Host added was in lost list earlier: [host]

640
JobListener

JobListener
Spark subscribes for job completion or failure events (after submitting a job to
DAGScheduler) using JobListener trait.

The following are the job listeners used:

1. JobWaiter waits until DAGScheduler completes a job and passes the results of tasks to
a resultHandler function.

2. ApproximateActionListener …​FIXME

An instance of JobListener is used in the following places:

In ActiveJob as a listener to notify if tasks in this job finish or the job fails.

In JobSubmitted

JobListener Contract
JobListener is a private[spark] contract with the following two methods:

private[spark] trait JobListener {

def taskSucceeded(index: Int, result: Any)
def jobFailed(exception: Exception)
}

A JobListener object is notified each time a task succeeds (by taskSucceeded ) and when
the whole job fails (by jobFailed ).

641
JobWaiter

JobWaiter
JobWaiter[T](
dagScheduler: DAGScheduler,
val jobId: Int,
totalTasks: Int,
resultHandler: (Int, T) => Unit)
extends JobListener

JobWaiter is a JobListener that is used when DAGScheduler submits a job or submits a

map stage.

You can use a JobWaiter to block until the job finishes executing or to cancel it.

While the methods execute, JobSubmitted and MapStageSubmitted events are posted that
reference the JobWaiter .

As a JobListener , JobWaiter gets notified about task completions or failures, using

taskSucceeded and jobFailed , respectively. When the total number of tasks (that equals

the number of partitions to compute) equals the number of taskSucceeded , the JobWaiter
instance is marked successful. A jobFailed event marks the JobWaiter instance failed.

642
TaskScheduler — Spark Scheduler

TaskScheduler — Spark Scheduler
TaskScheduler is responsible for submitting tasks for execution in a Spark application (per

scheduling policy).

Figure 1. TaskScheduler works for a single SparkContext

TaskScheduler works closely with DAGScheduler that submits sets of tasks for
Note
execution (for every stage in a Spark job).

TaskScheduler tracks the executors in a Spark application using

executorHeartbeatReceived and executorLost methods that are to inform about active and
lost executors, respectively.

Spark comes with the following custom TaskSchedulers :

TaskSchedulerImpl — the default TaskScheduler (that the following two YARN-specific

TaskSchedulers extend).

YarnScheduler for Spark on YARN in client deploy mode.

YarnClusterScheduler for Spark on YARN in cluster deploy mode.

The source of TaskScheduler is available in

Note
org.apache.spark.scheduler.TaskScheduler.

TaskScheduler Contract

643
TaskScheduler — Spark Scheduler

trait TaskScheduler {
def applicationAttemptId(): Option[String]
def applicationId(): String
def cancelTasks(stageId: Int, interruptThread: Boolean): Unit
def defaultParallelism(): Int
def executorHeartbeatReceived(
execId: String,
accumUpdates: Array[(Long, Seq[AccumulatorV2[_, _]])],
blockManagerId: BlockManagerId): Boolean
def executorLost(executorId: String, reason: ExecutorLossReason): Unit
def postStartHook(): Unit
def rootPool: Pool
def schedulingMode: SchedulingMode
def setDAGScheduler(dagScheduler: DAGScheduler): Unit
def start(): Unit
def stop(): Unit
def submitTasks(taskSet: TaskSet): Unit
}

Note TaskScheduler is a private[spark] contract.

Table 1. TaskScheduler Contract

Method Description
Unique identifier of an (execution) attempt of a Spark
applicationAttemptId application.
Used exclusively when SparkContext is initialized.

Unique identifier of a Spark application.

By default, it is in the format spark-application-
applicationId [System.currentTimeMillis] .

Used exclusively when SparkContext is initialized (to

set spark.app.id).

Cancels all tasks of a given stage.

cancelTasks Used exclusively when DAGScheduler fails a Spark job
and independent single-job stages.

Calculates the default level of parallelism.

defaultParallelism Used when SparkContext is requested for the default
level of parallelism.

Intercepts heartbeats (with task metrics) from executors.

644
TaskScheduler — Spark Scheduler

executorHeartbeatReceived(
execId: String,
accumUpdates: Array[(Long, Seq[AccumulatorV2[_, _
]])],
blockManagerId: BlockManagerId): Boolean
executorHeartbeatReceived

Expected to return true when the executor execId is

managed by the TaskScheduler . false is to indicate
that the block manager (on the executor) should re-
register.
Used exclusively when HeartbeatReceiver RPC
endpoint receives a heartbeat and task metrics from an
executor.

Intercepts events about executors getting lost.

Used when HeartbeatReceiver RPC endpoint gets
executorLost informed about disconnected executors (i.e. that are no
longer available) and when DriverEndpoint forgets or
disables malfunctioning executors (i.e. either lost or
blacklisted for some reason).

Post-start initialization.
Does nothing by default, but allows custom
implementations for some additional post-start
postStartHook
initialization.
Used exclusively when SparkContext is created (right
before SparkContext is considered fully initialized).

rootPool Pool (of Schedulables).

Scheduling mode.

schedulingMode Puts tasks in order according to a scheduling policy (as

schedulingMode ). It is used in
SparkContext.getSchedulingMode.

Assigns DAGScheduler.
setDAGScheduler Used exclusively when DAGScheduler is created (and
passes on a reference to itself).

Starts TaskScheduler .
start
Used exclusively when SparkContext is created.

Stops TaskScheduler .
stop
Used exclusively when DAGScheduler is stopped.

645
TaskScheduler — Spark Scheduler

Submits tasks for execution (as TaskSet) of a given

stage.
submitTasks
Used exclusively when DAGScheduler submits tasks (of
a stage) for execution.

TaskScheduler’s Lifecycle
A TaskScheduler is created while SparkContext is being created (by calling
SparkContext.createTaskScheduler for a given master URL and deploy mode).

Figure 2. TaskScheduler uses SchedulerBackend to support different clusters

At this point in SparkContext’s lifecycle, the internal _taskScheduler points at the
TaskScheduler (and it is "announced" by sending a blocking TaskSchedulerIsSet message

to HeartbeatReceiver RPC endpoint).

The TaskScheduler is started right after the blocking TaskSchedulerIsSet message receives
a response.

The application ID and the application’s attempt ID are set at this point (and SparkContext
uses the application id to set spark.app.id Spark property, and configure SparkUI, and
BlockManager).

FIXME The application id is described as "associated with the job." in

Caution TaskScheduler, but I think it is "associated with the application" and you can
have many jobs per application.

Right before SparkContext is fully initialized, TaskScheduler.postStartHook is called.

The internal _taskScheduler is cleared (i.e. set to null ) while SparkContext is being
stopped.

TaskScheduler is stopped while DAGScheduler is being stopped.

646
TaskScheduler — Spark Scheduler

FIXME If it is SparkContext to start a TaskScheduler, shouldn’t

Warning
SparkContext stop it too? Why is this the way it is now?

647
Tasks

Task
Task (aka command) is the smallest individual unit of execution that is launched to

compute a RDD partition.

Figure 1. Tasks correspond to partitions in RDD

A task is described by the Task contract with a single runTask to run it and optional
placement preferences to place the computation on right executors.

There are two concrete implementations of Task contract:

ShuffleMapTask that executes a task and divides the task’s output to multiple buckets
(based on the task’s partitioner).

ResultTask that executes a task and sends the task’s output back to the driver
application.

The very last stage in a Spark job consists of multiple ResultTasks, while earlier stages can
only be ShuffleMapTasks.

Caution FIXME You could have a Spark job with ShuffleMapTask being the last.

Tasks are launched on executors and ran when TaskRunner starts.

In other (more technical) words, a task is a computation on the records in a RDD partition in
a stage of a RDD in a Spark job.

Note T is the type defined when a Task is created.

648
Tasks

Table 1. Task Internal Registries and Counters

Name Description
context Used when ???

Set for a Task when TaskSetManager is created and

epoch
later used when TaskRunner runs and when
DAGScheduler handles a ShuffleMapTask successful
completion.

_executorDeserializeTime Used when ???

_executorDeserializeCpuTime Used when ???

_killed Used when ???

TaskMetrics

metrics
Created lazily when Task is created from
serializedTaskMetrics.
Used when ???

TaskMemoryManager that manages the memory

taskMemoryManager allocated by the task.
Used when ???

taskThread Used when ???

A task can only belong to one stage and operate on a single partition. All tasks in a stage
must be completed before the stages that follow can start.

Tasks are spawned one by one for each stage and partition.

Caution FIXME What are stageAttemptId and taskAttemptId ?

Task Contract

def runTask(context: TaskContext): T

def preferredLocations: Seq[TaskLocation] = Nil

Note Task is a private[spark] contract.

649
Tasks

Table 2. Task Contract

Method Description
runTask Used when a task runs.

Collection of TaskLocations.

Used exclusively when TaskSetManager registers a task

as pending execution and dequeueSpeculativeTask.
preferredLocations Empty by default and so no task location preferences are
defined that says the task could be launched on any
executor.
Defined by the custom tasks, i.e. ShuffleMapTask and
ResultTask.

Creating Task Instance

Task takes the following when created:

Stage ID

Stage attempt ID (different per stage execution re-attempt)

Partition ID

Local Properties (defaults to empty properties)

Serialized TaskMetrics (that were part of the owning Stage)

(optional) Job ID

(optional) Application ID

(optional) Application attempt ID

Task initializes the internal registries and counters.

Running Task Thread —  run Method

run(
taskAttemptId: Long,
attemptNumber: Int,
metricsSystem: MetricsSystem): T

run registers the task (identified as taskAttemptId ) with the local BlockManager .

650
Tasks

Note run uses SparkEnv to access the current BlockManager .

run creates a TaskContextImpl that in turn becomes the task’s TaskContext.

Note run is a final method and so must not be overriden.

run checks _killed flag and, if enabled, kills the task (with interruptThread flag disabled).

run creates a Hadoop CallerContext and sets it.

run runs the task.

Note This is the moment when the custom Task 's runTask is executed.

In the end, run notifies TaskContextImpl that the task has completed (regardless of the
final outcome — a success or a failure).

In case of any exceptions, run notifies TaskContextImpl that the task has failed. run
requests MemoryStore to release unroll memory for this task (for both ON_HEAP and
OFF_HEAP memory modes).

run uses SparkEnv to access the current BlockManager that it uses to access
Note
MemoryStore.

run requests MemoryManager to notify any tasks waiting for execution memory to be freed

to wake up and try to acquire memory again.

run unsets the task’s TaskContext .

Note run uses SparkEnv to access the current MemoryManager .

run is used exclusively when TaskRunner starts. The Task instance has just
Note been deserialized from taskBytes that were sent over the wire to an executor.
localProperties and TaskMemoryManager are already assigned.

Task States
A task can be in one of the following states (as described by TaskState enumeration):

LAUNCHING

RUNNING when the task is being started.

FINISHED when the task finished with the serialized result.

FAILED when the task fails, e.g. when FetchFailedException, CommitDeniedException or

any Throwable occurs

651
Tasks

KILLED when an executor kills a task.

LOST

States are the values of org.apache.spark.TaskState .

Task status updates are sent from executors to the driver through
Note
ExecutorBackend.

Task is finished when it is in one of FINISHED , FAILED , KILLED , LOST .

LOST and FAILED states are considered failures.

Tip Task states correspond to org.apache.mesos.Protos.TaskState.

Collect Latest Values of (Internal and External)

Accumulators —  collectAccumulatorUpdates Method

collectAccumulatorUpdates(taskFailed: Boolean = false): Seq[AccumulableInfo]

collectAccumulatorUpdates collects the latest values of internal and external accumulators

from a task (and returns the values as a collection of AccumulableInfo).

Internally, collectAccumulatorUpdates takes TaskMetrics .

collectAccumulatorUpdates uses TaskContextImpl to access the task’s

Note
TaskMetrics .

collectAccumulatorUpdates collects the latest values of:

internal accumulators whose current value is not the zero value and the RESULT_SIZE
accumulator (regardless whether the value is its zero or not).

external accumulators when taskFailed is disabled ( false ) or which should be

included on failures.

collectAccumulatorUpdates returns an empty collection when TaskContextImpl is not

initialized.

collectAccumulatorUpdates is used when TaskRunner runs a task (and sends a

Note
task’s final results back to the driver).

Killing Task —  kill Method

652
Tasks

kill(interruptThread: Boolean)

kill marks the task to be killed, i.e. it sets the internal _killed flag to true .

kill calls TaskContextImpl.markInterrupted when context is set.

If interruptThread is enabled and the internal taskThread is available, kill interrupts it.

Caution FIXME When could context and interruptThread not be set?

653
ShuffleMapTask — Task for ShuffleMapStage

ShuffleMapTask — Task for ShuffleMapStage

ShuffleMapTask is a Task that computes a MapStatus , i.e. writes the result of computing

records in a RDD partition to the shuffle system and returns information about the
BlockManager and estimated size of the result shuffle blocks.

ShuffleMapTask is created exclusively when DAGScheduler submits missing tasks for a

ShuffleMapStage .

Table 1. ShuffleMapTask’s Internal Registries and Counters

Name Description
Collection of TaskLocations.
Corresponds directly to unique entries in locs with the
only rule that when locs is not defined, it is empty, and
preferredLocs no task location preferences are defined.
Initialized when ShuffleMapTask is created.
Used exclusively when ShuffleMapTask is requested for
preferred locations.

Note Spark uses broadcast variables to send (serialized) tasks to executors.

Creating ShuffleMapTask Instance

ShuffleMapTask takes the following when created:

stageId  — the stage of the task

stageAttemptId  — the stage’s attempt

taskBinary  — the broadcast variable with the serialized task (as an array of bytes)

Partition

Collection of TaskLocations

localProperties  — task-specific local properties

serializedTaskMetrics  — the serialized FIXME (as an array of bytes)

jobId  — optional ActiveJob id (default: undefined)

appId  — optional application id (default: undefined)

appAttemptId  — optional application attempt id (default: undefined)

654
ShuffleMapTask — Task for ShuffleMapStage

ShuffleMapTask calculates preferredLocs internal attribute that is the input locs if defined.

Otherwise, it is empty.

preferredLocs and locs are transient so they are not sent over the wire with
Note
the task.

ShuffleMapTask initializes the internal registries and counters.

Writing Records (After Computing RDD Partition) to Shuffle

System —  runTask Method

runTask(context: TaskContext): MapStatus

Note runTask is part of Task contract to…​FIXME

runTask computes a MapStatus (which is the BlockManager and an estimated size of the

result shuffle block) after the records of the Partition were written to the shuffle system.

Internally, runTask uses the current closure Serializer to deserialize the taskBinary
serialized task (into a pair of RDD and ShuffleDependency).

runTask measures the thread and CPU time for deserialization (using the System clock and

JMX if supported) and stores it in _executorDeserializeTime and

_executorDeserializeCpuTime attributes.

Note runTask uses SparkEnv to access the current closure Serializer .

Note The taskBinary serialized task is given when ShuffleMapTask is created.

runTask requests ShuffleManager for a ShuffleWriter (given the ShuffleHandle of the

deserialized ShuffleDependency , partitionId and input TaskContext).

Note runTask uses SparkEnv to access the current ShuffleManager .

Note The partitionId partition is given when ShuffleMapTask is created.

runTask gets the records in the RDD partition (as an Iterator ) and writes them (to the

shuffle system).

This is the moment in Task 's lifecycle (and its corresponding RDD) when a
Note RDD partition is computed and in turn becomes a sequence of records (i.e. real
data) on a executor.

runTask stops the ShuffleWriter (with success flag enabled) and returns the MapStatus .

655
ShuffleMapTask — Task for ShuffleMapStage

When the record writing was not successful, runTask stops the ShuffleWriter (with
success flag disabled) and the exception is re-thrown.

You may also see the following DEBUG message in the logs when the ShuffleWriter could
not be stopped.

DEBUG Could not stop writer

preferredLocations Method

preferredLocations: Seq[TaskLocation]

Note preferredLocations is part of Task contract to…​FIXME

preferredLocations simply returns preferredLocs internal property.

656
ResultTask

ResultTask
ResultTask is a Task that executes a function on the records in a RDD partition.

ResultTask is created exclusively when DAGScheduler submits missing tasks for a

ResultStage .

ResultTask is created with a broadcast variable with the RDD and the function to execute it

on and the partition.

Table 1. ResultTask’s Internal Registries and Counters

Name Description
Collection of TaskLocations.
Corresponds directly to unique entries in locs with the
only rule that when locs is not defined, it is empty, and
preferredLocs no task location preferences are defined.
Initialized when ResultTask is created.
Used exclusively when ResultTask is requested for
preferred locations.

Creating ResultTask Instance

ResultTask takes the following when created:

stageId  — the stage the task is executed for

stageAttemptId  — the stage attempt id

Broadcast variable with the serialized task (as Array[Byte] ). The broadcast contains
of a serialized pair of RDD and the function to execute.

Partition to compute

Collection of TaskLocations, i.e. preferred locations (executors) to execute the task on

outputId

local Properties

The stage’s serialized TaskMetrics (as Array[Byte] )

(optional) Job id

(optional) Application id

657
ResultTask

(optional) Application attempt id

ResultTask initializes the internal registries and counters.

preferredLocations Method

preferredLocations: Seq[TaskLocation]

Note preferredLocations is part of Task contract.

preferredLocations simply returns preferredLocs internal property.

Deserialize RDD and Function (From Broadcast) and

Execute Function (on RDD Partition) —  runTask Method

runTask(context: TaskContext): U

Note U is the type of a result as defined when ResultTask is created.

runTask deserializes a RDD and a function from the broadcast and then executes the

function (on the records from the RDD partition).

Note runTask is part of Task contract to run a task.

Internally, runTask starts by tracking the time required to deserialize a RDD and a function
to execute.

runTask creates a new closure Serializer .

Note runTask uses SparkEnv to access the current closure Serializer .

runTask requests the closure Serializer to deserialize an RDD and the function to

execute (from taskBinary broadcast).

Note taskBinary broadcast is defined when ResultTask is created.

runTask records _executorDeserializeTime and _executorDeserializeCpuTime properties.

In the end, runTask executes the function (passing in the input context and the records
from partition of the RDD).

partition to use to access the records in a deserialized RDD is defined when

Note
ResultTask was created.

658
ResultTask

659
FetchFailedException

FetchFailedException
FetchFailedException exception may be thrown when a task runs (and

ShuffleBlockFetcherIterator did not manage to fetch shuffle blocks).

FetchFailedException contains the following:

the unique identifier for a BlockManager (as BlockManagerId)

shuffleId

mapId

reduceId

A short exception message

cause - the root Throwable object

When FetchFailedException is reported, TaskRunner catches it and notifies

ExecutorBackend (with TaskState.FAILED task state).

The root cause of the FetchFailedException is usually because the executor (with the
BlockManager for the shuffle blocks) is lost (i.e. no longer available) due to:

1. OutOfMemoryError could be thrown (aka OOMed) or some other unhandled exception.

2. The cluster manager that manages the workers with the executors of your Spark
application, e.g. YARN, enforces the container memory limits and eventually decided to
kill the executor due to excessive memory usage.

You should review the logs of the Spark application using web UI, Spark History Server or
cluster-specific tools like yarn logs -applicationId for Hadoop YARN.

A solution is usually to tune the memory of your Spark application.

Caution FIXME Image with the call to ExecutorBackend.

toTaskFailedReason Method

Caution FIXME

660
MapStatus — Shuffle Map Output Status

MapStatus — Shuffle Map Output Status

MapStatus is the result of running a ShuffleMapTask that includes information about the

BlockManager and estimated size of the reduce blocks.

There are two types of MapStatus :

CompressedMapStatus that compresses the estimated map output size to 8 bits

( Byte ) for efficient reporting.

HighlyCompressedMapStatus that stores the average size of non-empty blocks, and

a compressed bitmap for tracking which blocks are empty.

When the number of blocks (the size of uncompressedSizes ) is greater than 2000,
HighlyCompressedMapStatus is chosen.

Caution FIXME What exactly is 2000? Is this the number of tasks in a job?

MapStatus Contract

trait MapStatus {
def location: BlockManagerId
def getSizeForBlock(reduceId: Int): Long
}

Note MapStatus is a private[spark] contract.

Table 1. MapStatus Contract

Method Description

location
The BlockManager where a ShuffleMapTask ran and the
result is stored.

getSizeForBlock The estimated size for the reduce block (in bytes).

661
TaskSet — Set of Tasks for Stage

TaskSet — Set of Tasks for Single Stage

A TaskSet is a collection of tasks that belong to a single stage and a stage attempt. It has
also priority and properties attributes. Priority is used in FIFO scheduling mode (see
Priority Field and FIFO Scheduling) while properties are the properties of the first job in the
stage.

Caution FIXME Where are properties of a TaskSet used?

A TaskSet represents the missing partitions of a stage.

The pair of a stage and a stage attempt uniquely describes a TaskSet and that is what you
can see in the logs when a TaskSet is used:

TaskSet [stageId].[stageAttemptId]

A TaskSet contains a fully-independent sequence of tasks that can run right away based on
the data that is already on the cluster, e.g. map output files from previous stages, though it
may fail if this data becomes unavailable.

TaskSet can be submitted (consult TaskScheduler Contract).

removeRunningTask
Caution FIXME Review TaskSet.removeRunningTask(tid)

Where TaskSets are used

DAGScheduler.submitMissingTasks

TaskSchedulerImpl.submitTasks

TaskSchedulerImpl.createTaskSetManager

Priority Field and FIFO Scheduling

A TaskSet has priority field that turns into the priority field’s value of TaskSetManager
(which is a Schedulable).

The priority field is used in FIFOSchedulingAlgorithm in which equal priorities give stages
an advantage (not to say priority).

662
TaskSet — Set of Tasks for Stage

FIFOSchedulingAlgorithm is only used for FIFO scheduling mode in a Pool (i.e.

Note
a schedulable collection of Schedulable objects).

Effectively, the priority field is the job’s id of the first job this stage was part of (for FIFO
scheduling).

663
TaskSetManager

TaskSetManager
TaskSetManager is a Schedulable that manages scheduling of tasks in a TaskSet.

A TaskSet represents a set of tasks that correspond to missing partitions of a

Note
stage.

TaskSetManager is created when TaskSchedulerImpl submits tasks (for a given TaskSet ).

Figure 1. TaskSetManager and its Dependencies

When TaskSetManager is created for a TaskSet, TaskSetManager registers all the tasks as
pending execution.

TaskSetManager is notified when a task (from the TaskSet it manages) finishes 

— sucessfully or due to a failure (in task execution or an executor being lost).

TaskSetManager uses maxTaskFailures to control how many times a single task can fail

before an entire TaskSet gets aborted that can take the following values:

664
TaskSetManager

1 for local run mode

maxFailures in Spark local-with-retries (i.e. local[N, maxFailures] )

spark.task.maxFailures property for Spark local-cluster and Spark clustered (using

Spark Standalone, Mesos and YARN)

The responsibilities of a TaskSetManager include:

Scheduling the tasks in a taskset

Retrying tasks on failure

Locality-aware scheduling via delay scheduling

Enable DEBUG logging levels for org.apache.spark.scheduler.TaskSchedulerImpl (or

org.apache.spark.scheduler.cluster.YarnScheduler for YARN) and org.apache.spark.scheduler.T
following two-stage job to see their low-level innerworkings.
A cluster manager is recommended since it gives more task localization choices (with YARN add
localization).

$ ./bin/spark-shell --master yarn --conf spark.ui.showConsoleProgress=false

// Keep # partitions low to keep # messages low

scala> sc.parallelize(0 to 9, 3).groupBy(_ % 3).count
INFO YarnScheduler: Adding task set 0.0 with 3 tasks
DEBUG TaskSetManager: Epoch for TaskSet 0.0: 0
DEBUG TaskSetManager: Valid locality levels for TaskSet 0.0: NO_PREF, ANY
DEBUG YarnScheduler: parentName: , name: TaskSet_0.0, runningTasks: 0
INFO TaskSetManager: Starting task 0.0 in stage 0.0 (TID 0, 10.0.2.87, executor 1, partition
INFO TaskSetManager: Starting task 1.0 in stage 0.0 (TID 1, 10.0.2.87, executor 2, partition
DEBUG YarnScheduler: parentName: , name: TaskSet_0.0, runningTasks: 1
INFO TaskSetManager: Starting task 2.0 in stage 0.0 (TID 2, 10.0.2.87, executor 1, partition
DEBUG YarnScheduler: parentName: , name: TaskSet_0.0, runningTasks: 1
DEBUG TaskSetManager: No tasks for locality level NO_PREF, so moving to locality level ANY
Tip INFO TaskSetManager: Finished task 0.0 in stage 0.0 (TID 0) in 518 ms on 10.0.2.87 (executor
INFO TaskSetManager: Finished task 1.0 in stage 0.0 (TID 1) in 512 ms on 10.0.2.87 (executor
DEBUG YarnScheduler: parentName: , name: TaskSet_0.0, runningTasks: 0
INFO TaskSetManager: Finished task 2.0 in stage 0.0 (TID 2) in 51 ms on 10.0.2.87 (executor 1
INFO YarnScheduler: Removed TaskSet 0.0, whose tasks have all completed, from pool
INFO YarnScheduler: Adding task set 1.0 with 3 tasks
DEBUG TaskSetManager: Epoch for TaskSet 1.0: 1
DEBUG TaskSetManager: Valid locality levels for TaskSet 1.0: NODE_LOCAL, RACK_LOCAL, ANY
DEBUG YarnScheduler: parentName: , name: TaskSet_1.0, runningTasks: 0
INFO TaskSetManager: Starting task 0.0 in stage 1.0 (TID 3, 10.0.2.87, executor 2, partition
INFO TaskSetManager: Starting task 1.0 in stage 1.0 (TID 4, 10.0.2.87, executor 1, partition
DEBUG YarnScheduler: parentName: , name: TaskSet_1.0, runningTasks: 1
INFO TaskSetManager: Starting task 2.0 in stage 1.0 (TID 5, 10.0.2.87, executor 1, partition
INFO TaskSetManager: Finished task 1.0 in stage 1.0 (TID 4) in 130 ms on 10.0.2.87 (executor
DEBUG YarnScheduler: parentName: , name: TaskSet_1.0, runningTasks: 1
DEBUG TaskSetManager: No tasks for locality level NODE_LOCAL, so moving to locality level RAC
DEBUG TaskSetManager: No tasks for locality level RACK_LOCAL, so moving to locality level ANY
INFO TaskSetManager: Finished task 0.0 in stage 1.0 (TID 3) in 133 ms on 10.0.2.87 (executor
DEBUG YarnScheduler: parentName: , name: TaskSet_1.0, runningTasks: 0
INFO TaskSetManager: Finished task 2.0 in stage 1.0 (TID 5) in 21 ms on 10.0.2.87 (executor 1
INFO YarnScheduler: Removed TaskSet 1.0, whose tasks have all completed, from pool
res0: Long = 3

Table 1. TaskSetManager’s Internal Registries and Counters

665
TaskSetManager

Name Description

Indices of all the pending tasks to execute (regardless of

their localization preferences).
allPendingTasks
Updated with an task index when TaskSetManager
registers a task as pending execution (per preferred
locations).

The number of the tasks that have already completed

execution.
calculatedTasks
Starts from 0 when a TaskSetManager is created and is
only incremented when the TaskSetManager checks that
there is enough memory to fetch a task result.

The number of task copies currently running per task

(index in its task set).
The number of task copies of a task is increased when
copiesRunning
finds a task for execution (given resource offer) or
checking for speculatable tasks and decreased when a
task fails or an executor is lost (for a shuffle map stage
and no external shuffle service).

currentLocalityIndex

epoch Current map output tracker epoch.

Lookup table of TaskInfo indices that failed to executor

failedExecutors ids and the time of the failure.
Used in handleFailedTask.

Disabled, i.e. false , by default.

isZombie
Read Zombie state in this document.

lastLaunchTime

localityWaits

TaskLocality locality preferences of the pending tasks in

the TaskSet ranging from PROCESS_LOCAL through
NODE_LOCAL , NO_PREF , and RACK_LOCAL to ANY .

NOTE: myLocalityLevels may contain only a few of all

myLocalityLevels
the available TaskLocality preferences with ANY as a
mandatory task locality preference.
Set immediately when TaskSetManager is created.

Recomputed every change in the status of executors.

666
TaskSetManager

name

Array of the number of task failures per task.

numFailures Incremented when TaskSetManager handles a task failure

and immediatelly checked if above acceptable number of
task failures.

numTasks Number of tasks to compute.

Lookup table of the indices of tasks pending execution

per executor.

pendingTasksForExecutor Updated with an task index and executor when

TaskSetManager registers a task as pending execution
(per preferred locations) (and the location is a
ExecutorCacheTaskLocation or HDFSCacheTaskLocation ).

Lookup table of the indices of tasks pending execution

per host.
pendingTasksForHost
Updated with an task index and host when
TaskSetManager registers a task as pending execution
(per preferred locations).

Lookup table of the indices of tasks pending execution

per rack.
pendingTasksForRack
Updated with an task index and rack when
TaskSetManager registers a task as pending execution
(per preferred locations).

Lookup table of the indices of tasks pending execution

with no location preferences.
pendingTasksWithNoPrefs
Updated with an task index when TaskSetManager
registers a task as pending execution (per preferred
locations).

priority

recentExceptions

Collection of running tasks that a TaskSetManager

manages.
Used to implement runningTasks (that is simply the size
of runningTasksSet but a required part of any
runningTasksSet
Schedulable). runningTasksSet is expanded when
registering a running task and shrinked when
unregistering a running task.

667
TaskSetManager

Used in TaskSchedulerImpl to cancel tasks.

speculatableTasks

The stage’s id a TaskSetManager runs for.

stageId Set when TaskSetManager is created.
NOTE: stageId is part of Schedulable contract.

Status of tasks (with a boolean flag, i.e. true or false ,

per task).

All tasks start with their flags disabled, i.e. false , when
TaskSetManager is created.
successful
The flag for a task is turned on, i.e. true , when a task
finishes successfully but also with a failure.

A flag is explicitly turned off only for ShuffleMapTask

tasks when their executor is lost.

taskAttempts Registry of TaskInfos per every task attempt per task.

Registry of TaskInfos per task id.

Updated with the task (id) and the corresponding
TaskInfo when TaskSetManager finds a task for

taskInfos
execution (given resource offer).
NOTE: It appears that the entires stay forever, i.e. are
never removed (perhaps because the maintenance
overhead is not needed given a TaskSetManager is a
short-lived entity).

Lookup table of Tasks (per partition id) to schedule

execution of.
tasks
NOTE: The tasks all belong to a single TaskSet that was
given when TaskSetManager was created (which actually
represent a single Stage).

tasksSuccessful

The current total size of the result of all the tasks that
have finished.

totalResultSize
Starts from 0 when TaskSetManager is created.

Only increased with the size of a task result whenever a

TaskSetManager checks that there is enough memory to
fetch the task result.

668
TaskSetManager

Enable DEBUG logging level for org.apache.spark.scheduler.TaskSetManager

logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.scheduler.TaskSetManager=DEBUG

Refer to Logging.

isTaskBlacklistedOnExecOrNode Method

Caution FIXME

getLocalityIndex Method

Caution FIXME

dequeueSpeculativeTask Method

Caution FIXME

executorAdded Method
executorAdded simply calls recomputeLocality method.

abortIfCompletelyBlacklisted Method

Caution FIXME

TaskSetManager is Schedulable
TaskSetManager is a Schedulable with the following implementation:

name is TaskSet_[taskSet.stageId.toString]

no parent is ever assigned, i.e. it is always null .

It means that it can only be a leaf in the tree of Schedulables (with Pools being the
nodes).

669
TaskSetManager

schedulingMode always returns SchedulingMode.NONE (since there is nothing to

schedule).

weight is always 1 .

minShare is always 0 .

runningTasks is the number of running tasks in the internal runningTasksSet .

priority is the priority of the owned TaskSet (using taskSet.priority ).

stageId is the stage id of the owned TaskSet (using taskSet.stageId ).

schedulableQueue returns no queue, i.e. null .

addSchedulable and removeSchedulable do nothing.

getSchedulableByName always returns null .

getSortedTaskSetQueue returns a one-element collection with the sole element being

itself.

executorLost

checkSpeculatableTasks

Marking Task As Fetching Indirect Result 

—  handleTaskGettingResult Method

handleTaskGettingResult(tid: Long): Unit

handleTaskGettingResult finds TaskInfo for tid task in taskInfos internal registry and

marks it as fetching indirect task result. It then notifies DAGScheduler .

handleTaskGettingResult is executed when TaskSchedulerImpl is notified about

Note
fetching indirect task result.

Registering Running Task —  addRunningTask Method

addRunningTask(tid: Long): Unit

addRunningTask adds tid to runningTasksSet internal registry and requests the parent

pool to increase the number of running tasks (if defined).

670
TaskSetManager

Unregistering Running Task —  removeRunningTask

Method

removeRunningTask(tid: Long): Unit

removeRunningTask removes tid from runningTasksSet internal registry and requests the

parent pool to decrease the number of running task (if defined).

Checking Speculatable Tasks 

—  checkSpeculatableTasks Method

Note checkSpeculatableTasks is part of the Schedulable Contract.

checkSpeculatableTasks(minTimeToSpeculation: Int): Boolean

checkSpeculatableTasks checks whether there are speculatable tasks in a TaskSet .

checkSpeculatableTasks is called when TaskSchedulerImpl checks for

Note
speculatable tasks.

If the TaskSetManager is zombie or has a single task in TaskSet, it assumes no speculatable

tasks.

The method goes on with the assumption of no speculatable tasks by default.

It computes the minimum number of finished tasks for speculation (as

spark.speculation.quantile of all the finished tasks).

You should see the DEBUG message in the logs:

DEBUG Checking for speculative tasks: minFinished = [minFinishedForSpeculation]

It then checks whether the number is equal or greater than the number of tasks completed
successfully (using tasksSuccessful ).

Having done that, it computes the median duration of all the successfully completed tasks
(using taskInfos internal registry) and task length threshold using the median duration
multiplied by spark.speculation.multiplier that has to be equal or less than 100 .

You should see the DEBUG message in the logs:

DEBUG Task length threshold for speculation: [threshold]

671
TaskSetManager

For each task (using taskInfos internal registry) that is not marked as successful yet (using
successful ) for which there is only one copy running (using copiesRunning ) and the task

takes more time than the calculated threshold, but it was not in speculatableTasks it is
assumed speculatable.

You should see the following INFO message in the logs:

INFO Marking task [index] in stage [taskSet.id] (on [info.host]) as speculatable becau
se it ran more than [threshold] ms

The task gets added to the internal speculatableTasks collection. The method responds
positively.

getAllowedLocalityLevel Method

Caution FIXME

Finding Task For Execution (Given Resource Offer) 

—  resourceOffer Method

resourceOffer(
execId: String,
host: String,
maxLocality: TaskLocality): Option[TaskDescription]

(only if TaskSetBlacklist is defined) resourceOffer requests TaskSetBlacklist to check if

the input execId executor or host node are blacklisted.

When TaskSetManager is a zombie or the resource offer (as executor and host) is
blacklisted, resourceOffer finds no tasks to execute (and returns no TaskDescription).

resourceOffer finds a task to schedule for a resource offer when neither

Note
TaskSetManager is a zombie nor the resource offer is blacklisted.

resourceOffer calculates the allowed task locality for task selection. When the input

maxLocality is not NO_PREF task locality, resourceOffer getAllowedLocalityLevel (for the

current time) and sets it as the current task locality if more localized (specific).

TaskLocality can be the most localized PROCESS_LOCAL , NODE_LOCAL through

Note
NO_PREF and RACK_LOCAL to ANY .

resourceOffer dequeues a task tor execution (given locality information).

672
TaskSetManager

If a task (index) is found, resourceOffer takes the Task (from tasks registry).

resourceOffer requests TaskSchedulerImpl for the id for the new task.

resourceOffer increments the number of the copies of the task that are currently running

and finds the task attempt number (as the size of taskAttempts entries for the task index).

resourceOffer creates a TaskInfo that is then registered in taskInfos and taskAttempts.

If the maximum acceptable task locality is not NO_PREF , resourceOffer getLocalityIndex

(using the task’s locality) and records it as currentLocalityIndex with the current time as
lastLaunchTime.

resourceOffer serializes the task.

resourceOffer uses SparkEnv to access the closure Serializer and create

Note
an instance thereof.

If the task serialization fails, you should see the following ERROR message in the logs:

Failed to serialize task [taskId], not attempting to retry it.

resourceOffer aborts the TaskSet with the following message and reports a

TaskNotSerializableException .

Failed to serialize task [taskId], not attempting to retry it.

Exception during serialization: [exception]

resourceOffer checks the size of the serialized task. If it is greater than 100 kB, you

should see the following WARN message in the logs:

WARN Stage [id] contains a task of very large size ([size] KB).
The maximum recommended task size is 100 KB.

Note The size of the serializable task, i.e. 100 kB, is not configurable.

If however the serialization went well and the size is fine too, resourceOffer registers the
task as running.

You should see the following INFO message in the logs:

INFO TaskSetManager: Starting [name] (TID [id], [host], executor

[id], partition [id], [taskLocality], [size] bytes)

673
TaskSetManager

For example:

INFO TaskSetManager: Starting task 1.0 in stage 0.0 (TID 1,

localhost, partition 1, PROCESS_LOCAL, 2054 bytes)

resourceOffer notifies DAGScheduler that the task has been started.

This is the moment when TaskSetManager informs DAGScheduler that a

Important
task has started.

Note resourceOffer is used when TaskSchedulerImpl resourceOfferSingleTaskSet.

Dequeueing Task For Execution (Given Locality

Information) —  dequeueTask Internal Method

dequeueTask(execId: String, host: String, maxLocality: TaskLocality): Option[(Int, Tas

kLocality, Boolean)]

dequeueTask tries to find the higest task index (meeting localization requirements) using

tasks (indices) registered for execution on execId executor. If a task is found, dequeueTask
returns its index, PROCESS_LOCAL task locality and the speculative marker disabled.

dequeueTask then goes over all the possible task localities and checks what locality is

allowed given the input maxLocality .

dequeueTask checks out NODE_LOCAL , NO_PREF , RACK_LOCAL and ANY in that order.

For NODE_LOCAL dequeueTask tries to find the higest task index (meeting localization
requirements) using tasks (indices) registered for execution on host host and if found
returns its index, NODE_LOCAL task locality and the speculative marker disabled.

For NO_PREF dequeueTask tries to find the higest task index (meeting localization
requirements) using pendingTasksWithNoPrefs internal registry and if found returns its
index, PROCESS_LOCAL task locality and the speculative marker disabled.

Note For NO_PREF the task locality is PROCESS_LOCAL .

For RACK_LOCAL dequeueTask finds the rack for the input host and if available tries to find
the higest task index (meeting localization requirements) using tasks (indices) registered for
execution on the rack. If a task is found, dequeueTask returns its index, RACK_LOCAL task
locality and the speculative marker disabled.

674
TaskSetManager

For ANY dequeueTask tries to find the higest task index (meeting localization requirements)
using allPendingTasks internal registry and if found returns its index, ANY task locality and
the speculative marker disabled.

In the end, when no task could be found, dequeueTask dequeueSpeculativeTask and if

found returns its index, locality and the speculative marker enabled.

The speculative marker is enabled for a task only when dequeueTask did not
Note manage to find a task for the available task localities and did find a speculative
task.

dequeueTask is used exclusively when TaskSetManager finds a task for

Note
execution (given resource offer).

Finding Higest Task Index (Not Blacklisted, With No Copies

Running and Not Completed Already) 
—  dequeueTaskFromList Internal Method

dequeueTaskFromList(
execId: String,
host: String,
list: ArrayBuffer[Int]): Option[Int]

dequeueTaskFromList takes task indices from the input list backwards (from the last to the

first entry). For every index dequeueTaskFromList checks if it is not blacklisted on the input
execId executor and host and if not, checks that:

number of the copies of the task currently running is 0

the task has not been marked as completed

If so, dequeueTaskFromList returns the task index.

If dequeueTaskFromList has checked all the indices and no index has passed the checks,
dequeueTaskFromList returns None (to indicate that no index has met the requirements).

dequeueTaskFromList is used exclusively when TaskSetManager dequeues a

Note
task tor execution (given locality information).

Finding Tasks (Indices) Registered For Execution on

Executor —  getPendingTasksForExecutor Internal
Method

675
TaskSetManager

getPendingTasksForExecutor(executorId: String): ArrayBuffer[Int]

getPendingTasksForExecutor finds pending tasks (indices) registered for execution on the

input executorId executor (in pendingTasksForExecutor internal registry).

getPendingTasksForExecutor may find no matching tasks and return an empty

Note
collection.

getPendingTasksForExecutor is used exclusively when TaskSetManager

Note
dequeues a task tor execution (given locality information).

Finding Tasks (Indices) Registered For Execution on Host 

—  getPendingTasksForHost Internal Method

getPendingTasksForHost(host: String): ArrayBuffer[Int]

getPendingTasksForHost finds pending tasks (indices) registered for execution on the input

host host (in pendingTasksForHost internal registry).

getPendingTasksForHost may find no matching tasks and return an empty

Note
collection.

getPendingTasksForHost is used exclusively when TaskSetManager dequeues a

Note
task tor execution (given locality information).

Finding Tasks (Indices) Registered For Execution on Rack 

—  getPendingTasksForRack Internal Method

getPendingTasksForRack(rack: String): ArrayBuffer[Int]

getPendingTasksForRack finds pending tasks (indices) registered for execution on the input

rack rack (in pendingTasksForRack internal registry).

getPendingTasksForRack may find no matching tasks and return an empty

Note
collection.

getPendingTasksForRack is used exclusively when TaskSetManager dequeues a

Note
task tor execution (given locality information).

Scheduling Tasks in TaskSet

676
TaskSetManager

Caution FIXME

For each submitted TaskSet, a new TaskSetManager is created. The TaskSetManager

completely and exclusively owns a TaskSet submitted for execution.

Caution FIXME A picture with TaskSetManager owning TaskSet

FIXME What component knows about TaskSet and TaskSetManager. Isn’t it

Caution that TaskSets are created by DAGScheduler while TaskSetManager is used
by TaskSchedulerImpl only?

TaskSetManager keeps track of the tasks pending execution per executor, host, rack or with
no locality preferences.

Locality-Aware Scheduling aka Delay Scheduling

TaskSetManager computes locality levels for the TaskSet for delay scheduling. While
computing you should see the following DEBUG in the logs:

DEBUG Valid locality levels for [taskSet]: [levels]

Caution FIXME What’s delay scheduling?

Events
Once a task has finished, TaskSetManager informs DAGScheduler.

Caution FIXME

Recording Successful Task And Notifying DAGScheduler 

—  handleSuccessfulTask Method

handleSuccessfulTask(tid: Long, result: DirectTaskResult[_]): Unit

handleSuccessfulTask records the tid task as finished, notifies the DAGScheduler that the

task has ended and attempts to mark the TaskSet finished.

handleSuccessfulTask is executed after TaskSchedulerImpl has been informed

Note
that tid task finished successfully (and the task result was deserialized).

Internally, handleSuccessfulTask finds TaskInfo (in taskInfos internal registry) and marks it
as FINISHED .

677
TaskSetManager

It then removes tid task from runningTasksSet internal registry.

handleSuccessfulTask notifies DAGScheduler that tid task ended successfully (with the

Task object from tasks internal registry and the result as Success ).

At this point, handleSuccessfulTask finds the other running task attempts of tid task and
requests SchedulerBackend to kill them (since they are no longer necessary now when at
least one task attempt has completed successfully). You should see the following INFO
message in the logs:

INFO Killing attempt [attemptNumber] for task [id] in stage [id]

(TID [id]) on [host] as the attempt [attemptNumber] succeeded on
[host]

Caution FIXME Review taskAttempts

If tid has not yet been recorded as successful, handleSuccessfulTask increases

tasksSuccessful counter. You should see the following INFO message in the logs:

INFO Finished task [id] in stage [id] (TID [taskId]) in

[duration] ms on [host] (executor [executorId])
([tasksSuccessful]/[numTasks])

tid task is marked as successful. If the number of task that have finished successfully is

exactly the number of the tasks to execute (in the TaskSet ), the TaskSetManager becomes
a zombie.

If tid task was already recorded as successful, you should merely see the following INFO
message in the logs:

INFO Ignoring task-finished event for [id] in stage [id] because

task [index] has already completed successfully

Ultimately, handleSuccessfulTask attempts to mark the TaskSet finished.

Attempting to Mark TaskSet Finished 

—  maybeFinishTaskSet Internal Method

maybeFinishTaskSet(): Unit

678
TaskSetManager

maybeFinishTaskSet notifies TaskSchedulerImpl that a TaskSet has finished when there are

no other running tasks and the TaskSetManager is not in zombie state.

Retrying Tasks on Failure

Caution FIXME

Up to spark.task.maxFailures attempts

Task retries and spark.task.maxFailures

When you start Spark program you set up spark.task.maxFailures for the number of failures
that are acceptable until TaskSetManager gives up and marks a job failed.

In Spark shell with local master, spark.task.maxFailures is fixed to 1 and you

Tip
need to use local-with-retries master to change it to some other value.

In the following example, you are going to execute a job with two partitions and keep one
failing at all times (by throwing an exception). The aim is to learn the behavior of retrying
task execution in a stage in TaskSet. You will only look at a single task execution, namely
0.0 .

679
TaskSetManager

$ ./bin/spark-shell --master "local[*, 5]"

...
scala> sc.textFile("README.md", 2).mapPartitionsWithIndex((idx, it) => if (idx == 0) t
hrow new Exception("Partition 2 marked failed") else it).count
...
15/10/27 17:24:56 INFO DAGScheduler: Submitting 2 missing tasks from ResultStage 1 (Ma
pPartitionsRDD[7] at mapPartitionsWithIndex at <console>:25)
15/10/27 17:24:56 DEBUG DAGScheduler: New pending partitions: Set(0, 1)
15/10/27 17:24:56 INFO TaskSchedulerImpl: Adding task set 1.0 with 2 tasks
...
15/10/27 17:24:56 INFO TaskSetManager: Starting task 0.0 in stage 1.0 (TID 2, localhos
t, partition 0,PROCESS_LOCAL, 2062 bytes)
...
15/10/27 17:24:56 INFO Executor: Running task 0.0 in stage 1.0 (TID 2)
...
15/10/27 17:24:56 ERROR Executor: Exception in task 0.0 in stage 1.0 (TID 2)
java.lang.Exception: Partition 2 marked failed
...
15/10/27 17:24:56 INFO TaskSetManager: Starting task 0.1 in stage 1.0 (TID 4, localhos
t, partition 0,PROCESS_LOCAL, 2062 bytes)
15/10/27 17:24:56 INFO Executor: Running task 0.1 in stage 1.0 (TID 4)
15/10/27 17:24:56 INFO HadoopRDD: Input split: file:/Users/jacek/dev/oss/spark/README.
md:0+1784
15/10/27 17:24:56 ERROR Executor: Exception in task 0.1 in stage 1.0 (TID 4)
java.lang.Exception: Partition 2 marked failed
...
15/10/27 17:24:56 ERROR Executor: Exception in task 0.4 in stage 1.0 (TID 7)
java.lang.Exception: Partition 2 marked failed
...
15/10/27 17:24:56 INFO TaskSetManager: Lost task 0.4 in stage 1.0 (TID 7) on executor
localhost: java.lang.Exception (Partition 2 marked failed) [duplicate 4]
15/10/27 17:24:56 ERROR TaskSetManager: Task 0 in stage 1.0 failed 5 times; aborting j
ob
15/10/27 17:24:56 INFO TaskSchedulerImpl: Removed TaskSet 1.0, whose tasks have all co
mpleted, from pool
15/10/27 17:24:56 INFO TaskSchedulerImpl: Cancelling stage 1
15/10/27 17:24:56 INFO DAGScheduler: ResultStage 1 (count at <console>:25) failed in 0
.058 s
15/10/27 17:24:56 DEBUG DAGScheduler: After removal of stage 1, remaining stages = 0
15/10/27 17:24:56 INFO DAGScheduler: Job 1 failed: count at <console>:25, took 0.08581
0 s
org.apache.spark.SparkException: Job aborted due to stage failure: Task 0 in stage 1.0
failed 5 times, most recent failure: Lost task 0.4 in stage 1.0 (TID 7, localhost): j
ava.lang.Exception: Partition 2 marked failed

Zombie state
A TaskSetManager is in zombie state when all tasks in a taskset have completed
successfully (regardless of the number of task attempts), or if the taskset has been aborted.

680
TaskSetManager

While in zombie state, a TaskSetManager can launch no new tasks and responds with no
TaskDescription to resourceOffers.

A TaskSetManager remains in the zombie state until all tasks have finished running, i.e. to
continue to track and account for the running tasks.

Aborting TaskSet —  abort Method

abort(message: String, exception: Option[Throwable] = None): Unit

abort informs DAGScheduler that the TaskSet has been aborted.

Caution FIXME image with DAGScheduler call

The TaskSetManager enters zombie state.

Finally, abort attempts to mark the TaskSet finished.

Creating TaskSetManager Instance

TaskSetManager takes the following when created:

TaskSchedulerImpl

TaskSet that the TaskSetManager manages scheduling for

Acceptable number of task failure, i.e. how many times a single task can fail before an
entire TaskSet gets aborted.

(optional) BlacklistTracker

Clock (defaults to SystemClock )

TaskSetManager initializes the internal registries and counters.

maxTaskFailures is 1 for local run mode, maxFailures for Spark local-with-

Note retries, and spark.task.maxFailures property for Spark local-cluster and Spark
with cluster managers (Spark Standalone, Mesos and YARN).

TaskSetManager requests the current epoch from MapOutputTracker and sets it on all tasks

in the taskset.

TaskSetManager uses TaskSchedulerImpl (that was given when created) to

Note
access the current MapOutputTracker .

You should see the following DEBUG in the logs:

681
TaskSetManager

DEBUG Epoch for [taskSet]: [epoch]

Caution FIXME Why is the epoch important?

TaskSetManager requests MapOutputTracker from TaskSchedulerImpl which is

Note
likely for unit testing only since MapOutputTracker is available using SparkEnv .

TaskSetManager adds the tasks as pending execution (in reverse order from the highest

partition to the lowest).

FIXME Why is reverse order important? The code says it’s to execute tasks
Caution
with low indices first.

Getting Notified that Task Failed —  handleFailedTask

Method

handleFailedTask(
tid: Long,
state: TaskState,
reason: TaskFailedReason): Unit

handleFailedTask finds TaskInfo of tid task in taskInfos internal registry and simply quits if

the task is already marked as failed or killed.

Figure 2. TaskSetManager Gets Notified that Task Has Failed

handleFailedTask is executed after TaskSchedulerImpl has been informed that
Note tid task failed or an executor was lost. In either case, tasks could not finish
successfully or could not report their status back.

handleFailedTask unregisters tid task from the internal registry of running tasks and then

marks the corresponding TaskInfo as finished (passing in the input state ).

handleFailedTask decrements the number of the running copies of tid task (in

copiesRunning internal registry).

682
TaskSetManager

With speculative execution of tasks enabled, there can be many copies of a

Note
task running simultaneuosly.

handleFailedTask uses the following pattern as the reason of the failure:

Lost task [id] in stage [taskSetId] (TID [tid], [host], executor [executorId]): [reaso
n]

handleFailedTask then calculates the failure exception per the input reason (follow the

links for more details):

FetchFailed

ExceptionFailure

ExecutorLostFailure

other TaskFailedReasons

Description of how the final failure exception is "computed" was moved to

Note respective sections below to make the reading slightly more pleasant and
comprehensible.

handleFailedTask informs DAGScheduler that tid task has ended (passing on the Task

instance from tasks internal registry, the input reason , null result, calculated
accumUpdates per failure, and the TaskInfo).

This is the moment when TaskSetManager informs DAGScheduler that a

Important
task has ended.

If tid task has already been marked as completed (in successful internal registry) you
should see the following INFO message in the logs:

INFO Task [id] in stage [id] (TID [tid]) failed, but the task
will not be re-executed (either because the task failed with a
shuffle data fetch failure, so the previous stage needs to be
re-run, or because a different copy of the task has already
succeeded).

Read up on Speculative Execution of Tasks to find out why a single task could be
Tip
executed multiple times.

If however tid task was not recorded as completed, handleFailedTask records it as

pending.

683
TaskSetManager

If the TaskSetManager is not a zombie and the task failed reason should be counted
towards the maximum number of times the task is allowed to fail before the stage is aborted
(i.e. TaskFailedReason.countTowardsTaskFailures attribute is enabled), the optional
TaskSetBlacklist is notified (passing on the host, executor and the task’s index).

handleFailedTask then increments the number of failures for tid task and checks if the

number of failures is equal or greater than the allowed number of task failures per TaskSet
(as defined when the TaskSetManager was created).

If so, i.e. the number of task failures of tid task reached the maximum value, you should
see the following ERROR message in the logs:

ERROR Task [id] in stage [id] failed [maxTaskFailures] times; aborting job

And handleFailedTask aborts the TaskSet with the following message and then quits:

Task [index] in stage [id] failed [maxTaskFailures] times, most recent failure: [failu
reReason]

In the end (except when the number of failures of tid task grew beyond the acceptable
number), handleFailedTask attempts to mark the TaskSet as finished.

handleFailedTask is used when TaskSchedulerImpl is informed that a task has

Note
failed or when TaskSetManager is informed that an executor has been lost.

FetchFailed TaskFailedReason

For FetchFailed you should see the following WARN message in the logs:

WARN Lost task [id] in stage [id] (TID [tid], [host], executor [id]): [reason]

Unless tid has already been marked as successful (in successful internal registry), it
becomes so and the number of successful tasks in TaskSet gets increased.

The TaskSetManager enters zombie state.

The failure exception is empty.

ExceptionFailure TaskFailedReason

For ExceptionFailure , handleFailedTask checks if the exception is of type

NotSerializableException . If so, you should see the following ERROR message in the logs:

684
TaskSetManager

ERROR Task [id] in stage [id] (TID [tid]) had a not serializable result: [description]
; not retrying

And handleFailedTask aborts the TaskSet and then quits.

Otherwise, if the exception is not of type NotSerializableException , handleFailedTask

accesses accumulators and calculates whether to print the WARN message (with the failure
reason) or the INFO message.

If the failure has already been reported (and is therefore a duplication),

spark.logging.exceptionPrintInterval is checked before reprinting the duplicate exception in
its entirety.

For full printout of the ExceptionFailure , the following WARN appears in the logs:

WARN Lost task [id] in stage [id] (TID [tid], [host], executor [id]): [reason]

Otherwise, the following INFO appears in the logs:

INFO Lost task [id] in stage [id] (TID [tid]) on [host], executor [id]: [className] ([
description]) [duplicate [dupCount]]

The exception in ExceptionFailure becomes the failure exception.

ExecutorLostFailure TaskFailedReason

For ExecutorLostFailure if not exitCausedByApp , you should see the following INFO in the
logs:

INFO Task [tid] failed because while it was being computed, its executor exited for a
reason unrelated to the task. Not counting this failure towards the maximum number of
failures for the task.

The failure exception is empty.

Other TaskFailedReasons
For the other TaskFailedReasons, you should see the following WARN message in the logs:

WARN Lost task [id] in stage [id] (TID [tid], [host], executor [id]): [reason]

The failure exception is empty.

685
TaskSetManager

Registering Task As Pending Execution (Per Preferred

Locations) —  addPendingTask Internal Method

addPendingTask(index: Int): Unit

addPendingTask registers a index task in the pending-task lists that the task should be

eventually scheduled to (per its preferred locations).

Internally, addPendingTask takes the preferred locations of the task (given index ) and
registers the task in the internal pending-task registries for every preferred location:

pendingTasksForExecutor when the TaskLocation is ExecutorCacheTaskLocation .

pendingTasksForHost for the hosts of a TaskLocation.

pendingTasksForRack for the racks from TaskSchedulerImpl per the host (of a
TaskLocation).

For a TaskLocation being HDFSCacheTaskLocation , addPendingTask requests

TaskSchedulerImpl for the executors on the host (of a preferred location) and registers the

task in pendingTasksForExecutor for every executor (if available).

You should see the following INFO message in the logs:

INFO Pending task [index] has a cached location at [host] , where there are executors
[executors]

When addPendingTask could not find executors for a HDFSCacheTaskLocation preferred

location, you should see the following DEBUG message in the logs:

DEBUG Pending task [index] has a cached location at [host] , but there are no executor
s alive there.

If the task has no location preferences, addPendingTask registers it in

pendingTasksWithNoPrefs.

addPendingTask always registers the task in allPendingTasks.

addPendingTask is used immediatelly when TaskSetManager is created and later

Note
when handling a task failure or lost executor.

686
TaskSetManager

Re-enqueuing ShuffleMapTasks (with no

ExternalShuffleService) and Reporting All Running Tasks
on Lost Executor as Failed —  executorLost Method

executorLost(execId: String, host: String, reason: ExecutorLossReason): Unit

executorLost re-enqueues all the ShuffleMapTasks that have completed already on the lost

executor (when external shuffle service is not in use) and reports all currently-running tasks
on the lost executor as failed.

executorLost is part of the Schedulable contract that TaskSchedulerImpl uses

Note
to inform TaskSetManagers about lost executors.

Since TaskSetManager manages execution of the tasks in a single TaskSet,

when an executor gets lost, the affected tasks that have been running on the
Note
failed executor need to be re-enqueued. executorLost is the mechanism to
"announce" the event to all TaskSetManagers .

Internally, executorLost first checks whether the tasks are ShuffleMapTasks and whether
an external shuffle service is enabled (that could serve the map shuffle outputs in case of
failure).

executorLost checks out the first task in tasks as it is assumed the other
Note belong to the same stage. If the task is a ShuffleMapTask, the entire TaskSet is
for a ShuffleMapStage.

executorLost uses SparkEnv to access the current BlockManager and finds

Note out whether an external shuffle service is enabled or not (that is controlled using
spark.shuffle.service.enabled property).

If executorLost is indeed due to an executor lost that executed tasks for a ShuffleMapStage
(that this TaskSetManager manages) and no external shuffle server is enabled,
executorLost finds all the tasks that were scheduled on this lost executor and marks the

ones that were already successfully completed as not executed yet.

executorLost uses records every tasks on the lost executor in successful (as
Note false ) and decrements [copiesRunning copiesRunning], and tasksSuccessful
for every task.

executorLost registers every task as pending execution (per preferred locations) and

informs DAGScheduler that the tasks (on the lost executor) have ended (with Resubmitted
reason).

executorLost uses TaskSchedulerImpl to access the DAGScheduler .

Note
TaskSchedulerImpl is given when the TaskSetManager was created.

687
TaskSetManager

Regardless of whether this TaskSetManager manages ShuffleMapTasks or not (it could also
manage ResultTasks) and whether the external shuffle service is used or not, executorLost
finds all currently-running tasks on this lost executor and reports them as failed (with the task
state FAILED ).

executorLost finds out if the reason for the executor lost is due to application
fault, i.e. assumes ExecutorExited 's exit status as the indicator,
Note
ExecutorKilled for non-application’s fault and any other reason is an
application fault.

executorLost recomputes locality preferences.

Recomputing Task Locality Preferences 

—  recomputeLocality Method

recomputeLocality(): Unit

recomputeLocality recomputes the internal caches: myLocalityLevels, localityWaits and

currentLocalityIndex.

Caution FIXME But why are the caches important (and have to be recomputed)?

recomputeLocality records the current TaskLocality level of this TaskSetManager (that is

currentLocalityIndex in myLocalityLevels).

TaskLocality is one of PROCESS_LOCAL , NODE_LOCAL , NO_PREF , RACK_LOCAL

Note
and ANY values.

recomputeLocality computes locality levels (for scheduled tasks) and saves the result in

myLocalityLevels internal cache.

recomputeLocality computes localityWaits (by finding locality wait for every locality level in

myLocalityLevels internal cache).

In the end, recomputeLocality getLocalityIndex of the previous locality level and records it in
currentLocalityIndex.

recomputeLocality is used when TaskSetManager gets notified about status

Note
change in executors, i.e. when an executor is lost or added.

Computing Locality Levels (for Scheduled Tasks) 

—  computeValidLocalityLevels Internal Method

688
TaskSetManager

computeValidLocalityLevels(): Array[TaskLocality]

computeValidLocalityLevels computes valid locality levels for tasks that were registered in

corresponding registries per locality level.

TaskLocality is a task locality preference and can be the most localized

Note
PROCESS_LOCAL , NODE_LOCAL through NO_PREF and RACK_LOCAL to ANY .

Table 2. TaskLocalities and Corresponding Internal Registries

TaskLocality Internal Registry
PROCESS_LOCAL pendingTasksForExecutor

NODE_LOCAL pendingTasksForHost

NO_PREF pendingTasksWithNoPrefs

RACK_LOCAL pendingTasksForRack

computeValidLocalityLevels walks over every internal registry and if it is not empty

computes locality wait for the corresponding TaskLocality and proceeds with it only when
the locality wait is not 0 .

For TaskLocality with pending tasks, computeValidLocalityLevels asks TaskSchedulerImpl

whether there is at least one executor alive (for PROCESS_LOCAL, NODE_LOCAL and
RACK_LOCAL) and if so registers the TaskLocality .

computeValidLocalityLevels uses TaskSchedulerImpl that was given when

Note
TaskSetManager was created.

computeValidLocalityLevels always registers ANY task locality level.

In the end, you should see the following DEBUG message in the logs:

DEBUG TaskSetManager: Valid locality levels for [taskSet]: [comma-separated levels]

computeValidLocalityLevels is used when TaskSetManager is created and later

Note
to recompute locality.

Finding Locality Wait —  getLocalityWait Internal

Method

689
TaskSetManager

getLocalityWait(level: TaskLocality): Long

getLocalityWait finds locality wait (in milliseconds) for a given TaskLocality.

getLocalityWait uses spark.locality.wait (default: 3s ) when the TaskLocality -specific

property is not defined or 0 for NO_PREF and ANY .

Note NO_PREF and ANY task localities have no locality wait.

Table 3. TaskLocalities and Corresponding Spark Properties

TaskLocality Spark Property
PROCESS_LOCAL spark.locality.wait.process

NODE_LOCAL spark.locality.wait.node

RACK_LOCAL spark.locality.wait.rack

getLocalityWait is used when TaskSetManager calculates localityWaits,

Note computes locality levels (for scheduled tasks) and recomputes locality
preferences.

Checking Available Memory For Task Results 

—  canFetchMoreResults Method

canFetchMoreResults(size: Long): Boolean

canFetchMoreResults checks whether there is enough memory to fetch the result of a task.

Internally, canFetchMoreResults increments the internal totalResultSize with the input size
(which is the size of the result of a task) and increments the internal calculatedTasks.

If the current internal totalResultSize is bigger than the maximum result size,
canFetchMoreResults prints out the following ERROR message to the logs:

Total size of serialized results of [calculatedTasks] tasks ([totalResultSize]) is big

ger than spark.driver.maxResultSize ([maxResultSize])

canFetchMoreResults uses spark.driver.maxResultSize configuration property to

Note
control the maximum result size. The default value is 1g .

In the end, canFetchMoreResults aborts the TaskSet and returns false .

690
TaskSetManager

Otherwise, canFetchMoreResults returns true .

canFetchMoreResults is used exclusively when TaskResultGetter is requested

Note
to enqueue a successful task.

Settings

691
TaskSetManager

Table 4. Spark Properties

Spark Property Default Value Description

The maximum size of all

the task results in a
TaskSet . If the value is
smaller than 1m or
1048576 (1024 * 1024),
spark.driver.maxResultSize 1g it is considered 0 .
Used when
TaskSetManager checks
available memory for a
task result and
Utils.getMaxResultSize

Time interval to pass

after which a task can be
re-launched on the
spark.scheduler.executorTaskBlacklistTime 0L
executor where it has
once failed. It is to
prevent repeated task
failures due to executor
failures.

How frequently to reprint

spark.logging.exceptionPrintInterval 10000 duplicate exceptions in
full (in millis).

For locality-aware delay

scheduling for
PROCESS_LOCAL ,
spark.locality.wait 3s NODE_LOCAL , and
RACK_LOCAL
TaskLocalities when
locality-specific setting is
not set.

The value of Scheduling delay for

spark.locality.wait.process PROCESS_LOCAL
spark.locality.wait TaskLocality

The value of Scheduling delay for

spark.locality.wait.node NODE_LOCAL
spark.locality.wait TaskLocality

The value of Scheduling delay for

spark.locality.wait.rack RACK_LOCAL
spark.locality.wait TaskLocality

692
TaskSetManager

693
Schedulable

Schedulable
Schedulable is a contract of schedulable entities.

Schedulable is a private[spark] Scala trait. You can find the sources in

Note
org.apache.spark.scheduler.Schedulable.

There are currently two types of Schedulable entities in Spark:

Pool

TaskSetManager

Schedulable Contract
Every Schedulable follows the following contract:

It has a name .

name: String

It has a parent Pool (of other Schedulables ).

parent: Pool

With the parent property you could build a tree of Schedulables

It has a schedulingMode , weight , minShare , runningTasks , priority , stageId .

schedulingMode: SchedulingMode
weight: Int
minShare: Int
runningTasks: Int
priority: Int
stageId: Int

It manages a collection of Schedulables and can add or remove one.

schedulableQueue: ConcurrentLinkedQueue[Schedulable]
addSchedulable(schedulable: Schedulable): Unit
removeSchedulable(schedulable: Schedulable): Unit

694
Schedulable

Note schedulableQueue is java.util.concurrent.ConcurrentLinkedQueue.

It can query for a Schedulable by name.

getSchedulableByName(name: String): Schedulable

It can return a sorted collection of TaskSetManagers.

It can be informed about lost executors.

executorLost(executorId: String, host: String, reason: ExecutorLossReason): Unit

It is called by TaskSchedulerImpl to inform TaskSetManagers about executors being

lost.

It checks for speculatable tasks.

checkSpeculatableTasks(): Boolean

Caution FIXME What are speculatable tasks?

getSortedTaskSetQueue

getSortedTaskSetQueue: ArrayBuffer[TaskSetManager]

getSortedTaskSetQueue is used in TaskSchedulerImpl to handle resource offers (to let every

TaskSetManager know about a new executor ready to execute tasks).

schedulableQueue

schedulableQueue: ConcurrentLinkedQueue[Schedulable]

schedulableQueue is used in SparkContext.getAllPools.

695
Schedulable Pool

Schedulable Pool
Pool is a Schedulable entity that represents a tree of TaskSetManagers, i.e. it contains a

collection of TaskSetManagers or the Pools thereof.

A Pool has a mandatory name, a scheduling mode, initial minShare and weight that are
defined when it is created.

Note An instance of Pool is created when TaskSchedulerImpl is initialized.

The TaskScheduler Contract and Schedulable Contract both require that their
Note
entities have rootPool of type Pool .

increaseRunningTasks Method

Caution FIXME

decreaseRunningTasks Method

Caution FIXME

taskSetSchedulingAlgorithm Attribute
Using the scheduling mode (given when a Pool object is created), Pool selects
SchedulingAlgorithm and sets taskSetSchedulingAlgorithm :

FIFOSchedulingAlgorithm for FIFO scheduling mode.

FairSchedulingAlgorithm for FAIR scheduling mode.

It throws an IllegalArgumentException when unsupported scheduling mode is passed on:

Unsupported spark.scheduler.mode: [schedulingMode]

Tip Read about the scheduling modes in SchedulingMode.

Note taskSetSchedulingAlgorithm is used in getSortedTaskSetQueue.

Getting TaskSetManagers Sorted 

—  getSortedTaskSetQueue Method

696
Schedulable Pool

Note getSortedTaskSetQueue is part of the Schedulable Contract.

getSortedTaskSetQueue sorts all the Schedulables in schedulableQueue queue by a

SchedulingAlgorithm (from the internal taskSetSchedulingAlgorithm).

Note It is called when TaskSchedulerImpl processes executor resource offers.

Schedulables by Name 
—  schedulableNameToSchedulable Registry

schedulableNameToSchedulable = new ConcurrentHashMap[String, Schedulable]

schedulableNameToSchedulable is a lookup table of Schedulable objects by their names.

Beside the obvious usage in the housekeeping methods like addSchedulable ,

removeSchedulable , getSchedulableByName from the Schedulable Contract, it is exclusively

used in SparkContext.getPoolForName.

addSchedulable Method

Note addSchedulable is part of the Schedulable Contract.

addSchedulable adds a Schedulable to the schedulableQueue and

schedulableNameToSchedulable.

More importantly, it sets the Schedulable entity’s parent to itself.

removeSchedulable Method

Note removeSchedulable is part of the Schedulable Contract.

removeSchedulable removes a Schedulable from the schedulableQueue and

schedulableNameToSchedulable.

Note removeSchedulable is the opposite to addSchedulable method.

SchedulingAlgorithm
SchedulingAlgorithm is the interface for a sorting algorithm to sort Schedulables.

There are currently two SchedulingAlgorithms :

FIFOSchedulingAlgorithm for FIFO scheduling mode.

697
Schedulable Pool

FairSchedulingAlgorithm for FAIR scheduling mode.

FIFOSchedulingAlgorithm
FIFOSchedulingAlgorithm is a scheduling algorithm that compares Schedulables by their

priority first and, when equal, by their stageId .

Note priority and stageId are part of Schedulable Contract.

Caution FIXME A picture is worth a thousand words. How to picture the algorithm?

FairSchedulingAlgorithm
FairSchedulingAlgorithm is a scheduling algorithm that compares Schedulables by their

minShare , runningTasks , and weight .

Note minShare , runningTasks , and weight are part of Schedulable Contract.

Figure 1. FairSchedulingAlgorithm
For each input Schedulable , minShareRatio is computed as runningTasks by minShare
(but at least 1 ) while taskToWeightRatio is runningTasks by weight .

698
Schedulable Pool

699
Schedulable Builders

Schedulable Builders
SchedulableBuilder is a contract of schedulable builders that operate on a pool of

TaskSetManagers (from an owning TaskSchedulerImpl).

Schedulable builders can build pools and add new Schedulable entities to the pool.

A SchedulableBuilder is created when TaskSchedulerImpl is being initialized.

Note
You can select the SchedulableBuilder to use by spark.scheduler.mode setting.

Spark comes with two implementations of the SchedulableBuilder Contract:

FIFOSchedulableBuilder - the default SchedulableBuilder

FairSchedulableBuilder

SchedulableBuilder is a private[spark] Scala trait. You can find the sources

Note
in org.apache.spark.scheduler.SchedulableBuilder.

SchedulableBuilder Contract
Every SchedulableBuilder provides the following services:

It manages a root pool.

It can build pools.

It can add a Schedulable with properties.

Root Pool (rootPool method)

rootPool: Pool

rootPool method returns a Pool (of Schedulables).

This is the data structure managed (aka wrapped) by SchedulableBuilders .

Build Pools (buildPools method)

buildPools(): Unit

Note It is exclusively called by TaskSchedulerImpl.initialize.

700
Schedulable Builders

Adding Schedulable (to Pool) (addTaskSetManager method)

addTaskSetManager(manager: Schedulable, properties: Properties): Unit

addTaskSetManager registers the manager Schedulable (with additional properties ) to the

rootPool.

addTaskSetManager is exclusively used by TaskSchedulerImpl to submit a

Note
TaskSetManager for a stage for execution.

701
Schedulable Builders

FIFOSchedulableBuilder - SchedulableBuilder
for FIFO Scheduling Mode
FIFOSchedulableBuilder is a SchedulableBuilder that holds a single Pool (that is given when

FIFOSchedulableBuilder is created).

FIFOSchedulableBuilder is the default SchedulableBuilder for

Note
TaskSchedulerImpl .

When FIFOSchedulableBuilder is created, the TaskSchedulerImpl passes its

Note
own rootPool (a part of TaskScheduler Contract).

FIFOSchedulableBuilder obeys the SchedulableBuilder Contract as follows:

buildPools does nothing.

addTaskSetManager passes the input Schedulable to the one and only rootPool Pool

(using addSchedulable ) and completely disregards the properties of the Schedulable.

Creating FIFOSchedulableBuilder Instance

FIFOSchedulableBuilder takes the following when created:

rootPool Pool

702
Schedulable Builders

FairSchedulableBuilder - SchedulableBuilder
for FAIR Scheduling Mode
FairSchedulableBuilder is a SchedulableBuilder with the pools configured in an optional

allocations configuration file.

It reads the allocations file using the internal buildFairSchedulerPool method.

Enable INFO logging level for

org.apache.spark.scheduler.FairSchedulableBuilder logger to see what happens
inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.scheduler.FairSchedulableBuilder=INFO

Refer to Logging.

buildPools
buildPools builds the rootPool based on the allocations configuration file from the

optional spark.scheduler.allocation.file or fairscheduler.xml (on the classpath).

Note buildPools is part of the SchedulableBuilder Contract.

Spark comes with fairscheduler.xml.template to use as a template for the

Tip
allocations configuration file to start from.

It then ensures that the default pool is also registered.

addTaskSetManager
addTaskSetManager looks up the default pool (using Pool.getSchedulableByName).

Note addTaskSetManager is part of the SchedulableBuilder Contract.

Although the Pool.getSchedulableByName method may return no Schedulable for

Note a name, the default root pool does exist as it is assumed it was registered
before.

If properties for the Schedulable were given, spark.scheduler.pool property is looked up

and becomes the current pool name (or defaults to default ).

703
Schedulable Builders

spark.scheduler.pool is the only property supported. Refer to

Note
spark.scheduler.pool later in this document.

If the pool name is not available, it is registered with the pool name, FIFO scheduling mode,
minimum share 0 , and weight 1 .

After the new pool was registered, you should see the following INFO message in the logs:

INFO FairSchedulableBuilder: Created pool [poolName], schedulingMode: FIFO, minShare:

0, weight: 1

The manager schedulable is registered to the pool (either the one that already existed or
was created just now).

You should see the following INFO message in the logs:

INFO FairSchedulableBuilder: Added task set [manager.name] to pool [poolName]

spark.scheduler.pool Property
SparkContext.setLocalProperty allows for setting properties per thread to group jobs in
logical groups. This mechanism is used by FairSchedulableBuilder to watch for
spark.scheduler.pool property to group jobs from threads and submit them to a non-default

pool.

val sc: SparkContext = ???

sc.setLocalProperty("spark.scheduler.pool", "myPool")

Tip See addTaskSetManager for how this setting is used.

fairscheduler.xml Allocations Configuration File

The allocations configuration file is an XML file.

The default conf/fairscheduler.xml.template looks as follows:

704
Schedulable Builders

<?xml version="1.0"?>
<allocations>
<pool name="production">
<schedulingMode>FAIR</schedulingMode>
<weight>1</weight>
<minShare>2</minShare>
</pool>
<pool name="test">
<schedulingMode>FIFO</schedulingMode>
<weight>2</weight>
<minShare>3</minShare>
</pool>
</allocations>

The top-level element’s name allocations can be anything. Spark does not
Tip
insist on allocations and accepts any name.

Ensure Default Pool is Registered (buildDefaultPool

method)
buildDefaultPool method checks whether default was defined already and if not it adds

the default pool with FIFO scheduling mode, minimum share 0 , and weight 1 .

You should see the following INFO message in the logs:

INFO FairSchedulableBuilder: Created default pool default, schedulingMode: FIFO, minSh

are: 0, weight: 1

Build Pools from XML Allocations File

(buildFairSchedulerPool method)

buildFairSchedulerPool(is: InputStream)

buildFairSchedulerPool reads Pools from the allocations configuration file (as is ).

For each pool element, it reads its name (from name attribute) and assumes the default
pool configuration to be FIFO scheduling mode, minimum share 0 , and weight 1 (unless
overrode later).

FIXME Why is the difference between minShare 0 and weight 1 vs

Caution rootPool in TaskSchedulerImpl.initialize - 0 and 0? It is definitely an
inconsistency.

705
Schedulable Builders

If schedulingMode element exists and is not empty for the pool it becomes the current pool’s
scheduling mode. It is case sensitive, i.e. with all uppercase letters.

If minShare element exists and is not empty for the pool it becomes the current pool’s
minShare . It must be an integer number.

If weight element exists and is not empty for the pool it becomes the current pool’s
weight . It must be an integer number.

The pool is then registered to rootPool .

If all is successful, you should see the following INFO message in the logs:

INFO FairSchedulableBuilder: Created pool [poolName], schedulingMode: [schedulingMode]

, minShare: [minShare], weight: [weight]

Settings

spark.scheduler.allocation.file
spark.scheduler.allocation.file is the file path of an optional scheduler configuration file

that FairSchedulableBuilder.buildPools uses to build pools.

706
Scheduling Mode — spark.scheduler.mode Spark Property

Scheduling Mode —  spark.scheduler.mode

Spark Property
Scheduling Mode (aka order task policy or scheduling policy or scheduling order) defines a
policy to sort tasks in order for execution.

The scheduling mode schedulingMode attribute is part of the TaskScheduler Contract.

The only implementation of the TaskScheduler contract in Spark — TaskSchedulerImpl — 

uses spark.scheduler.mode setting to configure schedulingMode that is merely used to set
up the rootPool attribute (with FIFO being the default). It happens when TaskSchedulerImpl
is initialized.

There are three acceptable scheduling modes:

FIFO with no pools but a single top-level unnamed pool with elements being

TaskSetManager objects; lower priority gets Schedulable sooner or earlier stage wins.

FAIR with a hierarchy of Schedulable (sub)pools with the rootPool at the top.

NONE (not used)

Out of three possible SchedulingMode policies only FIFO and FAIR modes are
Note
supported by TaskSchedulerImpl.

After the root pool is initialized, the scheduling mode is no longer relevant (since
the Schedulable that represents the root pool is fully set up).
Note
The root pool is later used when TaskSchedulerImpl submits tasks (as
TaskSets ) for execution.

Note The root pool is a Schedulable . Refer to Schedulable.

Monitoring FAIR Scheduling Mode using Spark UI

Caution FIXME Describe me…​

707
TaskInfo

TaskInfo
TaskInfo is information about a running task attempt inside a TaskSet.

TaskInfo is created when:

TaskSetManager dequeues a task for execution (given resource offer) (and records the

task as running)

TaskUIData does dropInternalAndSQLAccumulables

JsonProtocol re-creates a task details from JSON

Back then, at the commit 63051dd2bcc4bf09d413ff7cf89a37967edc33ba, when

TaskInfo was first merged to Apache Spark on 07/06/12, TaskInfo was part
Note
of spark.scheduler.mesos package — note "Mesos" in the name of the package
that shows how much Spark and Mesos influenced each other at that time.

Table 1. TaskInfo’s Internal Registries and Counters

Name Description
Time when TaskInfo was marked as finished.
finishTime
Used when…​FIXME

Creating TaskInfo Instance

TaskInfo takes the following when created:

Task ID

Index of the task within its TaskSet that may not necessarily be the same as the ID of
the RDD partition that the task is computing.

Task attempt ID

Time when the task was dequeued for execution

Executor that has been offered (as a resource) to run the task

Host of the executor

TaskLocality, i.e. locality preference of the task

Flag whether a task is speculative or not

TaskInfo initializes the internal registries and counters.

708
TaskInfo

Marking Task As Finished (Successfully or Not) 

—  markFinished Method

markFinished(state: TaskState, time: Long = System.currentTimeMillis): Unit

markFinished records the input time as finishTime.

markFinished marks TaskInfo as failed when the input state is FAILED or killed for

state being KILLED .

markFinished is used when TaskSetManager is notified that a task has finished

Note
successfully or failed.

709
TaskDescription — Metadata of Single Task

TaskDescription — Metadata of Single Task

TaskDescription is a metadata of a single task with the following properties:

Task ID

Task attempt number

Executor ID

Task name

Task index (within the TaskSet)

Added files (as Map[String, Long] )

Added JAR files (as Map[String, Long] )

Properties

Serialized task (as ByteBuffer )

The name of the task is of the format:

task [taskID] in stage [taskSetID]

TaskDescription is created when:

TaskSetManager is requested to find a task ready for execution (given a resource offer)

TaskDescription is requested to decode (a TaskDescription from a serialized format

as a ByteBuffer )

The textual representation of a TaskDescription is as follows:

TaskDescription(TID=[taskId], index=[index])

Decoding TaskDescription (from Serialized Format) 

—  decode Method

decode(byteBuffer: ByteBuffer): TaskDescription

decode …​FIXME

710
TaskDescription — Metadata of Single Task

decode is used when:

CoarseGrainedExecutorBackend is requested to handle a LaunchTask

Note message
Spark on Mesos' MesosExecutorBackend is requested to launch a task

Encoding TaskDescription (to Serialized Format) 

—  encode Method

encode(taskDescription: TaskDescription): ByteBuffer

encode …​FIXME

encode is used when:

DriverEndpoint (of CoarseGrainedSchedulerBackend ) is requested to

Note launchTasks
Spark on Mesos' MesosFineGrainedSchedulerBackend is requested to
createMesosTask

711
TaskSchedulerImpl — Default TaskScheduler

TaskSchedulerImpl — Default TaskScheduler
TaskSchedulerImpl is the default TaskScheduler.

TaskSchedulerImpl can schedule tasks for multiple types of cluster managers by means of

SchedulerBackends.

When a Spark application starts (and so an instance of SparkContext is created)

TaskSchedulerImpl with a SchedulerBackend and DAGScheduler are created and soon

started.

Figure 1. TaskSchedulerImpl and Other Services

TaskSchedulerImpl generates tasks for executor resource offers.

TaskSchedulerImpl can track racks per host and port (that however is only used with

Hadoop YARN cluster manager).

Using spark.scheduler.mode setting you can select the scheduling policy.

TaskSchedulerImpl submits tasks using SchedulableBuilders.

Table 1. TaskSchedulerImpl’s Internal Registries and Counters

Name Description

SchedulerBackend
backend
Set when TaskSchedulerImpl is initialized.

DAGScheduler
dagScheduler
Used when…​FIXME

Lookup table of hosts per executor.

executorIdToHost
Used when…​FIXME

executorIdToRunningTaskIds Lookup table of running tasks per executor.

712
TaskSchedulerImpl — Default TaskScheduler

executorIdToRunningTaskIds Used when…​FIXME

executorIdToTaskCount
Lookup table of the number of running tasks by
executor.

executorsByHost Collection of executors per host

Flag…​FIXME
hasLaunchedTask
Used when…​FIXME

Lookup table of executors per hosts in a cluster.

hostToExecutors
Used when…​FIXME

Lookup table of hosts per rack.

hostsByRack
Used when…​FIXME

The next task id counting from 0 .

nextTaskId
Used when TaskSchedulerImpl …​

Schedulable Pool
rootPool
Used when TaskSchedulerImpl …​

SchedulingMode
schedulingMode
Used when TaskSchedulerImpl …​

taskSetsByStageIdAndAttempt Lookup table of TaskSet by stage and attempt ids.

taskIdToExecutorId Lookup table of executor by task id.

taskIdToTaskSetManager Registry of active TaskSetManager per task id.

Enable INFO or DEBUG logging levels for

org.apache.spark.scheduler.TaskSchedulerImpl logger to see what happens
inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.scheduler.TaskSchedulerImpl=DEBUG

Refer to Logging.

713
TaskSchedulerImpl — Default TaskScheduler

Finding Unique Identifier of Spark Application 

—  applicationId Method

applicationId(): String

applicationId is part of TaskScheduler contract to find the Spark application’s

Note
id.

applicationId simply request SchedulerBackend for the Spark application’s id.

nodeBlacklist Method

Caution FIXME

cleanupTaskState Method

Caution FIXME

newTaskId Method

Caution FIXME

getExecutorsAliveOnHost Method

Caution FIXME

isExecutorAlive Method

Caution FIXME

hasExecutorsAliveOnHost Method

Caution FIXME

hasHostAliveOnRack Method

Caution FIXME

714
TaskSchedulerImpl — Default TaskScheduler

executorLost Method

Caution FIXME

mapOutputTracker

Caution FIXME

starvationTimer

Caution FIXME

executorHeartbeatReceived Method

executorHeartbeatReceived(
execId: String,
accumUpdates: Array[(Long, Seq[AccumulatorV2[_, _]])],
blockManagerId: BlockManagerId): Boolean

executorHeartbeatReceived is…​

Caution FIXME

Note executorHeartbeatReceived is part of the TaskScheduler Contract.

Cancelling Tasks for Stage —  cancelTasks Method

cancelTasks(stageId: Int, interruptThread: Boolean): Unit

Note cancelTasks is part of TaskScheduler contract.

cancelTasks cancels all tasks submitted for execution in a stage stageId .

Note cancelTasks is used exclusively when DAGScheduler cancels a stage.

handleSuccessfulTask Method

715
TaskSchedulerImpl — Default TaskScheduler

handleSuccessfulTask(
taskSetManager: TaskSetManager,
tid: Long,
taskResult: DirectTaskResult[_]): Unit

handleSuccessfulTask simply forwards the call to the input taskSetManager (passing tid

and taskResult ).

handleSuccessfulTask is called when TaskSchedulerGetter has managed to

Note
deserialize the task result of a task that finished successfully.

handleTaskGettingResult Method

handleTaskGettingResult(taskSetManager: TaskSetManager, tid: Long): Unit

handleTaskGettingResult simply forwards the call to the taskSetManager .

handleTaskGettingResult is used to inform that TaskResultGetter enqueues a

Note successful task with IndirectTaskResult task result (and so is about to fetch a
remote block from a BlockManager ).

applicationAttemptId Method

applicationAttemptId(): Option[String]

Caution FIXME

schedulableBuilder Attribute
schedulableBuilder is a SchedulableBuilder for the TaskSchedulerImpl .

It is set up when a TaskSchedulerImpl is initialized and can be one of two available builders:

FIFOSchedulableBuilder when scheduling policy is FIFO (which is the default

scheduling policy).

FairSchedulableBuilder for FAIR scheduling policy.

Note Use spark.scheduler.mode setting to select the scheduling policy.

Tracking Racks per Hosts and Ports —  getRackForHost

716
TaskSchedulerImpl — Default TaskScheduler

Tracking Racks per Hosts and Ports —  getRackForHost

Method

getRackForHost(value: String): Option[String]

getRackForHost is a method to know about the racks per hosts and ports. By default, it

assumes that racks are unknown (i.e. the method returns None ).

Note It is overriden by the YARN-specific TaskScheduler YarnScheduler.

getRackForHost is currently used in two places:

TaskSchedulerImpl.resourceOffers to track hosts per rack (using the internal

hostsByRack registry) while processing resource offers.

TaskSchedulerImpl.removeExecutor to…​FIXME

TaskSetManager.addPendingTask, TaskSetManager.dequeueTask, and

TaskSetManager.dequeueSpeculativeTask

Creating TaskSchedulerImpl Instance

TaskSchedulerImpl takes the following when created:

SparkContext

Acceptable number of task failures

optional BlacklistTracker

optional isLocal flag to differentiate between local and cluster run modes (defaults to
false )

TaskSchedulerImpl initializes the internal registries and counters.

There is another TaskSchedulerImpl constructor that requires a SparkContext

Note object only and sets maxTaskFailures to spark.task.maxFailures or, if not set,
defaults to 4 .

TaskSchedulerImpl sets schedulingMode to the value of spark.scheduler.mode setting

(defaults to FIFO ).

Note schedulingMode is part of TaskScheduler Contract.

Failure to set schedulingMode results in a SparkException :

717
TaskSchedulerImpl — Default TaskScheduler

Unrecognized spark.scheduler.mode: [schedulingModeConf]

Ultimately, TaskSchedulerImpl creates a TaskResultGetter.

Saving SchedulerBackend and Building Schedulable Pools

(aka Initializing TaskSchedulerImpl) —  initialize
Method

initialize(backend: SchedulerBackend): Unit

initialize initializes TaskSchedulerImpl .

Figure 2. TaskSchedulerImpl initialization

initialize saves the input SchedulerBackend.

initialize then sets schedulable Pool as an empty-named Pool (passing in

SchedulingMode, initMinShare and initWeight as 0 ).

Note SchedulingMode is defined when TaskSchedulerImpl is created.

Note schedulingMode and rootPool are a part of TaskScheduler Contract.

initialize sets SchedulableBuilder (based on SchedulingMode):

FIFOSchedulableBuilder for FIFO scheduling mode

FairSchedulableBuilder for FAIR scheduling mode

initialize requests SchedulableBuilder to build pools.

FIXME Why are rootPool and schedulableBuilder created only now?

Caution What do they need that it is not available when TaskSchedulerImpl is
created?

initialize is called while SparkContext is created and creates

Note
SchedulerBackend and TaskScheduler .

718
TaskSchedulerImpl — Default TaskScheduler

Starting TaskSchedulerImpl —  start Method

As part of initialization of a SparkContext , TaskSchedulerImpl is started (using start from
the TaskScheduler Contract).

start(): Unit

start starts the scheduler backend.

Figure 3. Starting TaskSchedulerImpl in Spark Standalone

start also starts task-scheduler-speculation executor service.

Handling Task Status Update —  statusUpdate Method

statusUpdate(tid: Long, state: TaskState, serializedData: ByteBuffer): Unit

statusUpdate finds TaskSetManager for the input tid task (in taskIdToTaskSetManager).

When state is LOST , statusUpdate …​FIXME

TaskState.LOST is only used by the deprecated Mesos fine-grained scheduling

Note
mode.

When state is one of the finished states, i.e. FINISHED , FAILED , KILLED or LOST ,
statusUpdate cleanupTaskState for the input tid .

statusUpdate requests TaskSetManager to unregister tid from running tasks.

statusUpdate requests TaskResultGetter to schedule an asynchrounous task to deserialize

the task result (and notify TaskSchedulerImpl back) for tid in FINISHED state and
schedule an asynchrounous task to deserialize TaskFailedReason (and notify

719
TaskSchedulerImpl — Default TaskScheduler

TaskSchedulerImpl back) for tid in the other finished states (i.e. FAILED , KILLED ,

LOST ).

If a task is in LOST state, statusUpdate notifies DAGScheduler that the executor was lost
(with SlaveLost and the reason Task [tid] was lost, so marking the executor as lost as
well. ) and requests SchedulerBackend to revive offers.

In case the TaskSetManager for tid could not be found (in taskIdToTaskSetManager
registry), you should see the following ERROR message in the logs:

ERROR Ignoring update with state [state] for TID [tid] because its task set is gone (t
his is likely the result of receiving duplicate task finished status updates)

Any exception is caught and reported as ERROR message in the logs:

ERROR Exception in statusUpdate

FIXME image with scheduler backends calling

Caution
TaskSchedulerImpl.statusUpdate .

statusUpdate is used when:

1. DriverEndpoint (of CoarseGrainedSchedulerBackend) is requested to

handle a StatusUpdate message
Note
2. LocalEndpoint is requested to handle a StatusUpdate message

3. MesosFineGrainedSchedulerBackend is requested to handle a task status

update

task-scheduler-speculation Scheduled Executor Service 

—  speculationScheduler Internal Attribute
speculationScheduler is a java.util.concurrent.ScheduledExecutorService with the name

task-scheduler-speculation for speculative execution of tasks.

When TaskSchedulerImpl starts (in non-local run mode) with spark.speculation enabled,
speculationScheduler is used to schedule checkSpeculatableTasks to execute periodically

every spark.speculation.interval after the initial spark.speculation.interval passes.

speculationScheduler is shut down when TaskSchedulerImpl stops.

Checking for Speculatable Tasks 

—  checkSpeculatableTasks Method

720
TaskSchedulerImpl — Default TaskScheduler

checkSpeculatableTasks(): Unit

checkSpeculatableTasks requests rootPool to check for speculatable tasks (if they ran for

more than 100 ms) and, if there any, requests SchedulerBackend to revive offers.

checkSpeculatableTasks is executed periodically as part of speculative

Note
execution of tasks.

Acceptable Number of Task Failures 

—  maxTaskFailures Attribute
The acceptable number of task failures ( maxTaskFailures ) can be explicitly defined when
creating TaskSchedulerImpl instance or based on spark.task.maxFailures setting that
defaults to 4 failures.

Note It is exclusively used when submitting tasks through TaskSetManager.

Cleaning up After Removing Executor 

—  removeExecutor Internal Method

removeExecutor(executorId: String, reason: ExecutorLossReason): Unit

removeExecutor removes the executorId executor from the following internal registries:

executorIdToTaskCount, executorIdToHost , executorsByHost , and hostsByRack . If the

affected hosts and racks are the last entries in executorsByHost and hostsByRack ,
appropriately, they are removed from the registries.

Unless reason is LossReasonPending , the executor is removed from executorIdToHost

registry and TaskSetManagers get notified.

The internal removeExecutor is called as part of statusUpdate and

Note
executorLost.

Intercepting Nearly-Completed SparkContext Initialization 

—  postStartHook Callback
postStartHook is a custom implementation of postStartHook from the TaskScheduler

Contract that waits until a scheduler backend is ready (using the internal blocking
waitBackendReady).

721
TaskSchedulerImpl — Default TaskScheduler

postStartHook is used when SparkContext is created (before it is fully created)

Note
and YarnClusterScheduler.postStartHook.

Stopping TaskSchedulerImpl —  stop Method

stop(): Unit

stop() stops all the internal services, i.e. task-scheduler-speculation executor service,

SchedulerBackend, TaskResultGetter, and starvationTimer timer.

Finding Default Level of Parallelism 

—  defaultParallelism Method

defaultParallelism(): Int

Note defaultParallelism is part of TaskScheduler contract as a hint for sizing jobs.

defaultParallelism simply requests SchedulerBackend for the default level of parallelism.

Default level of parallelism is a hint for sizing jobs that SparkContext uses to
Note
create RDDs with the right number of partitions when not specified explicitly.

Submitting Tasks for Execution (from TaskSet for Stage) 

—  submitTasks Method

submitTasks(taskSet: TaskSet): Unit

Note submitTasks is part of TaskScheduler Contract.

722
TaskSchedulerImpl — Default TaskScheduler

Figure 4. TaskSchedulerImpl.submitTasks
When executed, you should see the following INFO message in the logs:

INFO TaskSchedulerImpl: Adding task set [id] with [count] tasks

submitTasks creates a TaskSetManager (for the input taskSet and acceptable number of

task failures).

submitTasks uses acceptable number of task failures that is defined when

Note
TaskSchedulerImpl is created.

submitTasks registers the TaskSetManager per stage and stage attempt id (in

taskSetsByStageIdAndAttempt).

Note The stage and the stage attempt id are attributes of a TaskSet.

Note submitTasks assumes that only one TaskSet can be active for a Stage .

If there is more than one active TaskSetManager for the stage, submitTasks reports a
IllegalStateException with the message:

more than one active taskSet for stage [stage]: [TaskSet ids]

TaskSetManager is considered active when it is not a zombie. submitTasks

Note adds the TaskSetManager to the Schedulable root pool (available as
schedulableBuilder).

723
TaskSchedulerImpl — Default TaskScheduler

The root pool can be a single flat linked queue (in FIFO scheduling mode) or a
Note
hierarchy of pools of Schedulables (in FAIR scheduling mode).

submitTasks makes sure that the requested resources, i.e. CPU and memory, are assigned

to the Spark application for a non-local environment.

When submitTasks is called the very first time ( hasReceivedTask is false ) in cluster mode
only (i.e. isLocal of the TaskSchedulerImpl is false ), starvationTimer is scheduled to
execute after spark.starvation.timeout to ensure that the requested resources, i.e. CPUs and
memory, were assigned by a cluster manager.

After the first spark.starvation.timeout passes, the internal hasReceivedTask

Note
flag becomes true .

Every time the starvation timer thread is executed and hasLaunchedTask flag is false , the
following WARN message is printed out to the logs:

WARN Initial job has not accepted any resources; check your cluster UI to ensure that
workers are registered and have sufficient resources

Otherwise, when the hasLaunchedTask flag is true the timer thread cancels itself.

In the end, submitTasks requests the current SchedulerBackend to revive offers (available
as backend).

Tip Use dag-scheduler-event-loop thread to step through the code in a debugger.

Creating TaskSetManager —  createTaskSetManager

Method

createTaskSetManager(taskSet: TaskSet, maxTaskFailures: Int): TaskSetManager

createTaskSetManager creates a TaskSetManager (passing on the reference to

TaskSchedulerImpl , the input taskSet and maxTaskFailures , and optional

BlacklistTracker ).

createTaskSetManager uses the optional BlacklistTracker that is specified when

Note
TaskSchedulerImpl is created.

createTaskSetManager is used exclusively when TaskSchedulerImpl submits

Note
tasks (for a given TaskSet ).

724
TaskSchedulerImpl — Default TaskScheduler

Notifying TaskSetManager that Task Failed 

—  handleFailedTask Method

handleFailedTask(
taskSetManager: TaskSetManager,
tid: Long,
taskState: TaskState,
reason: TaskFailedReason): Unit

handleFailedTask notifies taskSetManager that tid task has failed and, only when

taskSetManager is not in zombie state and tid is not in KILLED state, requests

SchedulerBackend to revive offers.

handleFailedTask is called when TaskResultGetter deserializes a

Note
TaskFailedReason for a failed task.

taskSetFinished Method

taskSetFinished(manager: TaskSetManager): Unit

taskSetFinished looks all TaskSets up by the stage id (in taskSetsByStageIdAndAttempt

registry) and removes the stage attempt from them, possibly with removing the entire stage
record from taskSetsByStageIdAndAttempt registry completely (if there are no other attempts
registered).

Figure 5. TaskSchedulerImpl.taskSetFinished is called when all tasks are finished

Note A TaskSetManager manages a TaskSet for a stage.

taskSetFinished then removes manager from the parent’s schedulable pool.

You should see the following INFO message in the logs:

INFO Removed TaskSet [id], whose tasks have all completed, from pool [name]

725
TaskSchedulerImpl — Default TaskScheduler

taskSetFinished method is called when TaskSetManager has received the

Note
results of all the tasks in a TaskSet .

Notifying DAGScheduler About New Executor 

—  executorAdded Method

executorAdded(execId: String, host: String)

executorAdded just notifies DAGScheduler that an executor was added.

Caution FIXME Image with a call from TaskSchedulerImpl to DAGScheduler, please.

Note executorAdded uses DAGScheduler that was given when setDAGScheduler.

Waiting Until SchedulerBackend is Ready 

—  waitBackendReady Internal Method

waitBackendReady(): Unit

waitBackendReady waits until a SchedulerBackend is ready.

Note SchedulerBackend is ready by default.

waitBackendReady keeps checking the status every 100 milliseconds until

SchedulerBackend is ready or the SparkContext is stopped.

If the SparkContext happens to be stopped while waiting, waitBackendReady reports a

IllegalStateException :

Spark context stopped while waiting for backend

waitBackendReady is used when TaskSchedulerImpl is notified that

Note
SparkContext is near to get fully initialized.

Creating TaskDescriptions For Available Executor

Resource Offers (with CPU Cores) —  resourceOffers
Method

resourceOffers(offers: Seq[WorkerOffer]): Seq[Seq[TaskDescription]]

726
TaskSchedulerImpl — Default TaskScheduler

resourceOffers takes the resources offers (as WorkerOffers) and generates a collection

of tasks (as TaskDescription) to launch (given the resources available).

WorkerOffer represents a resource offer with CPU cores free to use on an

Note
executor.

Figure 6. Processing Executor Resource Offers

Internally, resourceOffers first updates hostToExecutors and executorIdToHost lookup
tables to record new hosts and executors (given the input offers ).

For new executors (not in executorIdToRunningTaskIds) resourceOffers notifies

DAGScheduler that an executor was added.

Note TaskSchedulerImpl uses resourceOffers to track active executors.

FIXME a picture with executorAdded call from TaskSchedulerImpl to

Caution
DAGScheduler.

resourceOffers requests BlacklistTracker to applyBlacklistTimeout and filters out offers

on blacklisted nodes and executors.

resourceOffers uses the optional BlacklistTracker that was given when

Note
TaskSchedulerImpl was created.

Caution FIXME Expand on blacklisting

resourceOffers then randomly shuffles offers (to evenly distribute tasks across executors

and avoid over-utilizing some executors) and initializes the local data structures tasks and
availableCpus (as shown in the figure below).

727
TaskSchedulerImpl — Default TaskScheduler

Figure 7. Internal Structures of resourceOffers with 5 WorkerOffers (with 4, 2, 0, 3, 2 free

cores)
resourceOffers takes TaskSets in scheduling order from top-level Schedulable Pool.

Figure 8. TaskSchedulerImpl Requesting TaskSets (as TaskSetManagers) from Root Pool

rootPool is configured when TaskSchedulerImpl is initialized.

rootPool is part of the TaskScheduler Contract and exclusively managed by

SchedulableBuilders, i.e. FIFOSchedulableBuilder and FairSchedulableBuilder
Note (that manage registering TaskSetManagers with the root pool).
TaskSetManager manages execution of the tasks in a single TaskSet that
represents a single Stage.

For every TaskSetManager (in scheduling order), you should see the following DEBUG
message in the logs:

DEBUG TaskSchedulerImpl: parentName: [name], name: [name], runningTasks: [count]

Only if a new executor was added, resourceOffers notifies every TaskSetManager about the
change (to recompute locality preferences).

728
TaskSchedulerImpl — Default TaskScheduler

resourceOffers then takes every TaskSetManager (in scheduling order) and offers them

each node in increasing order of locality levels (per TaskSetManager’s valid locality levels).

Note A TaskSetManager computes locality levels of the tasks it manages.

For every TaskSetManager and the TaskSetManager 's valid locality level, resourceOffers
tries to find tasks to schedule (on executors) as long as the TaskSetManager manages to
launch a task (given the locality level).

If resourceOffers did not manage to offer resources to a TaskSetManager so it could launch

any task, resourceOffers requests the TaskSetManager to abort the TaskSet if completely
blacklisted.

When resourceOffers managed to launch a task, the internal hasLaunchedTask flag gets
enabled (that effectively means what the name says "there were executors and I managed
to launch a task").

resourceOffers is used when:

CoarseGrainedSchedulerBackend (via RPC endpoint) makes executor

resource offers
Note
LocalEndpoint revives resource offers

Spark on Mesos' MesosFineGrainedSchedulerBackend does resourceOffers

Finding Tasks from TaskSetManager to Schedule on

Executors —  resourceOfferSingleTaskSet Internal
Method

resourceOfferSingleTaskSet(
taskSet: TaskSetManager,
maxLocality: TaskLocality,
shuffledOffers: Seq[WorkerOffer],
availableCpus: Array[Int],
tasks: Seq[ArrayBuffer[TaskDescription]]): Boolean

resourceOfferSingleTaskSet takes every WorkerOffer (from the input shuffledOffers ) and

(only if the number of available CPU cores (using the input availableCpus ) is at least
spark.task.cpus) requests TaskSetManager (as the input taskSet ) to find a Task to
execute (given the resource offer) (as an executor, a host, and the input maxLocality ).

resourceOfferSingleTaskSet adds the task to the input tasks collection.

729
TaskSchedulerImpl — Default TaskScheduler

resourceOfferSingleTaskSet records the task id and TaskSetManager in the following

registries:

taskIdToTaskSetManager

taskIdToExecutorId

executorIdToRunningTaskIds

resourceOfferSingleTaskSet decreases spark.task.cpus from the input availableCpus (for

the WorkerOffer ).

resourceOfferSingleTaskSet makes sure that the number of available CPU

Note
cores (in the input availableCpus per WorkerOffer ) is at least 0 .

If there is a TaskNotSerializableException , you should see the following ERROR in the logs:

ERROR Resource offer failed, task set [name] was not serializable

resourceOfferSingleTaskSet returns whether a task was launched or not.

resourceOfferSingleTaskSet is used when TaskSchedulerImpl creates

Note
TaskDescriptions for available executor resource offers (with CPU cores).

TaskLocality — Task Locality Preference

TaskLocality represents a task locality preference and can be one of the following (from

most localized to the widest):

1. PROCESS_LOCAL

2. NODE_LOCAL

3. NO_PREF

4. RACK_LOCAL

5. ANY

WorkerOffer — Free CPU Cores on Executor

WorkerOffer(executorId: String, host: String, cores: Int)

WorkerOffer represents a resource offer with free CPU cores available on an executorId

executor on a host .

730
TaskSchedulerImpl — Default TaskScheduler

Settings
Table 2. Spark Properties
Spark Property Default Value Description
4 in cluster
mode
The number of individual task
spark.task.maxFailures 1 in local failures before giving up on the
entire TaskSet and the job
maxFailures afterwards.
in local-with-
retries

spark.task.cpus 1 The number of CPU cores per task.

Threshold above which Spark

spark.starvation.timeout 15s warns a user that an initial TaskSet
may be starved.

A case-insensitive name of the

scheduling mode —  FAIR , FIFO ,
or NONE .
spark.scheduler.mode FIFO
NOTE: Only FAIR and FIFO are
supported by TaskSchedulerImpl .
See schedulableBuilder.

731
Speculative Execution of Tasks

Speculative Execution of Tasks

Speculative tasks (also speculatable tasks or task strugglers) are tasks that run slower
than most (FIXME the setting) of the all tasks in a job.

Speculative execution of tasks is a health-check procedure that checks for tasks to be

speculated, i.e. running slower in a stage than the median of all successfully completed
tasks in a taskset (FIXME the setting). Such slow tasks will be re-submitted to another
worker. It will not stop the slow tasks, but run a new copy in parallel.

The thread starts as TaskSchedulerImpl starts in clustered deployment modes with

spark.speculation enabled. It executes periodically every spark.speculation.interval after the
initial spark.speculation.interval passes.

When enabled, you should see the following INFO message in the logs:

INFO TaskSchedulerImpl: Starting speculative execution thread

It works as task-scheduler-speculation daemon thread pool using

j.u.c.ScheduledThreadPoolExecutor with core pool size 1 .

The job with speculatable tasks should finish while speculative tasks are running, and it will
leave these tasks running - no KILL command yet.

It uses checkSpeculatableTasks method that asks rootPool to check for speculatable tasks.
If there are any, SchedulerBackend is called for reviveOffers.

FIXME How does Spark handle repeated results of speculative tasks since
Caution
there are copies launched?

Settings

732
Speculative Execution of Tasks

Table 1. Spark Properties

Spark Property Default Value Description

Enables ( true ) or disables

( false ) speculative execution of
spark.speculation false tasks (by means of task-
scheduler-speculation Scheduled
Executor Service).

spark.speculation.interval 100ms
The time interval to use before
checking for speculative tasks.

spark.speculation.multiplier 1.5

The percentage of tasks that has

spark.speculation.quantile 0.75 not finished yet at which to start
speculation.

733
TaskResultGetter

TaskResultGetter
TaskResultGetter is a helper class of TaskSchedulerImpl for asynchronous deserialization

of task results of tasks that have finished successfully (possibly fetching remote blocks) or
the failures for failed tasks.

Caution FIXME Image with the dependencies

Tip Consult Task States in Tasks to learn about the different task states.

The only instance of TaskResultGetter is created while TaskSchedulerImpl is

Note
created.

TaskResultGetter requires a SparkEnv and TaskSchedulerImpl to be created and is

stopped when TaskSchedulerImpl stops.

TaskResultGetter uses task-result-getter asynchronous task executor for operation.

Enable DEBUG logging level for org.apache.spark.scheduler.TaskResultGetter

logger to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.scheduler.TaskResultGetter=DEBUG

Refer to Logging.

task-result-getter Asynchronous Task Executor

getTaskResultExecutor: ExecutorService

getTaskResultExecutor creates a daemon thread pool with spark.resultGetter.threads

threads and task-result-getter prefix.

Read up on java.util.concurrent.ThreadPoolExecutor that getTaskResultExecutor

Tip
uses under the covers.

stop Method

stop(): Unit

734
TaskResultGetter

stop stops the internal task-result-getter asynchronous task executor.

serializer Attribute

serializer: ThreadLocal[SerializerInstance]

serializer is a thread-local SerializerInstance that TaskResultGetter uses to deserialize

byte buffers (with TaskResult s or a TaskEndReason ).

When created for a new thread, serializer is initialized with a new instance of Serializer
(using SparkEnv.closureSerializer).

TaskResultGetter uses java.lang.ThreadLocal for the thread-local

Note
SerializerInstance variable.

taskResultSerializer Attribute

taskResultSerializer: ThreadLocal[SerializerInstance]

taskResultSerializer is a thread-local SerializerInstance that TaskResultGetter uses to…​

When created for a new thread, taskResultSerializer is initialized with a new instance of
Serializer (using SparkEnv.serializer).

TaskResultGetter uses java.lang.ThreadLocal for the thread-local

Note
SerializerInstance variable.

Enqueuing Successful Task (Deserializing Task Result and

Notifying TaskSchedulerImpl) 
—  enqueueSuccessfulTask Method

enqueueSuccessfulTask(
taskSetManager: TaskSetManager,
tid: Long,
serializedData: ByteBuffer): Unit

enqueueSuccessfulTask submits an asynchronous task (to task-result-getter asynchronous

task executor) that first deserializes serializedData to a DirectTaskResult , then updates

the internal accumulator (with the size of the DirectTaskResult ) and ultimately notifies the
TaskSchedulerImpl that the tid task was completed and the task result was received

successfully or not.

735
TaskResultGetter

enqueueSuccessfulTask is just the asynchronous task enqueued for execution

Note
by task-result-getter asynchronous task executor at some point in the future.

Internally, the enqueued task first deserializes serializedData to a TaskResult (using the
internal thread-local serializer).

The TaskResult could be a DirectTaskResult or a IndirectTaskResult.

For a DirectTaskResult, the task checks the available memory for the task result and, when
the size overflows spark.driver.maxResultSize, it simply returns.

enqueueSuccessfulTask is a mere thread so returning from a thread is to do

Note nothing else. That is why the check for quota does abort when there is not
enough memory.

Otherwise, when there is enough memory to hold the task result, it deserializes the
DirectTaskResult (using the internal thread-local taskResultSerializer).

For a IndirectTaskResult, the task checks the available memory for the task result and, when
the size could overflow the maximum result size, it removes the block and simply returns.

Otherwise, when there is enough memory to hold the task result, you should see the
following DEBUG message in the logs:

DEBUG Fetching indirect task result for TID [tid]

The task notifies TaskSchedulerImpl that it is about to fetch a remote block for a task result.
It then gets the block from remote block managers (as serialized bytes).

When the block could not be fetched, TaskSchedulerImpl is informed (with TaskResultLost
task failure reason) and the task simply returns.

enqueueSuccessfulTask is a mere thread so returning from a thread is to do

Note
nothing else and so the real handling is when TaskSchedulerImpl is informed.

The task result (as a serialized byte buffer) is then deserialized to a DirectTaskResult (using
the internal thread-local serializer) and deserialized again using the internal thread-local
taskResultSerializer (just like for the DirectTaskResult case). The block is removed from
BlockManagerMaster and simply returns.

A IndirectTaskResult is deserialized twice to become the final deserialized task

Note result (using serializer for a DirectTaskResult ). Compare it to a
DirectTaskResult task result that is deserialized once only.

With no exceptions thrown, enqueueSuccessfulTask informs the TaskSchedulerImpl that the

tid task was completed and the task result was received.

736
TaskResultGetter

A ClassNotFoundException leads to aborting the TaskSet (with ClassNotFound with

classloader: [loader] error message) while any non-fatal exception shows the following

ERROR message in the logs followed by aborting the TaskSet .

ERROR Exception while getting task result

enqueueSuccessfulTask is used exclusively when TaskSchedulerImpl is

Note requested to handle a task status update (and the task has finished
successfully).

Deserializing TaskFailedReason and Notifying

TaskSchedulerImpl —  enqueueFailedTask Method

enqueueFailedTask(
taskSetManager: TaskSetManager,
tid: Long,
taskState: TaskState.TaskState,
serializedData: ByteBuffer): Unit

enqueueFailedTask submits an asynchronous task (to task-result-getter asynchronous

task executor) that first attempts to deserialize a TaskFailedReason from serializedData

(using the internal thread-local serializer) and then notifies TaskSchedulerImpl that the task
has failed.

Any ClassNotFoundException leads to the following ERROR message in the logs (without
breaking the flow of enqueueFailedTask ):

ERROR Could not deserialize TaskEndReason: ClassNotFound with classloader [loader]

enqueueFailedTask is called when TaskSchedulerImpl is notified about a task

Note
that has failed (and is in FAILED , KILLED or LOST state).

Settings
Table 1. Spark Properties
Spark Property Default Value Description

spark.resultGetter.threads 4
The number of threads for
TaskResultGetter .

737
TaskResultGetter

738
TaskContext

TaskContext
TaskContext is the base for contextual information about a task.

You can access the active TaskContext instance using TaskContext.get method.

import org.apache.spark.TaskContext
val ctx = TaskContext.get

TaskContext allows for registering task listeners and accessing local properties that were

set on the driver.

Note TaskContext is serializable.

package org.apache.spark

abstract class TaskContext extends Serializable {

// only required methods that have no implementation
// the others follow
def isCompleted(): Boolean
def isInterrupted(): Boolean
def isRunningLocally(): Boolean
def addTaskCompletionListener(listener: TaskCompletionListener): TaskContext
def addTaskFailureListener(listener: TaskFailureListener): TaskContext
def stageId(): Int
def stageAttemptNumber(): Int
def partitionId(): Int
def attemptNumber(): Int
def taskAttemptId(): Long
def getLocalProperty(key: String): String
def taskMetrics(): TaskMetrics
def getMetricsSources(sourceName: String): Seq[Source]
private[spark] def killTaskIfInterrupted(): Unit
private[spark] def getKillReason(): Option[String]
private[spark] def taskMemoryManager(): TaskMemoryManager
private[spark] def registerAccumulator(a: AccumulatorV2[_, _]): Unit
private[spark] def setFetchFailed(fetchFailed: FetchFailedException): Unit
}

Table 1. (Subset of) TaskContext Contract

Method Description

Registers a TaskCompletionListener
addTaskCompletionListener
Used when…​

739
TaskContext

addTaskFailureListener Registers a TaskFailureListener

Used when…​

Specifies how many times the task has been attempted

attemptNumber (starting from 0).
Used when…​

Used when…​
getLocalProperty
Accesses local properties set by the driver using
SparkContext.setLocalProperty.

getMetricsSources
Gives all the metrics sources by sourceName which are
associated with the instance that runs the task.

isCompleted Used when…​

A flag that is enabled when a task was killed.

isInterrupted
Used when…​

If the task was marked for interruption, i.e. cancellation,

killTaskIfInterrupted (is supposed to) throws a
TaskKilledException with the reason for the interrupt
(that in turn kills the task).
Used (to break a task execution) when:
killTaskIfInterrupted InterruptibleIterator is requested to hasNext

TaskRunner is requested to run

SortedIterator and UnsafeSorterSpillReader are

requested to loadNext

Spark SQL’s FileScanRDD is requested to compute

Id of the Partition computed by the task.

partitionId
Used when…​

registerAccumulator Used when…​

Id of the Stage the task belongs to.

stageId
Used when…​

Id of the attempt of the task.

taskAttemptId
Used when…​

740
TaskContext

taskMemoryManager Used when…​

TaskMetrics of the active Task.

taskMetrics
Used when…​

TaskContextImpl is the one and only known implementation of TaskContext

Note
Contract in Apache Spark.

unset Method

Caution FIXME

setTaskContext Method

Caution FIXME

Accessing Active TaskContext —  get Method

get(): TaskContext

get method returns the TaskContext instance for an active task (as a TaskContextImpl).

There can only be one instance and tasks can use the object to access contextual
information about themselves.

val rdd = sc.range(0, 3, numSlices = 3)

scala> rdd.partitions.size
res0: Int = 3

rdd.foreach { n =>
import org.apache.spark.TaskContext
val tc = TaskContext.get
val msg = s"""|-------------------
|partitionId: ${tc.partitionId}
|stageId: ${tc.stageId}
|attemptNum: ${tc.attemptNumber}
|taskAttemptId: ${tc.taskAttemptId}
|-------------------""".stripMargin
println(msg)
}

741
TaskContext

TaskContext object uses ThreadLocal to keep it thread-local, i.e. to associate

Note
state with the thread of a task.

Registering Task Listeners

Using TaskContext object you can register task listeners for task completion regardless of
the final state and task failures only.

addTaskCompletionListener Method

addTaskCompletionListener(listener: TaskCompletionListener): TaskContext

addTaskCompletionListener(f: (TaskContext) => Unit): TaskContext

addTaskCompletionListener methods register a TaskCompletionListener listener to be

executed on task completion.

It will be executed regardless of the final state of a task - success, failure, or

Note
cancellation.

val rdd = sc.range(0, 5, numSlices = 1)

import org.apache.spark.TaskContext
val printTaskInfo = (tc: TaskContext) => {
val msg = s"""|-------------------
|partitionId: ${tc.partitionId}
|stageId: ${tc.stageId}
|attemptNum: ${tc.attemptNumber}
|taskAttemptId: ${tc.taskAttemptId}
|-------------------""".stripMargin
println(msg)
}

rdd.foreachPartition { _ =>
val tc = TaskContext.get
tc.addTaskCompletionListener(printTaskInfo)
}

addTaskFailureListener Method

addTaskFailureListener(listener: TaskFailureListener): TaskContext

addTaskFailureListener(f: (TaskContext, Throwable) => Unit): TaskContext

742
TaskContext

addTaskFailureListener methods register a TaskFailureListener listener to be executed on

task failure only. It can be executed multiple times since a task can be re-attempted when it
fails.

val rdd = sc.range(0, 2, numSlices = 2)

import org.apache.spark.TaskContext
val printTaskErrorInfo = (tc: TaskContext, error: Throwable) => {
val msg = s"""|-------------------
|partitionId: ${tc.partitionId}
|stageId: ${tc.stageId}
|attemptNum: ${tc.attemptNumber}
|taskAttemptId: ${tc.taskAttemptId}
|error: ${error.toString}
|-------------------""".stripMargin
println(msg)
}

val throwExceptionForOddNumber = (n: Long) => {

if (n % 2 == 1) {
throw new Exception(s"No way it will pass for odd number: $n")
}
}

// FIXME It won't work.

rdd.map(throwExceptionForOddNumber).foreachPartition { _ =>
val tc = TaskContext.get
tc.addTaskFailureListener(printTaskErrorInfo)
}

// Listener registration matters.

rdd.mapPartitions { (it: Iterator[Long]) =>
val tc = TaskContext.get
tc.addTaskFailureListener(printTaskErrorInfo)
it
}.map(throwExceptionForOddNumber).count

(Unused) Accessing Partition Id —  getPartitionId

Method

getPartitionId(): Int

getPartitionId gets the active TaskContext and returns partitionId or 0 (if TaskContext

not available).

Note getPartitionId is not used.

743
TaskContext

744
TaskContextImpl

TaskContextImpl
TaskContextImpl is the one and only TaskContext.

Caution FIXME

stage

partition

task attempt

attempt number

runningLocally = false

taskMemoryManager

Caution FIXME Where and how is TaskMemoryManager used?

taskMetrics Property

Caution FIXME

markTaskCompleted Method

Caution FIXME

markTaskFailed Method

Caution FIXME

Creating TaskContextImpl Instance

Caution FIXME

markInterrupted Method

Caution FIXME

745
TaskContextImpl

746
TaskResults — DirectTaskResult and IndirectTaskResult

TaskResults — DirectTaskResult and
IndirectTaskResult
TaskResult models a task result. It has exactly two concrete implementations:

1. DirectTaskResult is the TaskResult to be serialized and sent over the wire to the driver
together with the result bytes and accumulators.

2. IndirectTaskResult is the TaskResult that is just a pointer to a task result in a

BlockManager .

The decision of the concrete TaskResult is made when a TaskRunner finishes running a
task and checks the size of the result.

Note The types are private[spark] .

DirectTaskResult Task Result

DirectTaskResult[T](
var valueBytes: ByteBuffer,
var accumUpdates: Seq[AccumulatorV2[_, _]])
extends TaskResult[T] with Externalizable

DirectTaskResult is the TaskResult of running a task (that is later returned serialized to the

driver) when the size of the task’s result is smaller than spark.driver.maxResultSize and
spark.task.maxDirectResultSize (or spark.rpc.message.maxSize whatever is smaller).

Note DirectTaskResult is Java’s java.io.Externalizable.

IndirectTaskResult Task Result

IndirectTaskResult[T](blockId: BlockId, size: Int)

extends TaskResult[T] with Serializable

IndirectTaskResult is a TaskResult that…​

Note IndirectTaskResult is Java’s java.io.Serializable.

747
TaskResults — DirectTaskResult and IndirectTaskResult

748
TaskMemoryManager — Memory Manager of Single Task

TaskMemoryManager — Memory Manager of
Single Task
TaskMemoryManager manages the memory allocated to an individual task.

TaskMemoryManager is created when:

TaskRunner is requested to run

Spark SQL’s HashedRelation is created or requested to read

Figure 1. Creating TaskMemoryManager for Task

TaskMemoryManager assumes that:

The number of bits to address pages (aka PAGE_NUMBER_BITS ) is 13

The number of bits to encode offsets in data pages (aka OFFSET_BITS ) is 51 (i.e. 64
bits - PAGE_NUMBER_BITS )

The number of entries in the page table and allocated pages (aka PAGE_TABLE_SIZE ) is
8192 (i.e. 1 << PAGE_NUMBER_BITS )

The maximum page size (aka MAXIMUM_PAGE_SIZE_BYTES ) is 15GB (i.e. ((1L << 31) - 1)
* 8L )

When created, TaskMemoryManager is given a MemoryManager that is used for the following:

Acquiring an execution memory

749
TaskMemoryManager — Memory Manager of Single Task

cleanUpAllAllocatedMemory

releaseExecutionMemory

showMemoryUsage

pageSizeBytes

Allocating a memory block for Tungsten consumers

freePage

getMemoryConsumptionForThisTask

Table 1. TaskMemoryManager’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
acquiredButNotUsed The size of memory allocated but not used.

Collection of flags ( true or false values) of size

PAGE_TABLE_SIZE with all bits initially disabled (i.e.
false ).

allocatedPages TIP: allocatedPages is java.util.BitSet.

When allocatePage is called, it will record the page in the
registry by setting the bit at the specified index (that
corresponds to the allocated page) to true .

consumers MemoryConsumers

The array of size PAGE_TABLE_SIZE with indices being

MemoryBlock objects.
pageTable
When allocating a MemoryBlock page for Tungsten
consumers, the index corresponds to pageNumber that
points to the MemoryBlock page allocated.

MemoryMode (i.e. OFF_HEAP or ON_HEAP )

tungstenMemoryMode
Set to the tungstenMemoryMode of the MemoryManager
while TaskMemoryManager is created

750
TaskMemoryManager — Memory Manager of Single Task

Enable INFO , DEBUG or even TRACE logging levels for

org.apache.spark.memory.TaskMemoryManager logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.memory.TaskMemoryManager=TRACE

Refer to Logging.

cleanUpAllAllocatedMemory Method

long cleanUpAllAllocatedMemory()

cleanUpAllAllocatedMemory clears page table.

Caution FIXME

All recorded consumers are queried for the size of used memory. If the memory used is
greater than 0, the following WARN message is printed out to the logs:

WARN TaskMemoryManager: leak [bytes] memory from [consumer]

The consumers collection is then cleared.

MemoryManager.releaseExecutionMemory is executed to release the memory that is not

used by any consumer.

Before cleanUpAllAllocatedMemory returns, it calls

MemoryManager.releaseAllExecutionMemoryForTask that in turn becomes the return value.

Caution FIXME Image with the interactions to MemoryManager .

cleanUpAllAllocatedMemory is used exclusively when TaskRunner is requested

Note
to run (and cleans up after itself).

Acquiring Execution Memory 

—  acquireExecutionMemory Method

long acquireExecutionMemory(long required, MemoryConsumer consumer)

751
TaskMemoryManager — Memory Manager of Single Task

acquireExecutionMemory allocates up to required size of memory for consumer . When no

memory could be allocated, it calls spill on every consumer, itself including. Finally,
acquireExecutionMemory returns the allocated memory.

acquireExecutionMemory synchronizes on itself, and so no other calls on the

Note
object could be completed.

Note MemoryConsumer knows its mode — on- or off-heap.

acquireExecutionMemory first calls memoryManager.acquireExecutionMemory(required,

taskAttemptId, mode) .

Tip TaskMemoryManager is a mere wrapper of MemoryManager to track consumers?

Caution FIXME

When the memory obtained is less than requested (by required ), acquireExecutionMemory
requests all consumers to release memory (by spilling it to disk).

acquireExecutionMemory requests memory from consumers that work in the

Note
same mode except the requesting one.

You may see the following DEBUG message when spill released some memory:

DEBUG Task [taskAttemptId] released [bytes] from [consumer] for [consumer]

acquireExecutionMemory calls memoryManager.acquireExecutionMemory(required,

taskAttemptId, mode) again (it called it at the beginning).

It does the memory acquisition until it gets enough memory or there are no more consumers
to request spill from.

You may also see the following ERROR message in the logs when there is an error while
requesting spill with OutOfMemoryError followed.

ERROR error while calling spill() on [consumer]

If the earlier spill on the consumers did not work out and there is still memory to be
acquired, acquireExecutionMemory requests the input consumer to spill memory to disk (that
in fact requested more memory!)

If the consumer releases some memory, you should see the following DEBUG message in
the logs:

752
TaskMemoryManager — Memory Manager of Single Task

DEBUG Task [taskAttemptId] released [bytes] from itself ([consumer])

acquireExecutionMemory calls memoryManager.acquireExecutionMemory(required,

taskAttemptId, mode) once more.

memoryManager.acquireExecutionMemory(required, taskAttemptId, mode) could

Note have been called "three" times, i.e. at the very beginning, for each consumer,
and on itself.

It records the consumer in consumers registry.

You should see the following DEBUG message in the logs:

DEBUG Task [taskAttemptId] acquired [bytes] for [consumer]

acquireExecutionMemory is called when a MemoryConsumer tries to acquires a

Note
memory and allocatePage.

Allocating Memory Block for Tungsten Consumers 

—  allocatePage Method

MemoryBlock allocatePage(long size, MemoryConsumer consumer)

It only handles Tungsten Consumers, i.e. MemoryConsumers in

Note
tungstenMemoryMode mode.

allocatePage allocates a block of memory (aka page) smaller than

MAXIMUM_PAGE_SIZE_BYTES maximum size.

It checks size against the internal MAXIMUM_PAGE_SIZE_BYTES maximum size. If it is greater

than the maximum size, the following IllegalArgumentException is thrown:

Cannot allocate a page with more than [MAXIMUM_PAGE_SIZE_BYTES] bytes

It then acquires execution memory (for the input size and consumer ).

It finishes by returning null when no execution memory could be acquired.

With the execution memory acquired, it finds the smallest unallocated page index and
records the page number (using allocatedPages registry).

If the index is PAGE_TABLE_SIZE or higher, releaseExecutionMemory(acquired, consumer) is

called and then the following IllegalStateException is thrown:

753
TaskMemoryManager — Memory Manager of Single Task

Have already allocated a maximum of [PAGE_TABLE_SIZE] pages

It then attempts to allocate a MemoryBlock from Tungsten MemoryAllocator (calling

memoryManager.tungstenMemoryAllocator().allocate(acquired) ).

Caution FIXME What is MemoryAllocator ?

When successful, MemoryBlock gets assigned pageNumber and it gets added to the internal
pageTable registry.

You should see the following TRACE message in the logs:

TRACE Allocate page number [pageNumber] ([acquired] bytes)

The page is returned.

If a OutOfMemoryError is thrown when allocating a MemoryBlock page, the following WARN

message is printed out to the logs:

WARN Failed to allocate a page ([acquired] bytes), try again.

And acquiredButNotUsed gets acquired memory space with the pageNumber cleared in
allocatedPages (i.e. the index for pageNumber gets false ).

Caution FIXME Why is the code tracking acquiredButNotUsed ?

Another allocatePage attempt is recursively tried.

Caution FIXME Why is there a hope for being able to allocate a page?

Creating TaskMemoryManager Instance

TaskMemoryManager takes the following when created:

MemoryManager

Task ID

TaskMemoryManager initializes the internal registries and counters.

releaseExecutionMemory Method

754
TaskMemoryManager — Memory Manager of Single Task

void releaseExecutionMemory(long size, MemoryConsumer consumer)

releaseExecutionMemory …​FIXME

releaseExecutionMemory is used when:

MemoryConsumer is requested to freeMemory

Note
TaskMemoryManager is requested to allocatePage and freePage

getMemoryConsumptionForThisTask Method

long getMemoryConsumptionForThisTask()

getMemoryConsumptionForThisTask …​FIXME

Note getMemoryConsumptionForThisTask is used exclusively in Spark tests.

showMemoryUsage Method

void showMemoryUsage()

showMemoryUsage …​FIXME

showMemoryUsage is used exclusively when MemoryConsumer is requested to

Note
throwOom.

pageSizeBytes Method

long pageSizeBytes()

pageSizeBytes simply requests the MemoryManager for pageSizeBytes.

Note pageSizeBytes is used when…​FIXME

Freeing Memory Page —  freePage Method

void freePage(MemoryBlock page, MemoryConsumer consumer)

755
TaskMemoryManager — Memory Manager of Single Task

pageSizeBytes simply requests the MemoryManager for pageSizeBytes.

pageSizeBytes is used when MemoryConsumer is requested to freePage and

Note
throwOom.

Getting Page —  getPage Method

Object getPage(long pagePlusOffsetAddress)

getPage …​FIXME

Note getPage is used when…​FIXME

Getting Page Offset —  getOffsetInPage Method

long getOffsetInPage(long pagePlusOffsetAddress)

getPage …​FIXME

Note getPage is used when…​FIXME

756
MemoryConsumer

MemoryConsumer
MemoryConsumer is the contract for memory consumers of TaskMemoryManager with support

for spilling.

A MemoryConsumer basically tracks how much memory is allocated.

Creating a MemoryConsumer requires a TaskMemoryManager with optional pageSize and a

MemoryMode .

If not specified, pageSize defaults to TaskMemoryManager.pageSizeBytes and

Note
ON_HEAP memory mode.

spill Method

abstract long spill(long size, MemoryConsumer trigger)

throws IOException

Caution FIXME

spill is used when TaskMemoryManager forces MemoryConsumers to release

Note
memory when requested to acquire execution memory

Memory Allocated —  used Registry

used is the amount of memory in use (i.e. allocated) by the MemoryConsumer .

Deallocate MemoryBlock —  freePage Method

protected void freePage(MemoryBlock page)

freePage is a protected method to deallocate the MemoryBlock .

Internally, it decrements used registry by the size of page and frees the page.

Allocate LongArray —  allocateArray Method

LongArray allocateArray(long size)

757
MemoryConsumer

allocateArray allocates LongArray of size length.

Internally, it allocates a page for the requested size . The size is recorded in the internal
used counter.

However, if it was not possible to allocate the size memory, it shows the current memory
usage and a OutOfMemoryError is thrown.

Unable to acquire [required] bytes of memory, got [got]

Acquiring Memory —  acquireMemory Method

long acquireMemory(long size)

acquireMemory acquires execution memory of size size. The memory is recorded in used

registry.

throwOom Internal Method

void throwOom(final MemoryBlock page, final long required)

throwOom …​FIXME

throwOom is used when MemoryConsumer is requested to allocateArray and

Note
allocatePage.

allocatePage Method

MemoryBlock allocatePage(long required)

allocatePage …​FIXME

Note allocatePage is used when…​FIXME

758
TaskMetrics

TaskMetrics
TaskMetrics is a collection of metrics tracked during execution of a Task.

TaskMetrics uses accumulators to represent the metrics and offers "increment" methods to

increment them.

The local values of the accumulators for a task (as accumulated while the task
Note runs) are sent from the executor to the driver when the task completes (and
DAGScheduler re-creates TaskMetrics ).

Table 1. Metrics
Property Name Type

_memoryBytesSpilled internal.metrics.memoryBytesSpilled LongAccumulator

CollectionAccumulator[(BlockId,
_updatedBlockStatuses internal.metrics.updatedBlockStatuses
BlockStatus)]

Table 2. TaskMetrics’s Internal Registries and Counters

Name Description
Internal accumulators indexed by their names.

nameToAccums Used when TaskMetrics re-creates TaskMetrics from

AccumulatorV2s , …​FIXME

NOTE: nameToAccums is a transient and lazy value.

Collection of internal AccumulatorV2 objects.

internalAccums Used when…​FIXME
NOTE: internalAccums is a transient and lazy value.

Collection of external AccumulatorV2 objects.

externalAccums Used when TaskMetrics re-creates TaskMetrics from

AccumulatorV2s , …​FIXME

NOTE: externalAccums is a transient and lazy value.

759
TaskMetrics

accumulators Method

Caution FIXME

mergeShuffleReadMetrics Method

Caution FIXME

memoryBytesSpilled Method

Caution FIXME

updatedBlockStatuses Method

Caution FIXME

setExecutorCpuTime Method

Caution FIXME

setResultSerializationTime Method

Caution FIXME

setJvmGCTime Method

Caution FIXME

setExecutorRunTime Method

Caution FIXME

setExecutorDeserializeCpuTime Method

Caution FIXME

setExecutorDeserializeTime Method

760
TaskMetrics

Caution FIXME

setUpdatedBlockStatuses Method

Caution FIXME

Re-Creating TaskMetrics From AccumulatorV2s 

—  fromAccumulators Method

fromAccumulators(accums: Seq[AccumulatorV2[_, _]]): TaskMetrics

fromAccumulators creates a new TaskMetrics and registers accums as internal and

external task metrics (using nameToAccums internal registry).

Internally, fromAccumulators creates a new TaskMetrics . It then splits accums into internal
and external task metrics collections (using nameToAccums internal registry).

For every internal task metrics, fromAccumulators finds the metrics in nameToAccums
internal registry (of the new TaskMetrics instance), copies metadata, and merges state.

In the end, fromAccumulators adds the external accumulators to the new TaskMetrics
instance.

fromAccumulators is used exclusively when DAGScheduler gets notified that a

Note
task has finished (and re-creates TaskMetrics ).

Recording Memory Bytes Spilled 

—  incMemoryBytesSpilled Method

incMemoryBytesSpilled(v: Long): Unit

incMemoryBytesSpilled adds v to _memoryBytesSpilled task metrics.

761
TaskMetrics

incMemoryBytesSpilled is used when:

1. Aggregator updates task metrics

2. CoGroupedRDD computes a Partition

3. BlockStoreShuffleReader reads combined key-value records for a reduce

task

Note 4. ShuffleExternalSorter frees execution memory by spilling to disk

5. ExternalSorter writes the records into a temporary partitioned file in the

disk store
6. UnsafeExternalSorter spills current records due to memory pressure

7. SpillableIterator spills records to disk

8. JsonProtocol creates TaskMetrics from JSON

Recording Updated BlockStatus For Block 

—  incUpdatedBlockStatuses Method

incUpdatedBlockStatuses(v: (BlockId, BlockStatus)): Unit

incUpdatedBlockStatuses adds v in _updatedBlockStatuses internal registry.

incUpdatedBlockStatuses is used exclusively when BlockManager does

Note
addUpdatedBlockStatusToTaskMetrics .

Registering Internal Accumulators —  register Method

register(sc: SparkContext): Unit

register registers the internal accumulators (from nameToAccums internal registry) with

countFailedValues enabled ( true ).

Note register is used exclusively when Stage is requested for its new attempt.

762
ShuffleWriteMetrics

ShuffleWriteMetrics
ShuffleWriteMetrics is a collection of accumulators that represents task metrics about

writing shuffle data.

ShuffleWriteMetrics tracks the following task metrics:

1. Shuffle Bytes Written

2. Shuffle Write Time

3. Shuffle Records Written

Accumulators allow tasks (running on executors) to communicate with the

Note
driver.

Table 1. ShuffleWriteMetrics’s Accumulators

Name Description
Accumulator to track how many shuffle bytes were written
in a shuffle task.
Used when ShuffleWriteMetrics is requested the shuffle
_bytesWritten bytes written and to increment or decrement it.
NOTE: _bytesWritten is available as
internal.metrics.shuffle.write.bytesWritten (internally
shuffleWrite.BYTES_WRITTEN ) in TaskMetrics.

Accumulator to track shuffle write time (as 64-bit integer)

of a shuffle task.

Used when ShuffleWriteMetrics is requested the shuffle

_writeTime write time and to increment it.
NOTE: _writeTime is available as
internal.metrics.shuffle.write.writeTime (internally
shuffleWrite.WRITE_TIME ) in TaskMetrics.

Accumulator to track how many shuffle records were

written in a shuffle task.
Used when ShuffleWriteMetrics is requested the shuffle
_recordsWritten records written and to increment or decrement it.

NOTE: _recordsWritten is available as

internal.metrics.shuffle.write.recordsWritten
(internally shuffleWrite.RECORDS_WRITTEN ) in TaskMetrics.

763
ShuffleWriteMetrics

decRecordsWritten Method

Caution FIXME

decBytesWritten Method

Caution FIXME

writeTime Method

Caution FIXME

recordsWritten Method

Caution FIXME

Returning Number of Shuffle Bytes Written 

—  bytesWritten Method

bytesWritten: Long

bytesWritten represents the shuffle bytes written metrics of a shuffle task.

Internally, bytesWritten returns the sum of _bytesWritten internal accumulator.

bytesWritten is used when:

1. ShuffleWriteMetricsUIData is created

2. In decBytesWritten
3. StatsReportListener intercepts stage completed events to show shuffle
bytes written
Note
4. ShuffleExternalSorter does writeSortedFile (to incDiskBytesSpilled )

5. JsonProtocol converts ShuffleWriteMetrics to JSON

6. ExecutorsListener intercepts task end events to update executor metrics

7. JobProgressListener updates stage and executor metrics

764
ShuffleWriteMetrics

Incrementing Shuffle Bytes Written Metrics 

—  incBytesWritten Method

incBytesWritten(v: Long): Unit

incBytesWritten simply adds v to _bytesWritten internal accumulator.

incBytesWritten is used when:

1. UnsafeShuffleWriter does mergeSpills

Note
2. DiskBlockObjectWriter does updateBytesWritten

3. JsonProtocol creates TaskMetrics from JSON

Incrementing Shuffle Write Time Metrics 

—  incWriteTime Method

incWriteTime(v: Long): Unit

incWriteTime simply adds v to _writeTime internal accumulator.

incWriteTime is used when:

1. SortShuffleWriter stops.

2. BypassMergeSortShuffleWriter writes records (i.e. when it initializes

DiskBlockObjectWriter partition writers) and later when concatenates per-
partition files into a single file.

Note 3. UnsafeShuffleWriter does mergeSpillsWithTransferTo .

4. DiskBlockObjectWriter does commitAndGet (but only when syncWrites

flag is enabled that forces outstanding writes to disk).

5. JsonProtocol creates TaskMetrics from JSON

6. TimeTrackingOutputStream does its operation (after all it is an output stream

to track shuffle write time).

Incrementing Shuffle Records Written Metrics 

—  incRecordsWritten Method

incRecordsWritten(v: Long): Unit

765
ShuffleWriteMetrics

incRecordsWritten simply adds v to _recordsWritten internal accumulator.

incRecordsWritten is used when:

1. ShuffleExternalSorter does writeSortedFile

Note
2. DiskBlockObjectWriter does recordWritten

3. JsonProtocol creates TaskMetrics from JSON

766
TaskSetBlacklist — Blacklisting Executors and Nodes For TaskSet

TaskSetBlacklist  — Blacklisting Executors

and Nodes For TaskSet
Caution FIXME

updateBlacklistForFailedTask Method

Caution FIXME

isExecutorBlacklistedForTaskSet Method

Caution FIXME

isNodeBlacklistedForTaskSet Method

Caution FIXME

767
SchedulerBackend — Pluggable Scheduler Backends

SchedulerBackend — Pluggable Scheduler
Backends
SchedulerBackend is a pluggable interface to support various cluster managers, e.g. Apache

Mesos, Hadoop YARN or Spark’s own Spark Standalone and Spark local.

As the cluster managers differ by their custom task scheduling modes and resource offers
mechanisms Spark abstracts the differences in SchedulerBackend contract.

Table 1. Built-In (Direct and Indirect) SchedulerBackends per Cluster Environment

Cluster Environment SchedulerBackends
Local mode LocalSchedulerBackend

(base for custom

CoarseGrainedSchedulerBackend
SchedulerBackends)

Spark Standalone StandaloneSchedulerBackend

YarnSchedulerBackend:
YarnClientSchedulerBackend (for client deploy
Spark on YARN mode)
YarnClusterSchedulerBackend (for cluster deploy
mode)

MesosCoarseGrainedSchedulerBackend
Spark on Mesos
MesosFineGrainedSchedulerBackend

A scheduler backend is created and started as part of SparkContext’s initialization (when

TaskSchedulerImpl is started - see Creating Scheduler Backend and Task Scheduler).

FIXME Image how it gets created with SparkContext in play here or in

Caution
SparkContext doc.

Scheduler backends are started and stopped as part of TaskSchedulerImpl’s initialization

and stopping.

Being a scheduler backend in Spark assumes a Apache Mesos-like model in which "an
application" gets resource offers as machines become available and can launch tasks on
them. Once a scheduler backend obtains the resource allocation, it can start executors.

768
SchedulerBackend — Pluggable Scheduler Backends

Understanding how Apache Mesos works can greatly improve understanding

Tip
Spark.

SchedulerBackend Contract

trait SchedulerBackend {
def applicationId(): String
def applicationAttemptId(): Option[String]
def defaultParallelism(): Int
def getDriverLogUrls: Option[Map[String, String]]
def isReady(): Boolean
def killTask(taskId: Long, executorId: String, interruptThread: Boolean): Unit
def reviveOffers(): Unit
def start(): Unit
def stop(): Unit
}

org.apache.spark.scheduler.SchedulerBackend is a private[spark] Scala trait in

Note
Spark.

Table 2. SchedulerBackend Contract

Method Description
Unique identifier of Spark Application
applicationId Used when TaskSchedulerImpl is asked for the unique
identifier of a Spark application (that is actually a part of
TaskScheduler contract).

Attempt id of a Spark application

Only supported by YARN cluster scheduler backend as
the YARN cluster manager supports multiple application
attempts.
applicationAttemptId
Used when…​

NOTE: applicationAttemptId is also a part of

TaskScheduler contract and TaskSchedulerImpl directly
calls the SchedulerBackend’s applicationAttemptId .

defaultParallelism
Used when TaskSchedulerImpl finds the default level of
parallelism (as a hint for sizing jobs).

getDriverLogUrls
Returns no URLs by default and only supported by
YarnClusterSchedulerBackend

769
SchedulerBackend — Pluggable Scheduler Backends

Controls whether SchedulerBackend is ready (i.e. true )

isReady or not (i.e. false ). Enabled by default.
Used when TaskSchedulerImpl waits until
SchedulerBackend is ready (which happens just before
SparkContext is fully initialized).

Reports a UnsupportedOperationException by default.

Used when:
killTask
TaskSchedulerImpl cancels the tasks for a stage

TaskSetManager is notified about successful task

attempt.

Used when TaskSchedulerImpl :

Submits tasks (from TaskSet )
Receives task status updates
reviveOffers
Notifies TaskSetManager that a task has failed
Checks for speculatable tasks
Gets notified about executor being lost

Starts SchedulerBackend .
start
Used when TaskSchedulerImpl is started.

Stops SchedulerBackend .
stop
Used when TaskSchedulerImpl is stopped.

770
CoarseGrainedSchedulerBackend

CoarseGrainedSchedulerBackend
CoarseGrainedSchedulerBackend is a SchedulerBackend.

CoarseGrainedSchedulerBackend is an ExecutorAllocationClient.

CoarseGrainedSchedulerBackend is responsible for requesting resources from a cluster

manager for executors that it in turn uses to launch tasks (on coarse-grained executors).

CoarseGrainedSchedulerBackend holds executors for the duration of the Spark job rather than

relinquishing executors whenever a task is done and asking the scheduler to launch a new
executor for each new task.

Caution FIXME Picture with dependencies

CoarseGrainedSchedulerBackend registers CoarseGrainedScheduler RPC Endpoint that

executors use for RPC communication.

Note Active executors are executors that are not pending to be removed or lost.

Table 1. Built-In CoarseGrainedSchedulerBackends per Cluster Environment

Cluster Environment CoarseGrainedSchedulerBackend
Spark Standalone StandaloneSchedulerBackend

Spark on YARN YarnSchedulerBackend

Spark on Mesos MesosCoarseGrainedSchedulerBackend

CoarseGrainedSchedulerBackend is only created indirectly through built-in

Note
implementations per cluster environment.

Table 2. CoarseGrainedSchedulerBackend’s Internal Pro

Name Initial Value

currentExecutorIdCounter

createTime Current time

defaultAskTimeout spark.rpc.askTimeout or spark.network.timeout or

120s

771
CoarseGrainedSchedulerBackend

driverEndpoint (uninitialized)

executorDataMap empty

executorsPendingToRemove empty

hostToLocalTaskCount empty

localityAwareTasks 0

maxRegisteredWaitingTimeMs spark.scheduler.maxRegisteredResourcesWaitingTime

maxRpcMessageSize spark.rpc.message.maxSize but not greater than

2047

_minRegisteredRatio spark.scheduler.minRegisteredResourcesRatio

numPendingExecutors 0

772
CoarseGrainedSchedulerBackend

totalCoreCount 0

totalRegisteredExecutors 0

Enable INFO or DEBUG logging level for

org.apache.spark.scheduler.cluster.CoarseGrainedSchedulerBackend logger to see what
happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.scheduler.cluster.CoarseGrainedSchedulerBackend=DEBUG

Refer to Logging.

Killing All Executors on Node —  killExecutorsOnHost

Method

Caution FIXME

Making Fake Resource Offers on Executors 

—  makeOffers Internal Methods

makeOffers(): Unit
makeOffers(executorId: String): Unit

makeOffers takes the active executors (out of the executorDataMap internal registry) and

creates WorkerOffer resource offers for each (one per executor with the executor’s id, host
and free cores).

Caution Only free cores are considered in making offers. Memory is not! Why?!

It then requests TaskSchedulerImpl to process the resource offers to create a collection of

TaskDescription collections that it in turn uses to launch tasks.

Creating CoarseGrainedSchedulerBackend Instance

CoarseGrainedSchedulerBackend takes the following when created:

1. TaskSchedulerImpl

2. RpcEnv

773
CoarseGrainedSchedulerBackend

CoarseGrainedSchedulerBackend initializes the internal registries and counters.

Getting Executor Ids —  getExecutorIds Method

When called, getExecutorIds simply returns executor ids from the internal
executorDataMap registry.

Note It is called when SparkContext calculates executor ids.

CoarseGrainedSchedulerBackend Contract

class CoarseGrainedSchedulerBackend {
def minRegisteredRatio: Double
def createDriverEndpoint(properties: Seq[(String, String)]): DriverEndpoint
def reset(): Unit
def sufficientResourcesRegistered(): Boolean
def doRequestTotalExecutors(requestedTotal: Int): Future[Boolean]
def doKillExecutors(executorIds: Seq[String]): Future[Boolean]
}

Note CoarseGrainedSchedulerBackend is a private[spark] contract.

Table 3. FIXME Contract

Method Description
Ratio between 0 and 1 (inclusive).
minRegisteredRatio
Controlled by
spark.scheduler.minRegisteredResourcesRatio.

reset FIXME

doRequestTotalExecutors FIXME

doKillExecutors FIXME

Always positive, i.e. true , that means that sufficient

resources are available.
sufficientResourcesRegistered
Used when CoarseGrainedSchedulerBackend checks if
sufficient compute resources are available.

It can reset a current internal state to the initial state.

numExistingExecutors Method

774
CoarseGrainedSchedulerBackend

Caution FIXME

killExecutors Methods

Caution FIXME

getDriverLogUrls Method

Caution FIXME

applicationAttemptId Method

Caution FIXME

Requesting Additional Executors —  requestExecutors

Method

requestExecutors(numAdditionalExecutors: Int): Boolean

requestExecutors is a "decorator" method that ultimately calls a cluster-specific

doRequestTotalExecutors method and returns whether the request was acknowledged or

not (it is assumed false by default).

requestExecutors method is part of ExecutorAllocationClient Contract that

Note SparkContext uses for requesting additional executors (as a part of a developer
API for dynamic allocation of executors).

When called, you should see the following INFO message followed by DEBUG message in
the logs:

INFO Requesting [numAdditionalExecutors] additional executor(s) from the cluster manag

er
DEBUG Number of pending executors is now [numPendingExecutors]

numPendingExecutors is increased by the input numAdditionalExecutors .

requestExecutors requests executors from a cluster manager (that reflects the current

computation needs). The "new executor total" is a sum of the internal numExistingExecutors
and numPendingExecutors decreased by the number of executors pending to be removed.

If numAdditionalExecutors is negative, a IllegalArgumentException is thrown:

775
CoarseGrainedSchedulerBackend

Attempted to request a negative number of additional executor(s) [numAdditionalExecuto

rs] from the cluster manager. Please specify a positive number!

Note It is a final method that no other scheduler backends could customize further.

The method is a synchronized block that makes multiple concurrent requests be

Note
handled in a serial fashion, i.e. one by one.

Requesting Exact Number of Executors 

—  requestTotalExecutors Method

requestTotalExecutors(
numExecutors: Int,
localityAwareTasks: Int,
hostToLocalTaskCount: Map[String, Int]): Boolean

requestTotalExecutors is a "decorator" method that ultimately calls a cluster-specific

doRequestTotalExecutors method and returns whether the request was acknowledged or

not (it is assumed false by default).

requestTotalExecutors is part of ExecutorAllocationClient Contract that

Note
SparkContext uses for requesting the exact number of executors.

It sets the internal localityAwareTasks and hostToLocalTaskCount registries. It then

calculates the exact number of executors which is the input numExecutors and the executors
pending removal decreased by the number of already-assigned executors.

If numExecutors is negative, a IllegalArgumentException is thrown:

Attempted to request a negative number of executor(s) [numExecutors] from the cluster

manager. Please specify a positive number!

Note It is a final method that no other scheduler backends could customize further.

The method is a synchronized block that makes multiple concurrent requests be

Note
handled in a serial fashion, i.e. one by one.

Finding Default Level of Parallelism 

—  defaultParallelism Method

defaultParallelism(): Int

776
CoarseGrainedSchedulerBackend

Note defaultParallelism is part of the SchedulerBackend Contract.

defaultParallelism is spark.default.parallelism Spark property if set.

Otherwise, defaultParallelism is the maximum of totalCoreCount or 2 .

Killing Task —  killTask Method

killTask(taskId: Long, executorId: String, interruptThread: Boolean): Unit

Note killTask is part of the SchedulerBackend contract.

killTask simply sends a KillTask message to driverEndpoint.

Caution FIXME Image

Stopping All Executors —  stopExecutors Method

stopExecutors sends a blocking StopExecutors message to driverEndpoint (if already

initialized).

Note It is called exclusively while CoarseGrainedSchedulerBackend is being stopped.

You should see the following INFO message in the logs:

INFO CoarseGrainedSchedulerBackend: Shutting down all executors

Reset State —  reset Method

reset resets the internal state:

1. Sets numPendingExecutors to 0

2. Clears executorsPendingToRemove

3. Sends a blocking RemoveExecutor message to driverEndpoint for every executor (in

the internal executorDataMap ) to inform it about SlaveLost with the message:

Stale executor after cluster manager re-registered.

reset is a method that is defined in CoarseGrainedSchedulerBackend , but used and

overriden exclusively by YarnSchedulerBackend.

777
CoarseGrainedSchedulerBackend

Remove Executor —  removeExecutor Method

removeExecutor(executorId: String, reason: ExecutorLossReason)

removeExecutor sends a blocking RemoveExecutor message to driverEndpoint.

It is called by subclasses SparkDeploySchedulerBackend,

Note
CoarseMesosSchedulerBackend, and YarnSchedulerBackend.

CoarseGrainedScheduler RPC Endpoint 

—  driverEndpoint
When CoarseGrainedSchedulerBackend starts, it registers CoarseGrainedScheduler RPC
endpoint to be the driver’s communication endpoint.

driverEndpoint is a DriverEndpoint.

CoarseGrainedSchedulerBackend is created while SparkContext is being created

Note that in turn lives inside a Spark driver. That explains the name driverEndpoint
(at least partially).

It is called standalone scheduler’s driver endpoint internally.

It tracks:

It uses driver-revive-thread daemon single-thread thread pool for …​FIXME

FIXME A potential issue with

Caution driverEndpoint.asInstanceOf[NettyRpcEndpointRef].toURI - doubles
spark:// prefix.

Starting CoarseGrainedSchedulerBackend (and Registering

CoarseGrainedScheduler RPC Endpoint) —  start
Method

start(): Unit

Note start is part of the SchedulerBackend contract.

start takes all spark. -prefixed properties and registers the CoarseGrainedScheduler RPC

endpoint (backed by DriverEndpoint ThreadSafeRpcEndpoint).

778
CoarseGrainedSchedulerBackend

Figure 1. CoarseGrainedScheduler Endpoint

start uses TaskSchedulerImpl to access the current SparkContext and in turn
Note
SparkConf.

start uses RpcEnv that was given when CoarseGrainedSchedulerBackend was

Note
created.

Checking If Sufficient Compute Resources Available Or

Waiting Time Passed —  isReady Method

isReady(): Boolean

Note isReady is part of the SchedulerBackend contract.

isReady allows to delay task launching until sufficient resources are available or

spark.scheduler.maxRegisteredResourcesWaitingTime passes.

Internally, isReady checks whether there are sufficient resources available.

sufficientResourcesRegistered by default responds that sufficient resources are

Note
available.

If the resources are available, you should see the following INFO message in the logs and
isReady is positive.

INFO SchedulerBackend is ready for scheduling beginning after

reached minRegisteredResourcesRatio: [minRegisteredRatio]

minRegisteredRatio is in the range 0 to 1 (uses

Note spark.scheduler.minRegisteredResourcesRatio) to denote the minimum ratio of
registered resources to total expected resources before submitting tasks.

If there are no sufficient resources available yet (the above requirement does not hold),
isReady checks whether the time since startup passed

spark.scheduler.maxRegisteredResourcesWaitingTime to give a way to launch tasks (even

when minRegisteredRatio not being reached yet).

779
CoarseGrainedSchedulerBackend

You should see the following INFO message in the logs and isReady is positive.

INFO SchedulerBackend is ready for scheduling beginning after

waiting maxRegisteredResourcesWaitingTime:
[maxRegisteredWaitingTimeMs](ms)

Otherwise, when no sufficient resources are available and

spark.scheduler.maxRegisteredResourcesWaitingTime has not elapsed, isReady is
negative.

Reviving Resource Offers (by Posting ReviveOffers to

CoarseGrainedSchedulerBackend RPC Endpoint) 
—  reviveOffers Method

reviveOffers(): Unit

Note reviveOffers is part of the SchedulerBackend contract.

reviveOffers simply sends a ReviveOffers message to CoarseGrainedSchedulerBackend

RPC endpoint.

780
CoarseGrainedSchedulerBackend

Figure 2. CoarseGrainedExecutorBackend Revives Offers

Stopping CoarseGrainedSchedulerBackend (and Stopping

Executors) —  stop Method

stop(): Unit

Note stop is part of the SchedulerBackend contract.

stop stops all executors and CoarseGrainedScheduler RPC endpoint (by sending a

blocking StopDriver message).

In case of any Exception , stop reports a SparkException with the message:

Error stopping standalone scheduler's driver endpoint

createDriverEndpointRef Method

createDriverEndpointRef(properties: ArrayBuffer[(String, String)]): RpcEndpointRef

createDriverEndpointRef creates DriverEndpoint and registers it as

CoarseGrainedScheduler.

Note createDriverEndpointRef is used when CoarseGrainedSchedulerBackend starts.

Creating DriverEndpoint —  createDriverEndpoint

Method

createDriverEndpoint(properties: Seq[(String, String)]): DriverEndpoint

createDriverEndpoint simply creates a DriverEndpoint.

Note DriverEndpoint is the RPC endpoint of CoarseGrainedSchedulerBackend .

The purpose of createDriverEndpoint is to allow YARN to use the custom

Note
YarnDriverEndpoint .

createDriverEndpoint is used when CoarseGrainedSchedulerBackend

Note
createDriverEndpointRef.

781
CoarseGrainedSchedulerBackend

Settings
Table 4. Spark Properties
Default
Property Description
Value
Time (in
spark.scheduler.revive.interval 1s
milliseconds)
between resource
offers revives.

Maximum message
size to allow in
RPC
communication. In
MB when the unit
is not given.
Generally only
applies to map
output size
(serialized)
spark.rpc.message.maxSize 128 information sent
between executors
and the driver.
Increase this if you
are running jobs
with many
thousands of map
and reduce tasks
and see messages
about the RPC
message size.

Double number
between 0 and 1
(including) that
controls the
minimum ratio of
(registered
spark.scheduler.minRegisteredResourcesRatio 0 resources / total
expected
resources) before
submitting tasks.

See isReady in this

document.

Time to wait for

sufficient resources
spark.scheduler.maxRegisteredResourcesWaitingTime 30s
available.

782
CoarseGrainedSchedulerBackend

See isReady in this

document.

783
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

DriverEndpoint — 
CoarseGrainedSchedulerBackend RPC
Endpoint
DriverEndpoint is a ThreadSafeRpcEndpoint that acts as a message handler for

CoarseGrainedSchedulerBackend to communicate with CoarseGrainedExecutorBackend.

Figure 1. CoarseGrainedSchedulerBackend uses DriverEndpoint for communication with

CoarseGrainedExecutorBackend
DriverEndpoint is created when CoarseGrainedSchedulerBackend starts.

DriverEndpoint uses executorDataMap internal registry of all the executors that registered

with the driver. An executor sends a RegisterExecutor message to inform that it wants to
register.

Figure 2. Executor registration (RegisterExecutor RPC message flow)

DriverEndpoint uses a single thread executor called driver-revive-thread to make

executor resource offers (for launching tasks) (by emitting ReviveOffers message every
spark.scheduler.revive.interval).

784
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

Table 1. CoarseGrainedClusterMessages and Their Handlers (in alphabetical order)

CoarseGrainedClusterMessage Event Handler When emitted?

CoarseGrainedSchedulerBackend
KillExecutorsOnHost
KillExecutorsOnHost requested to kill all executors on a
handler
node.

CoarseGrainedSchedulerBackend
KillTask KillTask handler
requested to kill a task.

Periodically (every
spark.scheduler.revive.interval
soon after DriverEndpoint
ReviveOffers makeOffers starts accepting messages
CoarseGrainedSchedulerBackend
is requested to revive resource
offers.

RegisterExecutor CoarseGrainedExecutorBackend
RegisterExecutor registers with the driver.
handler

CoarseGrainedExecutorBackend
StatusUpdate sends task status updates to the
StatusUpdate
handler driver.

Table 2. DriverEndpoint’s Internal Properties

Name Initial Value Description

Executor addresses (host and port)

for executors.
addressToExecutorId
Set when an executor connects to
register itself. See RegisterExecutor
RPC message.

executorsPendingLossReason

reviveThread

disableExecutor Internal Method

Caution FIXME

KillExecutorsOnHost Handler

Caution FIXME

785
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

executorIsAlive Internal Method

Caution FIXME

onStop Callback

Caution FIXME

onDisconnected Callback
When called, onDisconnected removes the worker from the internal addressToExecutorId
registry (that effectively removes the worker from a cluster).

While removing, it calls removeExecutor with the reason being SlaveLost and message:

Remote RPC client disassociated. Likely due to containers

exceeding thresholds, or network issues. Check driver logs for
WARN messages.

Note onDisconnected is called when a remote host is lost.

RemoveExecutor

RetrieveSparkProps

StopDriver
StopDriver message stops the RPC endpoint.

StopExecutors
StopExecutors message is receive-reply and blocking. When received, the following INFO

message appears in the logs:

INFO Asking each executor to shut down

It then sends a StopExecutor message to every registered executor (from

executorDataMap ).

786
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

Scheduling Sending ReviveOffers Periodically 

—  onStart Callback

onStart(): Unit

onStart is part of RpcEndpoint contract that is executed before a RPC

Note
endpoint starts accepting messages.

onStart schedules a periodic action to send ReviveOffers immediately every

spark.scheduler.revive.interval.

Note spark.scheduler.revive.interval defaults to 1s .

Making Executor Resource Offers (for Launching Tasks) 

—  makeOffers Internal Method

makeOffers(): Unit

makeOffers first creates WorkerOffers for all active executors (registered in the internal

executorDataMap cache).

WorkerOffer represents a resource offer with CPU cores available on an

Note
executor.

makeOffers then requests TaskSchedulerImpl to generate tasks for the available

WorkerOffers followed by launching the tasks on respective executors.

makeOffers uses TaskSchedulerImpl that was given when

Note
CoarseGrainedSchedulerBackend was created.

Note Tasks are described using TaskDescription that holds…​FIXME

makeOffers is used when CoarseGrainedSchedulerBackend RPC endpoint

Note
( DriverEndpoint ) handles ReviveOffers or RegisterExecutor messages.

Making Executor Resource Offer on Single Executor (for

Launching Tasks) —  makeOffers Internal Method

makeOffers(executorId: String): Unit

makeOffers makes sure that the input executorId is alive.

787
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

makeOffers does nothing when the input executorId is registered as pending

Note
to be removed or got lost.

makeOffers finds the executor data (in executorDataMap registry) and creates a

WorkerOffer.

WorkerOffer represents a resource offer with CPU cores available on an

Note
executor.

makeOffers then requests TaskSchedulerImpl to generate tasks for the WorkerOffer

followed by launching the tasks (on the executor).

makeOffers is used when CoarseGrainedSchedulerBackend RPC endpoint

Note
( DriverEndpoint ) handles StatusUpdate messages.

Launching Tasks on Executors —  launchTasks Internal

Method

launchTasks(tasks: Seq[Seq[TaskDescription]]): Unit

launchTasks flattens (and hence "destroys" the structure of) the input tasks collection and

takes one task at a time. Tasks are described using TaskDescription.

The input tasks collection contains one or more TaskDescriptions per executor
Note (and the "task partitioning" per executor is of no use in launchTasks so it simply
flattens the input data structure).

launchTasks encodes the TaskDescription and makes sure that the encoded task’s size is

below the maximum RPC message size.

The maximum RPC message size is calculated when

Note CoarseGrainedSchedulerBackend is created and corresponds to
spark.rpc.message.maxSize Spark property (with maximum of 2047 MB).

If the size of the encoded task is acceptable, launchTasks finds the ExecutorData of the
executor that has been assigned to execute the task (in executorDataMap internal registry)
and decreases the executor’s available number of cores.

Note ExecutorData tracks the number of free cores of an executor (as freeCores ).

The default task scheduler in Spark — TaskSchedulerImpl — uses

Note spark.task.cpus Spark property to control the number of tasks that can be
scheduled per executor.

You should see the following DEBUG message in the logs:

788
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

DEBUG DriverEndpoint: Launching task [taskId] on executor id: [executorId] hostname: [

executorHost].

In the end, launchTasks sends the (serialized) task to associated executor to launch the
task (by sending a LaunchTask message to the executor’s RPC endpoint with the serialized
task insize SerializableBuffer ).

ExecutorData tracks the RpcEndpointRef of executors to send serialized tasks

Note
to (as executorEndpoint ).

This is the moment in a task’s lifecycle when the driver sends the serialized
Important
task to an assigned executor.

In case the size of a serialized TaskDescription equals or exceeds the maximum RPC
message size, launchTasks finds the TaskSetManager (associated with the
TaskDescription ) and aborts it with the following message:

Serialized task [id]:[index] was [limit] bytes, which exceeds

max allowed: spark.rpc.message.maxSize ([maxRpcMessageSize]
bytes). Consider increasing spark.rpc.message.maxSize or using
broadcast variables for large values.

launchTasks uses the registry of active TaskSetManagers per task id from

Note TaskSchedulerImpl that was given when CoarseGrainedSchedulerBackend was
created.

Scheduling in Spark relies on cores only (not memory), i.e. the number of tasks
Spark can run on an executor is limited by the number of cores available only.
When submitting a Spark application for execution both executor resources — 
Note
memory and cores — can however be specified explicitly. It is the job of a
cluster manager to monitor the memory and take action when its use exceeds
what was assigned.

launchTasks is used when CoarseGrainedSchedulerBackend is requested to

Note
make resource offers on single or all executors.

Creating DriverEndpoint Instance

DriverEndpoint takes the following when created:

RpcEnv

Collection of Spark properties and their values

789
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

DriverEndpoint initializes the internal registries and counters.

RegisterExecutor Handler

RegisterExecutor(
executorId: String,
executorRef: RpcEndpointRef,
hostname: String,
cores: Int,
logUrls: Map[String, String])
extends CoarseGrainedClusterMessage

RegisterExecutor is sent when CoarseGrainedExecutorBackend (RPC Endpoint)

Note
is started.

Figure 3. Executor registration (RegisterExecutor RPC message flow)

When received, DriverEndpoint makes sure that no other executors were registered under
the input executorId and that the input hostname is not blacklisted.

DriverEndpoint uses TaskSchedulerImpl (for the list of blacklisted nodes) that

Note
was specified when CoarseGrainedSchedulerBackend was created.

If the requirements hold, you should see the following INFO message in the logs:

INFO Registered executor [executorRef] ([address]) with ID [executorId]

DriverEndpoint does the bookkeeping:

Registers executorId (in addressToExecutorId)

790
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

Adds cores (in totalCoreCount)

Increments totalRegisteredExecutors

Creates and registers ExecutorData for executorId (in executorDataMap)

Updates currentExecutorIdCounter if the input executorId is greater than the current

value.

If numPendingExecutors is greater than 0 , you should see the following DEBUG message
in the logs and DriverEndpoint decrements numPendingExecutors .

DEBUG Decremented number of pending executors ([numPendingExecutors] left)

DriverEndpoint sends RegisteredExecutor message back (that is to confirm that the

executor was registered successfully).

DriverEndpoint uses the input executorRef as the executor’s

Note
RpcEndpointRef.

DriverEndpoint replies true (to acknowledge the message).

DriverEndpoint then announces the new executor by posting SparkListenerExecutorAdded

to LiveListenerBus (with the current time, executor id, and ExecutorData ).

In the end, DriverEndpoint makes executor resource offers (for launching tasks).

If however there was already another executor registered under the input executorId ,
DriverEndpoint sends RegisterExecutorFailed message back with the reason:

Duplicate executor ID: [executorId]

If however the input hostname is blacklisted, you should see the following INFO message in
the logs:

INFO Rejecting [executorId] as it has been blacklisted.

DriverEndpoint sends RegisterExecutorFailed message back with the reason:

Executor is blacklisted: [executorId]

StatusUpdate Handler

791
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

StatusUpdate(
executorId: String,
taskId: Long,
state: TaskState,
data: SerializableBuffer)
extends CoarseGrainedClusterMessage

StatusUpdate is sent when CoarseGrainedExecutorBackend sends task status

Note
updates to the driver.

When StatusUpdate is received, DriverEndpoint requests the TaskSchedulerImpl to handle

the task status update.

If the task has finished, DriverEndpoint updates the number of cores available for work on
the corresponding executor (registered in executorDataMap).

DriverEndpoint uses TaskSchedulerImpl 's spark.task.cpus as the number of

Note
cores that became available after the task has finished.

DriverEndpoint makes an executor resource offer on the single executor.

When DriverEndpoint found no executor (in executorDataMap), you should see the
following WARN message in the logs:

WARN Ignored task status update ([taskId] state [state]) from unknown executor with ID
[executorId]

KillTask Handler

KillTask(
taskId: Long,
executor: String,
interruptThread: Boolean)
extends CoarseGrainedClusterMessage

Note KillTask is sent when CoarseGrainedSchedulerBackend kills a task.

When KillTask is received, DriverEndpoint finds executor (in executorDataMap

registry).

If found, DriverEndpoint passes the message on to the executor (using its registered RPC
endpoint for CoarseGrainedExecutorBackend ).

Otherwise, you should see the following WARN in the logs:

792
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

WARN Attempted to kill task [taskId] for unknown executor [executor].

Removing Executor from Internal Registries (and Notifying

TaskSchedulerImpl and Posting
SparkListenerExecutorRemoved) —  removeExecutor
Internal Method

removeExecutor(executorId: String, reason: ExecutorLossReason): Unit

When removeExecutor is executed, you should see the following DEBUG message in the
logs:

DEBUG Asked to remove executor [executorId] with reason [reason]

removeExecutor then tries to find the executorId executor (in executorDataMap internal

registry).

If the executorId executor was found, removeExecutor removes the executor from the
following registries:

addressToExecutorId

executorDataMap

executorsPendingLossReason

executorsPendingToRemove

removeExecutor decrements:

totalCoreCount by the executor’s totalCores

totalRegisteredExecutors

In the end, removeExecutor notifies TaskSchedulerImpl that an executor was lost.

removeExecutor uses TaskSchedulerImpl that is specified when

Note
CoarseGrainedSchedulerBackend is created.

removeExecutor posts SparkListenerExecutorRemoved to LiveListenerBus (with the

executorId executor).

If however the executorId executor could not be found, removeExecutor requests

BlockManagerMaster to remove the executor asynchronously.

793
DriverEndpoint — CoarseGrainedSchedulerBackend RPC Endpoint

removeExecutor uses SparkEnv to access the current BlockManager and then

Note
BlockManagerMaster.

You should see the following INFO message in the logs:

INFO Asked to remove non-existent executor [executorId]

removeExecutor is used when DriverEndpoint handles RemoveExecutor

Note
message and gets disassociated with a remote RPC endpoint of an executor.

794
ExecutorBackend — Pluggable Executor Backends

ExecutorBackend — Pluggable Executor
Backends
ExecutorBackend is a pluggable interface that TaskRunners use to send task status updates

to a scheduler.

Figure 1. ExecutorBackend receives notifications from TaskRunners

TaskRunner manages a single individual task and is managed by an Executor
Note
to launch a task.

Caution FIXME What is "a scheduler" in this context?

It is effectively a bridge between the driver and an executor, i.e. there are two endpoints
running.

There are three concrete executor backends:

1. CoarseGrainedExecutorBackend

2. LocalSchedulerBackend (for local run mode)

3. MesosExecutorBackend

ExecutorBackend Contract

trait ExecutorBackend {
def statusUpdate(taskId: Long, state: TaskState, data: ByteBuffer): Unit
}

Note ExecutorBackend is a private[spark] contract.

795
ExecutorBackend — Pluggable Executor Backends

Table 1. ExecutorBackend Contract

Method Description

statusUpdate
Used when TaskRunner is requested to run a task (to
send task status updates).

796
CoarseGrainedExecutorBackend

CoarseGrainedExecutorBackend
CoarseGrainedExecutorBackend is a standalone application that is started in a resource

container when:

1. Spark Standalone’s StandaloneSchedulerBackend starts

2. Spark on YARN’s ExecutorRunnable is started.

3. Spark on Mesos’s MesosCoarseGrainedSchedulerBackend launches Spark executors

When started, CoarseGrainedExecutorBackend registers the Executor RPC endpoint to

communicate with the driver (i.e. with CoarseGrainedScheduler RPC endpoint).

Figure 1. CoarseGrainedExecutorBackend Communicates with Driver’s

CoarseGrainedSchedulerBackend Endpoint
When launched, CoarseGrainedExecutorBackend immediately connects to the owning
CoarseGrainedSchedulerBackend to inform that it is ready to launch tasks.

CoarseGrainedExecutorBackend is an ExecutorBackend that controls the lifecycle of a single

executor and sends the executor’s status updates to the driver.

Figure 2. CoarseGrainedExecutorBackend Sending Task Status Updates to Driver’s

CoarseGrainedScheduler Endpoint
CoarseGrainedExecutorBackend is a ThreadSafeRpcEndpoint that connects to the driver

(before accepting messages) and shuts down when the driver disconnects.

797
CoarseGrainedExecutorBackend

Table 1. CoarseGrainedExecutorBackend’s Executor RPC Endpoint Messages (in

alphabetical order)
Message Description

KillTask

Forwards launch task requests from the driver to the

LaunchTask
single managed coarse-grained executor.

Creates the single managed Executor.

RegisteredExecutor Sent exclusively when CoarseGrainedSchedulerBackend
receives RegisterExecutor .

RegisterExecutorFailed

StopExecutor

Shutdown

798
CoarseGrainedExecutorBackend

Table 2. CoarseGrainedExecutorBackend’s Internal Properties

Name Initial Value Description

Initialized when CoarseGrainedExecutorBackend is

created.
ser SerializerInstance
NOTE: CoarseGrainedExecutorBackend uses the
input env to access closureSerializer .

RpcEndpointRef of the driver

driver (empty)
FIXME

Enabled when CoarseGrainedExecutorBackend

gets notified to stop itself or shut down the
managed executor.
stopping false
Used when CoarseGrainedExecutorBackend RPC
Endpoint gets notified that a remote RPC
endpoint disconnected.

Single managed coarse-grained Executor

managed exclusively by the
CoarseGrainedExecutorBackend to forward launch
and kill task requests to from the driver.
executor (uninitialized) Initialized after CoarseGrainedExecutorBackend
has registered with
CoarseGrainedSchedulerBackend and stopped
when CoarseGrainedExecutorBackend gets
requested to shut down.

Enable INFO logging level for

org.apache.spark.executor.CoarseGrainedExecutorBackend logger to see what
happens inside.

Tip Add the following line to conf/log4j.properties :

log4j.logger.org.apache.spark.executor.CoarseGrainedExecutorBackend=INFO

Forwarding Launch Task Request to Executor (from Driver) 

—  LaunchTask Message Handler

LaunchTask(data: SerializableBuffer) extends CoarseGrainedClusterMessage

799
CoarseGrainedExecutorBackend

CoarseGrainedExecutorBackend acts as a proxy between the driver and the

Note managed single executor and merely re-packages LaunchTask payload (as
serialized data ) to pass it along for execution.

LaunchTask first decodes TaskDescription from data . You should see the following INFO

message in the logs:

INFO CoarseGrainedExecutorBackend: Got assigned task [id]

LaunchTask then launches the task on the executor (passing itself as the owning

ExecutorBackend and decoded TaskDescription).

If executor is not available, LaunchTask terminates CoarseGrainedExecutorBackend with the

error code 1 and ExecutorLossReason with the following message:

Received LaunchTask command but executor was null

LaunchTask is sent when CoarseGrainedSchedulerBackend is requested to

Note
launch tasks (one LaunchTask per task).

Sending Task Status Updates to Driver —  statusUpdate

Method

statusUpdate(taskId: Long, state: TaskState, data: ByteBuffer): Unit

statusUpdate is part of ExecutorBackend Contract to send task status updates

Note
to a scheduler (on the driver).

statusUpdate creates a StatusUpdate (with the input taskId , state , and data together

with the executor id) and sends it to the driver (if connected already).

Figure 3. CoarseGrainedExecutorBackend Sending Task Status Updates to Driver’s

CoarseGrainedScheduler Endpoint
When no driver is available, you should see the following WARN message in the logs:

800
CoarseGrainedExecutorBackend

WARN Drop [msg] because has not yet connected to driver

Driver’s URL
The driver’s URL is of the format spark://[RpcEndpoint name]@[hostname]:[port] , e.g.
spark://[email protected]:64859 .

Launching CoarseGrainedExecutorBackend Standalone

Application (in Resource Container) —  main Method
CoarseGrainedExecutorBackend is a standalone application (i.e. comes with main entry

method) that parses command-line arguments and runs CoarseGrainedExecutorBackend’s

Executor RPC endpoint to communicate with the driver.

Table 3. CoarseGrainedExecutorBackend Command-Line Arguments

Argument Required? Description
--driver-url yes Driver’s URL. See driver’s URL

--executor-id yes Executor id

--hostname yes Host name

Number of cores (that must be greater

--cores yes
than 0 ).

--app-id yes Application id

Worker’s URL, e.g.

spark://[email protected]:64557

--worker-url no NOTE: --worker-url is only used in

Spark Standalone to enforce fate-sharing
with the worker.

User-defined class path entry which can

be an URL or path to a resource (often a
--user-class-path no
jar file) to be added to CLASSPATH; can
be specified multiple times.

When executed with unrecognized command-line arguments or required arguments are

missing, main shows the usage help and exits (with exit status 1 ).

801
CoarseGrainedExecutorBackend

$ ./bin/spark-class org.apache.spark.executor.CoarseGrainedExecutorBackend

Usage: CoarseGrainedExecutorBackend [options]

Options are:
--driver-url <driverUrl>
--executor-id <executorId>
--hostname <hostname>
--cores <cores>
--app-id <appid>
--worker-url <workerUrl>
--user-class-path <url>

main is used when:

Spark Standalone’s StandaloneSchedulerBackend starts.

Spark on YARN’s ExecutorRunnable is started (in a YARN resource

Note
container).
Spark on Mesos’s MesosCoarseGrainedSchedulerBackend launches Spark
executors

Running CoarseGrainedExecutorBackend (and Registering

Executor RPC Endpoint) —  run Internal Method

run(
driverUrl: String,
executorId: String,
hostname: String,
cores: Int,
appId: String,
workerUrl: Option[String],
userClassPath: scala.Seq[URL]): Unit

When executed, run executes Utils.initDaemon(log) .

Caution FIXME What does initDaemon do?

run runs itself with a Hadoop UserGroupInformation (as a thread local variable
Note
distributed to child threads for authenticating HDFS and YARN calls).

Note run expects a clear hostname with no : included (for a port perhaps).

802
CoarseGrainedExecutorBackend

run uses spark.executor.port Spark property (or 0 if not set) for the port to create a

RpcEnv called driverPropsFetcher (together with the input hostname and clientMode

enabled).

run resolves RpcEndpointRef for the input driverUrl and requests SparkAppConfig (by

posting a blocking RetrieveSparkAppConfig ).

This is the first moment when CoarseGrainedExecutorBackend initiates

Important
communication with the driver available at driverUrl through RpcEnv .

run uses SparkAppConfig to get the driver’s sparkProperties and adds spark.app.id

Spark property with the value of the input appId .

run shuts driverPropsFetcher RPC Endpoint down.

run creates a SparkConf using the Spark properties fetched from the driver, i.e. with the

executor-related Spark settings if they were missing and the rest unconditionally.

If spark.yarn.credentials.file Spark property is defined in SparkConf , you should see the

following INFO message in the logs:

INFO Will periodically update credentials from: [spark.yarn.credentials.file]

run requests the current SparkHadoopUtil to start start the credential updater.

Note run uses SparkHadoopUtil.get to access the current SparkHadoopUtil .

run creates SparkEnv for executors (with the input executorId , hostname and cores ,

and isLocal disabled).

This is the moment when SparkEnv gets created with all the executor
Important
services.

run sets up an RPC endpoint with the name Executor and

CoarseGrainedExecutorBackend as the endpoint.

(only in Spark Standalone) If the optional input workerUrl was defined, run sets up an
RPC endpoint with the name WorkerWatcher and WorkerWatcher RPC endpoint.

The optional input workerUrl is defined only when --worker-url command-

line argument was used to launch CoarseGrainedExecutorBackend standalone
Note application.

--worker-url is only used in Spark Standalone.

803
CoarseGrainedExecutorBackend

run 's main thread is blocked until RpcEnv terminates and only the RPC endpoints process

RPC messages.

Once RpcEnv has terminated, run stops the credential updater.

Caution FIXME Think of the place for Utils.initDaemon , Utils.getProcessName et al.

run is used exclusively when CoarseGrainedExecutorBackend standalone

Note
application is launched.

Creating CoarseGrainedExecutorBackend Instance

CoarseGrainedExecutorBackend takes the following when created:

1. RpcEnv

2. driverUrl

3. executorId

4. hostname

5. cores

6. userClassPath

7. SparkEnv

driverUrl , executorId , hostname , cores and userClassPath correspond to

Note CoarseGrainedExecutorBackend standalone application’s command-line
arguments.

CoarseGrainedExecutorBackend initializes the internal properties.

CoarseGrainedExecutorBackend is created (to act as an RPC endpoint) when

Note
Executor RPC endpoint is registered.

Registering with Driver —  onStart Method

onStart(): Unit

onStart is part of RpcEndpoint contract that is executed before a RPC

Note
endpoint starts accepting messages.

When executed, you should see the following INFO message in the logs:

804
CoarseGrainedExecutorBackend

INFO CoarseGrainedExecutorBackend: Connecting to driver: [driverUrl]

Note driverUrl is given when CoarseGrainedExecutorBackend is created.

onStart then takes the RpcEndpointRef of the driver asynchronously and initializes the

internal driver property. onStart sends a blocking RegisterExecutor message immediately

(with executorId, RpcEndpointRef to itself, hostname, cores and log URLs).

In case of failures, onStart terminates CoarseGrainedExecutorBackend with the error code

1 and the reason (and no notification to the driver):

Cannot register with driver: [driverUrl]

Creating Single Managed Executor 

—  RegisteredExecutor Message Handler

RegisteredExecutor
extends CoarseGrainedClusterMessage with RegisterExecutorResponse

When RegisteredExecutor is received, you should see the following INFO in the logs:

INFO CoarseGrainedExecutorBackend: Successfully registered with driver

CoarseGrainedExecutorBackend creates a Executor (with isLocal disabled) that becomes

the single managed Executor.

CoarseGrainedExecutorBackend uses executorId , hostname , env ,

Note userClassPath to create the Executor that are specified when
CoarseGrainedExecutorBackend is created.

If creating the Executor fails with a non-fatal exception, RegisteredExecutor terminates

CoarseGrainedExecutorBackend with the reason:

Unable to create executor due to [message]

RegisteredExecutor is sent exclusively when CoarseGrainedSchedulerBackend

RPC Endpoint receives a RegisterExecutor (that is sent right before
Note
CoarseGrainedExecutorBackend RPC Endpoint starts accepting messages which
happens when CoarseGrainedExecutorBackend is started).

RegisterExecutorFailed

805
CoarseGrainedExecutorBackend

RegisterExecutorFailed(message)

When a RegisterExecutorFailed message arrives, the following ERROR is printed out to the
logs:

ERROR CoarseGrainedExecutorBackend: Slave registration failed: [message]

CoarseGrainedExecutorBackend then exits with the exit code 1 .

Killing Tasks —  KillTask Message Handler

KillTask(taskId, _, interruptThread) message kills a task (calls Executor.killTask ).

If an executor has not been initialized yet (FIXME: why?), the following ERROR message is
printed out to the logs and CoarseGrainedExecutorBackend exits:

ERROR Received KillTask command but executor was null

StopExecutor Handler

case object StopExecutor

extends CoarseGrainedClusterMessage

When StopExecutor is received, the handler turns stopping internal flag on. You should see
the following INFO message in the logs:

INFO CoarseGrainedExecutorBackend: Driver commanded a shutdown

In the end, the handler sends a Shutdown message to itself.

StopExecutor message is sent when CoarseGrainedSchedulerBackend RPC

Note Endpoint (aka DriverEndpoint ) processes StopExecutors or RemoveExecutor
messages.

Shutdown Handler

case object Shutdown

extends CoarseGrainedClusterMessage

806
CoarseGrainedExecutorBackend

Shutdown turns stopping internal flag on and starts the CoarseGrainedExecutorBackend-stop-

executor thread that stops the owned Executor (using executor reference).

Shutdown message is sent exclusively when CoarseGrainedExecutorBackend

Note
receives StopExecutor .

Terminating CoarseGrainedExecutorBackend (and

Notifying Driver with RemoveExecutor) —  exitExecutor
Method

exitExecutor(
code: Int,
reason: String,
throwable: Throwable = null,
notifyDriver: Boolean = true): Unit

When exitExecutor is executed, you should see the following ERROR message in the logs
(followed by throwable if available):

ERROR Executor self-exiting due to : [reason]

If notifyDriver is enabled (it is by default) exitExecutor informs the driver that the
executor should be removed (by sending a blocking RemoveExecutor message with executor
id and a ExecutorLossReason with the input reason ).

You may see the following WARN message in the logs when the notification fails.

Unable to notify the driver due to [message]

In the end, exitExecutor terminates the CoarseGrainedExecutorBackend JVM process with

the status code .

exitExecutor uses Java’s System.exit and initiates JVM’s shutdown sequence

Note
(and executing all registered shutdown hooks).

exitExecutor is used when:

CoarseGrainedExecutorBackend fails to associate with the driver, create a

managed executor or register with the driver
Note
no executor has been created before launch or kill task requests

driver has disconnected.

807
CoarseGrainedExecutorBackend

onDisconnected Callback

Caution FIXME

start Method

Caution FIXME

stop Method

Caution FIXME

requestTotalExecutors

Caution FIXME

Extracting Log URLs —  extractLogUrls Method

Caution FIXME

808
MesosExecutorBackend

MesosExecutorBackend
Caution FIXME

registered Method

Caution FIXME

launchTask Method

launchTask(d: ExecutorDriver, taskInfo: TaskInfo): Unit

launchTask is part of Apache Mesos' Executor Contract to be invoked when a

Note
task has been launched on this executor.

launchTask …​FIXME

809
BlockManager — Key-Value Store of Blocks of Data

BlockManager — Key-Value Store of Blocks of

Data
BlockManager is a key-value store of blocks of data (block storage) identified by a block ID.

BlockManager acts as a local cache that runs on every node in a Spark cluster, i.e. the driver

and executors.

BlockManager provides interface for uploading and fetching blocks both locally and remotely

using various stores, i.e. memory, disk, and off-heap.

BlockManager is created exclusively when SparkEnv is created (for the driver and

executors). While being created, BlockManager gets a DiskBlockManager,

BlockInfoManager, MemoryStore and DiskStore (that it immediately wires together, i.e.
BlockInfoManager with MemoryStore and DiskStore with DiskBlockManager ).

BlockManager uses a Scala ExecutionContextExecutorService to execute FIXME

asynchronously (on a thread pool with block-manager-future prefix and maximum of 128
threads).

The common idiom in Spark to access a BlockManager regardless of a location, i.e. the
driver or executors, is through SparkEnv:

// BlockManager is a private[spark] class

// so the following has to be under org.apache.spark package
// e.g. package org.apache.spark
import org.apache.spark.storage.BlockManager
val bm: BlockManager = SparkEnv.get.blockManager

BlockManager is a BlockDataManager, i.e. manages the storage for blocks that can

represent cached RDD partitions, intermediate shuffle outputs, broadcasts, etc.

BlockManager is a BlockEvictionHandler that can drop a block from memory and store it on

a disk if required.

Cached blocks are blocks with non-zero sum of memory and disk sizes.

Tip Use Web UI, esp. Storage and Executors tabs, to monitor the memory used.

Use spark-submit's command-line options, i.e. --driver-memory for the driver and
--executor-memory for executors or their equivalents as Spark properties, i.e.
Tip
spark.executor.memory and spark.driver.memory, to control the memory for
storage memory.

810
BlockManager — Key-Value Store of Blocks of Data

A BlockManager is created when a Spark application starts and must be initialized before it
is fully operable.

When External Shuffle Service is enabled, BlockManager uses ExternalShuffleClient to read

other executors' shuffle files.

BlockManager uses BlockManagerSource to report metrics under the name BlockManager.

Table 1. BlockManager’s Internal Properties

Name Initial Value Description
blockInfoManager FIXME BlockInfoManager for…​FIXME

diskStore FIXME DiskStore for…​FIXME

diskBlockManager FIXME DiskBlockManager for…​FIXME

Total available on- Total maximum value that BlockManager

maxMemory
heap and off-heap can ever possibly use (that depends on
memory for MemoryManager and may vary over
storage (in bytes) time).

maxOffHeapMemory

maxOnHeapMemory

MemoryStore (with the BlockInfoManager,

memoryStore
the SerializerManager, MemoryManager
and this BlockManager as the
BlockEvictionHandler)

Enable INFO , DEBUG or TRACE logging level for

org.apache.spark.storage.BlockManager logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.storage.BlockManager=TRACE

Refer to Logging.

You may want to shut off WARN messages being printed out about the current
state of blocks using the following line to cut the noise:
Tip
log4j.logger.org.apache.spark.storage.BlockManager=OFF

811
BlockManager — Key-Value Store of Blocks of Data

getLocations Method

Caution FIXME

blockIdsToHosts Method

Caution FIXME

getLocationBlockIds Method

Caution FIXME

getPeers Method

Caution FIXME

releaseAllLocksForTask Method

Caution FIXME

Stopping BlockManager —  stop Method

stop(): Unit

stop …​FIXME

Note stop is used exclusively when SparkEnv is requested to stop.

Getting IDs of Existing Blocks (For a Given Filter) 

—  getMatchingBlockIds Method

getMatchingBlockIds(filter: BlockId => Boolean): Seq[BlockId]

getMatchingBlockIds …​FIXME

getMatchingBlockIds is used exclusively when BlockManagerSlaveEndpoint is

Note
requested to handle a GetMatchingBlockIds message.

812
BlockManager — Key-Value Store of Blocks of Data

getLocalValues Method

getLocalValues(blockId: BlockId): Option[BlockResult]

getLocalValues …​FIXME

Internally, when getLocalValues is executed, you should see the following DEBUG
message in the logs:

DEBUG BlockManager: Getting local block [blockId]

getLocalValues obtains a read lock for blockId .

When no blockId block was found, you should see the following DEBUG message in the
logs and getLocalValues returns "nothing" (i.e. NONE ).

DEBUG Block [blockId] was not found

When the blockId block was found, you should see the following DEBUG message in the
logs:

DEBUG Level for block [blockId] is [level]

If blockId block has memory level and is registered in MemoryStore , getLocalValues

returns a BlockResult as Memory read method and with a CompletionIterator for an
interator:

1. Values iterator from MemoryStore for blockId for "deserialized" persistence levels.

2. Iterator from SerializerManager after the data stream has been deserialized for the
blockId block and the bytes for blockId block for "serialized" persistence levels.

getLocalValues is used when TorrentBroadcast reads the blocks of a

Note
broadcast variable and stores them in a local BlockManager .

Caution FIXME

getRemoteValues Internal Method

getRemoteValues[T: ClassTag](blockId: BlockId): Option[BlockResult]

813
BlockManager — Key-Value Store of Blocks of Data

getRemoteValues …​FIXME

Retrieving Block from Local or Remote Block Managers 

—  get Method

get[T: ClassTag](blockId: BlockId): Option[BlockResult]

get attempts to get the blockId block from a local block manager first before requesting it

from remote block managers.

Internally, get tries to get the block from the local BlockManager. If the block was found,
you should see the following INFO message in the logs and get returns the local
BlockResult.

INFO Found block [blockId] locally

If however the block was not found locally, get tries to get the block from remote block
managers. If retrieved from a remote block manager, you should see the following INFO
message in the logs and get returns the remote BlockResult.

INFO Found block [blockId] remotely

In the end, get returns "nothing" (i.e. NONE ) when the blockId block was not found either
in the local BlockManager or any remote BlockManager .

get is used when:

BlockManager is requested to getOrElseUpdate and getSingle

Note BlockRDD is requested to compute a partition

Spark Streaming’s WriteAheadLogBackedBlockRDD is requested to compute

a partition

Getting Local Block Data As Bytes —  getLocalBytes

Method

Caution FIXME

Finding Shuffle Block Data —  getBlockData Method

814
BlockManager — Key-Value Store of Blocks of Data

Caution FIXME

removeBlockInternal Method

Caution FIXME

Is External Shuffle Service Enabled? 

—  externalShuffleServiceEnabled Flag
When the External Shuffle Service is enabled for a Spark application, BlockManager uses
ExternalShuffleClient to read other executors' shuffle files.

Caution FIXME How is shuffleClient used?

Stores
A Store is the place where blocks are held.

There are the following possible stores:

MemoryStore for memory storage level.

DiskStore for disk storage level.

ExternalBlockStore for OFF_HEAP storage level.

Storing Block Data Locally —  putBlockData Method

putBlockData(
blockId: BlockId,
data: ManagedBuffer,
level: StorageLevel,
classTag: ClassTag[_]): Boolean

putBlockData simply stores blockId locally (given the given storage level ).

Note putBlockData is part of the BlockDataManager Contract.

Internally, putBlockData wraps ChunkedByteBuffer around data buffer’s NIO ByteBuffer

and calls putBytes.

Storing Block Bytes Locally —  putBytes Method

815
BlockManager — Key-Value Store of Blocks of Data

putBytes(
blockId: BlockId,
bytes: ChunkedByteBuffer,
level: StorageLevel,
tellMaster: Boolean = true): Boolean

putBytes makes sure that the bytes are not null and doPutBytes.

putBytes is used when:

BlockManager is requested to puts a block data locally

TaskRunner is requested to run (and the result size is above

maxDirectResultSize)
TorrentBroadcast is requested to writeBlocks and readBlocks
Note
Spark Streaming’s WriteAheadLogBackedBlockRDD is requested to compute

Spark Streaming’s BlockManagerBasedBlockHandler is requested to

storeBlock

Spark Streaming’s WriteAheadLogBasedBlockHandler is requested to

storeBlock

doPutBytes Internal Method

def doPutBytes[T](
blockId: BlockId,
bytes: ChunkedByteBuffer,
level: StorageLevel,
classTag: ClassTag[T],
tellMaster: Boolean = true,
keepReadLock: Boolean = false): Boolean

doPutBytes calls the internal helper doPut with a function that accepts a BlockInfo and

does the uploading.

Inside the function, if the storage level 's replication is greater than 1, it immediately starts
replication of the blockId block on a separate thread (from futureExecutionContext thread
pool). The replication uses the input bytes and level storage level.

For a memory storage level, the function checks whether the storage level is deserialized
or not. For a deserialized storage level , BlockManager 's SerializerManager deserializes
bytes into an iterator of values that MemoryStore stores. If however the storage level is

not deserialized, the function requests MemoryStore to store the bytes

816
BlockManager — Key-Value Store of Blocks of Data

If the put did not succeed and the storage level is to use disk, you should see the following
WARN message in the logs:

WARN BlockManager: Persisting block [blockId] to disk instead.

And DiskStore stores the bytes.

DiskStore is requested to store the bytes of a block with memory and disk
Note
storage level only when MemoryStore has failed.

If the storage level is to use disk only, DiskStore stores the bytes.

doPutBytes requests current block status and if the block was successfully stored, and the

driver should know about it ( tellMaster ), the function reports the current storage status of
the block to the driver. The current TaskContext metrics are updated with the updated block
status (only when executed inside a task where TaskContext is available).

You should see the following DEBUG message in the logs:

DEBUG BlockManager: Put block [blockId] locally took [time] ms

The function waits till the earlier asynchronous replication finishes for a block with replication
level greater than 1 .

The final result of doPutBytes is the result of storing the block successful or not (as
computed earlier).

Note doPutBytes is used exclusively when BlockManager is requested to putBytes.

maybeCacheDiskValuesInMemory Method

Caution FIXME

doPut Internal Method

doPut[T](
blockId: BlockId,
level: StorageLevel,
classTag: ClassTag[_],
tellMaster: Boolean,
keepReadLock: Boolean)(putBody: BlockInfo => Option[T]): Option[T]

doPut is an internal helper method for doPutBytes and doPutIterator.

817
BlockManager — Key-Value Store of Blocks of Data

doPut executes the input putBody function with a BlockInfo being a new BlockInfo object

(with level storage level) that BlockInfoManager managed to create a write lock for.

If the block has already been created (and BlockInfoManager did not manage to create a
write lock for), the following WARN message is printed out to the logs:

WARN Block [blockId] already exists on this machine; not re-adding it

doPut releases the read lock for the block when keepReadLock flag is disabled and returns

None immediately.

If however the write lock has been given, doPut executes putBody .

If the result of putBody is None the block is considered saved successfully.

For successful save and keepReadLock enabled, BlockInfoManager is requested to

downgrade an exclusive write lock for blockId to a shared read lock.

For successful save and keepReadLock disabled, BlockInfoManager is requested to release

lock on blockId .

For unsuccessful save, the block is removed from memory and disk stores and the following
WARN message is printed out to the logs:

WARN Putting block [blockId] failed

Ultimately, the following DEBUG message is printed out to the logs:

DEBUG Putting block [blockId] [withOrWithout] replication took [usedTime] ms

Removing Block From Memory and Disk —  removeBlock

Method

removeBlock(blockId: BlockId, tellMaster: Boolean = true): Unit

removeBlock removes the blockId block from the MemoryStore and DiskStore.

When executed, it prints out the following DEBUG message to the logs:

DEBUG Removing block [blockId]

818
BlockManager — Key-Value Store of Blocks of Data

It requests BlockInfoManager for lock for writing for the blockId block. If it receives none, it
prints out the following WARN message to the logs and quits.

WARN Asked to remove block [blockId], which does not exist

Otherwise, with a write lock for the block, the block is removed from MemoryStore and
DiskStore (see Removing Block in MemoryStore and Removing Block in DiskStore ).

If both removals fail, it prints out the following WARN message:

WARN Block [blockId] could not be removed as it was not found in either the disk, memo
ry, or external block store

The block is removed from BlockInfoManager.

It then calculates the current block status that is used to report the block status to the driver
(if the input tellMaster and the info’s tellMaster are both enabled, i.e. true ) and the
current TaskContext metrics are updated with the change.

It is used to remove RDDs and broadcast as well as in

Note
BlockManagerSlaveEndpoint while handling RemoveBlock messages.

Removing RDD Blocks —  removeRdd Method

removeRdd(rddId: Int): Int

removeRdd removes all the blocks that belong to the rddId RDD.

It prints out the following INFO message to the logs:

INFO Removing RDD [rddId]

It then requests RDD blocks from BlockInfoManager and removes them (from memory and
disk) (without informing the driver).

The number of blocks removed is the final result.

Note It is used by BlockManagerSlaveEndpoint while handling RemoveRdd messages.

Removing Broadcast Blocks —  removeBroadcast

Method

819
BlockManager — Key-Value Store of Blocks of Data

removeBroadcast(broadcastId: Long, tellMaster: Boolean): Int

removeBroadcast removes all the blocks of the input broadcastId broadcast.

Internally, it starts by printing out the following DEBUG message to the logs:

DEBUG Removing broadcast [broadcastId]

It then requests all the BroadcastBlockId objects that belong to the broadcastId broadcast
from BlockInfoManager and removes them (from memory and disk).

The number of blocks removed is the final result.

It is used by BlockManagerSlaveEndpoint while handling RemoveBroadcast

Note
messages.

Getting Block Status —  getStatus Method

Caution FIXME

Creating BlockManager Instance

BlockManager takes the following when created:

Executor ID

RpcEnv

BlockManagerMaster

SerializerManager

SparkConf

MemoryManager

MapOutputTracker

ShuffleManager

BlockTransferService

SecurityManager

CPU cores

820
BlockManager — Key-Value Store of Blocks of Data

executorId is SparkContext.DRIVER_IDENTIFIER , i.e. driver for the driver, and

Note the value of --executor-id command-line argument for
CoarseGrainedExecutorBackend executors or MesosExecutorBackend.

Caution FIXME Elaborate on the executor backends and executor ids.

When created, BlockManager sets externalShuffleServiceEnabled internal flag per

spark.shuffle.service.enabled Spark property.

BlockManager then creates an instance of DiskBlockManager (requesting

deleteFilesOnStop when an external shuffle service is not in use).

BlockManager creates an instance of BlockInfoManager (as blockInfoManager ).

BlockManager creates block-manager-future daemon cached thread pool with 128 threads

maximum (as futureExecutionContext ).

BlockManager creates a MemoryStore and DiskStore.

MemoryManager gets the MemoryStore object assigned.

BlockManager calculates the maximum memory to use (as maxMemory ) by requesting the

maximum on-heap and off-heap storage memory from the assigned MemoryManager .

Note UnifiedMemoryManager is the default MemoryManager (as of Spark 1.6).

BlockManager calculates the port used by the external shuffle service (as

externalShuffleServicePort ).

Note It is computed specially in Spark on YARN.

Caution FIXME Describe the YARN-specific part.

BlockManager creates a client to read other executors' shuffle files (as shuffleClient ). If

the external shuffle service is used an ExternalShuffleClient is created or the input

BlockTransferService is used.

BlockManager sets the maximum number of failures before this block manager refreshes the

block locations from the driver (as maxFailuresBeforeLocationRefresh ).

BlockManager registers BlockManagerSlaveEndpoint with the input RpcEnv, itself, and

MapOutputTracker (as slaveEndpoint ).

shuffleServerId

821
BlockManager — Key-Value Store of Blocks of Data

Caution FIXME

Initializing BlockManager —  initialize Method

initialize(appId: String): Unit

initialize initializes a BlockManager on the driver and executors (see Creating

SparkContext Instance and Creating Executor Instance, respectively).

The method must be called before a BlockManager can be considered fully

Note
operable.

initialize does the following in order:

1. Initializes BlockTransferService

2. Initializes the internal shuffle client, be it ExternalShuffleClient or BlockTransferService.

3. Registers itself with the driver’s BlockManagerMaster (using the id , maxMemory and its
slaveEndpoint ).

The BlockManagerMaster reference is passed in when the BlockManager is created on

the driver and executors.

4. Sets shuffleServerId to an instance of BlockManagerId given an executor id, host name

and port for BlockTransferService.

5. It creates the address of the server that serves this executor’s shuffle files (using
shuffleServerId)

Caution FIXME Review the initialize procedure again

Caution FIXME Describe shuffleServerId . Where is it used?

If the External Shuffle Service is used, the following INFO appears in the logs:

INFO external shuffle service port = [externalShuffleServicePort]

It registers itself to the driver’s BlockManagerMaster passing the BlockManagerId, the

maximum memory (as maxMemory ), and the BlockManagerSlaveEndpoint.

Ultimately, if the initialization happens on an executor and the External Shuffle Service is
used, it registers to the shuffle service.

822
BlockManager — Key-Value Store of Blocks of Data

initialize is called when the driver is launched (and SparkContext is

Note created) and when an Executor is created (for
CoarseGrainedExecutorBackend and MesosExecutorBackend).

Registering Executor’s BlockManager with External Shuffle

Server —  registerWithExternalShuffleServer Method

registerWithExternalShuffleServer(): Unit

registerWithExternalShuffleServer is an internal helper method to register the

BlockManager for an executor with an external shuffle server.

It is executed when a BlockManager is initialized on an executor and an

Note
external shuffle service is used.

When executed, you should see the following INFO message in the logs:

INFO Registering executor with local external shuffle service.

It uses shuffleClient to register the block manager using shuffleServerId (i.e. the host, the
port and the executorId) and a ExecutorShuffleInfo .

The ExecutorShuffleInfo uses localDirs and subDirsPerLocalDir from

Note
DiskBlockManager and the class name of the constructor ShuffleManager.

It tries to register at most 3 times with 5-second sleeps in-between.

The maximum number of attempts and the sleep time in-between are hard-
Note
coded, i.e. they are not configured.

Any issues while connecting to the external shuffle service are reported as ERROR
messages in the logs:

ERROR Failed to connect to external shuffle server, will retry [#attempts] more times
after waiting 5 seconds...

Re-registering BlockManager with Driver and Reporting

Blocks —  reregister Method

reregister(): Unit

823
BlockManager — Key-Value Store of Blocks of Data

When executed, reregister prints the following INFO message to the logs:

INFO BlockManager: BlockManager [blockManagerId] re-registering with master

reregister then registers itself to the driver’s BlockManagerMaster (just as it was when

BlockManager was initializing). It passes the BlockManagerId, the maximum memory (as
maxMemory ), and the BlockManagerSlaveEndpoint.

reregister will then report all the local blocks to the BlockManagerMaster.

You should see the following INFO message in the logs:

INFO BlockManager: Reporting [blockInfoManager.size] blocks to the master.

For each block metadata (in BlockInfoManager) it gets block current status and tries to send
it to the BlockManagerMaster.

If there is an issue communicating to the BlockManagerMaster, you should see the following
ERROR message in the logs:

ERROR BlockManager: Failed to report [blockId] to master; giving up.

After the ERROR message, reregister stops reporting.

reregister is called when a Executor was informed to re-register while

Note
sending heartbeats.

Calculate Current Block Status 

—  getCurrentBlockStatus Method

getCurrentBlockStatus(blockId: BlockId, info: BlockInfo): BlockStatus

getCurrentBlockStatus returns the current BlockStatus of the BlockId block (with the

block’s current StorageLevel, memory and disk sizes). It uses MemoryStore and DiskStore
for size and other information.

Most of the information to build BlockStatus is already in BlockInfo except

Note that it may not necessarily reflect the current state per MemoryStore and
DiskStore.

824
BlockManager — Key-Value Store of Blocks of Data

Internally, it uses the input BlockInfo to know about the block’s storage level. If the storage
level is not set (i.e. null ), the returned BlockStatus assumes the default NONE storage
level and the memory and disk sizes being 0 .

If however the storage level is set, getCurrentBlockStatus uses MemoryStore and DiskStore
to check whether the block is stored in the storages or not and request for their sizes in the
storages respectively (using their getSize or assume 0 ).

It is acceptable that the BlockInfo says to use memory or disk yet the block is
Note
not in the storages (yet or anymore). The method will give current status.

getCurrentBlockStatus is used when executor’s BlockManager is requested to

report the current status of the local blocks to the master, saving a block to a
Note
storage or removing a block from memory only or both, i.e. from memory and
disk.

reportAllBlocks Internal Method

reportAllBlocks(): Unit

reportAllBlocks …​FIXME

reportAllBlocks is used when BlockManager is requested to re-register all

Note
blocks to the driver.

Reporting Current Storage Status of Block to Driver 

—  reportBlockStatus Internal Method

reportBlockStatus(
blockId: BlockId,
info: BlockInfo,
status: BlockStatus,
droppedMemorySize: Long = 0L): Unit

reportBlockStatus is an internal method for reporting a block status to the driver and if told

to re-register it prints out the following INFO message to the logs:

INFO BlockManager: Got told to re-register updating block [blockId]

It does asynchronous reregistration (using asyncReregister ).

In either case, it prints out the following DEBUG message to the logs:

825
BlockManager — Key-Value Store of Blocks of Data

DEBUG BlockManager: Told master about block [blockId]

reportBlockStatus is used when BlockManager is requested to getBlockData,

Note
doPutBytes, doPutIterator, dropFromMemory and removeBlockInternal.

Reporting Block Status Update to Driver 

—  tryToReportBlockStatus Internal Method

def tryToReportBlockStatus(
blockId: BlockId,
info: BlockInfo,
status: BlockStatus,
droppedMemorySize: Long = 0L): Boolean

tryToReportBlockStatus reports block status update to BlockManagerMaster and returns its

response.

tryToReportBlockStatus is used when BlockManager is requested to

Note
reportAllBlocks or reportBlockStatus.

Broadcast Values
When a new broadcast value is created, TorrentBroadcast blocks are put in the block
manager.

You should see the following TRACE message:

TRACE Put for block [blockId] took [startTimeMs] to get into synchronized block

It puts the data in the memory first and drop to disk if the memory store can’t hold it.

DEBUG Put block [blockId] locally took [startTimeMs]

BlockManagerId
FIXME

Execution Context
block-manager-future is the execution context for…​FIXME

826
BlockManager — Key-Value Store of Blocks of Data

Misc
The underlying abstraction for blocks in Spark is a ByteBuffer that limits the size of a block
to 2GB ( Integer.MAX_VALUE - see Why does FileChannel.map take up to
Integer.MAX_VALUE of data? and SPARK-1476 2GB limit in spark for blocks). This has
implication not just for managed blocks in use, but also for shuffle blocks (memory mapped
blocks are limited to 2GB, even though the API allows for long ), ser-deser via byte array-
backed output streams.

When a non-local executor starts, it initializes a BlockManager object using spark.app.id

Spark property for the id.

BlockResult
BlockResult is a description of a fetched block with the readMethod and bytes .

Registering Task with BlockInfoManager 

—  registerTask Method

registerTask(taskAttemptId: Long): Unit

registerTask registers the input taskAttemptId with BlockInfoManager .

Note registerTask is used exclusively when Task runs.

Offering DiskBlockObjectWriter To Write Blocks To Disk

(For Current BlockManager) —  getDiskWriter Method

getDiskWriter(
blockId: BlockId,
file: File,
serializerInstance: SerializerInstance,
bufferSize: Int,
writeMetrics: ShuffleWriteMetrics): DiskBlockObjectWriter

getDiskWriter creates a DiskBlockObjectWriter with spark.shuffle.sync Spark property for

syncWrites .

getDiskWriter uses the same serializerManager that was used to create a

Note
BlockManager .

827
BlockManager — Key-Value Store of Blocks of Data

getDiskWriter is used when BypassMergeSortShuffleWriter writes records into

Note one single shuffle block data file, in ShuffleExternalSorter,
UnsafeSorterSpillWriter , ExternalSorter, and ExternalAppendOnlyMap .

Recording Updated BlockStatus In Current Task’s

TaskMetrics 
—  addUpdatedBlockStatusToTaskMetrics Internal
Method

addUpdatedBlockStatusToTaskMetrics(blockId: BlockId, status: BlockStatus): Unit

addUpdatedBlockStatusToTaskMetrics takes an active TaskContext (if available) and records

updated BlockStatus for Block (in the task’s TaskMetrics ).

addUpdatedBlockStatusToTaskMetrics is used when BlockManager doPutBytes

(for a block that was successfully stored), doPut, doPutIterator, removes blocks
Note
from memory (possibly spilling it to disk) and removes block from memory and
disk.

Requesting Shuffle-Related Spark Metrics Source 

—  shuffleMetricsSource Method

shuffleMetricsSource: Source

shuffleMetricsSource requests the ShuffleClient for the shuffle-related metrics and creates

a ShuffleMetricsSource with the source name per spark.shuffle.service.enabled

configuration property:

ExternalShuffle when spark.shuffle.service.enabled configuration property is on

( true )

NettyBlockTransfer when spark.shuffle.service.enabled configuration property is off

( false )

Note spark.shuffle.service.enabled configuration property is off ( false ) by default.

shuffleMetricsSource is used exclusively when Executor is created (for non-

Note
local / cluster modes).

Settings

828
BlockManager — Key-Value Store of Blocks of Data

Table 2. Spark Properties

Spark Property Default Value Description

Port to use for the block manager

spark.blockManager.port 0 when a more specific setting for the
driver or executors is not provided.

Controls whether
DiskBlockObjectWriter should force
outstanding writes to disk when
spark.shuffle.sync false
committing a single atomic block, i.e.
all operating system buffers should
synchronize with the disk to ensure
that all changes to a file are in fact
recorded in the storage.

Replicating Block To Peers —  replicate Internal

Method

replicate(
blockId: BlockId,
data: BlockData,
level: StorageLevel,
classTag: ClassTag[_],
existingReplicas: Set[BlockManagerId] = Set.empty): Unit

replicate …​FIXME

replicate is used when BlockManager is requested to doPutBytes,

Note
doPutIterator and replicateBlock.

replicateBlock Method

replicateBlock(
blockId: BlockId,
existingReplicas: Set[BlockManagerId],
maxReplicas: Int): Unit

replicateBlock …​FIXME

replicateBlock is used exclusively when BlockManagerSlaveEndpoint is

Note
requested to handle ReplicateBlock messages.

putIterator Method

829
BlockManager — Key-Value Store of Blocks of Data

putIterator[T: ClassTag](
blockId: BlockId,
values: Iterator[T],
level: StorageLevel,
tellMaster: Boolean = true): Boolean

putIterator …​FIXME

putIterator is used when:

BlockManager is requested to putSingle

Note
Spark Streaming’s BlockManagerBasedBlockHandler is requested to
storeBlock

putSingle Method

putSingle[T: ClassTag](
blockId: BlockId,
value: T,
level: StorageLevel,
tellMaster: Boolean = true): Boolean

putSingle …​FIXME

putSingle is used when TorrentBroadcast is requested to read the blocks of a

Note
broadcast variable and readBroadcastBlock.

Fetching Block From Remote Nodes —  getRemoteBytes

Method

getRemoteBytes(blockId: BlockId): Option[ChunkedByteBuffer]

getRemoteBytes …​FIXME

getRemoteBytes is used when:

BlockManager is requested to getRemoteValues

Note TorrentBroadcast is requested to readBlocks

TaskResultGetter is requested to enqueuing a successful

IndirectTaskResult

830
BlockManager — Key-Value Store of Blocks of Data

getRemoteValues Internal Method

getRemoteValues[T: ClassTag](blockId: BlockId): Option[BlockResult]

getRemoteValues …​FIXME

getRemoteValues is used exclusively when BlockManager is requested to get a

Note
block by BlockId.

getSingle Method

getSingle[T: ClassTag](blockId: BlockId): Option[T]

getSingle …​FIXME

Note getSingle is used exclusively in Spark tests.

shuffleClient Property

shuffleClient: ShuffleClient

shuffleClient is a ShuffleClient that BlockManager uses for the following:

shuffleMetricsSource

Registering the BlockManager of an executor with an external shuffle server

shuffleClient is also used when BlockStoreShuffleReader is requested to read combined

key-value records for a reduce task (and creates a ShuffleBlockFetcherIterator).

shuffleClient can be either a ExternalShuffleClient or the BlockTransferService (that is the

NettyBlockTransferService given by SparkEnv).

Caution FIXME Figure

shuffleClient uses spark.shuffle.service.enabled configuration property (default: false )

that controls whether to use ExternalShuffleClient ( true ) or the BlockTransferService (i.e.

NettyBlockTransferService).

blockTransferService Property

831
BlockManager — Key-Value Store of Blocks of Data

When created, BlockManager is given a BlockTransferService that is used for the following
services:

Fetching a block from remote nodes

Replicating a block to peers

Note Remote nodes, peers, block managers are all synonyms.

The BlockTransferService acts as the ShuffleClient when spark.shuffle.service.enabled

configuration property is off (which is the default).

When initialized, BlockManager requests the BlockTransferService to init. BlockManager

also requests the ShuffleClient to init (that does nothing by default).

When stopped, BlockManager requests the BlockTransferService to close. BlockManager

also requests the ShuffleClient to close .

Getting Block From Block Managers Or Computing and

Storing It Otherwise —  getOrElseUpdate Method

getOrElseUpdate[T](
blockId: BlockId,
level: StorageLevel,
classTag: ClassTag[T],
makeIterator: () => Iterator[T]): Either[BlockResult, Iterator[T]]

I think it is fair to say that getOrElseUpdate is like getOrElseUpdate of

scala.collection.mutable.Map in Scala.

getOrElseUpdate(key: K, op: ⇒ V): V

Quoting the official scaladoc:

Note If given key K is already in this map, getOrElseUpdate returns the associated
value V .
Otherwise, getOrElseUpdate computes a value V from given expression op ,
stores with the key K in the map and returns that value.

Since BlockManager is a key-value store of blocks of data identified by a block

ID that works just fine.

getOrElseUpdate first attempts to get the block by the BlockId (from the local block

manager first and, if unavailable, requesting remote peers).

832
BlockManager — Key-Value Store of Blocks of Data

Enable INFO logging level for org.apache.spark.storage.BlockManager logger to

see what happens when BlockManager tries to get a block.
Tip
See logging in this document.

getOrElseUpdate gives the BlockResult of the block if found.

If however the block was not found (in any block manager in a Spark cluster),
getOrElseUpdate doPutIterator (for the input BlockId , the makeIterator function and the

StorageLevel ).

getOrElseUpdate branches off per the result.

For None , getOrElseUpdate getLocalValues for the BlockId and eventually returns the
BlockResult (unless terminated by a SparkException due to some internal error).

For Some(iter) , getOrElseUpdate returns an iterator of T values.

getOrElseUpdate is used exclusively when RDD is requested to get or compute

Note
an RDD partition (for a RDDBlockId with a RDD ID and a partition index).

doPutIterator Internal Method

doPutIterator[T](
blockId: BlockId,
iterator: () => Iterator[T],
level: StorageLevel,
classTag: ClassTag[T],
tellMaster: Boolean = true,
keepReadLock: Boolean = false): Option[PartiallyUnrolledIterator[T]]

doPutIterator simply doPut with the putBody function that accepts a BlockInfo and does

the following:

1. putBody branches off per whether the StorageLevel indicates to use a memory or

simply a disk, i.e.

When the input StorageLevel indicates to use a memory for storage in

deserialized format, putBody requests MemoryStore to putIteratorAsValues (for
the BlockId and with the iterator factory function).

If the MemoryStore returned a correct value, the internal size is set to the value.

If however the MemoryStore failed to give a correct value, FIXME

833
BlockManager — Key-Value Store of Blocks of Data

When the input StorageLevel indicates to use memory for storage in serialized
format, putBody …​FIXME

When the input StorageLevel does not indicate to use memory for storage but disk
instead, putBody …​FIXME

2. putBody requests the current block status

3. Only when the block was successfully stored in either the memory or disk store:

putBody reports the block status to the BlockManagerMaster when the input

tellMaster flag (default: enabled) and the tellMaster flag of the block info are

both enabled.

putBody addUpdatedBlockStatusToTaskMetrics (with the BlockId and

BlockStatus )

putBody prints out the following DEBUG message to the logs:

Put block [blockId] locally took [time] ms

When the input StorageLevel indicates to use replication, putBody

doGetLocalBytes followed by replicate (with the input BlockId and the
StorageLevel as well as the BlockData to replicate)

With a successful replication, putBody prints out the following DEBUG message to
the logs:

Put block [blockId] remotely took [time] ms

4. In the end, putBody may or may not give a PartiallyUnrolledIterator if…​FIXME

doPutIterator is used when BlockManager is requested to get a block from

Note
block managers or computing and storing it otherwise and putIterator.

Removing Blocks From Memory Only 

—  dropFromMemory Method

dropFromMemory(
blockId: BlockId,
data: () => Either[Array[T], ChunkedByteBuffer]): StorageLevel

Note dropFromMemory is part of the BlockEvictionHandler Contract to…​FIXME

834
BlockManager — Key-Value Store of Blocks of Data

When dropFromMemory is executed, you should see the following INFO message in the logs:

INFO BlockManager: Dropping block [blockId] from memory

It then asserts that the blockId block is locked for writing.

If the block’s StorageLevel uses disks and the internal DiskStore object ( diskStore ) does
not contain the block, it is saved then. You should see the following INFO message in the
logs:

INFO BlockManager: Writing block [blockId] to disk

Caution FIXME Describe the case with saving a block to disk.

The block’s memory size is fetched and recorded (using MemoryStore.getSize ).

The block is removed from memory if exists. If not, you should see the following WARN
message in the logs:

WARN BlockManager: Block [blockId] could not be dropped from memory as it does not exi
st

It then calculates the current storage status of the block and reports it to the driver. It only
happens when info.tellMaster .

Caution FIXME When would info.tellMaster be true ?

A block is considered updated when it was written to disk or removed from memory or both.
If either happened, the current TaskContext metrics are updated with the change.

Ultimately, dropFromMemory returns the current storage level of the block.

835
MemoryStore

MemoryStore
MemoryStore is the memory store for blocks of data.

MemoryStore is created exclusively when BlockManager is created.

Figure 1. Creating MemoryStore

The "idiom" to access the current MemoryStore is to request SparkEnv for the
BlockManager that manages the MemoryStore.

SparkEnv.get.blockManager.memoryStore

MemoryStore uses Java’s java.util.LinkedHashMap with access-order ordering mode. In

access-order, the order of iteration is the order in which the entries were last accessed, from
least-recently accessed to most-recently. That gives LRU cache behaviour when evicting
blocks.

MemoryStore uses spark.storage.unrollMemoryThreshold configuration property (default:

1024 * 1024 bytes) when requested to putIteratorAsValues and putIteratorAsBytes.

836
MemoryStore

Table 1. MemoryStore’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description

Java’s java.util.LinkedHashMap of MemoryEntries per

BlockId (with the initial capacity of 32 , the load factor of
0.75 and access-order ordering mode, i.e. iteration is in
the order in which its entries were last accessed, from
entries least-recently accessed to most-recently).
Used when MemoryStore is requested to contains,
getBytes, getValues, getSize, putBytes,
putIteratorAsValues, putIteratorAsBytes, remove, clear,
evictBlocksToFreeSpace

Caution FIXME Where are these dependencies used?

Enable INFO or DEBUG logging level for

org.apache.spark.storage.memory.MemoryStore logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.storage.memory.MemoryStore=DEBUG

Refer to Logging.

releaseUnrollMemoryForThisTask Method

releaseUnrollMemoryForThisTask(memoryMode: MemoryMode, memory: Long = Long.MaxValue):

Unit

releaseUnrollMemoryForThisTask …​FIXME

releaseUnrollMemoryForThisTask is used when:

Task is requested to run (and cleans up after itself)

MemoryStore is requested to putIteratorAsValues and putIteratorAsBytes

Note
PartiallyUnrolledIterator is requested to releaseUnrollMemory

PartiallySerializedBlock is requested to discard and

finishWritingToStream

getValues Method

getValues(blockId: BlockId): Option[Iterator[_]]

837
MemoryStore

getValues does…​FIXME

getBytes Method

getBytes(blockId: BlockId): Option[ChunkedByteBuffer]

getBytes does…​FIXME

putIteratorAsBytes Method

putIteratorAsBytes[T](
blockId: BlockId,
values: Iterator[T],
classTag: ClassTag[T],
memoryMode: MemoryMode): Either[PartiallySerializedBlock[T], Long]

putIteratorAsBytes tries to put the blockId block in memory store as bytes.

Caution FIXME

Removing Block

Caution FIXME

Acquiring Storage Memory for Blocks —  putBytes

Method

putBytes[T](
blockId: BlockId,
size: Long,
memoryMode: MemoryMode,
_bytes: () => ChunkedByteBuffer): Boolean

putBytes requests storage memory for blockId from MemoryManager and registers the

block in entries internal registry.

Internally, putBytes first makes sure that blockId block has not been registered already in
entries internal registry.

putBytes then requests size memory for the blockId block in a given memoryMode from

the current MemoryManager .

838
MemoryStore

memoryMode can be ON_HEAP or OFF_HEAP and is a property of a StorageLevel.

import org.apache.spark.storage.StorageLevel._
scala> MEMORY_AND_DISK.useOffHeap
Note res0: Boolean = false

scala> OFF_HEAP.useOffHeap
res1: Boolean = true

If successful, putBytes "materializes" _bytes byte buffer and makes sure that the size is
exactly size . It then registers a SerializedMemoryEntry (for the bytes and memoryMode ) for
blockId in the internal entries registry.

You should see the following INFO message in the logs:

INFO Block [blockId] stored as bytes in memory (estimated size [size], free [bytes])

putBytes returns true only after blockId was successfully registered in the internal

entries registry.

Settings
Table 2. Spark Properties
Default
Spark Property Description
Value
Initial per-task memory size needed
to store a block in memory.
spark.storage.unrollMemoryThreshold
should be at most the total amount of
memory available for storage. If not,
you should see the following WARN
message in the logs:

Max memory [maxMemory]

spark.storage.unrollMemoryThreshold
1024 * is less than the initial
1024 memory threshold
[unrollMemoryThreshold]
needed to store a block
in memory. Please
configure Spark with
more memory.

Used when MemoryStore is

requested to putIteratorAsValues and
putIteratorAsBytes.

839
MemoryStore

Evicting Blocks From Memory 

—  evictBlocksToFreeSpace Method

evictBlocksToFreeSpace(
blockId: Option[BlockId],
space: Long,
memoryMode: MemoryMode): Long

evictBlocksToFreeSpace …​FIXME

evictBlocksToFreeSpace is used when StorageMemoryPool is requested to

Note
acquireMemory and freeSpaceToShrinkPool.

Checking Whether Block Exists In MemoryStore 

—  contains Method

contains(blockId: BlockId): Boolean

contains is positive ( true ) when the entries internal registry contains blockId key.

Note contains is used when…​FIXME

putIteratorAsValues Method

putIteratorAsValues[T](
blockId: BlockId,
values: Iterator[T],
classTag: ClassTag[T]): Either[PartiallyUnrolledIterator[T], Long]

putIteratorAsValues makes sure that the BlockId does not exist or throws an

IllegalArgumentException :

requirement failed: Block [blockId] is already present in the MemoryStore

putIteratorAsValues reserveUnrollMemoryForThisTask (with the initial memory threshold

and ON_HEAP memory mode).

Caution FIXME

putIteratorAsValues tries to put the blockId block in memory store as values .

840
MemoryStore

putIteratorAsValues is used when BlockManager stores bytes of a block or

Note iterator of values of a block or when attempting to cache spilled values read
from disk.

Creating MemoryStore Instance

MemoryStore takes the following when created:

SparkConf

BlockInfoManager

SerializerManager

MemoryManager

BlockEvictionHandler

MemoryStore initializes the internal registries and counters.

reserveUnrollMemoryForThisTask Method

reserveUnrollMemoryForThisTask(
blockId: BlockId,
memory: Long,
memoryMode: MemoryMode): Boolean

reserveUnrollMemoryForThisTask acquires a lock on MemoryManager and requests it to

acquireUnrollMemory.

reserveUnrollMemoryForThisTask is used when MemoryStore is requested to

Note
putIteratorAsValues and putIteratorAsBytes.

Requesting Total Amount Of Memory Available For Storage

(In Bytes) —  maxMemory Internal Method

maxMemory: Long

maxMemory requests the MemoryManager for the current maxOnHeapStorageMemory and

maxOffHeapStorageMemory, and simply returns their sum.

841
MemoryStore

Enable INFO logging to find the maxMemory in the logs when MemoryStore is
created:
Tip
MemoryStore started with capacity [maxMemory] MB

Note maxMemory is used for logging purposes only.

842
BlockEvictionHandler

BlockEvictionHandler
BlockEvictionHandler is a contract of FIXME that dropFromMemory.

package org.apache.spark.storage.memory

trait BlockEvictionHandler {
def dropFromMemory[T: ClassTag](
blockId: BlockId,
data: () => Either[Array[T], ChunkedByteBuffer]): StorageLevel
}

Note BlockEvictionHandler is a private[storage] contract.

Table 1. BlockEvictionHandler Contract

Method Description

dropFromMemory
Used exclusively when MemoryStore is requested to
evictBlocksToFreeSpace.

BlockManager is the one and only known implementation of

Note
BlockEvictionHandler Contract in Apache Spark.

843
StorageMemoryPool

StorageMemoryPool
StorageMemoryPool is a MemoryPool that…​FIXME

StorageMemoryPool is created along with MemoryManager (as onHeapStorageMemoryPool

and offHeapStorageMemoryPool pools).

Table 1. StorageMemoryPool’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
FIXME
poolName
Used when…​FIXME

The amount of memory in use for storage (caching)

_memoryUsed
Used when…​FIXME

MemoryStore
_memoryStore
Used when…​FIXME

memoryFree Method

memoryFree: Long

memoryFree …​FIXME

Note memoryFree is used when…​FIXME

acquireMemory Method

acquireMemory(blockId: BlockId, numBytes: Long): Boolean (1)

acquireMemory(
blockId: BlockId,
numBytesToAcquire: Long,
numBytesToFree: Long): Boolean

1. Calls acquireMemory with numBytesToFree as a difference between numBytes and

memoryFree

acquireMemory …​FIXME

844
StorageMemoryPool

acquireMemory is used when:

StaticMemoryManager is requested to acquireUnrollMemory and

Note acquireStorageMemory
UnifiedMemoryManager is requested to acquireStorageMemory

freeSpaceToShrinkPool Method

freeSpaceToShrinkPool(spaceToFree: Long): Long

freeSpaceToShrinkPool …​FIXME

freeSpaceToShrinkPool is used exclusively when UnifiedMemoryManager is

Note
requested to acquireExecutionMemory.

Creating StorageMemoryPool Instance

StorageMemoryPool takes the following when created:

Lock

MemoryMode (either ON_HEAP or OFF_HEAP )

StorageMemoryPool initializes the internal registries and counters.

845
MemoryPool

MemoryPool
MemoryPool is…​FIXME

846
DiskStore

DiskStore
Caution FIXME

putBytes

Caution FIXME

Removing Block

Caution FIXME

847
BlockDataManager

BlockDataManager — Block Storage
Management API
BlockDataManager is the contract for managing storage for blocks of data (aka block storage

management API).

package org.apache.spark.network

trait BlockDataManager {
def getBlockData(blockId: BlockId): ManagedBuffer
def putBlockData(
blockId: BlockId,
data: ManagedBuffer,
level: StorageLevel,
classTag: ClassTag[_]): Boolean
def releaseLock(blockId: BlockId, taskAttemptId: Option[Long]): Unit
}

Note BlockDataManager is a private[spark] contract.

Table 1. BlockDataManager Contract

Method Description
Fetches a local block data by blockId
Used when:

getBlockData NettyBlockRpcServer is requested to handle an

OpenBlocks message

ShuffleBlockFetcherIterator is requested to
fetchLocalBlocks

Uploads a block data locally by blockId . The return

value says whether the operation has succeeded ( true )
putBlockData or failed ( false ).
Used when…​FIXME

Releases the lock for getBlockData and putBlockData

releaseLock methods
Used when…​FIXME

Blocks are identified by BlockId that has a globally unique identifier ( name ) and stored as
ManagedBuffer.

848
BlockDataManager

Table 2. BlockIds
Name Description

Described by RDD ID ( rddId ) and a partition index

( splitIndex )
RDDBlockId
Created when an RDD is requested to get or compute an
RDD partition (identified by splitIndex ).

ShuffleBlockId Described by shuffleId , mapId and reduceId

ShuffleDataBlockId Described by shuffleId , mapId and reduceId

ShuffleIndexBlockId Described by shuffleId , mapId and reduceId

BroadcastBlockId Described by broadcastId identifier and optional field

TaskResultBlockId Described by taskId

StreamBlockId Described by streamId and uniqueId

BlockManager is the one and only known implementation of BlockDataManager

Note
Contract in Apache Spark.

849
RpcHandler

RpcHandler
RpcHandler is the base of…​FIXME

RpcHandler uses a OneWayRpcCallback that…​FIXME

package org.apache.spark.network.server;

abstract class RpcHandler {

// only required methods that have no implementation
// the others follow
abstract void receive(
TransportClient client,
ByteBuffer message,
RpcResponseCallback callback);
abstract StreamManager getStreamManager();
}

Table 1. (Subset of) RpcHandler Contract

Method Description
Used when:
AuthRpcHandler is requested to receive

receive SaslRpcHandler is requested to receive (after

authentication is complete)
TransportRequestHandler is requested to
processRpcRequest

getStreamManager Used when…​FIXME

Table 2. RpcHandlers
RpcHandler Description
AuthRpcHandler

ExternalShuffleBlockHandler

NettyBlockRpcServer

NettyRpcHandler

NoOpRpcHandler

SaslRpcHandler

850
RpcHandler

OneWayRpcCallback RpcResponseCallback
OneWayRpcCallback is a RpcResponseCallback that simply prints out the WARN and ERROR

for the following methods onSuccess and onFailure respectively.

void onSuccess(ByteBuffer response)

Response provided for one-way RPC.

void onFailure(Throwable e)

Error response provided for one-way RPC.

851
RpcResponseCallback

RpcResponseCallback
RpcResponseCallback is the contract of…​FIXME

package org.apache.spark.network.client;

interface RpcResponseCallback {
void onSuccess(ByteBuffer response);
void onFailure(Throwable e);
}

Table 1. RpcResponseCallback Contract

Method Description
Used when:

NettyBlockRpcServer is requested to receive RPC

messages (i.e. OpenBlocks and UploadBlock
messages)
RemoteNettyRpcCallContext is requested to send

TransportResponseHandler is requested to handle a

RpcResponse message
onSuccess
ExternalShuffleBlockHandler is requested to
handleMessage (i.e. OpenBlocks and
RegisterExecutor messages)

AuthRpcHandler and SaslRpcHandler are requested

to receive
Spark on Mesos' MesosExternalShuffleBlockHandler
is requested to handleMessage (i.e.
RegisterDriverParam message)

onFailure Used when…​FIXME

852
RpcResponseCallback

Table 2. RpcResponseCallbacks
RpcResponseCallback Description

"Unnamed" in
NettyBlockTransferService

"Unnamed" in
TransportRequestHandler

"Unnamed" in
TransportClient

"Unnamed" in
OneForOneBlockFetcher

OneWayRpcCallback

RegisterDriverCallback

RpcOutboxMessage

853
TransportRequestHandler

TransportRequestHandler
TransportRequestHandler is a MessageHandler of RequestMessage messages from Netty’s

Channel.

TransportRequestHandler is created exclusively when TransportContext is requested to

createChannelHandler.

Enable ERROR , WARN , TRACE logging level for

org.apache.spark.network.server.TransportRequestHandler logger to see what
happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.network.server.TransportRequestHandler=TRACE

Refer to Logging.

processRpcRequest Internal Method

void processRpcRequest(final RpcRequest req)

processRpcRequest …​FIXME

processRpcRequest is used exclusively when TransportRequestHandler is

Note
requested to handle a RpcRequest request.

processFetchRequest Internal Method

void processFetchRequest(final ChunkFetchRequest req)

processFetchRequest …​FIXME

processFetchRequest is used exclusively when TransportRequestHandler is

Note
requested to handle a ChunkFetchRequest request.

processOneWayMessage Internal Method

void processOneWayMessage(OneWayMessage req)

854
TransportRequestHandler

processOneWayMessage …​FIXME

processOneWayMessage is used exclusively when TransportRequestHandler is

Note
requested to handle a OneWayMessage request.

processStreamRequest Internal Method

void processStreamRequest(final StreamRequest req)

processStreamRequest …​FIXME

processStreamRequest is used exclusively when TransportRequestHandler is

Note
requested to handle a StreamRequest request.

Handling RequestMessages —  handle Method

void handle(RequestMessage request)

handle is part of MessageHandler Contract to handle messages (aka

Note
requests).

handle branches off per the type of the input RequestMessage :

For ChunkFetchRequest requests, handle processFetchRequest

For RpcRequest requests, handle processRpcRequest

For OneWayMessage requests, handle processOneWayMessage

For StreamRequest requests, handle processStreamRequest

For unknown requests, handle simply throws a IllegalArgumentException .

Unknown request type: [request]

Creating TransportRequestHandler Instance

TransportRequestHandler takes the following when created:

Netty’s Channel

TransportClient

RpcHandler

855
TransportRequestHandler

Maximum number of chunks allowed to be transferred at the same time

TransportRequestHandler initializes the internal registries and counters.

856
TransportContext

TransportContext
TransportContext is…​FIXME

createChannelHandler Internal Method

TransportChannelHandler createChannelHandler(Channel channel, RpcHandler rpcHandler)

createChannelHandler …​FIXME

createChannelHandler is used exclusively when TransportContext is requested

Note
to initializePipeline.

initializePipeline Method

TransportChannelHandler initializePipeline(SocketChannel channel) (1)

TransportChannelHandler initializePipeline(
SocketChannel channel,
RpcHandler channelRpcHandler)

1. Simply calls the other initializePipeline with the RpcHandler

initializePipeline …​FIXME

initializePipeline is used when:

Note TransportServer is requested to init

TransportClientFactory is requested to createClient

Creating TransportServer on Host and Port 

—  createServer Method

TransportServer createServer() (1)

TransportServer createServer(int port, List<TransportServerBootstrap> bootstraps) (2)
TransportServer createServer(List<TransportServerBootstrap> bootstraps) (3)
TransportServer createServer(
String host, int port, List<TransportServerBootstrap> bootstraps)

1. Uses 0 for the port and no bootstraps. Used exclusively for testing

857
TransportContext

2. Uses null for the host

3. Used exclusively for testing

createServer simply creates a TransportServer (with the current TransportContext , the

host, the port, the RpcHandler and the bootstraps).

createServer is used when:

NettyBlockTransferService is requested to createServer

Note NettyRpcEnv is requested to startServer

ExternalShuffleService is requested to start

Spark on YARN’s YarnShuffleService is requested to serviceInit

858
TransportServer

TransportServer
TransportServer is…​FIXME

TransportServer is created exclusively when TransportContext is requested to

createServer.

init Internal Method

void init(String hostToBind, int portToBind)

init …​FIXME

Note init is used exclusively when TransportServer is created.

getPort Method

int getPort()

getPort …​FIXME

getPort is used when:

NettyRpcEnv is requested for the address

Note
Spark on YARN’s YarnShuffleService is requested to serviceInit

Creating TransportServer Instance

TransportServer takes the following when created:

TransportContext

Host name to bind to

Port number to bind to

RpcHandler

TransportServerBootstraps

When created, TransportServer init with the host and port to bind to.

859
TransportServer

860
TransportClientFactory

TransportClientFactory
TransportClientFactory is…​FIXME

createUnmanagedClient Method

TransportClient createUnmanagedClient(String remoteHost, int remotePort)

throws IOException, InterruptedException

createUnmanagedClient …​FIXME

Note createUnmanagedClient is used when…​FIXME

createClient Internal Method

TransportClient createClient(String remoteHost, int remotePort)

throws IOException, InterruptedException
TransportClient createClient(InetSocketAddress address)
throws IOException, InterruptedException

createClient …​FIXME

createClient is used when:

NettyBlockTransferService is requested to fetchBlocks and uploadBlock

NettyRpcEnv is requested to createClient and downloadClient

Note TransportClientFactory is requested to createUnmanagedClient.

ExternalShuffleClient is requested to fetchBlocks

Spark on Mesos' MesosExternalShuffleClient is requested to

registerDriverWithShuffleService

861
MessageHandler

MessageHandler
MessageHandler is a contract of message handlers that can handle messages.

package org.apache.spark.network.server;

abstract class MessageHandler<T extends Message> {

abstract void handle(T message) throws Exception;
abstract void channelActive();
abstract void exceptionCaught(Throwable cause);
abstract void channelInactive();
}

Table 1. MessageHandler Contract

Method Description
handle Used when…​FIXME

channelActive Used when…​FIXME

exceptionCaught Used when…​FIXME

channelInactive Used when…​FIXME

Table 2. MessageHandlers
MessageHandler Description
TransportRequestHandler

TransportResponseHandler

862
BlockManagerMaster — BlockManager for Driver

BlockManagerMaster — BlockManager for
Driver
BlockManagerMaster runs on the driver.

BlockManagerMaster uses BlockManagerMasterEndpoint registered under

BlockManagerMaster RPC endpoint name on the driver (with the endpoint references on
executors) to allow executors for sending block status updates to it and hence keep track of
block statuses.

BlockManagerMaster is created in SparkEnv (for the driver and executors), and

Note
immediately used to create their BlockManagers.

Enable INFO or DEBUG logging level for

org.apache.spark.storage.BlockManagerMaster logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.storage.BlockManagerMaster=INFO

Refer to Logging.

removeExecutorAsync Method

Caution FIXME

contains Method

Caution FIXME

Creating BlockManagerMaster Instance

BlockManagerMaster takes the following when created:

RpcEndpointRef to…​FIXME

SparkConf

Flag whether BlockManagerMaster is created for the driver or executors.

BlockManagerMaster initializes the internal registries and counters.

863
BlockManagerMaster — BlockManager for Driver

Removing Executor —  removeExecutor Method

removeExecutor(execId: String): Unit

removeExecutor posts RemoveExecutor to BlockManagerMaster RPC endpoint and waits for

a response.

If false in response comes in, a SparkException is thrown with the following message:

BlockManagerMasterEndpoint returned false, expected true.

If all goes fine, you should see the following INFO message in the logs:

INFO BlockManagerMaster: Removed executor [execId]

removeExecutor is executed when DAGScheduler processes ExecutorLost

Note
event.

Removing Block —  removeBlock Method

removeBlock(blockId: BlockId): Unit

removeBlock simply posts a RemoveBlock blocking message to BlockManagerMaster RPC

endpoint (and ultimately disregards the reponse).

Removing RDD Blocks —  removeRdd Method

removeRdd(rddId: Int, blocking: Boolean)

removeRdd removes all the blocks of rddId RDD, possibly in blocking fashion.

Internally, removeRdd posts a RemoveRdd(rddId) message to BlockManagerMaster RPC

endpoint on a separate thread.

If there is an issue, you should see the following WARN message in the logs and the entire
exception:

WARN Failed to remove RDD [rddId] - [exception]

864
BlockManagerMaster — BlockManager for Driver

If it is a blocking operation, it waits for a result for spark.rpc.askTimeout,

spark.network.timeout or 120 secs.

Removing Shuffle Blocks —  removeShuffle Method

removeShuffle(shuffleId: Int, blocking: Boolean)

removeShuffle removes all the blocks of shuffleId shuffle, possibly in a blocking

fashion.

It posts a RemoveShuffle(shuffleId) message to BlockManagerMaster RPC endpoint on a

separate thread.

If there is an issue, you should see the following WARN message in the logs and the entire
exception:

WARN Failed to remove shuffle [shuffleId] - [exception]

If it is a blocking operation, it waits for the result for spark.rpc.askTimeout,

spark.network.timeout or 120 secs.

Note removeShuffle is used exclusively when ContextCleaner removes a shuffle.

Removing Broadcast Blocks —  removeBroadcast

Method

removeBroadcast(broadcastId: Long, removeFromMaster: Boolean, blocking: Boolean)

removeBroadcast removes all the blocks of broadcastId broadcast, possibly in a blocking

fashion.

It posts a RemoveBroadcast(broadcastId, removeFromMaster) message to

BlockManagerMaster RPC endpoint on a separate thread.

If there is an issue, you should see the following WARN message in the logs and the entire
exception:

WARN Failed to remove broadcast [broadcastId] with removeFromMaster = [removeFromMaste

r] - [exception]

865
BlockManagerMaster — BlockManager for Driver

If it is a blocking operation, it waits for the result for spark.rpc.askTimeout,

spark.network.timeout or 120 secs.

Stopping BlockManagerMaster —  stop Method

stop(): Unit

stop sends a StopBlockManagerMaster message to BlockManagerMaster RPC endpoint

and waits for a response.

Note It is only executed for the driver.

If all goes fine, you should see the following INFO message in the logs:

INFO BlockManagerMaster: BlockManagerMaster stopped

Otherwise, a SparkException is thrown.

BlockManagerMasterEndpoint returned false, expected true.

Registering BlockManager with Driver 

—  registerBlockManager Method

registerBlockManager(
blockManagerId: BlockManagerId,
maxMemSize: Long,
slaveEndpoint: RpcEndpointRef): BlockManagerId

registerBlockManager prints the following INFO message to the logs:

INFO BlockManagerMaster: Registering BlockManager [blockManagerId]

866
BlockManagerMaster — BlockManager for Driver

Figure 1. Registering BlockManager with the Driver

registerBlockManager then notifies the driver that the blockManagerId BlockManager tries

to register. registerBlockManager posts a blocking RegisterBlockManager message to

BlockManagerMaster RPC endpoint.

The input maxMemSize is the total available on-heap and off-heap memory for
Note
storage on a BlockManager .

registerBlockManager waits until a confirmation comes (as BlockManagerId) that becomes

the return value.

You should see the following INFO message in the logs:

INFO BlockManagerMaster: Registered BlockManager [updatedId]

registerBlockManager is used when BlockManager is initialized or re-registers

Note
itself with the driver (and reports the blocks).

Relaying Block Status Update From BlockManager to Driver

(by Sending Blocking UpdateBlockInfo to
BlockManagerMaster RPC Endpoint) 
—  updateBlockInfo Method

updateBlockInfo(
blockManagerId: BlockManagerId,
blockId: BlockId,
storageLevel: StorageLevel,
memSize: Long,
diskSize: Long): Boolean

867
BlockManagerMaster — BlockManager for Driver

updateBlockInfo sends a blocking UpdateBlockInfo event to BlockManagerMaster RPC

endpoint (and waits for a response).

updateBlockInfo prints out the following DEBUG message to the logs:

DEBUG BlockManagerMaster: Updated info of block [blockId]

updateBlockInfo returns the response from the BlockManagerMaster RPC endpoint.

updateBlockInfo is used exclusively when BlockManager is requested to report

Note
a block status update to the driver.

Get Block Locations of One Block —  getLocations

Method

getLocations(blockId: BlockId): Seq[BlockManagerId]

getLocations posts a blocking GetLocations message to BlockManagerMaster RPC

endpoint and returns the response.

getLocations is used when BlockManagerMaster checks if a block was

Note
registered and BlockManager getLocations.

Get Block Locations for Multiple Blocks 

—  getLocations Method

getLocations(blockIds: Array[BlockId]): IndexedSeq[Seq[BlockManagerId]]

getLocations posts a blocking GetLocationsMultipleBlockIds message to

BlockManagerMaster RPC endpoint and returns the response.

getLocations is used when DAGScheduler finds BlockManagers (and so

Note executors) for cached RDD partitions and when BlockManager
getLocationBlockIds and blockIdsToHosts.

Finding Peers of BlockManager —  getPeers Internal

Method

getPeers(blockManagerId: BlockManagerId): Seq[BlockManagerId]

868
BlockManagerMaster — BlockManager for Driver

getPeers posts a blocking GetPeers message to BlockManagerMaster RPC endpoint and

returns the response.

Peers of a BlockManager are the other BlockManagers in a cluster (except the

Note driver’s BlockManager). Peers are used to know the available executors in a
Spark application.

getPeers is used when BlockManager finds the peers of a BlockManager ,

Note
Structured Streaming’s KafkaSource and Spark Streaming’s KafkaRDD .

getExecutorEndpointRef Method

getExecutorEndpointRef(executorId: String): Option[RpcEndpointRef]

getExecutorEndpointRef posts GetExecutorEndpointRef(executorId) message to

BlockManagerMaster RPC endpoint and waits for a response which becomes the return
value.

getMemoryStatus Method

getMemoryStatus: Map[BlockManagerId, (Long, Long)]

getMemoryStatus posts a GetMemoryStatus message BlockManagerMaster RPC endpoint

and waits for a response which becomes the return value.

Storage Status (Posting GetStorageStatus to

BlockManagerMaster RPC endpoint) 
—  getStorageStatus Method

getStorageStatus: Array[StorageStatus]

getStorageStatus posts a GetStorageStatus message to BlockManagerMaster RPC

endpoint and waits for a response which becomes the return value.

getBlockStatus Method

getBlockStatus(
blockId: BlockId,
askSlaves: Boolean = true): Map[BlockManagerId, BlockStatus]

869
BlockManagerMaster — BlockManager for Driver

getBlockStatus posts a GetBlockStatus(blockId, askSlaves) message to

BlockManagerMaster RPC endpoint and waits for a response (of type Map[BlockManagerId,
Future[Option[BlockStatus]]] ).

It then builds a sequence of future results that are BlockStatus statuses and waits for a
result for spark.rpc.askTimeout, spark.network.timeout or 120 secs.

No result leads to a SparkException with the following message:

BlockManager returned null for BlockStatus query: [blockId]

getMatchingBlockIds Method

getMatchingBlockIds(
filter: BlockId => Boolean,
askSlaves: Boolean): Seq[BlockId]

getMatchingBlockIds posts a GetMatchingBlockIds(filter, askSlaves) message to

BlockManagerMaster RPC endpoint and waits for a response which becomes the result for
spark.rpc.askTimeout, spark.network.timeout or 120 secs.

hasCachedBlocks Method

hasCachedBlocks(executorId: String): Boolean

hasCachedBlocks posts a HasCachedBlocks(executorId) message to BlockManagerMaster

RPC endpoint and waits for a response which becomes the result.

870
BlockManagerMasterEndpoint — BlockManagerMaster RPC Endpoint

BlockManagerMasterEndpoint — 
BlockManagerMaster RPC Endpoint
BlockManagerMasterEndpoint is the ThreadSafeRpcEndpoint for BlockManagerMaster under

BlockManagerMaster name.

BlockManagerMasterEndpoint tracks status of the BlockManagers (on the executors) in a

Spark application.

BlockManagerMasterEndpoint is created when SparkEnv is created (for the driver and

executors).

Table 1. BlockManagerMaster RPC Endpoint’s Messages (in alphabetical order)

Message When posted?
Posted when BlockManagerMaster registers a
RegisterBlockManager
BlockManager .

Posted when BlockManagerMaster receives a block status

UpdateBlockInfo
update (from BlockManager on an executor).

Table 2. BlockManagerMasterEndpoint’s Internal Registries and Counters

Name Description
blockManagerIdByExecutor FIXME

Lookup table of BlockManagerInfo per BlockManagerId

blockManagerInfo
Updated when BlockManagerMasterEndpoint registers a
new BlockManager or removes a BlockManager

Collection of BlockId s and their locations (as

BlockManagerId ).

blockLocations Used in removeRdd to remove blocks for a RDD,

removeBlockManager to remove blocks after a
BlockManager gets removed, removeBlockFromWorkers ,
updateBlockInfo , and getLocations.

871
BlockManagerMasterEndpoint — BlockManagerMaster RPC Endpoint

Enable INFO logging level for

org.apache.spark.storage.BlockManagerMasterEndpoint logger to see what
happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.storage.BlockManagerMasterEndpoint=INFO

Refer to Logging.

storageStatus Internal Method

Caution FIXME

getLocationsMultipleBlockIds Method

Caution FIXME

Removing Shuffle Blocks —  removeShuffle Internal

Method
Caution FIXME

UpdateBlockInfo

class UpdateBlockInfo(
var blockManagerId: BlockManagerId,
var blockId: BlockId,
var storageLevel: StorageLevel,
var memSize: Long,
var diskSize: Long)

When received, BlockManagerMasterEndpoint …​FIXME

Caution FIXME

RemoveExecutor

RemoveExecutor(execId: String)

872
BlockManagerMasterEndpoint — BlockManagerMaster RPC Endpoint

When received, executor execId is removed and the response true sent back.

Note RemoveExecutor is posted when BlockManagerMaster removes an executor.

Finding Peers of BlockManager —  getPeers Internal

Method

getPeers(blockManagerId: BlockManagerId): Seq[BlockManagerId]

getPeers finds all the registered BlockManagers (using blockManagerInfo internal registry)

and checks if the input blockManagerId is amongst them.

If the input blockManagerId is registered, getPeers returns all the registered

BlockManagers but the one on the driver and blockManagerId .

Otherwise, getPeers returns no BlockManagers .

Peers of a BlockManager are the other BlockManagers in a cluster (except the

Note driver’s BlockManager). Peers are used to know the available executors in a
Spark application.

getPeers is used exclusively when BlockManagerMasterEndpoint handles

Note
GetPeers message.

Finding Peers of BlockManager —  GetPeers Message

GetPeers(blockManagerId: BlockManagerId)
extends ToBlockManagerMaster

GetPeers replies with the peers of blockManagerId .

Peers of a BlockManager are the other BlockManagers in a cluster (except the

Note driver’s BlockManager). Peers are used to know the available executors in a
Spark application.

GetPeers is posted when BlockManagerMaster requests the peers of a

Note
BlockManager .

BlockManagerHeartbeat

Caution FIXME

873
BlockManagerMasterEndpoint — BlockManagerMaster RPC Endpoint

GetLocations Message

GetLocations(blockId: BlockId)
extends ToBlockManagerMaster

GetLocations replies with the locations of blockId .

GetLocations is posted when BlockManagerMaster requests the block locations

Note
of a single block.

GetLocationsMultipleBlockIds Message

GetLocationsMultipleBlockIds(blockIds: Array[BlockId])
extends ToBlockManagerMaster

GetLocationsMultipleBlockIds replies with the getLocationsMultipleBlockIds for the input

blockIds .

GetLocationsMultipleBlockIds is posted when BlockManagerMaster requests

Note
the block locations for multiple blocks.

RegisterBlockManager Event

RegisterBlockManager(
blockManagerId: BlockManagerId,
maxMemSize: Long,
sender: RpcEndpointRef)

When received, BlockManagerMasterEndpoint registers the BlockManager .

Registering BlockManager (on Executor) —  register

Internal Method

register(id: BlockManagerId, maxMemSize: Long, slaveEndpoint: RpcEndpointRef): Unit

register records the current time and registers BlockManager (using BlockManagerId)

unless it has been registered already (in blockManagerInfo internal registry).

The input maxMemSize is the total available on-heap and off-heap memory for
Note
storage on a BlockManager .

874
BlockManagerMasterEndpoint — BlockManagerMaster RPC Endpoint

Note register is executed when RegisterBlockManager has been received.

Registering a BlockManager can only happen once for an executor (identified

Note
by BlockManagerId.executorId in blockManagerIdByExecutor internal registry).

If another BlockManager has earlier been registered for the executor, you should see the
following ERROR message in the logs:

ERROR Got two different block manager registrations on same executor - will replace ol
d one [oldId] with new one [id]

And then executor is removed.

You should see the following INFO message in the logs:

INFO Registering block manager [hostPort] with [bytes] RAM, [id]

The BlockManager is recorded in the internal registries:

blockManagerIdByExecutor

blockManagerInfo

FIXME Why does blockManagerInfo require a new

Caution
System.currentTimeMillis() since time was already recorded?

In either case, SparkListenerBlockManagerAdded is posted (to listenerBus).

The method can only be executed on the driver where listenerBus is

Note
available.

Caution FIXME Describe listenerBus + omnigraffle it.

Other RPC Messages

GetLocationsMultipleBlockIds

GetRpcHostPortForExecutor

GetMemoryStatus

GetStorageStatus

GetBlockStatus

GetMatchingBlockIds

875
BlockManagerMasterEndpoint — BlockManagerMaster RPC Endpoint

RemoveShuffle

RemoveBroadcast

RemoveBlock

StopBlockManagerMaster

BlockManagerHeartbeat

HasCachedBlocks

Removing Executor —  removeExecutor Internal Method

removeExecutor(execId: String)

removeExecutor prints the following INFO message to the logs:

INFO BlockManagerMasterEndpoint: Trying to remove executor [execId] from BlockManagerM

aster.

If the execId executor is registered (in the internal blockManagerIdByExecutor internal

registry), removeExecutor removes the corresponding BlockManager .

removeExecutor is executed when BlockManagerMasterEndpoint receives a

Note RemoveExecutor or registers a new BlockManager (and another BlockManager
was already registered that is replaced by the new one).

Removing BlockManager —  removeBlockManager

Internal Method

removeBlockManager(blockManagerId: BlockManagerId)

removeBlockManager looks up blockManagerId and removes the executor it was working on

from the internal registries:

blockManagerIdByExecutor

blockManagerInfo

It then goes over all the blocks for the BlockManager , and removes the executor for each
block from blockLocations registry.

876
BlockManagerMasterEndpoint — BlockManagerMaster RPC Endpoint

SparkListenerBlockManagerRemoved(System.currentTimeMillis(), blockManagerId) is
posted to listenerBus.

You should then see the following INFO message in the logs:

INFO BlockManagerMasterEndpoint: Removing block manager [blockManagerId]

removeBlockManager is used exclusively when BlockManagerMasterEndpoint

Note
removes an executor.

Get Block Locations —  getLocations Method

getLocations(blockId: BlockId): Seq[BlockManagerId]

When executed, getLocations looks up blockId in the blockLocations internal registry

and returns the locations (as a collection of BlockManagerId ) or an empty collection.

Creating BlockManagerMasterEndpoint Instance

BlockManagerMasterEndpoint takes the following when created:

RpcEnv

Flag whether BlockManagerMasterEndpoint works in local or cluster mode

SparkConf

LiveListenerBus

BlockManagerMasterEndpoint initializes the internal registries and counters.

877
DiskBlockManager

DiskBlockManager
DiskBlockManager creates and maintains the logical mapping between logical blocks and

physical on-disk locations.

By default, one block is mapped to one file with a name given by its BlockId. It is however
possible to have a block map to only a segment of a file.

Block files are hashed among the local directories.

DiskBlockManager is used exclusively by DiskStore and created when

Note
BlockManager is created (and passed to DiskStore ).

Table 1. DiskBlockManager’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description

Local directories for storing block data

localDirs is initialized using createLocalDirs.

There has to be at least one local directory

Note
or DiskBlockManager cannot be created.

localDirs
Used when:
DiskBlockManager is requested to getFile, initialize
subDirs and stop
BlockManager is requested to register the executor’s
BlockManager with an external shuffle server

PySpark’s BasePythonRunner is requested to

compute

The value of spark.diskStore.subDirectories Spark

configuration property or 64 .

subDirsPerLocalDir Used when:

DiskBlockManager is created and is requested to
getFile

BlockManager is requested to register the executor’s

BlockManager with an external shuffle server

878
DiskBlockManager

Enable INFO or DEBUG logging levels for

org.apache.spark.storage.DiskBlockManager logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.storage.DiskBlockManager=DEBUG

Refer to Logging.

Finding File —  getFile Method

Caution FIXME

createTempShuffleBlock Method

createTempShuffleBlock(): (TempShuffleBlockId, File)

createTempShuffleBlock creates a temporary TempShuffleBlockId block.

Caution FIXME

getAllFiles Method

getAllFiles(): Seq[File]

getAllFiles …​FIXME

getAllFiles is used exclusively when DiskBlockManager is requested to

Note
getAllBlocks.

Creating DiskBlockManager Instance

DiskBlockManager(conf: SparkConf, deleteFilesOnStop: Boolean)

When created, DiskBlockManager uses spark.diskStore.subDirectories to set

subDirsPerLocalDir .

879
DiskBlockManager

DiskBlockManager creates one or many local directories to store block data (as localDirs).

When not successful, you should see the following ERROR message in the logs and
DiskBlockManager exits with error code 53 .

ERROR DiskBlockManager: Failed to create any local dir.

DiskBlockManager initializes the internal subDirs collection of locks for every local directory

to store block data with an array of subDirsPerLocalDir size for files.

In the end, DiskBlockManager registers a shutdown hook to clean up the local directories for
blocks.

Registering Shutdown Hook —  addShutdownHook

Internal Method

addShutdownHook(): AnyRef

addShutdownHook registers a shutdown hook to execute doStop at shutdown.

When executed, you should see the following DEBUG message in the logs:

DEBUG DiskBlockManager: Adding shutdown hook

addShutdownHook adds the shutdown hook so it prints the following INFO message and

executes doStop.

INFO DiskBlockManager: Shutdown hook called

Stopping DiskBlockManager (Removing Local Directories

for Blocks) —  doStop Internal Method

doStop(): Unit

doStop deletes the local directories recursively (only when the constructor’s

deleteFilesOnStop is enabled and the parent directories are not registered to be removed at

shutdown).

Note doStop is used when DiskBlockManager is requested to shut down or stop.

880
DiskBlockManager

Getting Local Directories for Spark to Write Files 

—  Utils.getConfiguredLocalDirs Internal Method

getConfiguredLocalDirs(conf: SparkConf): Array[String]

getConfiguredLocalDirs returns the local directories where Spark can write files.

Internally, getConfiguredLocalDirs uses conf SparkConf to know if External Shuffle

Service is enabled (using spark.shuffle.service.enabled).

getConfiguredLocalDirs checks if Spark runs on YARN and if so, returns LOCAL_DIRS -

controlled local directories.

In non-YARN mode (or for the driver in yarn-client mode), getConfiguredLocalDirs checks
the following environment variables (in the order) and returns the value of the first met:

1. SPARK_EXECUTOR_DIRS environment variable

2. SPARK_LOCAL_DIRS environment variable

3. MESOS_DIRECTORY environment variable (only when External Shuffle Service is not used)

In the end, when no earlier environment variables were found, getConfiguredLocalDirs uses
spark.local.dir Spark property or falls back on java.io.tmpdir System property.

getConfiguredLocalDirs is used when:

DiskBlockManager is requested to createLocalDirs

Note
Utils helper is requested to getLocalDir and
getOrCreateLocalRootDirsImpl

Getting Writable Directories in YARN 

—  getYarnLocalDirs Internal Method

getYarnLocalDirs(conf: SparkConf): String

getYarnLocalDirs uses conf SparkConf to read LOCAL_DIRS environment variable with

comma-separated local directories (that have already been created and secured so that only
the user has access to them).

getYarnLocalDirs throws an Exception with the message Yarn Local dirs can’t be empty

if LOCAL_DIRS environment variable was not set.

881
DiskBlockManager

Checking If Spark Runs on YARN 

—  isRunningInYarnContainer Internal Method

isRunningInYarnContainer(conf: SparkConf): Boolean

isRunningInYarnContainer uses conf SparkConf to read Hadoop YARN’s CONTAINER_ID

environment variable to find out if Spark runs in a YARN container.

Note CONTAINER_ID environment variable is exported by YARN NodeManager.

Getting All Blocks Stored On Disk —  getAllBlocks

Method

getAllBlocks(): Seq[BlockId]

getAllBlocks gets all the blocks stored on disk.

Internally, getAllBlocks takes the block files and returns their names (as BlockId ).

getAllBlocks is used exclusively when BlockManager is requested to find IDs

Note
of existing blocks for a given filter.

Creating Local Directories for Storing Block Data 

—  createLocalDirs Internal Method

createLocalDirs(conf: SparkConf): Array[File]

createLocalDirs creates blockmgr-[random UUID] directory under local directories to store

block data.

Internally, createLocalDirs reads local writable directories and creates a subdirectory

blockmgr-[random UUID] under every configured parent directory.

If successful, you should see the following INFO message in the logs:

INFO DiskBlockManager: Created local directory at [localDir]

When failed to create a local directory, you should see the following ERROR message in the
logs:

882
DiskBlockManager

ERROR DiskBlockManager: Failed to create local dir in [rootDir]. Ignoring this directo
ry.

Note createLocalDirs is used exclusively when localDirs is initialized.

stop Internal Method

stop(): Unit

stop …​FIXME

Note stop is used exclusively when BlockManager is requested to stop.

File Locks for Local Block Store Directories —  subDirs

Internal Property

subDirs: Array[Array[File]]

subDirs is a collection of subDirsPerLocalDir file locks for every local block store directory

where DiskBlockManager stores block data (with the columns being the number of local
directories and the rows as collection of subDirsPerLocalDir size).

Note subDirs(n) is to access n -th local directory.

Note subDirs is used when DiskBlockManager is requested to getFile or getAllFiles.

Settings
Table 2. Spark Properties
Spark Property Default Value Description
spark.diskStore.subDirectories 64 The number of …​FIXME

883
BlockInfoManager

BlockInfoManager
BlockInfoManager manages memory blocks (aka memory pages). It controls concurrent

access to memory blocks by read and write locks (for existing and new ones).

Locks are the mechanism to control concurrent access to data and prevent
Note
destructive interaction between operations that use the same resource.

Table 1. BlockInfoManager Internal Registries and Counters

Name Description
infos Tracks BlockInfo per block (as BlockId).

readLocksByTask
Tracks tasks (by TaskAttemptId ) and the blocks they
locked for reading (as BlockId).

writeLocksByTask
Tracks tasks (by TaskAttemptId ) and the blocks they
locked for writing (as BlockId).

BlockInfoManager is a private[storage] class that belongs to

Note
org.apache.spark.storage package.

Enable TRACE logging level for org.apache.spark.storage.BlockInfoManager

logger to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.storage.BlockInfoManager=TRACE

Refer to Logging.

registerTask Method

Caution FIXME

Downgrading Exclusive Write Lock For Block to Shared

Read Lock —  downgradeLock Method

downgradeLock(blockId: BlockId): Unit

downgradeLock …​FIXME

884
BlockInfoManager

Obtaining Read Lock For Block —  lockForReading

Method

lockForReading(
blockId: BlockId,
blocking: Boolean = true): Option[BlockInfo]

lockForReading locks blockId memory block for reading when the block was registered

earlier and no writer tasks use it.

When executed, lockForReading prints out the following TRACE message to the logs:

TRACE BlockInfoManager: Task [currentTaskAttemptId] trying to acquire read lock for [b

lockId]

lockForReading looks up the metadata of the blockId block (in infos registry).

If no metadata could be found, it returns None which means that the block does not exist or
was removed (and anybody could acquire a write lock).

Otherwise, when the metadata was found, i.e. registered, it checks so-called writerTask.
Only when the block has no writer tasks, a read lock can be acquired. If so, the readerCount
of the block metadata is incremented and the block is recorded (in the internal
readLocksByTask registry). You should see the following TRACE message in the logs:

TRACE BlockInfoManager: Task [taskAttemptId] acquired read lock for [blockId]

The BlockInfo for the blockId block is returned.

-1024 is a special taskAttemptId , aka NON_TASK_WRITER, used to mark a

Note
non-task thread, e.g. by a driver thread or by unit test code.

For blocks with writerTask other than NO_WRITER , when blocking is enabled,
lockForReading waits (until another thread invokes the Object.notify method or the

Object.notifyAll methods for this object).

With blocking enabled, it will repeat the waiting-for-read-lock sequence until either None
or the lock is obtained.

When blocking is disabled and the lock could not be obtained, None is returned
immediately.

lockForReading is a synchronized method, i.e. no two objects can use this and
Note
other instance methods.

885
BlockInfoManager

Obtaining Write Lock for Block —  lockForWriting

Method

lockForWriting(
blockId: BlockId,
blocking: Boolean = true): Option[BlockInfo]

When executed, lockForWriting prints out the following TRACE message to the logs:

TRACE Task [currentTaskAttemptId] trying to acquire write lock for [blockId]

It looks up blockId in the internal infos registry. When no BlockInfo could be found, None
is returned. Otherwise, blockId block is checked for writerTask to be
BlockInfo.NO_WRITER with no readers (i.e. readerCount is 0 ) and only then the lock is

returned.

When the write lock can be returned, BlockInfo.writerTask is set to currentTaskAttemptId

and a new binding is added to the internal writeLocksByTask registry. You should see the
following TRACE message in the logs:

TRACE Task [currentTaskAttemptId] acquired write lock for [blockId]

If, for some reason, blockId has a writer or the number of readers is positive (i.e.
BlockInfo.readerCount is greater than 0 ), the method will wait (based on the input

blocking flag) and attempt the write lock acquisition process until it finishes with a write

lock.

(deadlock possible) The method is synchronized and can block, i.e. wait that
Note causes the current thread to wait until another thread invokes Object.notify or
Object.notifyAll methods for this object.

lockForWriting return None for no blockId in the internal infos registry or when

blocking flag is disabled and the write lock could not be acquired.

Obtaining Write Lock for New Block 

—  lockNewBlockForWriting Method

lockNewBlockForWriting(
blockId: BlockId,
newBlockInfo: BlockInfo): Boolean

886
BlockInfoManager

lockNewBlockForWriting obtains a write lock for blockId but only when the method could

register the block.

lockNewBlockForWriting is similar to lockForWriting method but for brand new

Note
blocks.

When executed, lockNewBlockForWriting prints out the following TRACE message to the
logs:

TRACE Task [currentTaskAttemptId] trying to put [blockId]

If some other thread has already created the block, it finishes returning false . Otherwise,
when the block does not exist, newBlockInfo is recorded in the internal infos registry and
the block is locked for this client for writing. It then returns true .

lockNewBlockForWriting executes itself in synchronized block so once the

Note BlockInfoManager is locked the other internal registries should be available only
for the currently-executing thread.

currentTaskAttemptId Method

Caution FIXME

Releasing Lock on Block —  unlock Method

unlock(blockId: BlockId): Unit

unlock releases…​FIXME

When executed, unlock starts by printing out the following TRACE message to the logs:

TRACE BlockInfoManager: Task [currentTaskAttemptId] releasing lock for [blockId]

unlock gets the metadata for blockId . It may throw a IllegalStateException if the block

was not found.

If the writer task for the block is not NO_WRITER, it becomes so and the blockId block is
removed from the internal writeLocksByTask registry for the current task attempt.

Otherwise, if the writer task is indeed NO_WRITER , it is assumed that the blockId block is
locked for reading. The readerCount counter is decremented for the blockId block and the
read lock removed from the internal readLocksByTask registry for the current task attempt.

887
BlockInfoManager

In the end, unlock wakes up all the threads waiting for the BlockInfoManager (using Java’s
Object.notifyAll).

Caution FIXME What threads could wait?

Releasing All Locks Obtained by Task 

—  releaseAllLocksForTask Method

Caution FIXME

Removing Memory Block —  removeBlock Method

Caution FIXME

assertBlockIsLockedForWriting Method

Caution FIXME

888
BlockInfo

BlockInfo — Metadata of Memory Block

BlockInfo is a metadata of memory block (aka memory page) — the memory block’s size,

the number of readers and the id of the writer task.

BlockInfo has a StorageLevel, ClassTag and tellMaster flag.

Size —  size Attribute

size attribute is the size of the memory block. It starts with 0 .

It represents the number of bytes that BlockManager saved or BlockManager.doPutIterator.

Reader Count —  readerCount Counter

readerCount counter is the number of readers of the memory block, i.e. the number of read

locks. It starts with 0 .

readerCount is incremented when a read lock is acquired and decreases when the following

happens:

The memory block is unlocked

All locks for the memory block obtained by a task are released.

The memory block is removed

Clearing the current state of BlockInfoManager .

Writer Task —  writerTask Attribute

writerTask attribute is the task that owns the write lock for the memory block.

A writer task can be one of the three possible identifiers:

NO_WRITER (i.e. -1 ) to denote no writers and hence no write lock in use.

NON_TASK_WRITER (i.e. -1024 ) for non-task threads, e.g. by a driver thread or by unit
test code.

the task attempt id of the task which currently holds the write lock for this block.

The writer task is assigned in the following scenarios:

A write lock is requested for a memory block (with no writer and readers)

889
BlockInfo

A memory block is unlocked

All locks obtained by a task are released

A memory block is removed

Clearing the current state of BlockInfoManager .

890
BlockManagerSlaveEndpoint

BlockManagerSlaveEndpoint
BlockManagerSlaveEndpoint is a thread-safe RPC endpoint for remote communication

between executors and the driver.

Caution FIXME the intro needs more love.

While a BlockManager is being created so is the BlockManagerSlaveEndpoint RPC endpoint

with the name BlockManagerEndpoint[randomId] to handle RPC messages.

Enable DEBUG logging level for

org.apache.spark.storage.BlockManagerSlaveEndpoint logger to see what happens
inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.storage.BlockManagerSlaveEndpoint=DEBUG

Refer to Logging.

RemoveBlock Message

RemoveBlock(blockId: BlockId)

When a RemoveBlock message comes in, you should see the following DEBUG message in
the logs:

DEBUG BlockManagerSlaveEndpoint: removing block [blockId]

It then calls BlockManager to remove blockId block.

Handling RemoveBlock messages happens on a separate thread. See

Note
BlockManagerSlaveEndpoint Thread Pool.

When the computation is successful, you should see the following DEBUG in the logs:

DEBUG BlockManagerSlaveEndpoint: Done removing block [blockId], response is [response]

And true response is sent back. You should see the following DEBUG in the logs:

891
BlockManagerSlaveEndpoint

DEBUG BlockManagerSlaveEndpoint: Sent response: true to [senderAddress]

In case of failure, you should see the following ERROR in the logs and the stack trace.

ERROR BlockManagerSlaveEndpoint: Error in removing block [blockId]

RemoveRdd Message

RemoveRdd(rddId: Int)

When a RemoveRdd message comes in, you should see the following DEBUG message in
the logs:

DEBUG BlockManagerSlaveEndpoint: removing RDD [rddId]

It then calls BlockManager to remove rddId RDD.

Handling RemoveRdd messages happens on a separate thread. See

Note
BlockManagerSlaveEndpoint Thread Pool.

When the computation is successful, you should see the following DEBUG in the logs:

DEBUG BlockManagerSlaveEndpoint: Done removing RDD [rddId], response is [response]

And the number of blocks removed is sent back. You should see the following DEBUG in the
logs:

DEBUG BlockManagerSlaveEndpoint: Sent response: [#blocks] to [senderAddress]

In case of failure, you should see the following ERROR in the logs and the stack trace.

ERROR BlockManagerSlaveEndpoint: Error in removing RDD [rddId]

RemoveShuffle Message

RemoveShuffle(shuffleId: Int)

892
BlockManagerSlaveEndpoint

When a RemoveShuffle message comes in, you should see the following DEBUG message
in the logs:

DEBUG BlockManagerSlaveEndpoint: removing shuffle [shuffleId]

If MapOutputTracker was given (when the RPC endpoint was created), it calls
MapOutputTracker to unregister the shuffleId shuffle.

It then calls ShuffleManager to unregister the shuffleId shuffle.

Handling RemoveShuffle messages happens on a separate thread. See

Note
BlockManagerSlaveEndpoint Thread Pool.

When the computation is successful, you should see the following DEBUG in the logs:

DEBUG BlockManagerSlaveEndpoint: Done removing shuffle [shuffleId], response is [respo

nse]

And the result is sent back. You should see the following DEBUG in the logs:

DEBUG BlockManagerSlaveEndpoint: Sent response: [response] to [senderAddress]

In case of failure, you should see the following ERROR in the logs and the stack trace.

ERROR BlockManagerSlaveEndpoint: Error in removing shuffle [shuffleId]

RemoveShuffle is posted when BlockManagerMaster and

Note
BlockManagerMasterEndpoint remove all blocks for a shuffle.

RemoveBroadcast Message

RemoveBroadcast(broadcastId: Long)

When a RemoveBroadcast message comes in, you should see the following DEBUG
message in the logs:

DEBUG BlockManagerSlaveEndpoint: removing broadcast [broadcastId]

It then calls BlockManager to remove the broadcastId broadcast.

893
BlockManagerSlaveEndpoint

Handling RemoveBroadcast messages happens on a separate thread. See

Note
BlockManagerSlaveEndpoint Thread Pool.

When the computation is successful, you should see the following DEBUG in the logs:

DEBUG BlockManagerSlaveEndpoint: Done removing broadcast [broadcastId], response is [r

esponse]

And the result is sent back. You should see the following DEBUG in the logs:

DEBUG BlockManagerSlaveEndpoint: Sent response: [response] to [senderAddress]

In case of failure, you should see the following ERROR in the logs and the stack trace.

ERROR BlockManagerSlaveEndpoint: Error in removing broadcast [broadcastId]

GetBlockStatus Message

GetBlockStatus(blockId: BlockId)

When a GetBlockStatus message comes in, it responds with the result of calling
BlockManager about the status of blockId .

GetMatchingBlockIds Message

GetMatchingBlockIds(filter: BlockId => Boolean, askSlaves: Boolean = true)

When received a GetMatchingBlockIds , BlockManagerSlaveEndpoint requests BlockManager

to find IDs of existing blocks for a given filter and sends them back.

TriggerThreadDump Message
When a TriggerThreadDump message comes in, a thread dump is generated and sent back.

BlockManagerSlaveEndpoint Thread Pool

BlockManagerSlaveEndpoint uses block-manager-slave-async-thread-pool daemon thread

pool ( asyncThreadPool ) for some messages to talk to other Spark services, i.e.
BlockManager , MapOutputTracker, ShuffleManager in a non-blocking, asynchronous way.

894
BlockManagerSlaveEndpoint

The reason for the async thread pool is that the block-related operations might take quite
some time and to release the main RPC thread other threads are spawned to talk to the
external services and pass responses on to the clients.

BlockManagerSlaveEndpoint uses Java’s

Note
java.util.concurrent.ThreadPoolExecutor.

895
DiskBlockObjectWriter

DiskBlockObjectWriter
DiskBlockObjectWriter is a java.io.OutputStream that BlockManager offers for writing blocks

to disk.

Whenever DiskBlockObjectWriter is requested to write a key-value pair, it makes sure that

the underlying output streams are open.

DiskBlockObjectWriter can be in the following states (that match the state of the underlying

output streams):

1. Initialized

2. Open

3. Closed

896
DiskBlockObjectWriter

Table 1. DiskBlockObjectWriter’s Internal Registries and Counters

Name Description

Internal flag…​FIXME
initialized
Used when…​FIXME

Internal flag…​FIXME
hasBeenClosed
Used when…​FIXME

Internal flag…​FIXME
streamOpen
Used when…​FIXME

FIXME
objOut
Used when…​FIXME

FIXME
mcs
Used when…​FIXME

FIXME
bs
Used when…​FIXME

FIXME
objOut
Used when…​FIXME

FIXME
blockId
Used when…​FIXME

Note DiskBlockObjectWriter is a private[spark] class.

updateBytesWritten Method

Caution FIXME

initialize Method

Caution FIXME

Writing Bytes (From Byte Array Starting From Offset) 

—  write Method

897
DiskBlockObjectWriter

write(kvBytes: Array[Byte], offs: Int, len: Int): Unit

write …​FIXME

Caution FIXME

recordWritten Method

Caution FIXME

commitAndGet Method

commitAndGet(): FileSegment

Note commitAndGet is used when…​FIXME

close Method

Caution FIXME

Creating DiskBlockObjectWriter Instance

DiskBlockObjectWriter takes the following when created:

1. file

2. serializerManager  — SerializerManager

3. serializerInstance  — SerializerInstance

4. bufferSize

5. syncWrites flag

6. writeMetrics  — ShuffleWriteMetrics

7. blockId  — BlockId

DiskBlockObjectWriter initializes the internal registries and counters.

Writing Key-Value Pair —  write Method

898
DiskBlockObjectWriter

write(key: Any, value: Any): Unit

Before writing, write opens the stream unless already open.

write then writes the key first followed by writing the value .

In the end, write recordWritten.

write is used when BypassMergeSortShuffleWriter writes records and in

Note ExternalAppendOnlyMap , ExternalSorter and
WritablePartitionedPairCollection .

Opening DiskBlockObjectWriter —  open Method

open(): DiskBlockObjectWriter

open opens DiskBlockObjectWriter , i.e. initializes and re-sets bs and objOut internal output

streams.

Internally, open makes sure that DiskBlockObjectWriter is not closed (i.e. hasBeenClosed
flag is disabled). If it was, open throws a IllegalStateException :

Writer already closed. Cannot be reopened.

Unless DiskBlockObjectWriter has already been initialized (i.e. initialized flag is enabled),
open initializes it (and turns initialized flag on).

Regardless of whether DiskBlockObjectWriter was already initialized or not, open requests

SerializerManager to wrap mcs output stream for encryption and compression (for blockId)

and sets it as bs.

open uses SerializerManager that was specified when

Note
DiskBlockObjectWriter was created

open requests SerializerInstance to serialize bs output stream and sets it as objOut.

open uses SerializerInstance that was specified when

Note
DiskBlockObjectWriter was created

In the end, open turns streamOpen flag on.

open is used exclusively when DiskBlockObjectWriter writes a key-value pair

Note
or bytes from a specified byte array but the stream is not open yet.

899
DiskBlockObjectWriter

900
BlockManagerSource — Metrics Source for BlockManager

BlockManagerSource — Metrics Source for

BlockManager
BlockManagerSource is the metrics source of a BlockManager.

BlockManagerSource is registered under the name BlockManager (when SparkContext is

created).

Table 1. BlockManagerSource’s Gauge Metrics (in alphabetical order)

Name Type Description
Requests BlockManagerMaster for
storage status (for every
disk.diskSpaceUsed_MB long
BlockManager) and sums up their
disk space used ( diskUsed ).

Requests BlockManagerMaster for

storage status (for every
memory.maxMem_MB long
BlockManager) and sums up their
maximum memory limit ( maxMem ).

Requests BlockManagerMaster for

storage status (for every
memory.maxOffHeapMem_MB long BlockManager) and sums up their
off-heap memory remaining
( maxOffHeapMem ).

Requests BlockManagerMaster for

storage status (for every
memory.maxOnHeapMem_MB long BlockManager) and sums up their
on-heap memory remaining
( maxOnHeapMem ).

Requests BlockManagerMaster for

storage status (for every
BlockManager) and sums up their
memory.memUsed_MB long memory used ( memUsed ).

Requests BlockManagerMaster for

storage status (for every
memory.offHeapMemUsed_MB long BlockManager) and sums up their
off-heap memory used
( offHeapMemUsed ).

901
BlockManagerSource — Metrics Source for BlockManager

on-heap memory used

( onHeapMemUsed ).

Requests BlockManagerMaster for

storage status (for every
memory.remainingMem_MB long BlockManager) and sums up their
memory remaining
( memRemaining ).

Requests BlockManagerMaster for

storage status (for every
memory.remainingOffHeapMem_MB long BlockManager) and sums up their
off-heap memory remaining
( offHeapMemRemaining ).

Requests BlockManagerMaster for

storage status (for every
memory.remainingOnHeapMem_MB long BlockManager) and sums up their
on-heap memory remaining
( onHeapMemRemaining ).

You can access the BlockManagerSource metrics using the web UI’s port (as spark.ui.port
configuration property).

$ http --follow http://localhost:4040/metrics/json \

| jq '.gauges | keys | .[] | select(test(".driver.BlockManager"; "g"))'
"local-1528725411625.driver.BlockManager.disk.diskSpaceUsed_MB"
"local-1528725411625.driver.BlockManager.memory.maxMem_MB"
"local-1528725411625.driver.BlockManager.memory.maxOffHeapMem_MB"
"local-1528725411625.driver.BlockManager.memory.maxOnHeapMem_MB"
"local-1528725411625.driver.BlockManager.memory.memUsed_MB"
"local-1528725411625.driver.BlockManager.memory.offHeapMemUsed_MB"
"local-1528725411625.driver.BlockManager.memory.onHeapMemUsed_MB"
"local-1528725411625.driver.BlockManager.memory.remainingMem_MB"
"local-1528725411625.driver.BlockManager.memory.remainingOffHeapMem_MB"
"local-1528725411625.driver.BlockManager.memory.remainingOnHeapMem_MB"

BlockManagerSource takes a BlockManager when created.

BlockManagerSource is created when SparkContext is created.

902
ShuffleMetricsSource — Metrics Source of BlockManager for Shuffle-Related Metrics

ShuffleMetricsSource — Metrics Source of
BlockManager for Shuffle-Related Metrics
ShuffleMetricsSource is the metrics source of a BlockManager for shuffle-related metrics.

ShuffleMetricsSource lives on a Spark executor and is registered only when a Spark

application runs in a non-local / cluster mode.

Figure 1. Registering ShuffleMetricsSource with "executor" MetricsSystem

ShuffleMetricsSource is created exclusively when BlockManager is requested for the

shuffleMetricsSource.

When created, ShuffleMetricsSource gets a MetricSet that BlockManager requests from the
ShuffleClient (only when in a non-local / cluster mode).

ShuffleMetricsSource is registered under the following source name per the type of a

BlockManager :

NettyBlockTransfer when spark.shuffle.service.enabled configuration property is off

( false )

ExternalShuffle when spark.shuffle.service.enabled configuration property is on

( true )

Note spark.shuffle.service.enabled configuration property is off ( false ) by default.

Table 1. ShuffleMetricsSource’s Gauge Metrics (in alphabetical order)

Name Type Description

903
ShuffleMetricsSource — Metrics Source of BlockManager for Shuffle-Related Metrics

Since Executor does not have a web UI attached you cannot access the
Note
metrics using the HTTP protocol (through MetricsServlet JSON metrics sink).

Creating ShuffleMetricsSource Instance

ShuffleMetricsSource takes the following when created:

Source name

Dropwizard Metrics' MetricSet

904
StorageStatus

StorageStatus
StorageStatus is a developer API that Spark uses to pass "just enough" information about

registered BlockManagers in a Spark application between Spark services (mostly for

monitoring purposes like web UI or SparkListeners).

There are two ways to access StorageStatus about all the known
BlockManagers in a Spark application:

Note SparkContext.getExecutorStorageStatus
Being a SparkListener and intercepting onBlockManagerAdded and
onBlockManagerRemoved events

StorageStatus is created when:

BlockManagerMasterEndpoint is requested for storage status (of every BlockManager in

a Spark application)

StorageStatusListener gets notified about a new BlockManager (in a Spark application)

Table 1. StorageStatus’s Internal Registries and Counters

Name Description
Lookup table of BlockIds per BlockId .
_nonRddBlocks
Used when…​FIXME

Lookup table of BlockIds with BlockStatus per RDD id.

_rddBlocks
Used when…​FIXME

updateStorageInfo Method

Caution FIXME

Creating StorageStatus Instance

StorageStatus takes the following when created:

BlockManagerId

Maximum memory — total available on-heap and off-heap memory for storage on the
BlockManager

905
StorageStatus

StorageStatus initializes the internal registries and counters.

Getting RDD Blocks For RDD —  rddBlocksById Method

rddBlocksById(rddId: Int): Map[BlockId, BlockStatus]

rddBlocksById gives the blocks (as BlockId with their status as BlockStatus ) that belong

to rddId RDD.

rddBlocksById is used when:

StorageStatusListener removes the RDD blocks of an unpersisted RDD.

Note
AllRDDResource does getRDDStorageInfo

StorageUtils does getRddBlockLocations

Removing Block (From Internal Registries) 

—  removeBlock Internal Method

removeBlock(blockId: BlockId): Option[BlockStatus]

removeBlock removes blockId from _rddBlocks registry and returns it.

Internally, removeBlock updates block status of blockId (to be empty, i.e. removed).

removeBlock branches off per the type of BlockId , i.e. RDDBlockId or not.

For a RDDBlockId , removeBlock finds the RDD in _rddBlocks and removes the blockId .
removeBlock removes the RDD (from _rddBlocks) completely, if there are no more blocks

registered.

For a non- RDDBlockId , removeBlock removes blockId from _nonRddBlocks registry.

removeBlock is used when StorageStatusListener removes RDD blocks for an

Note
unpersisted RDD or updates storage status for an executor.

906
ManagedBuffer

ManagedBuffer
ManagedBuffer is the base of…​FIXME

package org.apache.spark.network.buffer;

abstract class ManagedBuffer {

abstract long size();
abstract ByteBuffer nioByteBuffer() throws IOException;
abstract InputStream createInputStream() throws IOException;
abstract ManagedBuffer retain();
abstract ManagedBuffer release();
abstract Object convertToNetty() throws IOException;
}

Table 1. ManagedBuffer Contract

Method Description
size Used when…​FIXME

nioByteBuffer Used when…​FIXME

createInputStream Used when…​FIXME

retain Used when…​FIXME

release Used when…​FIXME

convertToNetty Used when…​FIXME

Table 2. ManagedBuffers
ManagedBuffer Description
BlockManagerManagedBuffer

FileSegmentManagedBuffer

NettyManagedBuffer

NioManagedBuffer

907
MapOutputTracker — Shuffle Map Output Registry

MapOutputTracker — Shuffle Map Output

Registry
MapOutputTracker is a Spark service that runs on the driver and executors that tracks the

shuffle map outputs (with information about the BlockManager and estimated size of the
reduce blocks per shuffle).

MapOutputTracker is registered as the MapOutputTracker RPC Endpoint in the

Note
RPC Environment when SparkEnv is created.

There are two concrete MapOutputTrackers , i.e. one for the driver and another for executors:

MapOutputTrackerMaster for the driver

MapOutputTrackerWorker for executors

Given the different runtime environments of the driver and executors, accessing the current
MapOutputTracker is possible using SparkEnv.

SparkEnv.get.mapOutputTracker

Table 1. MapOutputTracker Internal Registries and Counters

Name Description
Internal cache with MapStatus array (indexed by partition
id) per shuffle id.
mapStatuses
Used when MapOutputTracker finds map outputs for a
ShuffleDependency , updates epoch and unregisters a
shuffle.

Tracks the epoch in a Spark application.

epoch
Starts from 0 when MapOutputTracker is created.
Can be updated (on MapOutputTrackerWorkers ) or
incremented (on the driver’s MapOutputTrackerMaster ).

epochLock FIXME

MapOutputTracker is also used for mapOutputTracker.containsShuffle and

MapOutputTrackerMaster.registerShuffle when a new ShuffleMapStage is created.

908
MapOutputTracker — Shuffle Map Output Registry

MapOutputTrackerMaster.getStatistics(dependency) returns MapOutputStatistics that

becomes the result of JobWaiter.taskSucceeded for ShuffleMapStage if it’s the final stage in
a job.

MapOutputTrackerMaster.registerMapOutputs for a shuffle id and a list of MapStatus when

a ShuffleMapStage is finished.

MapOutputTracker is used in BlockStoreShuffleReader and when creating

Note
BlockManager and BlockManagerSlaveEndpoint.

trackerEndpoint Property
trackerEndpoint is a RpcEndpointRef that MapOutputTracker uses to send RPC messages.

trackerEndpoint is initialized when SparkEnv is created for the driver and executors and

cleared when MapOutputTrackerMaster is stopped.

Creating MapOutputTracker Instance

Caution FIXME

deserializeMapStatuses Method

Caution FIXME

sendTracker Method

Caution FIXME

serializeMapStatuses Method

Caution FIXME

Computing Statistics for ShuffleDependency 

—  getStatistics Method

getStatistics(dep: ShuffleDependency[_, _, _]): MapOutputStatistics

909
MapOutputTracker — Shuffle Map Output Registry

getStatistics returns a MapOutputStatistics which is simply a pair of the shuffle id (of the

input ShuffleDependency ) and the total sums of estimated sizes of the reduce shuffle blocks
from all the BlockManagers.

Internally, getStatistics finds map outputs for the input ShuffleDependency and calculates
the total sizes for the estimated sizes of the reduce block (in bytes) for every MapStatus and
partition.

The internal totalSizes array has the number of elements as specified by the
number of partitions of the Partitioner of the input ShuffleDependency .
Note
totalSizes contains elements as a sum of the estimated size of the block for
partition in a BlockManager (for a MapStatus ).

getStatistics is used when DAGScheduler accepts a ShuffleDependency for

execution (and the corresponding ShuffleMapStage has already been
Note
computed) and gets notified that a ShuffleMapTask has completed (and map-
stage jobs waiting for the stage are then marked as finished).

Computing BlockManagerIds with Their Blocks and Sizes 

—  getMapSizesByExecutorId Methods

getMapSizesByExecutorId(shuffleId: Int, startPartition: Int, endPartition: Int)

: Seq[(BlockManagerId, Seq[(BlockId, Long)])]

getMapSizesByExecutorId(shuffleId: Int, reduceId: Int)

: Seq[(BlockManagerId, Seq[(BlockId, Long)])] (1)

1. Calls the other getMapSizesByExecutorId with endPartition as reduceId + 1 and is

used exclusively in tests.

Caution FIXME How do the start and end partitions influence the return value?

getMapSizesByExecutorId returns a collection of BlockManagerIds with their blocks and

sizes.

When executed, you should see the following DEBUG message in the logs:

DEBUG Fetching outputs for shuffle [id], partitions [startPartition]-[endPartition]

getMapSizesByExecutorId finds map outputs for the input shuffleId .

getMapSizesByExecutorId gets the map outputs for all the partitions (despite the
Note
method’s signature).

910
MapOutputTracker — Shuffle Map Output Registry

In the end, getMapSizesByExecutorId converts shuffle map outputs (as MapStatuses ) into the
collection of BlockManagerIds with their blocks and sizes.

getMapSizesByExecutorId is exclusively used when BlockStoreShuffleReader

Note
reads combined records for a reduce task.

Returning Current Epoch —  getEpoch Method

getEpoch: Long

getEpoch returns the current epoch.

getEpoch is used when DAGScheduler is notified that an executor was lost and
Note when TaskSetManager is created (and sets the epoch for the tasks in a
TaskSet).

Updating Epoch —  updateEpoch Method

updateEpoch(newEpoch: Long): Unit

updateEpoch updates epoch when the input newEpoch is greater (and hence more recent)

and clears the mapStatuses internal cache.

You should see the following INFO message in the logs:

INFO MapOutputTrackerWorker: Updating epoch to [newEpoch] and clearing cache

Note updateEpoch is exclusively used when TaskRunner runs (for a task).

Unregistering Shuffle —  unregisterShuffle Method

unregisterShuffle(shuffleId: Int): Unit

unregisterShuffle unregisters shuffleId , i.e. removes shuffleId entry from the

mapStatuses internal cache.

unregisterShuffle is used when ContextCleaner removes a shuffle (blocks)

Note from MapOutputTrackerMaster and BlockManagerMaster (aka shuffle cleanup)
and when BlockManagerSlaveEndpoint handles RemoveShuffle message.

911
MapOutputTracker — Shuffle Map Output Registry

stop Method

stop(): Unit

stop does nothing at all.

stop is used exclusively when SparkEnv stops (and stops all the services,
Note
MapOutputTracker including).

Note stop is overriden by MapOutputTrackerMaster.

Finding Map Outputs For ShuffleDependency in Cache

or Fetching Remotely —  getStatuses Internal Method

getStatuses(shuffleId: Int): Array[MapStatus]

getStatuses finds MapStatuses for the input shuffleId in the mapStatuses internal cache

and, when not available, fetches them from a remote MapOutputTrackerMaster (using RPC).

Internally, getStatuses first queries the mapStatuses internal cache and returns the map
outputs if found.

If not found (in the mapStatuses internal cache), you should see the following INFO
message in the logs:

INFO Don't have map outputs for shuffle [id], fetching them

If some other process fetches the map outputs for the shuffleId (as recorded in fetching
internal registry), getStatuses waits until it is done.

When no other process fetches the map outputs, getStatuses registers the input
shuffleId in fetching internal registry (of shuffle map outputs being fetched).

You should see the following INFO message in the logs:

INFO Doing the fetch; tracker endpoint = [trackerEndpoint]

getStatuses sends a GetMapOutputStatuses RPC remote message for the input shuffleId

to the trackerEndpoint expecting a Array[Byte] .

getStatuses requests shuffle map outputs remotely within a timeout and with
Note
retries. Refer to RpcEndpointRef.

912
MapOutputTracker — Shuffle Map Output Registry

getStatuses deserializes the map output statuses and records the result in the

mapStatuses internal cache.

You should see the following INFO message in the logs:

INFO Got the output locations

getStatuses removes the input shuffleId from fetching internal registry.

You should see the following DEBUG message in the logs:

DEBUG Fetching map output statuses for shuffle [id] took [time] ms

If getStatuses could not find the map output locations for the input shuffleId (locally and
remotely), you should see the following ERROR message in the logs and throws a
MetadataFetchFailedException .

ERROR Missing all output locations for shuffle [id]

getStatuses is used when MapOutputTracker getMapSizesByExecutorId and

Note
computes statistics for ShuffleDependency .

Converting MapStatuses To BlockManagerIds with

ShuffleBlockIds and Their Sizes 
—  convertMapStatuses Internal Method

convertMapStatuses(
shuffleId: Int,
startPartition: Int,
endPartition: Int,
statuses: Array[MapStatus]): Seq[(BlockManagerId, Seq[(BlockId, Long)])]

convertMapStatuses iterates over the input statuses array (of MapStatus entries indexed

by map id) and creates a collection of BlockManagerId (for each MapStatus entry) with a
ShuffleBlockId (with the input shuffleId , a mapId , and partition ranging from the input
startPartition and endPartition ) and estimated size for the reduce block for every status

and partitions.

For any empty MapStatus , you should see the following ERROR message in the logs:

ERROR Missing an output location for shuffle [id]

913
MapOutputTracker — Shuffle Map Output Registry

And convertMapStatuses throws a MetadataFetchFailedException (with shuffleId ,

startPartition , and the above error message).

convertMapStatuses is exclusively used when MapOutputTracker computes

Note
BlockManagerId s with their ShuffleBlockId s and sizes.

Sending Blocking Messages To trackerEndpoint

RpcEndpointRef —  askTracker Method

askTracker[T](message: Any): T

askTracker sends the message to trackerEndpoint RpcEndpointRef and waits for a result.

When an exception happens, you should see the following ERROR message in the logs and
askTracker throws a SparkException .

ERROR Error communicating with MapOutputTracker

askTracker is used when MapOutputTracker fetches map outputs for

Note
ShuffleDependency remotely and sends a one-way message.

914
MapOutputTrackerMaster — MapOutputTracker For Driver

MapOutputTrackerMaster — MapOutputTracker
For Driver
MapOutputTrackerMaster is the MapOutputTracker for the driver.

A MapOutputTrackerMaster is the source of truth for MapStatus objects (map output

locations) per shuffle id (as recorded from ShuffleMapTasks).

MapOutputTrackerMaster uses Java’s thread-safe

Note
java.util.concurrent.ConcurrentHashMap for mapStatuses internal cache.

There is currently a hardcoded limit of map and reduce tasks above which
Note Spark does not assign preferred locations aka locality preferences based on
map output sizes —  1000 for map and reduce each.

MapOutputTrackerMaster uses MetadataCleaner with

MetadataCleanerType.MAP_OUTPUT_TRACKER as cleanerType and cleanup function to drop

entries in mapStatuses .

915
MapOutputTrackerMaster — MapOutputTracker For Driver

Table 1. MapOutputTrackerMaster Internal Registries and Counters

Name Description

Internal registry of…​FIXME

cachedSerializedBroadcast
Used when…​FIXME

Internal registry of serialized shuffle map output statuses

cachedSerializedStatuses (as Array[Byte] ) per…​FIXME
Used when…​FIXME

Internal registry with…​FIXME

cacheEpoch
Used when…​FIXME

Internal registry of locks for shuffle ids.

shuffleIdLocks
Used when…​FIXME

Internal queue with GetMapOutputMessage requests for

map output statuses.

Used when MapOutputTrackerMaster posts

mapOutputRequests GetMapOutputMessage messages to and take one head
element off this queue.
NOTE: mapOutputRequests uses Java’s
java.util.concurrent.LinkedBlockingQueue.

Enable INFO or DEBUG logging level for

org.apache.spark.MapOutputTrackerMaster logger to see what happens in
MapOutputTrackerMaster .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.MapOutputTrackerMaster=DEBUG

Refer to Logging.

removeBroadcast Method

Caution FIXME

clearCachedBroadcast Method

Caution FIXME

916
MapOutputTrackerMaster — MapOutputTracker For Driver

post Method

Caution FIXME

stop Method

Caution FIXME

unregisterMapOutput Method

Caution FIXME

cleanup Function for MetadataCleaner

cleanup(cleanupTime: Long) method removes old entries in mapStatuses and

cachedSerializedStatuses that have timestamp earlier than cleanupTime .

It uses org.apache.spark.util.TimeStampedHashMap.clearOldValues method.

Enable DEBUG logging level for org.apache.spark.util.TimeStampedHashMap logger

to see what happens in TimeStampedHashMap.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.util.TimeStampedHashMap=DEBUG

You should see the following DEBUG message in the logs for entries being removed:

DEBUG Removing key [entry.getKey]

Creating MapOutputTrackerMaster Instance

MapOutputTrackerMaster takes the following when created:

1. SparkConf

2. broadcastManager  — BroadcastManager

3. isLocal  — flag to control whether MapOutputTrackerMaster runs in local or on a cluster.

MapOutputTrackerMaster initializes the internal registries and counters and starts map-

output-dispatcher threads.

917
MapOutputTrackerMaster — MapOutputTracker For Driver

Note MapOutputTrackerMaster is created when SparkEnv is created.

threadpool Thread Pool with map-output-

dispatcher Threads

threadpool: ThreadPoolExecutor

threadpool is a daemon fixed thread pool registered with map-output-dispatcher thread

name prefix.

threadpool uses spark.shuffle.mapOutput.dispatcher.numThreads (default: 8 ) for the

number of MessageLoop dispatcher threads to process received GetMapOutputMessage

messages.

The dispatcher threads are started immediately when MapOutputTrackerMaster

Note
is created.

Note threadpool is shut down when MapOutputTrackerMaster stops.

Finding Preferred BlockManagers with Most Shuffle Map

Outputs (For ShuffleDependency and Partition) 
—  getPreferredLocationsForShuffle Method

getPreferredLocationsForShuffle(dep: ShuffleDependency[_, _, _], partitionId: Int): Seq

[String]

getPreferredLocationsForShuffle finds the locations (i.e. BlockManagers) with the most map

outputs for the input ShuffleDependency and Partition.

getPreferredLocationsForShuffle is simply getLocationsWithLargestOutputs

Note
with a guard condition.

Internally, getPreferredLocationsForShuffle checks whether

spark.shuffle.reduceLocality.enabled Spark property is enabled (it is by default) with the

number of partitions of the RDD of the input ShuffleDependency and partitions in the
partitioner of the input ShuffleDependency both being less than 1000 .

The thresholds for the number of partitions in the RDD and of the partitioner
Note
when computing the preferred locations are 1000 and are not configurable.

918
MapOutputTrackerMaster — MapOutputTracker For Driver

If the condition holds, getPreferredLocationsForShuffle finds locations with the largest

number of shuffle map outputs for the input ShuffleDependency and partitionId (with the
number of partitions in the partitioner of the input ShuffleDependency and 0.2 ) and returns
the hosts of the preferred BlockManagers .

0.2 is the fraction of total map output that must be at a location to be

Note
considered as a preferred location for a reduce task. It is not configurable.

getPreferredLocationsForShuffle is used when ShuffledRDD and

Note
ShuffledRowRDD ask for preferred locations for a partition.

Incrementing Epoch —  incrementEpoch Method

incrementEpoch(): Unit

incrementEpoch increments the internal epoch.

You should see the following DEBUG message in the logs:

DEBUG MapOutputTrackerMaster: Increasing epoch to [epoch]

incrementEpoch is used when MapOutputTrackerMaster registers map outputs

(with changeEpoch flag enabled — it is disabled by default) and unregisters map
Note
outputs (for a shuffle, mapper and block manager), and when DAGScheduler is
notified that an executor got lost (with filesLost flag enabled).

Finding Locations with Largest Number of Shuffle Map

Outputs —  getLocationsWithLargestOutputs Method

getLocationsWithLargestOutputs(
shuffleId: Int,
reducerId: Int,
numReducers: Int,
fractionThreshold: Double): Option[Array[BlockManagerId]]

getLocationsWithLargestOutputs returns BlockManagerIds with the largest size (of all the

shuffle blocks they manage) above the input fractionThreshold (given the total size of all
the shuffle blocks for the shuffle across all BlockManagers).

getLocationsWithLargestOutputs may return no BlockManagerId if their shuffle

Note
blocks do not total up above the input fractionThreshold .

919
MapOutputTrackerMaster — MapOutputTracker For Driver

Note The input numReducers is not used.

Internally, getLocationsWithLargestOutputs queries the mapStatuses internal cache for the

input shuffleId .

One entry in mapStatuses internal cache is a MapStatus array indexed by

partition id.
Note
MapStatus includes information about the BlockManager (as BlockManagerId )
and estimated size of the reduce blocks.

getLocationsWithLargestOutputs iterates over the MapStatus array and builds an interim

mapping between BlockManagerId and the cumulative sum of shuffle blocks across
BlockManagers.

getLocationsWithLargestOutputs is used exclusively when

Note MapOutputTrackerMaster finds the preferred locations (BlockManagers and
hence executors) for a shuffle.

Requesting Tracking Status of Shuffle Map Output 

—  containsShuffle Method

containsShuffle(shuffleId: Int): Boolean

containsShuffle checks if the input shuffleId is registered in the

cachedSerializedStatuses or mapStatuses internal caches.

containsShuffle is used exclusively when DAGScheduler creates a

Note
ShuffleMapStage (for ShuffleDependency and ActiveJob).

Registering ShuffleDependency —  registerShuffle

Method

registerShuffle(shuffleId: Int, numMaps: Int): Unit

registerShuffle registers the input shuffleId in the mapStatuses internal cache.

The number of MapStatus entries in the new array in mapStatuses internal

Note
cache is exactly the input numMaps .

registerShuffle adds a lock in the shuffleIdLocks internal registry (without using it).

920
MapOutputTrackerMaster — MapOutputTracker For Driver

If the shuffleId has already been registered, registerShuffle throws a

IllegalArgumentException with the following message:

Shuffle ID [id] registered twice

registerShuffle is used exclusively when DAGScheduler creates a

Note
ShuffleMapStage (for ShuffleDependency and ActiveJob).

Registering Map Outputs for Shuffle (Possibly with Epoch

Change) —  registerMapOutputs Method

registerMapOutputs(
shuffleId: Int,
statuses: Array[MapStatus],
changeEpoch: Boolean = false): Unit

registerMapOutputs registers the input statuses (as the shuffle map output) with the input

shuffleId in the mapStatuses internal cache.

registerMapOutputs increments epoch if the input changeEpoch is enabled (it is not by

default).

registerMapOutputs is used when DAGScheduler handles successful

ShuffleMapTask completion and executor lost events.
Note
In both cases, the input changeEpoch is enabled.

Finding Serialized Map Output Statuses (And Possibly

Broadcasting Them) 
—  getSerializedMapOutputStatuses Method

getSerializedMapOutputStatuses(shuffleId: Int): Array[Byte]

getSerializedMapOutputStatuses finds cached serialized map statuses for the input

shuffleId .

If found, getSerializedMapOutputStatuses returns the cached serialized map statuses.

Otherwise, getSerializedMapOutputStatuses acquires the shuffle lock for shuffleId and

finds cached serialized map statuses again since some other thread could not update the
cachedSerializedStatuses internal cache.

921
MapOutputTrackerMaster — MapOutputTracker For Driver

getSerializedMapOutputStatuses returns the serialized map statuses if found.

If not, getSerializedMapOutputStatuses serializes the local array of MapStatuses (from

checkCachedStatuses).

You should see the following INFO message in the logs:

INFO Size of output statuses for shuffle [shuffleId] is [bytes] bytes

getSerializedMapOutputStatuses saves the serialized map output statuses in

cachedSerializedStatuses internal cache if the epoch has not changed in the meantime.
getSerializedMapOutputStatuses also saves its broadcast version in

cachedSerializedBroadcast internal cache.

If the epoch has changed in the meantime, the serialized map output statuses and their
broadcast version are not saved, and you should see the following INFO message in the
logs:

INFO Epoch changed, not caching!

getSerializedMapOutputStatuses removes the broadcast.

getSerializedMapOutputStatuses returns the serialized map statuses.

getSerializedMapOutputStatuses is used when MapOutputTrackerMaster

responds to GetMapOutputMessage requests and DAGScheduler creates
Note
ShuffleMapStage for ShuffleDependency (copying the shuffle map output
locations from previous jobs to avoid unnecessarily regenerating data).

Finding Cached Serialized Map Statuses 

—  checkCachedStatuses Internal Method

checkCachedStatuses(): Boolean

checkCachedStatuses is an internal helper method that getSerializedMapOutputStatuses

uses to do some bookkeeping (when the epoch and cacheEpoch differ) and set local
statuses , retBytes and epochGotten (that getSerializedMapOutputStatuses uses).

Internally, checkCachedStatuses acquires the epochLock lock and checks the status of
epoch to cached cacheEpoch .

If epoch is younger (i.e. greater), checkCachedStatuses clears cachedSerializedStatuses

internal cache, cached broadcasts and sets cacheEpoch to be epoch .

922
MapOutputTrackerMaster — MapOutputTracker For Driver

checkCachedStatuses gets the serialized map output statuses for the shuffleId (of the

owning getSerializedMapOutputStatuses).

When the serialized map output status is found, checkCachedStatuses saves it in a local
retBytes and returns true .

When not found, you should see the following DEBUG message in the logs:

DEBUG cached status not found for : [shuffleId]

checkCachedStatuses uses mapStatuses internal cache to get map output statuses for the

shuffleId (of the owning getSerializedMapOutputStatuses) or falls back to an empty array

and sets it to a local statuses . checkCachedStatuses sets the local epochGotten to the
current epoch and returns false .

MessageLoop Dispatcher Thread

MessageLoop is a dispatcher thread that, once started, runs indefinitely until PoisonPill

arrives.

MessageLoop takes GetMapOutputMessage messages off mapOutputRequests internal queue

(waiting if necessary until a message becomes available).

Unless PoisonPill is processed, you should see the following DEBUG message in the
logs:

DEBUG Handling request to send map output locations for shuffle [shuffleId] to [hostPo
rt]

MessageLoop replies back with serialized map output statuses for the shuffleId (from the

incoming GetMapOutputMessage message).

MessageLoop is created and executed immediately when

Note
MapOutputTrackerMaster is created.

PoisonPill Message
PoisonPill is a GetMapOutputMessage (with -99 as shuffleId ) that indicates that

MessageLoop should exit its message loop.

PoisonPill is posted when MapOutputTrackerMaster stops.

Settings

923
MapOutputTrackerMaster — MapOutputTracker For Driver

Table 2. Spark Properties

Default
Spark Property Description
Value
spark.shuffle.mapOutput.dispatcher.numThreads 8 FIXME

spark.shuffle.mapOutput.minSizeForBroadcast 512k FIXME

Controls whether to
compute locality
preferences for reduce
tasks.
When enabled (i.e.
true ),
spark.shuffle.reduceLocality.enabled true MapOutputTrackerMaster
computes the preferred
hosts on which to run a
given map output
partition in a given
shuffle, i.e. the nodes
that the most outputs for
that partition are on.

924
MapOutputTrackerMasterEndpoint

MapOutputTrackerMasterEndpoint
MapOutputTrackerMasterEndpoint is a RpcEndpoint for MapOutputTrackerMaster.

MapOutputTrackerMasterEndpoint handles the following messages:

GetMapOutputStatuses

StopMapOutputTracker

Enable INFO or DEBUG logging levels for

org.apache.spark.MapOutputTrackerMasterEndpoint logger to see what happens in
MapOutputTrackerMasterEndpoint .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.MapOutputTrackerMasterEndpoint=DEBUG

Refer to Logging.

Creating MapOutputTrackerMasterEndpoint Instance

MapOutputTrackerMasterEndpoint takes the following when created:

1. rpcEnv  — RpcEnv

2. tracker  — MapOutputTrackerMaster

3. conf  — SparkConf

When created, you should see the following DEBUG message in the logs:

DEBUG init

MapOutputTrackerMasterEndpoint is created when SparkEnv is created for the

Note
driver and executors.

GetMapOutputStatuses Message

GetMapOutputStatuses(shuffleId: Int)
extends MapOutputTrackerMessage

925
MapOutputTrackerMasterEndpoint

When GetMapOutputStatuses arrives, MapOutputTrackerMasterEndpoint reads the host and

the port of the sender.

You should see the following INFO message in the logs:

INFO Asked to send map output locations for shuffle [shuffleId] to [hostPort]

MapOutputTrackerMasterEndpoint posts a GetMapOutputMessage to MapOutputTrackerMaster

(with shuffleId and the current RpcCallContext ).

GetMapOutputStatuses is posted when MapOutputTracker fetches shuffle map

Note
outputs remotely.

StopMapOutputTracker Message

StopMapOutputTracker
extends MapOutputTrackerMessage

When StopMapOutputTracker arrives, you should see the following INFO message in the
logs:

INFO MapOutputTrackerMasterEndpoint stopped!

MapOutputTrackerMasterEndpoint confirms the request (by replying true ) and stops itself

(and stops accepting messages).

Note StopMapOutputTracker is posted when MapOutputTrackerMaster stops.

926
MapOutputTrackerWorker — MapOutputTracker for Executors

MapOutputTrackerWorker — MapOutputTracker
for Executors
A MapOutputTrackerWorker is the MapOutputTracker for executors.

MapOutputTrackerWorker uses Java’s thread-safe java.util.concurrent.ConcurrentHashMap

for mapStatuses internal cache and any lookup cache miss triggers a fetch from the driver’s
MapOutputTrackerMaster.

The only difference between MapOutputTrackerWorker and the base abstract

Note class MapOutputTracker is that the mapStatuses internal registry is an instance
of the thread-safe java.util.concurrent.ConcurrentHashMap.

Enable INFO or DEBUG logging level for

org.apache.spark.MapOutputTrackerWorker logger to see what happens in
MapOutputTrackerWorker .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.MapOutputTrackerWorker=DEBUG

Refer to Logging.

927
ShuffleManager — Pluggable Shuffle Systems

ShuffleManager — Pluggable Shuffle Systems

ShuffleManager is the pluggable mechanism for shuffle systems that track shuffle

dependencies for ShuffleMapStage on the driver and executors.

SortShuffleManager (short name: sort or tungsten-sort ) is the one and only

Note
ShuffleManager in Spark 2.0.

spark.shuffle.manager Spark property sets up the default shuffle manager.

The driver and executor access their ShuffleManager instances using SparkEnv.

val shuffleManager = SparkEnv.get.shuffleManager

The driver registers shuffles with a shuffle manager, and executors (or tasks running locally
in the driver) can ask to read and write data.

It is network-addressable, i.e. it is available on a host and port.

There can be many shuffle services running simultaneously and a driver registers with all of
them when CoarseGrainedSchedulerBackend is used.

ShuffleManager Contract

trait ShuffleManager {
def registerShuffle[K, V, C](
shuffleId: Int,
numMaps: Int,
dependency: ShuffleDependency[K, V, C]): ShuffleHandle
def getWriter[K, V](
handle: ShuffleHandle,
mapId: Int,
context: TaskContext): ShuffleWriter[K, V]
def getReader[K, C](
handle: ShuffleHandle,
startPartition: Int,
endPartition: Int,
context: TaskContext): ShuffleReader[K, C]
def unregisterShuffle(shuffleId: Int): Boolean
def shuffleBlockResolver: ShuffleBlockResolver
def stop(): Unit
}

Note ShuffleManager is a private[spark] contract.

928
ShuffleManager — Pluggable Shuffle Systems

Table 1. ShuffleManager Contract

Method Description

registerShuffle
Executed when ShuffleDependency is created and
registers itself.

getWriter
Used when a ShuffleMapTask runs (and requests a
ShuffleWriter to write records for a partition).

Returns a ShuffleReader for a range of reduce partitions

(to read key-value records for a ShuffleDependency
dependency).
Used when:
getReader
CoGroupedRDD, ShuffledRDD, and SubtractedRDD
are requested to compute a partition (for a
ShuffleDependency dependency)

Spark SQL’s ShuffledRowRDD is requested to

compute a partition

unregisterShuffle Executed when ??? removes the metadata of a shuffle.

Used when:
1. BlockManager requests a ShuffleBlockResolver
shuffleBlockResolver
capable of retrieving shuffle block data (for a
ShuffleBlockId)
2. BlockManager requests a ShuffleBlockResolver for
local shuffle block data as bytes.

stop Used when SparkEnv stops.

Tip Review ShuffleManager sources.

Settings

929
ShuffleManager — Pluggable Shuffle Systems

Table 2. Spark Properties

Default
Spark Property Description
Value

ShuffleManager for a Spark application.

You can use a short name or the fully-qualified
class name of a custom implementation.
spark.shuffle.manager sort
The predefined aliases are sort and tungsten-
sort with
org.apache.spark.shuffle.sort.SortShuffleManager
being the one and only ShuffleManager .

Further Reading or Watching

1. (slides) Spark shuffle introduction by Raymond Liu (aka colorant).

930
SortShuffleManager — The Default Shuffle System

SortShuffleManager — The Default (And Only)

Sort-Based Shuffle System
SortShuffleManager is the one and only ShuffleManager in Spark with the short name sort

or tungsten-sort .

You can use spark.shuffle.manager Spark property to activate your own

Note
implementation of ShuffleManager contract.

Caution FIXME The internal registries

Table 1. SortShuffleManager’s Internal Registries and Counters

Name Description
numMapsForShuffle

IndexShuffleBlockResolver created when

SortShuffleManager is created and used throughout the
lifetime of the owning SortShuffleManager .

shuffleBlockResolver
NOTE: shuffleBlockResolver is part of ShuffleManager
contract.
Beside the uses due to the contract,
shuffleBlockResolver is used in unregisterShuffle and
stopped in stop .

Enable DEBUG logging level for

org.apache.spark.shuffle.sort.SortShuffleManager$ logger to see what happens
inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.shuffle.sort.SortShuffleManager$=DEBUG

Refer to Logging.

unregisterShuffle Method

Caution FIXME

Creating SortShuffleManager Instance

931
SortShuffleManager — The Default Shuffle System

SortShuffleManager takes a SparkConf.

SortShuffleManager makes sure that spark.shuffle.spill Spark property is enabled. If not you

should see the following WARN message in the logs:

WARN SortShuffleManager: spark.shuffle.spill was set to false, but this configuration

is ignored as of Spark 1.6+. Shuffle will continue to spill to disk when necessary.

SortShuffleManager initializes the internal registries and counters.

SortShuffleManager is created when SparkEnv is created (on the driver and

Note
executors) which is at the very beginning of a Spark application’s lifecycle.

Creating ShuffleHandle (For ShuffleDependency) 

—  registerShuffle Method

registerShuffle[K, V, C](
shuffleId: Int,
numMaps: Int,
dependency: ShuffleDependency[K, V, C]): ShuffleHandle

Note registerShuffle is part of ShuffleManager contract.

Caution FIXME Copy the conditions

registerShuffle returns a new ShuffleHandle that can be one of the following:

1. BypassMergeSortShuffleHandle (with ShuffleDependency[K, V, V] ) when

shouldBypassMergeSort condition holds.

2. SerializedShuffleHandle (with ShuffleDependency[K, V, V] ) when

canUseSerializedShuffle condition holds.

3. BaseShuffleHandle

Selecting ShuffleWriter For ShuffleHandle —  getWriter

Method

getWriter[K, V](
handle: ShuffleHandle,
mapId: Int,
context: TaskContext): ShuffleWriter[K, V]

932
SortShuffleManager — The Default Shuffle System

Note getWriter is part of ShuffleManager contract.

Internally, getWriter makes sure that a ShuffleHandle is associated with its numMaps in
numMapsForShuffle internal registry.

Caution FIXME Associated?! What’s that?

getWriter expects that the input handle is of type BaseShuffleHandle

(despite the signature that says that it can work with any ShuffleHandle ).
Note
Moreover, getWriter further expects that in 2 (out of 3 cases) the input
handle is a more specialized IndexShuffleBlockResolver.

getWriter then returns a new ShuffleWriter for the input ShuffleHandle :

1. UnsafeShuffleWriter for SerializedShuffleHandle.

2. BypassMergeSortShuffleWriter for BypassMergeSortShuffleHandle.

3. SortShuffleWriter for BaseShuffleHandle.

Creating BlockStoreShuffleReader For ShuffleHandle And

Reduce Partitions —  getReader Method

getReader[K, C](
handle: ShuffleHandle,
startPartition: Int,
endPartition: Int,
context: TaskContext): ShuffleReader[K, C]

Note getReader is part of ShuffleManager Contract.

getReader returns a new BlockStoreShuffleReader passing all the input parameters on to it.

getReader assumes that the input ShuffleHandle is of type

Note
BaseShuffleHandle.

Stopping SortShuffleManager —  stop Method

stop(): Unit

Note stop is part of ShuffleManager contract.

stop stops IndexShuffleBlockResolver (available as shuffleBlockResolver internal

reference).

933
SortShuffleManager — The Default Shuffle System

Considering BypassMergeSortShuffleHandle for

ShuffleHandle —  shouldBypassMergeSort Method

shouldBypassMergeSort(conf: SparkConf, dep: ShuffleDependency[_, _, _]): Boolean

shouldBypassMergeSort holds (i.e. is positive) when:

1. The input ShuffleDependency has mapSideCombine flag enabled and aggregator

defined.

2. mapSideCombine flag is disabled (i.e. false ) but the number of partitions (of the

Partitioner of the input ShuffleDependency ) is at most

spark.shuffle.sort.bypassMergeThreshold Spark property (which defaults to 200 ).

Otherwise, shouldBypassMergeSort does not hold (i.e. false ).

shouldBypassMergeSort is exclusively used when SortShuffleManager selects a

Note
ShuffleHandle (for a ShuffleDependency ).

Considering SerializedShuffleHandle for ShuffleHandle 

—  canUseSerializedShuffle Method

canUseSerializedShuffle(dependency: ShuffleDependency[_, _, _]): Boolean

canUseSerializedShuffle condition holds (i.e. is positive) when all of the following hold

(checked in that order):

1. The Serializer of the input ShuffleDependency supports relocation of serialized

objects.

2. The Aggregator of the input ShuffleDependency is not defined.

3. The number of shuffle output partitions of the input ShuffleDependency is at most the
supported maximum number (which is (1 << 24) - 1 , i.e. 16777215 ).

You should see the following DEBUG message in the logs when canUseSerializedShuffle
holds:

DEBUG Can use serialized shuffle for shuffle [id]

Otherwise, canUseSerializedShuffle does not hold and you should see one of the following
DEBUG messages:

934
SortShuffleManager — The Default Shuffle System

DEBUG Can't use serialized shuffle for shuffle [id] because the serializer, [name], do
es not support object relocation

DEBUG SortShuffleManager: Can't use serialized shuffle for shuffle [id] because an agg
regator is defined

DEBUG Can't use serialized shuffle for shuffle [id] because it has more than [number]
partitions

canUseSerializedShuffle is exclusively used when SortShuffleManager selects

Note
a ShuffleHandle (for a ShuffleDependency ).

Settings
Table 2. Spark Properties
Default
Spark Property Description
Value

The maximum number of

reduce partitions below
spark.shuffle.sort.bypassMergeThreshold 200
which SortShuffleManager
avoids merge-sorting data
if there is no map-side
aggregation either.

No longer in use.
When false the following
WARN shows in the logs
when SortShuffleManager
is created:
spark.shuffle.spill true
WARN SortShuffleManager:
spark.shuffle.spill was set
to false, but this
configuration is ignored as
of Spark 1.6+. Shuffle will
continue to spill to disk
when necessary.

935
ExternalShuffleService

ExternalShuffleService
ExternalShuffleService is an external shuffle service that serves shuffle blocks from

outside an Executor process. It runs as a standalone application and manages shuffle output
files so they are available for executors at all time. As the shuffle output files are managed
externally to the executors it offers an uninterrupted access to the shuffle output files
regardless of executors being killed or down.

You start ExternalShuffleService using start-shuffle-service.sh shell script and enable

its use by the driver and executors using spark.shuffle.service.enabled.

There is a custom external shuffle service for Spark on YARN 

Note
— YarnShuffleService.

Enable INFO logging level for org.apache.spark.deploy.ExternalShuffleService

logger to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.ExternalShuffleService=INFO

Refer to Logging.

start-shuffle-service.sh Shell Script

start-shuffle-service.sh

start-shuffle-service.sh shell script allows you to launch ExternalShuffleService . The

script is under sbin directory.

When executed, it runs sbin/spark-config.sh and bin/load-spark-env.sh shell scripts. It

then executes sbin/spark-daemon.sh with start command and the parameters:
org.apache.spark.deploy.ExternalShuffleService and 1 .

936
ExternalShuffleService

$ ./sbin/start-shuffle-service.sh
starting org.apache.spark.deploy.ExternalShuffleService, logging
to ...logs/spark-jacek-
org.apache.spark.deploy.ExternalShuffleService-1-
japila.local.out

$ tail -f ...logs/spark-jacek-
org.apache.spark.deploy.ExternalShuffleService-1-
japila.local.out
Spark Command:
/Library/Java/JavaVirtualMachines/Current/Contents/Home/bin/java
-cp
/Users/jacek/dev/oss/spark/conf/:/Users/jacek/dev/oss/spark/asse
mbly/target/scala-2.11/jars/* -Xmx1g
org.apache.spark.deploy.ExternalShuffleService
========================================
Using Spark's default log4j profile: org/apache/spark/log4j-
defaults.properties
16/06/07 08:02:02 INFO ExternalShuffleService: Started daemon
with process name: [email protected]
16/06/07 08:02:03 INFO ExternalShuffleService: Starting shuffle
service on port 7337 with useSasl = false

You can also use spark-class to launch ExternalShuffleService .

Tip spark-class org.apache.spark.deploy.ExternalShuffleService

Launching ExternalShuffleService Standalone Application 

—  main Method
When started, it executes Utils.initDaemon(log) .

Caution FIXME Utils.initDaemon(log) ? See spark-submit.

It loads default Spark properties and creates a SecurityManager .

It sets spark.shuffle.service.enabled to true (as later it is checked whether it is enabled or

not).

A ExternalShuffleService is created and started.

937
ExternalShuffleService

A shutdown hook is registered so when ExternalShuffleService is shut down, it prints the

following INFO message to the logs and the stop method is executed.

INFO ExternalShuffleService: Shutting down shuffle service.

Enable DEBUG logging level for

org.apache.spark.network.shuffle.ExternalShuffleBlockResolver logger to see what
happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.network.shuffle.ExternalShuffleBlockResolver=DEBUG

Refer to Logging.

You should see the following INFO message in the logs:

INFO ExternalShuffleBlockResolver: Registered executor [AppExecId] with [executorInfo]

You should also see the following messages when a SparkContext is closed:

INFO ExternalShuffleBlockResolver: Application [appId] removed, cleanupLocalDirs = [cl

eanupLocalDirs]
INFO ExternalShuffleBlockResolver: Cleaning up executor [AppExecId]'s [executor.localD
irs.length] local dirs
DEBUG ExternalShuffleBlockResolver: Successfully cleaned up directory: [localDir]

Creating ExternalShuffleService Instance

ExternalShuffleService requires a SparkConf and SecurityManager.

When created, it reads spark.shuffle.service.enabled (disabled by default) and

spark.shuffle.service.port (defaults to 7337 ) configuration settings. It also checks whether
authentication is enabled.

Caution FIXME Review securityManager.isAuthenticationEnabled()

It then creates a TransportConf (as transportConf ).

It creates a ExternalShuffleBlockHandler (as blockHandler ) and TransportContext (as

transportContext ).

Caution FIXME TransportContext?

938
ExternalShuffleService

No internal TransportServer (as server ) is created.

Starting ExternalShuffleService —  start Method

start(): Unit

start starts a ExternalShuffleService .

When start is executed, you should see the following INFO message in the logs:

INFO ExternalShuffleService: Starting shuffle service on port [port] with useSasl = [u

seSasl]

If useSasl is enabled, a SaslServerBootstrap is created.

Caution FIXME SaslServerBootstrap?

The internal server reference (a TransportServer ) is created (which will attempt to bind to
port ).

port is set up by spark.shuffle.service.port or defaults to 7337 when

Note
ExternalShuffleService is created.

Stopping ExternalShuffleService  —  stop Method

stop(): Unit

stop closes the internal server reference and clears it (i.e. sets it to null ).

ExternalShuffleBlockHandler
ExternalShuffleBlockHandler is a RpcHandler (i.e. a handler for sendRPC() messages sent

by TransportClient s).

When created, ExternalShuffleBlockHandler requires a OneForOneStreamManager and

TransportConf with a registeredExecutorFile to create a ExternalShuffleBlockResolver .

It handles two BlockTransferMessage messages: OpenBlocks and RegisterExecutor.

939
ExternalShuffleService

Enable TRACE logging level for

org.apache.spark.network.shuffle.ExternalShuffleBlockHandler logger to see what
happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.network.shuffle.ExternalShuffleBlockHandler=TRACE

Refer to Logging.

handleMessage Method

handleMessage(
BlockTransferMessage msgObj,
TransportClient client,
RpcResponseCallback callback)

handleMessage handles two types of BlockTransferMessage messages:

OpenBlocks

RegisterExecutor

For any other BlockTransferMessage message it throws a UnsupportedOperationException :

Unexpected message: [msgObj]

OpenBlocks

OpenBlocks(String appId, String execId, String[] blockIds)

When OpenBlocks is received, handleMessage authorizes the client .

Caution FIXME checkAuth ?

It then gets block data for each block id in blockIds (using ExternalShuffleBlockResolver).

Finally, it registers a stream and does callback.onSuccess with a serialized byte buffer (for
the streamId and the number of blocks in msg ).

Caution FIXME callback.onSuccess ?

You should see the following TRACE message in the logs:

940
ExternalShuffleService

TRACE Registered streamId [streamId] with [length] buffers for client [clientId] from
host [remoteAddress]

RegisterExecutor

RegisterExecutor(String appId, String execId, ExecutorShuffleInfo executorInfo)

RegisterExecutor

ExternalShuffleBlockResolver

Caution FIXME

getBlockData Method

ManagedBuffer getBlockData(String appId, String execId, String blockId)

getBlockData parses blockId (in the format of shuffle_[shuffleId]_[mapId]_[reduceId] )

and returns the FileSegmentManagedBuffer that corresponds to

shuffle_[shuffleId]_[mapId]_0.data .

getBlockData splits blockId to 4 parts using _ (underscore). It works exclusively with

shuffle block ids with the other three parts being shuffleId , mapId , and reduceId .

It looks up an executor (i.e. a ExecutorShuffleInfo in executors private registry) for appId

and execId to search for a ManagedBuffer.

The ManagedBuffer is indexed using a binary file shuffle_[shuffleId]_[mapId]_0.index (that

contains offset and length of the buffer) with a data file being
shuffle_[shuffleId]_[mapId]_0.data (that is returned as FileSegmentManagedBuffer ).

It throws a IllegalArgumentException for block ids with less than four parts:

Unexpected block id format: [blockId]

or for non- shuffle block ids:

Expected shuffle block id, got: [blockId]

It throws a RuntimeException when no ExecutorShuffleInfo could be found.

941
ExternalShuffleService

Executor is not registered (appId=[appId], execId=[execId])"

Settings
Table 1. Spark Properties
Default
Spark Property Description
Value
Enables External Shuffle Service.
When true , the driver registers
itself with the shuffle service.
Used to enable for dynamic
allocation of executors and in
spark.shuffle.service.enabled false CoarseMesosSchedulerBackend to
instantiate
MesosExternalShuffleClient.
Explicitly disabled for
LocalSparkCluster (and any
attempts to set it are ignored).

spark.shuffle.service.port 7337

942
OneForOneStreamManager

OneForOneStreamManager
Caution FIXME

registerStream Method

long registerStream(String appId, Iterator<ManagedBuffer> buffers)

Caution FIXME

943
ShuffleBlockResolver

ShuffleBlockResolver
ShuffleBlockResolver is used to find shuffle block data.

The one and only implementation of ShuffleBlockResolver contract in Spark is

Note
IndexShuffleBlockResolver.

ShuffleBlockResolver is used exclusively in BlockManager to find shuffle block

Note
data.

ShuffleBlockResolver Contract

trait ShuffleBlockResolver {
def getBlockData(blockId: ShuffleBlockId): ManagedBuffer
def stop(): Unit
}

Note ShuffleBlockResolver is a private[spark] contract.

Table 1. ShuffleBlockResolver Contract

Method Description

Used when BlockManager is requested to find shuffle

getBlockData block data and later (duplicate?) for local shuffle block
data as serialized bytes.

stop Used when SortShuffleManager stops.

944
IndexShuffleBlockResolver

IndexShuffleBlockResolver
IndexShuffleBlockResolver is the one and only ShuffleBlockResolver in Spark.

IndexShuffleBlockResolver manages shuffle block data and uses shuffle index files for

faster shuffle data access. IndexShuffleBlockResolver can write a shuffle block index and
data file, find and remove shuffle index and data files per shuffle and map.

Note Shuffle block data files are more often referred as map outputs files.

IndexShuffleBlockResolver is managed exclusively by SortShuffleManager (so

BlockManager can access shuffle block data).

Figure 1. SortShuffleManager creates IndexShuffleBlockResolver

IndexShuffleBlockResolver is later passed in when SortShuffleManager creates a

ShuffleWriter for ShuffleHandle .

Table 1. IndexShuffleBlockResolver’s Internal Properties

Name Initial Value Description

Used when IndexShuffleBlockResolver

TransportConf for
transportConf creates a ManagedBuffer for a
shuffle module
ShuffleBlockId .

Creating IndexShuffleBlockResolver Instance

IndexShuffleBlockResolver takes the following when created:

1. SparkConf,

2. BlockManager (default: unspecified and SparkEnv is used to access one)

IndexShuffleBlockResolver initializes the internal properties.

IndexShuffleBlockResolver is created exclusively when SortShuffleManager is

Note
created.

945
IndexShuffleBlockResolver

Writing Shuffle Index and Data Files 

—  writeIndexFileAndCommit Method

writeIndexFileAndCommit(
shuffleId: Int,
mapId: Int,
lengths: Array[Long],
dataTmp: File): Unit

Internally, writeIndexFileAndCommit first finds the index file for the input shuffleId and
mapId .

writeIndexFileAndCommit creates a temporary file for the index file (in the same directory)

and writes offsets (as the moving sum of the input lengths starting from 0 to the final offset
at the end for the end of the output file).

Note The offsets are the sizes in the input lengths exactly.

Figure 2. writeIndexFileAndCommit and offsets in a shuffle index file

writeIndexFileAndCommit requests a shuffle block data file for the input shuffleId and

mapId .

writeIndexFileAndCommit checks if the given index and data files match each other (aka

consistency check).

946
IndexShuffleBlockResolver

If the consistency check fails, it means that another attempt for the same task has already
written the map outputs successfully and so the input dataTmp and temporary index files are
deleted (as no longer correct).

If the consistency check succeeds, the existing index and data files are deleted (if they exist)
and the temporary index and data files become "official", i.e. renamed to their final names.

In case of any IO-related exception, writeIndexFileAndCommit throws a IOException with

the messages:

fail to rename file [indexTmp] to [indexFile]

or

fail to rename file [dataTmp] to [dataFile]

writeIndexFileAndCommit is used when ShuffleWriter is requested to write

Note records to shuffle system, i.e. SortShuffleWriter, BypassMergeSortShuffleWriter,
and UnsafeShuffleWriter.

Creating ManagedBuffer to Read Shuffle Block Data File 

—  getBlockData Method

getBlockData(blockId: ShuffleBlockId): ManagedBuffer

Note getBlockData is part of ShuffleBlockResolver contract.

Internally, getBlockData finds the index file for the input shuffle blockId .

Note ShuffleBlockId knows shuffleId and mapId .

getBlockData discards blockId.reduceId bytes of data from the index file.

getBlockData uses Guava’s com.google.common.io.ByteStreams to skip the

Note
bytes.

getBlockData reads the start and end offsets from the index file and then creates a

FileSegmentManagedBuffer to read the data file for the offsets (using transportConf internal

property).

The start and end offsets are the offset and the length of the file segment for the
Note
block data.

947
IndexShuffleBlockResolver

In the end, getBlockData closes the index file.

Checking Consistency of Shuffle Index and Data Files and

Returning Block Lengths —  checkIndexAndDataFile
Internal Method

checkIndexAndDataFile(index: File, data: File, blocks: Int): Array[Long]

checkIndexAndDataFile first checks if the size of the input index file is exactly the input

blocks multiplied by 8 .

checkIndexAndDataFile returns null when the numbers, and hence the shuffle index and

data files, don’t match.

checkIndexAndDataFile reads the shuffle index file and converts the offsets into lengths of

each block.

checkIndexAndDataFile makes sure that the size of the input shuffle data file is exactly the

sum of the block lengths.

checkIndexAndDataFile returns the block lengths if the numbers match, and null

otherwise.

checkIndexAndDataFile is used exclusively when IndexShuffleBlockResolver

Note
writes shuffle index and data files.

Requesting Shuffle Block Index File (from

DiskBlockManager) —  getIndexFile Internal Method

getIndexFile(shuffleId: Int, mapId: Int): File

getIndexFile requests BlockManager for the current DiskBlockManager .

getIndexFile uses SparkEnv to access the current BlockManager unless

Note
specified when IndexShuffleBlockResolver is created.

getIndexFile then requests DiskBlockManager for the shuffle index file given the input

shuffleId and mapId (as ShuffleIndexBlockId )

getIndexFile is used when IndexShuffleBlockResolver writes shuffle index

Note and data files, creates a ManagedBuffer to read a shuffle block data file, and
ultimately removes the shuffle index and data files.

948
IndexShuffleBlockResolver

Requesting Shuffle Block Data File —  getDataFile

Method

getDataFile(shuffleId: Int, mapId: Int): File

getDataFile requests BlockManager for the current DiskBlockManager .

getDataFile uses SparkEnv to access the current BlockManager unless

Note
specified when IndexShuffleBlockResolver is created.

getDataFile then requests DiskBlockManager for the shuffle block data file given the input

shuffleId , mapId , and the special reduce id 0 (as ShuffleDataBlockId ).

getDataFile is used when:

1. IndexShuffleBlockResolver writes an index file, creates a ManagedBuffer

for ShuffleBlockId , and removes the data and index files that contain the
Note output data from one map
2. ShuffleWriter is requested to write records to shuffle system, i.e.
SortShuffleWriter, BypassMergeSortShuffleWriter, and
UnsafeShuffleWriter.

Removing Shuffle Index and Data Files (For Single Map) 

—  removeDataByMap Method

removeDataByMap(shuffleId: Int, mapId: Int): Unit

removeDataByMap finds and deletes the shuffle data for the input shuffleId and mapId first

followed by finding and deleting the shuffle data index file.

When removeDataByMap fails deleting the files, you should see a WARN message in the logs.

WARN Error deleting data [path]

or

WARN Error deleting index [path]

removeDataByMap is used exclusively when SortShuffleManager unregisters a

Note
shuffle, i.e. removes a shuffle from a shuffle system.

949
IndexShuffleBlockResolver

Stopping IndexShuffleBlockResolver —  stop Method

stop(): Unit

Note stop is part of ShuffleBlockResolver contract.

stop is a noop operation, i.e. does nothing when called.

950
ShuffleWriter

ShuffleWriter
Caution FIXME

ShuffleWriter Contract

abstract class ShuffleWriter[K, V] {

def write(records: Iterator[Product2[K, V]]): Unit
def stop(success: Boolean): Option[MapStatus]
}

Note ShuffleWriter is a private[spark] contract.

Table 1. ShuffleWriter Contract

Method Description
Writes a sequence of records (for a RDD partition) to a
write shuffle system when a ShuffleMapTask writes its
execution result.

Closes a ShuffleWriter and returns MapStatus if the

writing completed successfully.
stop
Used when a ShuffleMapTask finishes execution with the
input success flag to match the status of the task
execution.

951
BypassMergeSortShuffleWriter

BypassMergeSortShuffleWriter
BypassMergeSortShuffleWriter is a ShuffleWriter that ShuffleMapTask uses to write records

into one single shuffle block data file when the task runs for a ShuffleDependency .

Figure 1. BypassMergeSortShuffleWriter writing records (for ShuffleMapTask) using

DiskBlockObjectWriters
BypassMergeSortShuffleWriter is created exclusively when SortShuffleManager selects a

ShuffleWriter (for a BypassMergeSortShuffleHandle).

Review the conditions SortShuffleManager uses to select

Tip
BypassMergeSortShuffleHandle for a ShuffleHandle .

952
BypassMergeSortShuffleWriter

Table 1. BypassMergeSortShuffleWriter’s Internal Registries and Counters

Name Description
numPartitions FIXME

partitionWriters FIXME

partitionWriterSegments FIXME

IndexShuffleBlockResolver.
shuffleBlockResolver Initialized when BypassMergeSortShuffleWriter is created.
Used when BypassMergeSortShuffleWriter writes records.

MapStatus that BypassMergeSortShuffleWriter returns

when stopped
Initialized every time BypassMergeSortShuffleWriter
mapStatus writes records.
Used when BypassMergeSortShuffleWriter stops (with
success enabled) as a marker if any records were
written and returned if they did.

Temporary array of partition lengths after records are

written to a shuffle system.
Initialized every time BypassMergeSortShuffleWriter
partitionLengths
writes records before passing it in to
IndexShuffleBlockResolver). After
IndexShuffleBlockResolver finishes, it is used to initialize
mapStatus internal property.

Internal flag that controls the use of Java New I/O when
BypassMergeSortShuffleWriter concatenates per-partition
shuffle files into a single shuffle block data file.
transferToEnabled
Specified when BypassMergeSortShuffleWriter is created
and controlled by spark.file.transferTo Spark property.
Enabled by default.

953
BypassMergeSortShuffleWriter

Enable ERROR logging level for

org.apache.spark.shuffle.sort.BypassMergeSortShuffleWriter logger to see what
happens in BypassMergeSortShuffleWriter .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.shuffle.sort.BypassMergeSortShuffleWriter=ERROR

Refer to Logging.

Creating BypassMergeSortShuffleWriter Instance

BypassMergeSortShuffleWriter takes the following when created:

1. BlockManager

2. IndexShuffleBlockResolver

3. BypassMergeSortShuffleHandle

4. mapId

5. TaskContext

6. SparkConf

BypassMergeSortShuffleWriter uses spark.shuffle.file.buffer (for fileBufferSize as 32k by

default) and spark.file.transferTo (for transferToEnabled internal flag which is enabled by

default) Spark properties.

BypassMergeSortShuffleWriter initializes the internal registries and counters.

Writing Records (Into One Single Shuffle Block Data File) 

—  write Method

void write(Iterator<Product2<K, V>> records) throws IOException

write is part of ShuffleWriter contract to write a sequence of records to a

Note
shuffle system.

Internally, when the input records iterator has no more records, write creates an empty
partitionLengths internal array of numPartitions size.

954
BypassMergeSortShuffleWriter

write then requests the internal IndexShuffleBlockResolver to write shuffle index and data

files (with dataTmp as null ) and sets the internal mapStatus (with the address of
BlockManager in use and partitionLengths).

However, when there are records to write, write creates a new Serializer.

Serializer was specified when BypassMergeSortShuffleWriter was created and

Note
is exactly the Serializer of the ShuffleDependency.

write initializes partitionWriters internal array of DiskBlockObjectWriters for every partition.

For every partition, write requests DiskBlockManager for a temporary shuffle block and its
file.

write uses BlockManager to access DiskBlockManager . BlockManager was

Note
specified when BypassMergeSortShuffleWriter was created.

write requests BlockManager for a DiskBlockObjectWriter (for the temporary blockId

and file , SerializerInstance, fileBufferSize and writeMetrics ).

After DiskBlockObjectWriters were created, write increments shuffle write time.

write initializes partitionWriterSegments with FileSegment for every partition.

write takes records serially, i.e. record by record, and, after computing the partition for a

key, requests the corresponding DiskBlockObjectWriter to write them.

write uses partitionWriters internal array of DiskBlockObjectWriter indexed

Note
by partition number.

write uses the Partitioner from the ShuffleDependency for which

Note
BypassMergeSortShuffleWriter was created.

write initializes partitionWriters with numPartitions number of

Note
DiskBlockObjectWriters .

After all the records have been written, write requests every DiskBlockObjectWriter to
commitAndGet and saves the commit results in partitionWriterSegments. write closes

every DiskBlockObjectWriter .

write requests IndexShuffleBlockResolver for the shuffle block data file for shuffleId

and mapId .

IndexShuffleBlockResolver was defined when BypassMergeSortShuffleWriter

Note
was created.

955
BypassMergeSortShuffleWriter

write creates a temporary shuffle block data file and writes the per-partition shuffle files to

it.

This is the moment when BypassMergeSortShuffleWriter concatenates per-

Note
partition shuffle file segments into one single map shuffle data file.

In the end, write requests IndexShuffleBlockResolver to write shuffle index and data files
for the shuffleId and mapId (with partitionLengths and the temporary file) and creates a
new mapStatus (with the location of the BlockManager and partitionLengths).

Concatenating Per-Partition Files Into Single File (and

Tracking Write Time) —  writePartitionedFile Internal
Method

long[] writePartitionedFile(File outputFile) throws IOException

writePartitionedFile creates a file output stream for the input outputFile in append

mode.

writePartitionedFile uses Java’s java.io.FileOutputStream to create a file

Note
output stream.

writePartitionedFile starts tracking write time (as writeStartTime ).

For every numPartitions partition, writePartitionedFile takes the file from the FileSegment
(from partitionWriterSegments) and creates a file input stream to read raw bytes.

writePartitionedFile uses Java’s java.io.FileInputStream to create a file input

Note
stream.

writePartitionedFile then copies the raw bytes from each partition segment input stream

to outputFile (possibly using Java New I/O per transferToEnabled flag set when
BypassMergeSortShuffleWriter was created) and records the length of the shuffle data file (in

lengths internal array).

transferToEnabled is controlled by spark.file.transferTo Spark property and is

Note
enabled (i.e. true ) by default.

In the end, writePartitionedFile increments shuffle write time, clears partitionWriters array
and returns the lengths of the shuffle data files per partition.

writePartitionedFile uses ShuffleWriteMetrics to track shuffle write time that

Note
was created when BypassMergeSortShuffleWriter was created.

956
BypassMergeSortShuffleWriter

writePartitionedFile is used exclusively when BypassMergeSortShuffleWriter

Note
writes records.

Copying Raw Bytes Between Input Streams (Possibly Using

Java New I/O) —  Utils.copyStream Method

copyStream(
in: InputStream,
out: OutputStream,
closeStreams: Boolean = false,
transferToEnabled: Boolean = false): Long

copyStream branches off depending on the type of in and out streams, i.e. whether they

are both FileInputStream with transferToEnabled input flag is enabled.

If they are both FileInputStream with transferToEnabled enabled, copyStream gets their
FileChannels and transfers bytes from the input file to the output file and counts the number

of bytes, possibly zero, that were actually transferred.

copyStream uses Java’s java.nio.channels.FileChannel to manage file

Note
channels.

If either in and out input streams are not FileInputStream or transferToEnabled flag is
disabled (default), copyStream reads data from in to write to out and counts the number
of bytes written.

copyStream can optionally close in and out streams (depending on the input

closeStreams  — disabled by default).

Utils.copyStream is used when BypassMergeSortShuffleWriter writes records

Note
into one single shuffle block data file (among other places).

Note Utils.copyStream is here temporarily (until I find a better place).

Visit the official web site of JSR 51: New I/O APIs for the Java Platform and read
Tip
up on java.nio package.

957
SortShuffleWriter

SortShuffleWriter — Fallback ShuffleWriter
SortShuffleWriter is a ShuffleWriter that is used when SortShuffleManager returns a

ShuffleWriter for ShuffleHandle (and the more specialized BypassMergeSortShuffleWriter

and UnsafeShuffleWriter could not be used).

SortShuffleWriter is parameterized by types for K keys, V values, and C

Note
combiner values.

Table 1. SortShuffleWriter’s Internal Registries and Counters

Name Description
MapStatus the SortShuffleWriter has recently persisted
(as a shuffle partitioned file in disk store).
mapStatus
NOTE: Since write does not return a value, mapStatus
attribute is used to be returned when SortShuffleWriter
is closed.

stopping Internal flag to mark that SortShuffleWriter is closed.

Enable ERROR logging level for org.apache.spark.shuffle.sort.SortShuffleWriter

logger to see what happens in SortShuffleWriter .
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.shuffle.sort.SortShuffleWriter=ERROR

Refer to Logging.

Creating SortShuffleWriter Instance

SortShuffleWriter takes the following when created:

1. IndexShuffleBlockResolver

2. BaseShuffleHandle

3. mapId  — the mapper task id

4. TaskContext

SortShuffleWriter is created when SortShuffleManager returns a

Note
ShuffleWriter for the fallback BaseShuffleHandle .

958
SortShuffleWriter

Writing Records Into Shuffle Partitioned File In Disk Store 

—  write Method

write(records: Iterator[Product2[K, V]]): Unit

write is part of ShuffleWriter contract to write a sequence of records (for a

Note
RDD partition).

Internally, write creates a ExternalSorter with the types K, V, C or K, V, V depending

on mapSideCombine flag of the ShuffleDependency being enabled or not, respectively.

ShuffleDependency is defined when SortShuffleWriter is created (as the

Note
dependency of BaseShuffleHandle ).

write makes sure that Aggregator is defined for ShuffleDependency when

Note
mapSideCombine flag is enabled.

write inserts all the records to ExternalSorter

write requests IndexShuffleBlockResolver for the shuffle data output file (for the

ShuffleDependency and mapId ) and creates a temporary file for the shuffle data file in the
same directory.

write creates a ShuffleBlockId (for the ShuffleDependency and mapId and the special

IndexShuffleBlockResolver.NOOP_REDUCE_ID reduce id).

write requests ExternalSorter to write all the records (previously inserted in) into the

temporary partitioned file in the disk store.

write requests IndexShuffleBlockResolver to write an index file (for the temporary

partitioned file).

write creates a MapStatus (with the location of the shuffle server that serves the

executor’s shuffle files and the sizes of the shuffle partitioned file’s partitions).

Note The newly-created MapStatus is available as mapStatus internal attribute.

write does not handle exceptions so when they occur, they will break the
Note
processing.

In the end, write deletes the temporary partitioned file. You may see the following ERROR
message in the logs if write did not manage to do so:

ERROR Error while deleting temp file [path]

959
SortShuffleWriter

Closing SortShuffleWriter (and Calculating MapStatus) 

—  stop Method

stop(success: Boolean): Option[MapStatus]

stop is part of ShuffleWriter contract to close itself (and return the last written
Note
MapStatus).

stop turns stopping flag on and returns the internal mapStatus if the input success is

enabled.

Otherwise, when stopping flag is already enabled or the input success is disabled, stop
returns no MapStatus (i.e. None ).

In the end, stop stops the ExternalSorter and increments the shuffle write time task
metrics.

960
UnsafeShuffleWriter — ShuffleWriter for SerializedShuffleHandle

UnsafeShuffleWriter — ShuffleWriter for
SerializedShuffleHandle
UnsafeShuffleWriter is a ShuffleWriter that is used to write records (i.e. key-value pairs).

UnsafeShuffleWriter is chosen when SortShuffleManager is requested for a ShuffleWriter

for a SerializedShuffleHandle.

UnsafeShuffleWriter can use a specialized NIO-based merge procedure that avoids extra

serialization/deserialization.

Table 1. UnsafeShuffleWriter’s Internal Properties

Name Initial Value Description
ShuffleExternalSorter
Initialized when UnsafeShuffleWriter
opens (which is when
UnsafeShuffleWriter is created) and
destroyed when it closes internal
resources and writes spill files merged.
sorter (uninitialized)
Used when UnsafeShuffleWriter inserts
a record into ShuffleExternalSorter ,
writes records, forceSorterToSpill,
updatePeakMemoryUsed, closes internal
resources and writes spill files merged,
stops.

Enable ERROR or DEBUG logging levels for

org.apache.spark.shuffle.sort.UnsafeShuffleWriter logger to see what happens
in UnsafeShuffleWriter .
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.shuffle.sort.UnsafeShuffleWriter=DEBUG

Refer to Logging.

mergeSpillsWithTransferTo Method

Caution FIXME

forceSorterToSpill Method

961
UnsafeShuffleWriter — ShuffleWriter for SerializedShuffleHandle

Caution FIXME

mergeSpills Method

Caution FIXME

updatePeakMemoryUsed Method

Caution FIXME

Writing Records —  write Method

void write(Iterator<Product2<K, V>> records) throws IOException

Note write is part of ShuffleWriter contract.

Internally, write traverses the input sequence of records (for a RDD partition) and
insertRecordIntoSorter one by one. When all the records have been processed, write
closes internal resources and writes spill files merged.

In the end, write requests ShuffleExternalSorter to clean after itself.

Caution FIXME

Stopping UnsafeShuffleWriter —  stop Method

Option<MapStatus> stop(boolean success)

Caution FIXME

Note stop is part of ShuffleWriter contract.

Creating UnsafeShuffleWriter Instance

UnsafeShuffleWriter takes the following when created:

1. BlockManager

2. IndexShuffleBlockResolver

962
UnsafeShuffleWriter — ShuffleWriter for SerializedShuffleHandle

3. TaskMemoryManager

4. SerializedShuffleHandle

5. mapId

6. TaskContext

7. SparkConf

UnsafeShuffleWriter makes sure that the number of shuffle output partitions (of the

ShuffleDependency of the input SerializedShuffleHandle ) is at most (1 << 24) - 1 , i.e.

16777215 .

The number of shuffle output partitions is first enforced when

Note SortShuffleManager checks if SerializedShuffleHandle can be used for
ShuffleHandle (that eventually leads to UnsafeShuffleWriter ).

UnsafeShuffleWriter uses spark.file.transferTo and spark.shuffle.sort.initialBufferSize Spark

properties to initialize transferToEnabled and initialSortBufferSize attributes,

respectively.

If the number of shuffle output partitions is greater than the maximum, UnsafeShuffleWriter
throws a IllegalArgumentException .

UnsafeShuffleWriter can only be used for shuffles with at most 16777215 reduce partiti
ons

UnsafeShuffleWriter is created exclusively when SortShuffleManager selects a

Note
ShuffleWriter (for a SerializedShuffleHandle).

Opening UnsafeShuffleWriter (i.e. Creating

ShuffleExternalSorter and SerializationStream) —  open
Internal Method

void open() throws IOException

open makes sure that the internal reference to ShuffleExternalSorter (as sorter ) is not

defined and creates one itself.

open creates a new byte array output stream (as serBuffer ) with the buffer capacity of

1M .

963
UnsafeShuffleWriter — ShuffleWriter for SerializedShuffleHandle

open creates a new SerializationStream for the new byte array output stream using

SerializerInstance.

SerializerInstance was defined when UnsafeShuffleWriter was created (and

Note
is exactly the one used to create the ShuffleDependency ).

Note open is used exclusively when UnsafeShuffleWriter is created.

Inserting Record Into ShuffleExternalSorter 

—  insertRecordIntoSorter Method

void insertRecordIntoSorter(Product2<K, V> record)

throws IOException

insertRecordIntoSorter calculates the partition for the key of the input record .

Note Partitioner is defined when UnsafeShuffleWriter is created.

insertRecordIntoSorter then writes the key and the value of the input record to

SerializationStream and calculates the size of the serialized buffer.

Note SerializationStream is created when UnsafeShuffleWriter opens.

In the end, insertRecordIntoSorter inserts the serialized buffer to ShuffleExternalSorter

(as Platform.BYTE_ARRAY_OFFSET ).

Note ShuffleExternalSorter is created when UnsafeShuffleWriter opens.

insertRecordIntoSorter is used exclusively when UnsafeShuffleWriter writes

Note
records.

Closing Internal Resources and Writing Spill Files Merged 

—  closeAndWriteOutput Method

void closeAndWriteOutput() throws IOException

closeAndWriteOutput first updates peak memory used.

closeAndWriteOutput removes the internal ByteArrayOutputStream and SerializationStream.

closeAndWriteOutput requests ShuffleExternalSorter to close itself and return SpillInfo

metadata.

964
UnsafeShuffleWriter — ShuffleWriter for SerializedShuffleHandle

closeAndWriteOutput removes the internal ShuffleExternalSorter .

closeAndWriteOutput requests IndexShuffleBlockResolver for the data file for the

shuffleId and mapId .

closeAndWriteOutput creates a temporary file to merge spill files, deletes them afterwards,

and requests IndexShuffleBlockResolver to write index file and commit.

closeAndWriteOutput creates a MapStatus with the location of the executor’s BlockManager

and partition lengths in the merged file.

If there is an issue with deleting spill files, you should see the following ERROR message in
the logs:

ERROR Error while deleting spill file [path]

If there is an issue with deleting the temporary file, you should see the following ERROR
message in the logs:

ERROR Error while deleting temp file [path]

closeAndWriteOutput is used exclusively when UnsafeShuffleWriter writes

Note
records.

Settings
Table 2. Spark Properties
Default
Spark Property Description
Value
spark.file.transferTo true Controls whether…​FIXME

4096
spark.shuffle.sort.initialBufferSize
(bytes) Default initial sort buffer size

965
BaseShuffleHandle — Fallback Shuffle Handle

BaseShuffleHandle — Fallback Shuffle Handle

BaseShuffleHandle is a ShuffleHandle that is created solely to capture the parameters

when SortShuffleManager is requested for a ShuffleHandle (for a ShuffleDependency ):

1. shuffleId

2. numMaps

3. ShuffleDependency

BaseShuffleHandle is the last possible choice when SortShuffleManager is

Note requested for a ShuffleHandle (after BypassMergeSortShuffleHandle and
SerializedShuffleHandle have already been considered and failed the check).

966
BaseShuffleHandle — Fallback Shuffle Handle

// Start a Spark application, e.g. spark-shell, with the Spark properties to trigger s
election of BaseShuffleHandle:
// 1. spark.shuffle.spill.numElementsForceSpillThreshold=1
// 2. spark.shuffle.sort.bypassMergeThreshold=1

// numSlices > spark.shuffle.sort.bypassMergeThreshold

scala> val rdd = sc.parallelize(0 to 4, numSlices = 2).groupBy(_ % 2)
rdd: org.apache.spark.rdd.RDD[(Int, Iterable[Int])] = ShuffledRDD[2] at groupBy at <co
nsole>:24

scala> rdd.dependencies
DEBUG SortShuffleManager: Can't use serialized shuffle for shuffle 0 because an aggreg
ator is defined
res0: Seq[org.apache.spark.Dependency[_]] = List(org.apache.spark.ShuffleDependency@11
60c54b)

scala> rdd.getNumPartitions
res1: Int = 2

scala> import org.apache.spark.ShuffleDependency

import org.apache.spark.ShuffleDependency

scala> val shuffleDep = rdd.dependencies(0).asInstanceOf[ShuffleDependency[Int, Int, I

nt]]
shuffleDep: org.apache.spark.ShuffleDependency[Int,Int,Int] = org.apache.spark.Shuffle
Dependency@1160c54b

// mapSideCombine is disabled
scala> shuffleDep.mapSideCombine
res2: Boolean = false

// aggregator defined
scala> shuffleDep.aggregator
res3: Option[org.apache.spark.Aggregator[Int,Int,Int]] = Some(Aggregator(<function1>,<
function2>,<function2>))

// the number of reduce partitions < spark.shuffle.sort.bypassMergeThreshold

scala> shuffleDep.partitioner.numPartitions
res4: Int = 2

scala> shuffleDep.shuffleHandle
res5: org.apache.spark.shuffle.ShuffleHandle = org.apache.spark.shuffle.BaseShuffleHan
dle@22b0fe7e

967
BypassMergeSortShuffleHandle — Marker Interface for Bypass Merge Sort Shuffle Handles

BypassMergeSortShuffleHandle — Marker
Interface for Bypass Merge Sort Shuffle
Handles
BypassMergeSortShuffleHandles is a BaseShuffleHandle with no additional methods or fields

and serves only to identify the choice of bypass merge sort shuffle.

Like BaseShuffleHandle, BypassMergeSortShuffleHandles takes shuffleId , numMaps , and a

ShuffleDependency.

BypassMergeSortShuffleHandle is created when SortShuffleManager is requested for a

ShuffleHandle (for a ShuffleDependency ).

Review the conditions SortShuffleManager uses to select

Note
BypassMergeSortShuffleHandle for a ShuffleHandle .

968
BypassMergeSortShuffleHandle — Marker Interface for Bypass Merge Sort Shuffle Handles

scala> val rdd = sc.parallelize(0 to 8).groupBy(_ % 3)

rdd: org.apache.spark.rdd.RDD[(Int, Iterable[Int])] = ShuffledRDD[2] at groupBy at <co
nsole>:24

scala> rdd.dependencies
res0: Seq[org.apache.spark.Dependency[_]] = List(org.apache.spark.ShuffleDependency@65
5875bb)

scala> rdd.getNumPartitions
res1: Int = 8

scala> import org.apache.spark.ShuffleDependency

import org.apache.spark.ShuffleDependency

scala> val shuffleDep = rdd.dependencies(0).asInstanceOf[ShuffleDependency[Int, Int, I

nt]]
shuffleDep: org.apache.spark.ShuffleDependency[Int,Int,Int] = org.apache.spark.Shuffle
Dependency@655875bb

// mapSideCombine is disabled
scala> shuffleDep.mapSideCombine
res2: Boolean = false

// aggregator defined
scala> shuffleDep.aggregator
res3: Option[org.apache.spark.Aggregator[Int,Int,Int]] = Some(Aggregator(<function1>,<
function2>,<function2>))

// spark.shuffle.sort.bypassMergeThreshold == 200
// the number of reduce partitions < spark.shuffle.sort.bypassMergeThreshold
scala> shuffleDep.partitioner.numPartitions
res4: Int = 8

scala> shuffleDep.shuffleHandle
res5: org.apache.spark.shuffle.ShuffleHandle = org.apache.spark.shuffle.sort.BypassMer
geSortShuffleHandle@68893394

969
SerializedShuffleHandle — Marker Interface for Serialized Shuffle Handles

SerializedShuffleHandle — Marker Interface for

Serialized Shuffle Handles
SerializedShuffleHandle is a BaseShuffleHandle with no additional methods or fields and

serves only to identify the choice of a serialized shuffle.

Like BaseShuffleHandle, SerializedShuffleHandle takes shuffleId , numMaps , and a

ShuffleDependency.

SerializedShuffleHandle is created when SortShuffleManager is requested for a

ShuffleHandle (for a ShuffleDependency ) and the conditions hold (but for

BypassMergeSortShuffleHandle do not which are checked first).

970
ShuffleReader

ShuffleReader
ShuffleReader is a contract of shuffle readers to read combined key-value records for a

reduce task.

package org.apache.spark.shuffle

trait ShuffleReader[K, C] {
def read(): Iterator[Product2[K, C]]
}

Note ShuffleReader is a private[spark] contract.

Table 1. ShuffleReader Contract

Method Description
Reading combined key-value records for a reduce task
Used when:
CoGroupedRDD, ShuffledRDD, and SubtractedRDD
read
are requested to compute a partition (for a
ShuffleDependency dependency)

Spark SQL’s ShuffledRowRDD is requested to

compute a partition

BlockStoreShuffleReader is the one and only known ShuffleReader in Apache

Note
Spark.

971
BlockStoreShuffleReader

BlockStoreShuffleReader
BlockStoreShuffleReader is the one and only known ShuffleReader that reads the combined

key-values for the reduce task (for a range of start and end reduce partitions) from a shuffle
by requesting them from block managers.

BlockStoreShuffleReader is created exclusively when SortShuffleManager is requested for

the ShuffleReader for a range of reduce partitions.

Reading Combined Key-Value Records For Reduce Task

(using ShuffleBlockFetcherIterator) —  read Method

read(): Iterator[Product2[K, C]]

Note read is part of ShuffleReader Contract.

Internally, read first creates a ShuffleBlockFetcherIterator (passing in the values of

spark.reducer.maxSizeInFlight, spark.reducer.maxReqsInFlight and
spark.shuffle.detectCorrupt Spark properties).

read uses BlockManager to access ShuffleClient to create

Note
ShuffleBlockFetcherIterator .

read uses MapOutputTracker to find the BlockManagers with the shuffle blocks
Note
and sizes to create ShuffleBlockFetcherIterator .

read creates a new SerializerInstance (using Serializer from ShuffleDependency).

read creates a key/value iterator by deserializeStream every shuffle block stream.

read updates the context task metrics for each record read.

read uses CompletionIterator (to count the records read) and

Note
InterruptibleIterator (to support task cancellation).

If the ShuffleDependency has an Aggregator defined, read wraps the current iterator
inside an iterator defined by Aggregator.combineCombinersByKey (for mapSideCombine
enabled) or Aggregator.combineValuesByKey otherwise.

run reports an exception when ShuffleDependency has no Aggregator

Note
defined with mapSideCombine flag enabled.

972
BlockStoreShuffleReader

For keyOrdering defined in ShuffleDependency , run does the following:

1. Creates an ExternalSorter

2. Inserts all the records into the ExternalSorter

3. Updates context TaskMetrics

4. Returns a CompletionIterator for the ExternalSorter

Settings

973
BlockStoreShuffleReader

Table 1. Spark Properties

Spark Property Default Value Description

Maximum size (in bytes) of map

outputs to fetch simultaneously
from each reduce task.
Since each output requires a new
buffer to receive it, this represents
a fixed memory overhead per
spark.reducer.maxSizeInFlight 48m reduce task, so keep it small
unless you have a large amount of
memory.
Used when
BlockStoreShuffleReader creates
a ShuffleBlockFetcherIterator to
read records.

The maximum number of remote

requests to fetch blocks at any
given point.
When the number of hosts in the
cluster increases, it might lead to
very large number of in-bound
connections to one or more nodes,
spark.reducer.maxReqsInFlight (unlimited) causing the workers to fail under
load. By allowing it to limit the
number of fetch requests, this
scenario can be mitigated.
Used when
BlockStoreShuffleReader creates
a ShuffleBlockFetcherIterator to
read records.

Controls whether to detect any

corruption in fetched blocks.

spark.shuffle.detectCorrupt true Used when

BlockStoreShuffleReader creates
a ShuffleBlockFetcherIterator to
read records.

Creating BlockStoreShuffleReader Instance

BlockStoreShuffleReader takes the following when created:

BaseShuffleHandle

Reduce start partition index

974
BlockStoreShuffleReader

Reduce end partition index

TaskContext

SerializerManager

BlockManager

MapOutputTracker

BlockStoreShuffleReader initializes the internal registries and counters.

BlockStoreShuffleReader uses SparkEnv to access the SerializerManager,

Note
BlockManager and MapOutputTracker.

975
ShuffleBlockFetcherIterator

ShuffleBlockFetcherIterator
ShuffleBlockFetcherIterator is a Scala Iterator that fetches shuffle blocks (aka shuffle map

outputs) from block managers.

ShuffleBlockFetcherIterator is created exclusively when BlockStoreShuffleReader is

requested to read combined key-value records for a reduce task.

ShuffleBlockFetcherIterator allows for iterating over a sequence of blocks as (BlockId,

InputStream) pairs so a caller can handle shuffle blocks in a pipelined fashion as they are

received.

ShuffleBlockFetcherIterator is exhausted (i.e. can provide no elements) when the number

of blocks already processed is at least the total number of blocks to fetch.

ShuffleBlockFetcherIterator throttles the remote fetches to avoid consuming too much

memory.

Table 1. ShuffleBlockFetcherIterator’s Internal Registries and Counters

Name Description
numBlocksProcessed The number of blocks fetched and consumed.

Total number of blocks to fetch and consume.

ShuffleBlockFetcherIterator can produce up to numBlocksToFetch
elements.

numBlocksToFetch numBlocksToFetch is increased every time ShuffleBlockFetcherIterator

requested to splitLocalRemoteBlocks that prints it out as the INFO message
to the logs:

Getting [numBlocksToFetch] non-empty blocks out of [totalBlocks] blocks

Internal FIFO blocking queue (using Java’s

java.util.concurrent.LinkedBlockingQueue) to hold FetchResult remote and
local fetch results.
Used in:

results 1. next to take one FetchResult off the queue,

2. sendRequest to put SuccessFetchResult or FailureFetchResult remote

fetch results (as part of BlockFetchingListener callback),

3. fetchLocalBlocks (similarly to sendRequest) to put local fetch results,

4. cleanup to release managed buffers for SuccessFetchResult results.

976
ShuffleBlockFetcherIterator

The maximum size (in bytes) of all the remote shuffle blocks to fetch.
maxBytesInFlight
Set when ShuffleBlockFetcherIterator is created.

The maximum number of remote requests to fetch shuffle blocks.

maxReqsInFlight
Set when ShuffleBlockFetcherIterator is created.

The bytes of fetched remote shuffle blocks in flight

Starts at 0 when ShuffleBlockFetcherIterator is created.

bytesInFlight Incremented every sendRequest and decremented every next.

ShuffleBlockFetcherIterator makes sure that the invariant of
bytesInFlight below maxBytesInFlight holds every remote shuffle block
fetch.

The number of remote shuffle block fetch requests in flight.

Starts at 0 when ShuffleBlockFetcherIterator is created.
reqsInFlight
Incremented every sendRequest and decremented every next.

ShuffleBlockFetcherIterator makes sure that the invariant of reqsInFlight

below maxReqsInFlight holds every remote shuffle block fetch.

Flag whether ShuffleBlockFetcherIterator is still active. It is disabled, i.e.

false , when ShuffleBlockFetcherIterator is created.
isZombie
When enabled (when the task using ShuffleBlockFetcherIterator finishes),
the block fetch successful callback (registered in sendRequest ) will no
longer add fetched remote shuffle blocks into results internal queue.

The currently-processed SuccessFetchResult

currentResult
Set when ShuffleBlockFetcherIterator returns the next (BlockId,
InputStream) tuple and released (on cleanup).

Enable ERROR , WARN , INFO , DEBUG or TRACE logging levels for

org.apache.spark.storage.ShuffleBlockFetcherIterator logger to see what
happens in ShuffleBlockFetcherIterator .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.storage.ShuffleBlockFetcherIterator=TRACE

Refer to Logging.

fetchUpToMaxBytes Method

977
ShuffleBlockFetcherIterator

Caution FIXME

Creating ShuffleBlockFetcherIterator Instance

When created, ShuffleBlockFetcherIterator takes the following:

TaskContext

ShuffleClient

BlockManager

Blocks to fetch per BlockManager (as Seq[(BlockManagerId, Seq[(BlockId, Long)])] )

Function to wrap the returned input stream (as (BlockId, InputStream) ⇒ InputStream )

maxBytesInFlight — the maximum size (in bytes) of map outputs to fetch simultaneously

from each reduce task (controlled by spark.reducer.maxSizeInFlight Spark property)

maxReqsInFlight — the maximum number of remote requests to fetch blocks at any

given point (controlled by spark.reducer.maxReqsInFlight Spark property)

maxBlocksInFlightPerAddress

maxReqSizeShuffleToMem

detectCorrupt flag to detect any corruption in fetched blocks (controlled by

spark.shuffle.detectCorrupt Spark property)

Initializing ShuffleBlockFetcherIterator —  initialize

Internal Method

initialize(): Unit

initialize registers a task cleanup and fetches shuffle blocks from remote and local

BlockManagers.

Internally, initialize registers a TaskCompletionListener (that will clean up right after the
task finishes).

initialize splitLocalRemoteBlocks.

initialize registers the new remote fetch requests (with fetchRequests internal registry).

978
ShuffleBlockFetcherIterator

As ShuffleBlockFetcherIterator is in initialization phase, initialize makes sure that

reqsInFlight and bytesInFlight internal counters are both 0 . Otherwise, initialize throws
an exception.

initialize fetches shuffle blocks (from remote BlockManagers).

You should see the following INFO message in the logs:

INFO ShuffleBlockFetcherIterator: Started [numFetches] remote fetches in [time] ms

initialize fetches local shuffle blocks.

You should see the following DEBUG message in the logs:

DEBUG ShuffleBlockFetcherIterator: Got local blocks in [time] ms

Note initialize is used exclusively when ShuffleBlockFetcherIterator is created.

Sending Remote Shuffle Block Fetch Request 

—  sendRequest Internal Method

sendRequest(req: FetchRequest): Unit

Internally, when sendRequest runs, you should see the following DEBUG message in the
logs:

DEBUG ShuffleBlockFetcherIterator: Sending request for [blocks.size] blocks ([size] B)

from [hostPort]

sendRequest increments bytesInFlight and reqsInFlight internal counters.

The input FetchRequest contains the remote BlockManagerId address and the
Note
shuffle blocks to fetch (as a sequence of BlockId and their sizes).

sendRequest requests ShuffleClient to fetch shuffle blocks (from the host, the port, and

the executor as defined in the input FetchRequest ).

Note ShuffleClient was defined when ShuffleBlockFetcherIterator was created.

sendRequest registers a BlockFetchingListener with ShuffleClient that:

1. For every successfully fetched shuffle block adds it as SuccessFetchResult to results

internal queue.

979
ShuffleBlockFetcherIterator

2. For every shuffle block fetch failure adds it as FailureFetchResult to results internal
queue.

sendRequest is used exclusively when ShuffleBlockFetcherIterator is

Note
requested to fetch remote shuffle blocks.

onBlockFetchSuccess Callback

onBlockFetchSuccess(blockId: String, buf: ManagedBuffer): Unit

Internally, onBlockFetchSuccess checks if the iterator is not zombie and does the further
processing if it is not.

onBlockFetchSuccess marks the input blockId as received (i.e. removes it from all the

blocks to fetch as requested in sendRequest).

onBlockFetchSuccess adds the managed buf (as SuccessFetchResult ) to results internal

queue.

You should see the following DEBUG message in the logs:

DEBUG ShuffleBlockFetcherIterator: remainingBlocks: [blocks]

Regardless of zombie state of ShuffleBlockFetcherIterator , you should see the following

TRACE message in the logs:

TRACE ShuffleBlockFetcherIterator: Got remote block [blockId] after [time] ms

onBlockFetchFailure Callback

onBlockFetchFailure(blockId: String, e: Throwable): Unit

When onBlockFetchFailure is called, you should see the following ERROR message in the
logs:

ERROR ShuffleBlockFetcherIterator: Failed to get block(s) from [hostPort]

onBlockFetchFailure adds the block (as FailureFetchResult ) to results internal queue.

980
ShuffleBlockFetcherIterator

Throwing FetchFailedException (for ShuffleBlockId) 

—  throwFetchFailedException Internal Method

throwFetchFailedException(
blockId: BlockId,
address: BlockManagerId,
e: Throwable): Nothing

throwFetchFailedException throws a FetchFailedException when the input blockId is a

ShuffleBlockId .

throwFetchFailedException creates a FetchFailedException passing on the

Note
root cause of a failure, i.e. the input e .

Otherwise, throwFetchFailedException throws a SparkException :

Failed to get block [blockId], which is not a shuffle block

throwFetchFailedException is used when ShuffleBlockFetcherIterator is

Note
requested for the next element.

Releasing Resources —  cleanup Internal Method

cleanup(): Unit

Internally, cleanup marks ShuffleBlockFetcherIterator a zombie.

cleanup releases the current result buffer.

cleanup iterates over results internal queue and for every SuccessFetchResult , increments

remote bytes read and blocks fetched shuffle task metrics, and eventually releases the
managed buffer.

Note cleanup is used when ShuffleBlockFetcherIterator initializes itself.

Decrementing Reference Count Of and Releasing Result

Buffer (for SuccessFetchResult) 
—  releaseCurrentResultBuffer Internal Method

releaseCurrentResultBuffer(): Unit

981
ShuffleBlockFetcherIterator

releaseCurrentResultBuffer decrements the currently-processed SuccessFetchResult

reference's buffer reference count if there is any.

releaseCurrentResultBuffer releases currentResult.

releaseCurrentResultBuffer is used when ShuffleBlockFetcherIterator

Note
releases resources and BufferReleasingInputStream closes.

fetchLocalBlocks Internal Method

fetchLocalBlocks(): Unit

fetchLocalBlocks …​FIXME

Note fetchLocalBlocks is used when…​FIXME

hasNext Method

hasNext: Boolean

hasNext is part of Scala’s Iterator Contract to test whether this iterator can
Note
provide another element.

hasNext is positive ( true ) when numBlocksProcessed is less than numBlocksToFetch.

Otherwise, hasNext is negative ( false ).

splitLocalRemoteBlocks Internal Method

splitLocalRemoteBlocks(): ArrayBuffer[FetchRequest]

splitLocalRemoteBlocks …​FIXME

splitLocalRemoteBlocks is used exclusively when ShuffleBlockFetcherIterator

Note
is requested to initialize.

next Method

next(): (BlockId, InputStream)

982
ShuffleBlockFetcherIterator

next is part of Scala’s Iterator Contract to produce the next element of this
Note
iterator.

next …​FIXME

983
ShuffleExternalSorter — Cache-Efficient Sorter

ShuffleExternalSorter — Cache-Efficient Sorter
ShuffleExternalSorter is a specialized cache-efficient sorter that sorts arrays of

compressed record pointers and partition ids. By using only 8 bytes of space per record in
the sorting array, ShuffleExternalSorter can fit more of the array into cache.

ShuffleExternalSorter is a MemoryConsumer.

Table 1. ShuffleExternalSorter’s Internal Properties

Name Initial Value Description
inMemSorter (empty) ShuffleInMemorySorter

Enable INFO or ERROR logging levels for

org.apache.spark.shuffle.sort.ShuffleExternalSorter logger to see what
happens in ShuffleExternalSorter .
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.shuffle.sort.ShuffleExternalSorter=INFO

Refer to Logging.

getMemoryUsage Method

Caution FIXME

closeAndGetSpills Method

Caution FIXME

insertRecord Method

Caution FIXME

freeMemory Method

Caution FIXME

984
ShuffleExternalSorter — Cache-Efficient Sorter

getPeakMemoryUsedBytes Method

Caution FIXME

writeSortedFile Method

Caution FIXME

cleanupResources Method

Caution FIXME

Creating ShuffleExternalSorter Instance

ShuffleExternalSorter takes the following when created:

1. memoryManager  — TaskMemoryManager

2. blockManager  — BlockManager

3. taskContext  — TaskContext

4. initialSize

5. numPartitions

6. SparkConf

7. writeMetrics  — ShuffleWriteMetrics

ShuffleExternalSorter initializes itself as a MemoryConsumer (with pageSize as the

minimum of PackedRecordPointer.MAXIMUM_PAGE_SIZE_BYTES and pageSizeBytes, and

Tungsten memory mode).

ShuffleExternalSorter uses spark.shuffle.file.buffer (for fileBufferSizeBytes ) and

spark.shuffle.spill.numElementsForceSpillThreshold (for numElementsForSpillThreshold )

Spark properties.

ShuffleExternalSorter creates a ShuffleInMemorySorter (with

spark.shuffle.sort.useRadixSort Spark property enabled by default).

ShuffleExternalSorter initializes the internal registries and counters.

ShuffleExternalSorter is created when UnsafeShuffleWriter is open (which is

Note
when UnsafeShuffleWriter is created).

985
ShuffleExternalSorter — Cache-Efficient Sorter

Freeing Execution Memory by Spilling To Disk —  spill

Method

long spill(long size, MemoryConsumer trigger)

throws IOException

spill is part of MemoryConsumer contract to sort and spill the current records
Note
due to memory pressure.

spill frees execution memory, updates TaskMetrics , and in the end returns the spill size.

spill returns 0 when ShuffleExternalSorter has no ShuffleInMemorySorter

Note
or the ShuffleInMemorySorter manages no records.

You should see the following INFO message in the logs:

INFO Thread [id] spilling sort data of [memoryUsage] to disk ([size] times so far)

spill writes sorted file (with isLastFile disabled).

spill frees memory and records the spill size.

spill resets the internal ShuffleInMemorySorter (that in turn frees up the underlying in-

memory pointer array).

spill adds the spill size to TaskMetrics .

spill returns the spill size.

986
ExternalSorter

ExternalSorter
ExternalSorter is a Spillable of WritablePartitionedPairCollection of K -key / C -value

pairs.

When created ExternalSorter expects three different types of data defined, i.e. K , V ,
C , for keys, values, and combiner (partial) values, respectively.

ExternalSorter is exclusively used when SortShuffleWriter writes records

Note and BlockStoreShuffleReader reads combined key-value pairs (for reduce task
when ShuffleDependency has key ordering defined (to sort output).

Enable INFO or WARN logging levels for

org.apache.spark.util.collection.ExternalSorter logger to see what happens in
ExternalSorter .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.util.collection.ExternalSorter=INFO

Refer to Logging.

stop Method

Caution FIXME

writePartitionedFile Method

Caution FIXME

Creating ExternalSorter Instance

ExternalSorter takes the following:

1. TaskContext

2. Optional Aggregator

3. Optional Partitioner

4. Optional Scala’s Ordering

5. Optional Serializer

987
ExternalSorter

Note ExternalSorter uses SparkEnv to access the default Serializer .

ExternalSorter is created when SortShuffleWriter writes records and

Note BlockStoreShuffleReader reads combined key-value pairs (for reduce task
when ShuffleDependency has key ordering defined (to sort output).

spillMemoryIteratorToDisk Internal Method

spillMemoryIteratorToDisk(inMemoryIterator: WritablePartitionedIterator): SpilledFile

Caution FIXME

spill Method

spill(collection: WritablePartitionedPairCollection[K, C]): Unit

Note spill is part of Spillable contract.

Caution FIXME

maybeSpillCollection Internal Method

maybeSpillCollection(usingMap: Boolean): Unit

Caution FIXME

insertAll Method

insertAll(records: Iterator[Product2[K, V]]): Unit

Caution FIXME

insertAll is used when SortShuffleWriter writes records and

Note BlockStoreShuffleReader reads combined key-value pairs (for reduce task
when ShuffleDependency has key ordering defined (to sort output).

Settings

988
ExternalSorter

Table 1. Spark Properties

Default
Spark Property Description
Value

Size of the in-memory buffer for

each shuffle file output stream. In
bytes unless the unit is specified.
These buffers reduce the number of
disk seeks and system calls made
in creating intermediate shuffle files.
Used in ExternalSorter ,
spark.shuffle.file.buffer 32k
BypassMergeSortShuffleWriter and
ExternalAppendOnlyMap (for
fileBufferSize ) and in
ShuffleExternalSorter (for
fileBufferSizeBytes).
NOTE: spark.shuffle.file.buffer
was previously known as
spark.shuffle.file.buffer.kb .

spark.shuffle.spill.batchSize 10000
Size of object batches when
reading/writing from serializers.

989
Serialization

Serialization
Serialization systems:

Java serialization

Kryo

Avro

Thrift

Protobuf

990
Serializer — Task SerDe

Serializer — Task Serialization and

Deserialization
newInstance Method

Caution FIXME

deserialize Method

Caution FIXME

supportsRelocationOfSerializedObjects Property
supportsRelocationOfSerializedObjects should be enabled (i.e. true) only when reordering

the bytes of serialized objects in serialization stream output is equivalent to having re-
ordered those elements prior to serializing them.

supportsRelocationOfSerializedObjects is disabled (i.e. false ) by default.

Note KryoSerializer uses autoReset for supportsRelocationOfSerializedObjects .

Note supportsRelocationOfSerializedObjects is enabled in UnsafeRowSerializer .

991
SerializerInstance

SerializerInstance
Caution FIXME

serializeStream Method

Caution FIXME

992
SerializationStream

SerializationStream
Caution FIXME

writeKey Method

Caution FIXME

writeValue Method

Caution FIXME

993
DeserializationStream

DeserializationStream
Caution FIXME

994
ExternalClusterManager — Pluggable Cluster Managers

ExternalClusterManager — Pluggable Cluster
Managers
ExternalClusterManager is a contract for pluggable cluster managers. It returns a task

scheduler and a backend scheduler that will be used by SparkContext to schedule tasks.

The support for pluggable cluster managers was introduced in SPARK-13904

Note
Add support for pluggable cluster manager.

External cluster managers are registered using the java.util.ServiceLoader mechanism

(with service markers under META-INF/services directory). This allows auto-loading
implementations of ExternalClusterManager interface.

ExternalClusterManager is a private[spark] trait in

Note
org.apache.spark.scheduler package.

The two implementations of the ExternalClusterManager contract in Spark 2.0

Note
are YarnClusterManager and MesosClusterManager .

ExternalClusterManager Contract

canCreate Method

canCreate(masterURL: String): Boolean

canCreate is a mechanism to match a ExternalClusterManager implementation to a given

master URL.

canCreate is used when SparkContext loads the external cluster manager for
Note
a master URL.

createTaskScheduler Method

createTaskScheduler(sc: SparkContext, masterURL: String): TaskScheduler

createTaskScheduler creates a TaskScheduler given a SparkContext and the input

masterURL .

createSchedulerBackend Method

995
ExternalClusterManager — Pluggable Cluster Managers

createSchedulerBackend(sc: SparkContext,
masterURL: String,
scheduler: TaskScheduler): SchedulerBackend

createSchedulerBackend creates a SchedulerBackend given a SparkContext, the input

masterURL , and TaskScheduler.

Initializing Scheduling Components —  initialize Method

initialize(scheduler: TaskScheduler, backend: SchedulerBackend): Unit

initialize is called after the task scheduler and the backend scheduler were created and

initialized separately.

There is a cyclic dependency between a task scheduler and a backend

Note
scheduler that begs for this additional initialization step.

TaskScheduler and SchedulerBackend (with DAGScheduler) are commonly

Note
referred to as scheduling components.

996
BroadcastManager

BroadcastManager
Broadcast Manager ( BroadcastManager ) is a Spark service to manage broadcast variables
in Spark. It is created for a Spark application when SparkContext is initialized and is a simple
wrapper around BroadcastFactory.

BroadcastManager tracks the number of broadcast variables in a Spark application (using the

internal field nextBroadcastId ).

The idea is to transfer values used in transformations from a driver to executors in a most
effective way so they are copied once and used many times by tasks (rather than being
copied every time a task is launched).

When initialized, BroadcastManager creates an instance of TorrentBroadcastFactory.

stop Method

Caution FIXME

Creating BroadcastManager Instance

Caution FIXME

Initializing BroadcastManager —  initialize Internal

Method

initialize(): Unit

initialize creates and initializes a TorrentBroadcastFactory .

initialize is executed only once (when BroadcastManager is created) and

Note
controlled by the internal initialized flag.

newBroadcast Method

newBroadcast[T](value_ : T, isLocal: Boolean): Broadcast[T]

newBroadcast simply requests the current BroadcastFactory for a new broadcast variable.

997
BroadcastManager

Note The BroadcastFactory is created when BroadcastManager is initialized.

newBroadcast is executed for SparkContext.broadcast method and when

Note
MapOutputTracker serializes MapStatuses .

Settings
Table 1. Settings
Default
Name Description
value
The size of a block (in kB when unit not
specified).
spark.broadcast.blockSize 4m
Used when TorrentBroadcast stores
brodcast blocks to BlockManager .

The flag to enable compression.

Refer to CompressionCodec.
spark.broadcast.compress true
Used when TorrentBroadcast is created
and later when it stores broadcast blocks
to BlockManager . Also in
SerializerManager.

998
BroadcastFactory — Pluggable Broadcast Variable Factories

BroadcastFactory — Pluggable Broadcast
Variable Factories
BroadcastFactory is the contract for factories of broadcast variables in Apache Spark.

As of Spark 2.0, it is no longer possible to plug a custom BroadcastFactory in,

Note
and TorrentBroadcastFactory is the one and only known implementation.

BroadcastFactory is exclusively used and instantiated inside of BroadcastManager.

package org.apache.spark.broadcast

trait BroadcastFactory {
def initialize(isDriver: Boolean, conf: SparkConf, securityMgr: SecurityManager): Un
it
def newBroadcast[T: ClassTag](value: T, isLocal: Boolean, id: Long): Broadcast[T]
def unbroadcast(id: Long, removeFromDriver: Boolean, blocking: Boolean): Unit
def stop(): Unit
}

Note BroadcastFactory is a private[spark] contract.

Table 1. BroadcastFactory Contract

Method Description
initialize Used when…​FIXME

newBroadcast Used when…​FIXME

unbroadcast Used when…​FIXME

stop Used when…​FIXME

TorrentBroadcastFactory is the one and only known implementation of

Note
BroadcastFactory contract in Apache Spark.

999
TorrentBroadcastFactory

TorrentBroadcastFactory
TorrentBroadcastFactory is a BroadcastFactory of TorrentBroadcasts, i.e. BitTorrent-like

broadcast variables.

As of Spark 2.0 TorrentBroadcastFactory is the only implementation of

Note
BroadcastFactory.

initialize and stop do nothing.

unbroadcast removes all the persisted state associated with a TorrentBroadcast of a given

ID.

Creating TorrentBroadcast —  newBroadcast Method

newBroadcast[T: ClassTag](value_ : T, isLocal: Boolean, id: Long): Broadcast[T]

Note newBroadcast is part of BroadcastFactory Contract to…​FIXME.

newBroadcast creates a TorrentBroadcast (for the input value_ and id and ignoring the

isLocal parameter).

1000
TorrentBroadcast

TorrentBroadcast — BroadcastFactory With
BitTorrent-Like Protocol For Block Distribution
TorrentBroadcast is a BroadcastFactory that uses a BitTorrent-like protocol for block

distribution (that only happens when tasks access broadcast variables on executors).

Figure 1. TorrentBroadcast - broadcasting using BitTorrent

TorrentBroadcast is created exclusively when TorrentBroadcastFactory is requested to

newBroadcast.

When a broadcast variable is created (using SparkContext.broadcast ) on the driver, a new

instance of TorrentBroadcast is created.

// On the driver
val sc: SparkContext = ???
val anyScalaValue = ???
val b = sc.broadcast(anyScalaValue) // <-- TorrentBroadcast is created

1001
TorrentBroadcast

A broadcast variable is stored on the driver’s BlockManager as a single value and separately
as broadcast blocks (after it was divided into broadcast blocks, i.e. blockified). The
broadcast block size is the value of spark.broadcast.blockSize Spark property.

Figure 2. TorrentBroadcast puts broadcast and the chunks to driver’s BlockManager

TorrentBroadcast -based broadcast variables are created using
Note
TorrentBroadcastFactory.

Note TorrentBroadcast belongs to org.apache.spark.broadcast package.

TorrentBroadcast uses _value internal registry for the value that is computed by

readBroadcastBlock when first requested.

_value: T

_value is a @transient private lazy val which means that it is not serialized
Note
to be sent remotely and instantiated when first requested.

Enable INFO or DEBUG logging levels for

org.apache.spark.broadcast.TorrentBroadcast logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.broadcast.TorrentBroadcast=DEBUG

Refer to Logging.

unBlockifyObject Method

Caution FIXME

1002
TorrentBroadcast

releaseLock Method

Caution FIXME

Getting Value of Broadcast Variable —  getValue Method

def getValue(): T

getValue returns the value of a broadcast variable.

getValue is part of the Broadcast Variable Contract and is the only way to
Note
access the value of a broadcast variable.

Internaly, getValue reads the internal _value that, once accessed, reads broadcast blocks
from the local or remote BlockManagers.

The internal _value is transient and lazy, i.e. it is not preserved when
serialized and (re)created only when requested, respectively. That "trick" allows
Note
for serializing broadcast values on the driver before they are transferred to
executors over the wire.

readBroadcastBlock Internal Method

readBroadcastBlock(): T

Internally, readBroadcastBlock sets the SparkConf

Note The current SparkConf is available using SparkEnv.get.conf.

readBroadcastBlock requests the local BlockManager for values of the broadcast.

Note The current BlockManager is available using SparkEnv.get.blockManager.

If the broadcast was available locally, readBroadcastBlock releases a lock for the broadcast
and returns the value.

If however the broadcast was not found locally, you should see the following INFO message
in the logs:

INFO Started reading broadcast variable [id]

readBroadcastBlock reads blocks (as chunks) of the broadcast.

1003
TorrentBroadcast

You should see the following INFO message in the logs:

INFO Reading broadcast variable [id] took [usedTimeMs]

readBroadcastBlock unblockifies the collection of ByteBuffer blocks

readBroadcastBlock uses the current Serializer and the internal

Note CompressionCodec to bring all the blocks together as one single broadcast
variable.

readBroadcastBlock stores the broadcast variable with MEMORY_AND_DISK storage level to the

local BlockManager . When storing the broadcast variable was unsuccessful, a

SparkException is thrown.

Failed to store [broadcastId] in BlockManager

The broadcast variable is returned.

readBroadcastBlock is used exclusively when TorrentBroadcast is requested

Note
for the value.

setConf Internal Method

setConf(conf: SparkConf): Unit

setConf uses the input conf SparkConf to set compression codec and the block size.

Internally, setConf reads spark.broadcast.compress Spark property and if enabled (which it

is by default) sets a CompressionCodec (as an internal compressionCodec property).

setConf also reads spark.broadcast.blockSize Spark property and sets the block size (as

the internal blockSize property).

setConf is executed when TorrentBroadcast is created or re-created when

Note
deserialized on executors.

Storing Broadcast and Its Blocks in Local BlockManager 

—  writeBlocks Internal Method

writeBlocks(value: T): Int

1004
TorrentBroadcast

writeBlocks stores the broadcast’s value and blocks in the driver’s BlockManager. It

returns the number of the broadcast blocks the broadcast was divided into.

Internally, writeBlocks stores the block for value broadcast to the local BlockManager
(using a new BroadcastBlockId, value , MEMORY_AND_DISK storage level and without telling
the driver).

If storing the broadcast block fails, you should see the following SparkException in the logs:

Failed to store [broadcastId] in BlockManager

writeBlocks divides value into blocks (of spark.broadcast.blockSize size) using the

Serializer and an optional CompressionCodec (enabled by spark.broadcast.compress).

Every block gets its own BroadcastBlockId (with piece and an index) that is wrapped
inside a ChunkedByteBuffer . Blocks are stored in the local BlockManager (using the piece
block id, MEMORY_AND_DISK_SER storage level and informing the driver).

The entire broadcast value is stored in the local BlockManager with

Note MEMORY_AND_DISK storage level, and the pieces with MEMORY_AND_DISK_SER
storage level.

If storing any of the broadcast pieces fails, you should see the following SparkException in
the logs:

Failed to store [pieceId] of [broadcastId] in local BlockManager

writeBlocks is used exclusively when TorrentBroadcast is created (that

Note
happens on the driver only).

Chunking Broadcast Into Blocks —  blockifyObject

Method

blockifyObject[T](
obj: T,
blockSize: Int,
serializer: Serializer,
compressionCodec: Option[CompressionCodec]): Array[ByteBuffer]

blockifyObject divides (aka blockifies) the input obj broadcast variable into blocks (of

ByteBuffer ). blockifyObject uses the input serializer Serializer to write obj in a

serialized format to a ChunkedByteBufferOutputStream (of blockSize size) with the optional

CompressionCodec.

1005
TorrentBroadcast

blockifyObject is executed when TorrentBroadcast stores a broadcast and its

Note
blocks to a local BlockManager .

doUnpersist Method

doUnpersist(blocking: Boolean): Unit

doUnpersist removes all the persisted state associated with a broadcast variable on

executors.

doUnpersist is part of the Broadcast Variable Contract and is executed from

Note
unpersist method.

doDestroy Method

doDestroy(blocking: Boolean): Unit

doDestroy removes all the persisted state associated with a broadcast variable on all the

nodes in a Spark application, i.e. the driver and executors.

doDestroy is executed when Broadcast removes the persisted data and

Note
metadata related to a broadcast variable.

unpersist Internal Method

unpersist(
id: Long,
removeFromDriver: Boolean,
blocking: Boolean): Unit

unpersist removes all broadcast blocks from executors and possibly the driver (only when

removeFromDriver flag is enabled).

unpersist belongs to TorrentBroadcast private object and is executed when

Note TorrentBroadcast unpersists a broadcast variable and removes a broadcast
variable completely.

When executed, you should see the following DEBUG message in the logs:

DEBUG TorrentBroadcast: Unpersisting TorrentBroadcast [id]

1006
TorrentBroadcast

unpersist requests BlockManagerMaster to remove the id broadcast.

unpersist uses SparkEnv to get the BlockManagerMaster (through

Note
blockManager property).

Creating TorrentBroadcast Instance

TorrentBroadcast takes the following when created:

Object (the value) to be broadcast

ID

TorrentBroadcast initializes the internal registries and counters.

readBlocks Internal Method

readBlocks(): Array[BlockData]

readBlocks …​FIXME

Note readBlocks is used when…​FIXME

1007
CompressionCodec

CompressionCodec
With spark.broadcast.compress enabled (which is the default), TorrentBroadcast uses
compression for broadcast blocks.

Caution FIXME What’s compressed?

Table 1. Built-in Compression Codecs

Codec
Fully-Qualified Class Name Notes
Alias

lz4 org.apache.spark.io.LZ4CompressionCodec
The default
implementation

lzf org.apache.spark.io.LZFCompressionCodec

The fallback when the

snappy org.apache.spark.io.SnappyCompressionCodec default codec is not
available.

An implementation of CompressionCodec trait has to offer a constructor that accepts a single

argument being SparkConf. Read Creating CompressionCodec  —  createCodec Factory
Method in this document.

You can control the default compression codec in a Spark application using
spark.io.compression.codec Spark property.

Creating CompressionCodec  —  createCodec Factory

Method

createCodec(conf: SparkConf): CompressionCodec (1)

createCodec(conf: SparkConf, codecName: String): CompressionCodec (2)

createCodec uses the internal shortCompressionCodecNames lookup table to find the input

codecName (regardless of the case).

createCodec finds the constructor of the compression codec’s implementation (that accepts

a single argument being SparkConf).

If a compression codec could not be found, createCodec throws a

IllegalArgumentException exception:

1008
CompressionCodec

Codec [<codecName>] is not available. Consider setting spark.io.compression.codec=snap

py

getCodecName Method

getCodecName(conf: SparkConf): String

getCodecName reads spark.io.compression.codec Spark property from the input conf

SparkConf or assumes lz4 .

getCodecName is used when SparkContext sets up event logging (for History

Note
Server) or when creating a CompressionCodec .

Settings
Table 2. Settings
Default
Name Description
value
The compression codec to use.
spark.io.compression.codec lz4
Used when getCodecName is called to
find the current compression codec.

1009
ContextCleaner — Spark Application Garbage Collector

ContextCleaner  — Spark Application Garbage

Collector
ContextCleaner is a Spark service that is responsible for application-wide cleanup of

shuffles, RDDs, broadcasts, accumulators and checkpointed RDDs that is aimed at reducing
the memory requirements of long-running data-heavy Spark applications.

ContextCleaner runs on the driver. It is created and immediately started when

SparkContext starts (and spark.cleaner.referenceTracking Spark property is enabled,

which it is by default). It is stopped when SparkContext is stopped.

Table 1. ContextCleaner’s Internal Registries and Counters

Name Description
referenceBuffer Used when ???

referenceQueue Used when ???

listeners Used when ???

It uses a daemon Spark Context Cleaner thread that cleans RDD, shuffle, and broadcast
states (using keepCleaning method).

ShuffleDependencies register themselves for cleanup.

Enable INFO or DEBUG logging level for org.apache.spark.ContextCleaner logger

to see what happens in ContextCleaner .
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.ContextCleaner=DEBUG

Refer to Logging.

doCleanupRDD Method

Caution FIXME

keepCleaning Internal Method

1010
ContextCleaner — Spark Application Garbage Collector

keepCleaning(): Unit

keepCleaning runs indefinitely until ContextCleaner is stopped. It…​FIXME

You should see the following DEBUG message in the logs:

DEBUG Got cleaning task [task]

keepCleaning is exclusively used in Spark Context Cleaner Cleaning Thread

Note
that is started once when ContextCleaner is started.

Spark Context Cleaner Cleaning Thread 

—  cleaningThread Attribute

Caution FIXME

The name of the daemon thread is Spark Context Cleaner.

$ jstack -l [sparkPID] | grep "Spark Context Cleaner"

"Spark Context Cleaner" #80 daemon prio=5 os_prio=31 tid=0x00007fc304677800 nid=0xa103
in Object.wait() [0x0000000120371000]

Note cleaningThread is started as a daemon thread when ContextCleaner starts.

registerRDDCheckpointDataForCleanup Method

Caution FIXME

registerBroadcastForCleanup Method

Caution FIXME

registerRDDForCleanup Method

Caution FIXME

registerAccumulatorForCleanup Method

Caution FIXME

1011
ContextCleaner — Spark Application Garbage Collector

stop Method

Caution FIXME

Creating ContextCleaner Instance

ContextCleaner takes a SparkContext.

ContextCleaner initializes the internal registries and counters.

Starting ContextCleaner  —  start Method

start(): Unit

start starts cleaning thread and an action to request the JVM garbage collector (using

System.gc() ) every spark.cleaner.periodicGC.interval interval.

The action to request the JVM GC is scheduled on periodicGCService executor

Note
service.

periodicGCService Single-Thread Executor Service

periodicGCService is an internal single-thread executor service with the name context-

cleaner-periodic-gc to request the JVM garbage collector.

Requests for JVM GC are scheduled every spark.cleaner.periodicGC.interval

interval.
Note
The periodic runs are started when ContextCleaner starts and stopped when
ContextCleaner stops.

Registering ShuffleDependency for Cleanup 

—  registerShuffleForCleanup Method

registerShuffleForCleanup(shuffleDependency: ShuffleDependency[_, _, _]): Unit

registerShuffleForCleanup registers a ShuffleDependency for cleanup.

Internally, registerShuffleForCleanup simply executes registerForCleanup for the input

ShuffleDependency .

1012
ContextCleaner — Spark Application Garbage Collector

registerShuffleForCleanup is exclusively used when ShuffleDependency is

Note
created.

Registering Object Reference For Cleanup 

—  registerForCleanup Internal Method

registerForCleanup(objectForCleanup: AnyRef, task: CleanupTask): Unit

Internally, registerForCleanup adds the input objectForCleanup to referenceBuffer

internal queue.

Despite the widest-possible AnyRef type of the input objectForCleanup , the

Note type is really CleanupTaskWeakReference which is a custom Java’s
java.lang.ref.WeakReference.

Removing Shuffle Blocks From

MapOutputTrackerMaster and
BlockManagerMaster  —  doCleanupShuffle Method

doCleanupShuffle(shuffleId: Int, blocking: Boolean): Unit

doCleanupShuffle performs a shuffle cleanup which is to remove the shuffle from the current

MapOutputTrackerMaster and BlockManagerMaster. doCleanupShuffle also notifies

CleanerListeners.

Internally, when executed, you should see the following DEBUG message in the logs:

DEBUG Cleaning shuffle [id]

doCleanupShuffle unregisters the input shuffleId from MapOutputTrackerMaster .

Note doCleanupShuffle uses SparkEnv to access the current MapOutputTracker .

doCleanupShuffle removes the shuffle blocks of the input shuffleId from

BlockManagerMaster .

Note doCleanupShuffle uses SparkEnv to access the current BlockManagerMaster .

doCleanupShuffle informs all registered CleanerListener listeners (from listeners internal

queue) that the input shuffleId was cleaned.

1013
ContextCleaner — Spark Application Garbage Collector

In the end, you should see the following DEBUG message in the logs:

DEBUG Cleaned shuffle [id]

In case of any exception, you should see the following ERROR message in the logs and the
exception itself.

ERROR Error cleaning shuffle [id]

doCleanupShuffle is executed when ContextCleaner cleans a shuffle reference

Note
and (interestingly) while fitting a ALSModel (in Spark MLlib).

Settings
Table 2. Spark Properties
Default
Spark Property Description
Value

spark.cleaner.periodicGC.interval 30min
Controls how often to trigger a garba
collection.

spark.cleaner.referenceTracking true
Controls whether a ContextCleaner
created when a SparkContext

Controls whether the cleaning thread

block on cleanup tasks (other than sh
which is controlled by
spark.cleaner.referenceTracking.bloc
spark.cleaner.referenceTracking.blocking true
Spark property).
It is true as a workaround to
Removing broadcast in quick succes
causes Akka timeout.

Controls whether the cleaning thread

block on shuffle cleanup tasks.
spark.cleaner.referenceTracking.blocking.shuffle false
It is false as a workaround to
Akka timeouts from ContextCleaner w
cleaning shuffles.

spark.cleaner.referenceTracking.cleanCheckpoints false
Controls whether to clean checkpoint
reference is out of scope.

1014
ContextCleaner — Spark Application Garbage Collector

1015
CleanerListener

CleanerListener
Caution FIXME

shuffleCleaned Callback Method

Caution FIXME

1016
Dynamic Allocation (of Executors)

Dynamic Allocation (of Executors)

Dynamic Allocation (of Executors) (aka Elastic Scaling) is a Spark feature that allows for
adding or removing Spark executors dynamically to match the workload.

Unlike the "traditional" static allocation where a Spark application reserves CPU and
memory resources upfront (irrespective of how much it may eventually use), in dynamic
allocation you get as much as needed and no more. It scales the number of executors up
and down based on workload, i.e. idle executors are removed, and when there are pending
tasks waiting for executors to be launched on, dynamic allocation requests them.

Dynamic allocation is enabled using spark.dynamicAllocation.enabled setting. When

enabled, it is assumed that the External Shuffle Service is also used (it is not by default as
controlled by spark.shuffle.service.enabled property).

ExecutorAllocationManager is responsible for dynamic allocation of executors. With dynamic

allocation enabled, it is started when SparkContext is initialized.

Dynamic allocation reports the current state using ExecutorAllocationManager metric source.

Dynamic Allocation comes with the policy of scaling executors up and down as follows:

1. Scale Up Policy requests new executors when there are pending tasks and increases
the number of executors exponentially since executors start slow and Spark application
may need slightly more.

2. Scale Down Policy removes executors that have been idle for
spark.dynamicAllocation.executorIdleTimeout seconds.

Dynamic allocation is available for all the currently-supported cluster managers, i.e. Spark
Standalone, Hadoop YARN and Apache Mesos.

Tip Read about Dynamic Allocation on Hadoop YARN.

Tip Review the excellent slide deck Dynamic Allocation in Spark from Databricks.

Is Dynamic Allocation Enabled? 

—  Utils.isDynamicAllocationEnabled Method

isDynamicAllocationEnabled(conf: SparkConf): Boolean

isDynamicAllocationEnabled returns true if all the following conditions hold:

1017
Dynamic Allocation (of Executors)

1. spark.dynamicAllocation.enabled is enabled (i.e. true )

2. Spark on cluster is used (i.e. spark.master is non- local )

3. spark.dynamicAllocation.testing is enabled (i.e. true )

Otherwise, isDynamicAllocationEnabled returns false .

isDynamicAllocationEnabled returns true , i.e. dynamic allocation is enabled,

Note in Spark local (pseudo-cluster) for testing only (with
spark.dynamicAllocation.testing enabled).

isDynamicAllocationEnabled is used when Spark calculates the initial number of

Note executors for coarse-grained scheduler backends for YARN, Spark Standalone,
and Mesos. It is also used for Spark Streaming.

Enable WARN logging level for org.apache.spark.util.Utils logger to see what

happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.util.Utils=WARN

Refer to Logging.

Programmable Dynamic Allocation

SparkContext offers a developer API to scale executors up or down.

Getting Initial Number of Executors for Dynamic Allocation 

—  Utils.getDynamicAllocationInitialExecutors
Method

getDynamicAllocationInitialExecutors(conf: SparkConf): Int

getDynamicAllocationInitialExecutors first makes sure that

spark.dynamicAllocation.initialExecutors is equal or greater than

spark.dynamicAllocation.minExecutors.

spark.dynamicAllocation.initialExecutors falls back to

Note spark.dynamicAllocation.minExecutors if not set. Why to print the WARN
message to the logs?

If not, you should see the following WARN message in the logs:

1018
Dynamic Allocation (of Executors)

spark.dynamicAllocation.initialExecutors less than

spark.dynamicAllocation.minExecutors is invalid, ignoring its
setting, please update your configs.

getDynamicAllocationInitialExecutors makes sure that spark.executor.instances is greater

than spark.dynamicAllocation.minExecutors.

Both spark.executor.instances and spark.dynamicAllocation.minExecutors fall

Note
back to 0 when no defined explicitly.

If not, you should see the following WARN message in the logs:

spark.executor.instances less than

spark.dynamicAllocation.minExecutors is invalid, ignoring its
setting, please update your configs.

getDynamicAllocationInitialExecutors sets the initial number of executors to be the

maximum of:

spark.dynamicAllocation.minExecutors

spark.dynamicAllocation.initialExecutors

spark.executor.instances

You should see the following INFO message in the logs:

Using initial executors = [initialExecutors], max of

spark.dynamicAllocation.initialExecutors,
spark.dynamicAllocation.minExecutors and
spark.executor.instances

getDynamicAllocationInitialExecutors is used when

Note ExecutorAllocationManager sets the initial number of executors and in YARN to
set initial target number of executors.

Settings

1019
Dynamic Allocation (of Executors)

Table 1. Spark Properties

Spark Property Default Value

spark.dynamicAllocation.enabled false

spark.dynamicAllocation.initialExecutors spark.dynamicAllocation.minExecutors

spark.dynamicAllocation.minExecutors 0

spark.dynamicAllocation.maxExecutors Integer.MAX_VALUE

spark.dynamicAllocation.schedulerBacklogTimeout 1s

spark.dynamicAllocation.sustainedSchedulerBacklogTimeout spark.dynamicAllocation.schedulerBackl

spark.dynamicAllocation.executorIdleTimeout 60s

spark.dynamicAllocation.cachedExecutorIdleTimeout Integer.MAX_VALUE

spark.dynamicAllocation.testing

Future
SPARK-4922

1020
Dynamic Allocation (of Executors)

SPARK-4751

SPARK-7955

1021
ExecutorAllocationManager — Allocation Manager for Spark Core

ExecutorAllocationManager — Allocation
Manager for Spark Core
ExecutorAllocationManager is responsible for dynamically allocating and removing executors

based on the workload.

It intercepts Spark events using the internal ExecutorAllocationListener that keeps track of
the workload (changing the internal registries that the allocation manager uses for executors
management).

It uses ExecutorAllocationClient, LiveListenerBus, and SparkConf (that are all passed in

when ExecutorAllocationManager is created).

ExecutorAllocationManager is created when SparkContext is created and dynamic

allocation of executors is enabled.

SparkContext expects that SchedulerBackend follows the

Note ExecutorAllocationClient contract when dynamic allocation of executors is
enabled.

Table 1. FIXME’s Internal Properties

Name Initial Value Description
executorAllocationManagerSource ExecutorAllocationManagerSource FIXME

1022
ExecutorAllocationManager — Allocation Manager for Spark Core

Table 2. ExecutorAllocationManager’s Internal Registries and Counters

Name Description

Internal cache with…​FIXME

executorsPendingToRemove
Used when…​FIXME

Internal cache with…​FIXME

removeTimes
Used when…​FIXME

Internal cache with…​FIXME

executorIds
Used when…​FIXME

initialNumExecutors FIXME

numExecutorsTarget FIXME

numExecutorsToAdd FIXME

Flag whether…​FIXME
initializing
Starts enabled (i.e. true ).

Enable INFO logging level for org.apache.spark.ExecutorAllocationManager

logger to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.ExecutorAllocationManager=INFO

Refer to Logging.

addExecutors Method

Caution FIXME

removeExecutor Method

Caution FIXME

maxNumExecutorsNeeded Method

1023
ExecutorAllocationManager — Allocation Manager for Spark Core

Caution FIXME

Starting ExecutorAllocationManager  —  start

Method

start(): Unit

start registers ExecutorAllocationListener (with LiveListenerBus) to monitor scheduler

events and make decisions when to add and remove executors. It then immediately starts
spark-dynamic-executor-allocation allocation executor that is responsible for the scheduling
every 100 milliseconds.

100 milliseconds for the period between successive scheduling is fixed, i.e. not
Note
configurable.

It requests executors using the input ExecutorAllocationClient. It requests

spark.dynamicAllocation.initialExecutors.

start is called while SparkContext is being created (with dynamic allocation

Note
enabled).

Scheduling Executors —  schedule Method

schedule(): Unit

schedule calls updateAndSyncNumExecutorsTarget to…​FIXME

It then go over removeTimes to remove expired executors, i.e. executors for which
expiration time has elapsed.

updateAndSyncNumExecutorsTarget Method

updateAndSyncNumExecutorsTarget(now: Long): Int

updateAndSyncNumExecutorsTarget …​FIXME

If ExecutorAllocationManager is initializing it returns 0 .

Resetting ExecutorAllocationManager  —  reset

Method

1024
ExecutorAllocationManager — Allocation Manager for Spark Core

reset(): Unit

reset resets ExecutorAllocationManager to its initial state, i.e.

1. initializing is enabled (i.e. true ).

2. The currently-desired number of executors is set to the initial value.

3. The numExecutorsToAdd is set to 1 .

4. All executor pending to remove are cleared.

5. All ??? are cleared.

Stopping ExecutorAllocationManager  —  stop

Method

stop(): Unit

stop shuts down spark-dynamic-executor-allocation allocation executor.

Note stop waits 10 seconds for the termination to be complete.

Creating ExecutorAllocationManager Instance

ExecutorAllocationManager takes the following when created:

ExecutorAllocationClient

LiveListenerBus

SparkConf

ExecutorAllocationManager initializes the internal registries and counters.

Validating Configuration of Dynamic Allocation 

—  validateSettings Internal Method

validateSettings(): Unit

validateSettings makes sure that the settings for dynamic allocation are correct.

validateSettings validates the following and throws a SparkException if not set correctly.

1025
ExecutorAllocationManager — Allocation Manager for Spark Core

1. spark.dynamicAllocation.minExecutors must be positive

2. spark.dynamicAllocation.maxExecutors must be 0 or greater

3. spark.dynamicAllocation.minExecutors must be less than or equal to

spark.dynamicAllocation.maxExecutors

4. spark.dynamicAllocation.executorIdleTimeout must be greater than 0

5. spark.shuffle.service.enabled must be enabled.

6. The number of tasks per core, i.e. spark.executor.cores divided by spark.task.cpus, is

not zero.

Note validateSettings is used when ExecutorAllocationManager is created.

spark-dynamic-executor-allocation Allocation Executor

spark-dynamic-executor-allocation allocation executor is a…​FIXME

It is started…​

It is stopped…​

1026
ExecutorAllocationClient

ExecutorAllocationClient
ExecutorAllocationClient is a contract for clients to communicate with a cluster manager to

request or kill executors.

ExecutorAllocationClient Contract

trait ExecutorAllocationClient {
def getExecutorIds(): Seq[String]
def requestTotalExecutors(numExecutors: Int, localityAwareTasks: Int, hostToLocalTas
kCount: Map[String, Int]): Boolean
def requestExecutors(numAdditionalExecutors: Int): Boolean
def killExecutor(executorId: String): Boolean
def killExecutors(executorIds: Seq[String]): Seq[String]
def killExecutorsOnHost(host: String): Boolean
}

Note ExecutorAllocationClient is a private[spark] contract.

Table 1. ExecutorAllocationClient Contract

Method Description
Finds identifiers of the executors in use.
getExecutorIds
Used when SparkContext calculates the executors in use
and also when Spark Streaming manages executors.

Updates the cluster manager with the exact number of

executors desired. It returns whether the request has
been acknowledged by the cluster manager ( true ) or
not ( false ).

Used when:
SparkContext requests executors (for coarse-
requestTotalExecutors grained scheduler backends only).

ExecutorAllocationManager starts, does

updateAndSyncNumExecutorsTarget, and
addExecutors.
Streaming ExecutorAllocationManager requests
executors.
YarnSchedulerBackend stops.

1027
ExecutorAllocationClient

Requests additional executors from a cluster manager

requestExecutors and returns whether the request has been acknowledged
by the cluster manager ( true ) or not ( false ).
Used when SparkContext requests additional executors
(for coarse-grained scheduler backends only).

Requests a cluster manager to kill a single executor that

is no longer in use and returns whether the request has
been acknowledged by the cluster manager ( true ) or
not ( false ).
The default implementation simply calls killExecutors
(with a single-element collection of executors to kill).
killExecutor
Used when:
ExecutorAllocationManager removes an executor.

SparkContext is requested to kill executors.

Streaming ExecutorAllocationManager is requested

to kill executors.

Requests that a cluster manager to kill one or many

executors that are no longer in use and returns whether
killExecutors the request has been acknowledged by the cluster
manager ( true ) or not ( false ).
Interestingly, it is only used for killExecutor.

killExecutorsOnHost
Used exclusively when BlacklistTracker kills blacklisted
executors.

1028
ExecutorAllocationListener

ExecutorAllocationListener
Caution FIXME

ExecutorAllocationListener is a SparkListener that intercepts events about stages, tasks,

and executors, i.e. onStageSubmitted, onStageCompleted, onTaskStart, onTaskEnd,

onExecutorAdded, and onExecutorRemoved. Using the events ExecutorAllocationManager
can manage the pool of dynamically managed executors.

ExecutorAllocationListener is an internal class of ExecutorAllocationManager

Note
with full access to its internal registries.

1029
ExecutorAllocationManagerSource

ExecutorAllocationManagerSource — Metric
Source for Dynamic Allocation
ExecutorAllocationManagerSource is a metric source for dynamic allocation with name

ExecutorAllocationManager and the following gauges:

executors/numberExecutorsToAdd which exposes numExecutorsToAdd.

executors/numberExecutorsPendingToRemove which corresponds to the number of

elements in executorsPendingToRemove.

executors/numberAllExecutors which corresponds to the number of elements in

executorIds.

executors/numberTargetExecutors which is numExecutorsTarget.

executors/numberMaxNeededExecutors which simply calls maxNumExecutorsNeeded.

Spark uses Metrics Java library to expose internal state of its services to
Note
measure.

1030
HTTP File Server

HTTP File Server

It is started on a driver.

Caution FIXME Review HttpFileServer

Settings
spark.fileserver.port (default: 0 ) - the port of a file server

spark.fileserver.uri (Spark internal) - the URI of a file server

1031
Data Locality

Data locality / placement

Spark relies on data locality, aka data placement or proximity to data source, that makes
Spark jobs sensitive to where the data is located. It is therefore important to have Spark
running on Hadoop YARN cluster if the data comes from HDFS.

In Spark on YARN Spark tries to place tasks alongside HDFS blocks.

With HDFS the Spark driver contacts NameNode about the DataNodes (ideally local)
containing the various blocks of a file or directory as well as their locations (represented as
InputSplits ), and then schedules the work to the SparkWorkers.

Spark’s compute nodes / workers should be running on storage nodes.

Concept of locality-aware scheduling.

Spark tries to execute tasks as close to the data as possible to minimize data transfer (over
the wire).

Figure 1. Locality Level in the Spark UI

There are the following task localities (consult org.apache.spark.scheduler.TaskLocality
object):

PROCESS_LOCAL

NODE_LOCAL

NO_PREF

RACK_LOCAL

ANY

Task location can either be a host or a pair of a host and an executor.

1032
Cache Manager

Cache Manager
Cache Manager in Spark is responsible for passing RDDs partition contents to Block
Manager and making sure a node doesn’t load two copies of an RDD at once.

It keeps reference to Block Manager.

Caution FIXME Review the CacheManager class.

In the code, the current instance of Cache Manager is available under

SparkEnv.get.cacheManager .

Caching Query (cacheQuery method)

Caution FIXME

Uncaching Query (uncacheQuery method)

Caution FIXME

1033
OutputCommitCoordinator

OutputCommitCoordinator
OutputCommitCoordinator service is authority that coordinates result commits by means of

commit locks (using the internal authorizedCommittersByStage registry).

Result commits are the outputs of running tasks (and a running task is described by a task
attempt for a partition in a stage).

A partition (of a stage) is unlocked when it is marked as -1 in

Tip
authorizedCommittersByStage internal registry.

From the scaladoc (it’s a private[spark] class so no way to find it outside the code):

Authority that decides whether tasks can commit output to HDFS. Uses a "first
committer wins" policy. OutputCommitCoordinator is instantiated in both the drivers and
executors. On executors, it is configured with a reference to the driver’s
OutputCommitCoordinatorEndpoint, so requests to commit output will be forwarded to
the driver’s OutputCommitCoordinator.

The most interesting piece is in…​

This class was introduced in SPARK-4879; see that JIRA issue (and the associated pull
requests) for an extensive design discussion.

Authorized committers are task attempts (per partition and stage) that can…​FIXME

Table 1. OutputCommitCoordinator Internal Registries and Counters

Name Description

Tracks commit locks for task attempts for a partition in

a stage.
authorizedCommittersByStage
Used in taskCompleted to authorize task completions
to…​FIXME

Enable INFO or DEBUG logging level for

org.apache.spark.scheduler.OutputCommitCoordinator logger to see what happens
in OutputCommitCoordinator .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.scheduler.OutputCommitCoordinator=DEBUG

Refer to Logging.

1034
OutputCommitCoordinator

stop Method

Caution FIXME

stageStart Method

Caution FIXME

taskCompleted Method

taskCompleted(
stage: StageId,
partition: PartitionId,
attemptNumber: TaskAttemptNumber,
reason: TaskEndReason): Unit

taskCompleted marks the partition (in the stage ) completed (and hence a result

committed), but only when the attemptNumber is amongst authorized committers per stage
(for the partition ).

Internally, taskCompleted first finds authorized committers for the stage .

For task completions with no stage registered in authorizedCommittersByStage internal

registry, you should see the following DEBUG message in the logs and taskCompleted
simply exits.

DEBUG OutputCommitCoordinator: Ignoring task completion for completed stage

For the reason being Success taskCompleted does nothing and exits.

For the reason being TaskCommitDenied , you should see the following INFO message in
the logs and taskCompleted exits.

INFO OutputCommitCoordinator: Task was denied committing, stage: [stage], partition: [

partition], attempt: [attemptNumber]

For no stage registered or reason being Success or TaskCommitDenied ,

Note
taskCompleted does nothing (important).

For task completion reasons other than Success or TaskCommitDenied and attemptNumber
amongst authorized committers, taskCompleted marks partition unlocked.

1035
OutputCommitCoordinator

Note A task attempt can never be -1 .

When the lock for partition is cleared, You should see the following DEBUG message in
the logs:

DEBUG OutputCommitCoordinator: Authorized committer (attemptNumber=[attemptNumber], st

age=[stage], partition=[partition]) failed; clearing lock

taskCompleted is executed only when DAGScheduler informs that a task has

Note
completed.

1036
RpcEnv — RPC Environment

RpcEnv — RPC Environment
FIXME
Caution How to know the available endpoints in the environment? See the
exercise Developing RPC Environment.

RPC Environment (aka RpcEnv) is an environment for RpcEndpoints to process

messages. A RPC Environment manages the entire lifecycle of RpcEndpoints:

registers (sets up) endpoints (by name or uri)

routes incoming messages to them

stops them

A RPC Environment is defined by the name, host, and port. It can also be controlled by a
security manager.

You can create a RPC Environment using RpcEnv.create factory methods.

The only implementation of RPC Environment is Netty-based implementation.

A RpcEndpoint defines how to handle messages (what functions to execute given a

message). RpcEndpoints register (with a name or uri) to RpcEnv to receive messages from
RpcEndpointRefs.

Figure 1. RpcEnvironment with RpcEndpoints and RpcEndpointRefs

1037
RpcEnv — RPC Environment

RpcEndpointRefs can be looked up by name or uri (because different RpcEnvs may have
different naming schemes).

org.apache.spark.rpc package contains the machinery for RPC communication in Spark.

Client Mode = is this an executor or the driver?

When an RPC Environment is initialized as part of the initialization of the driver or executors
(using RpcEnv.create ), clientMode is false for the driver and true for executors.

RpcEnv.create(actorSystemName, hostname, port, conf, securityManager, clientMode = !is

Driver)

Refer to Client Mode in Netty-based RpcEnv for the implementation-specific details.

Creating RpcEndpointRef For URI 

—  asyncSetupEndpointRefByURI Method

Caution FIXME

Creating RpcEndpointRef For URI 

—  setupEndpointRefByURI Method

Caution FIXME

shutdown Method

Caution FIXME

Registering RPC Endpoint —  setupEndpoint Method

Caution FIXME

awaitTermination Method

Caution FIXME

ThreadSafeRpcEndpoint

1038
RpcEnv — RPC Environment

ThreadSafeRpcEndpoint is a marker RpcEndpoint that does nothing by itself but tells…​

Caution FIXME What is marker?

Note ThreadSafeRpcEndpoint is a private[spark] trait .

RpcAddress
RpcAddress is the logical address for an RPC Environment, with hostname and port.

RpcAddress is encoded as a Spark URL, i.e. spark://host:port .

RpcEndpointAddress
RpcEndpointAddress is the logical address for an endpoint registered to an RPC
Environment, with RpcAddress and name.

It is in the format of spark://[name]@[rpcAddress.host]:[rpcAddress.port].

Stopping RpcEndpointRef —  stop Method

stop(endpoint: RpcEndpointRef): Unit

Caution FIXME

Endpoint Lookup Timeout

When a remote endpoint is resolved, a local RPC environment connects to the remote one.
It is called endpoint lookup. To configure the time needed for the endpoint lookup you can
use the following settings.

It is a prioritized list of lookup timeout properties (the higher on the list, the more important):

spark.rpc.lookupTimeout

spark.network.timeout

Their value can be a number alone (seconds) or any number with time suffix, e.g. 50s ,
100ms , or 250us . See Settings.

Ask Operation Timeout

1039
RpcEnv — RPC Environment

Ask operation is when a RPC client expects a response to a message. It is a blocking

operation.

You can control the time to wait for a response using the following settings (in that order):

spark.rpc.askTimeout

spark.network.timeout

Their value can be a number alone (seconds) or any number with time suffix, e.g. 50s ,
100ms , or 250us . See Settings.

Exceptions
When RpcEnv catches uncaught exceptions, it uses RpcCallContext.sendFailure to send
exceptions back to the sender, or logging them if no such sender or
NotSerializableException .

If any error is thrown from one of RpcEndpoint methods except onError , onError will be
invoked with the cause. If onError throws an error, RpcEnv will ignore it.

RpcEnvConfig
RpcEnvConfig is a placeholder for an instance of SparkConf, the name of the RPC

Environment, host and port, a security manager, and clientMode.

Creating RpcEnv —  create Factory Methods

create(
name: String,
host: String,
port: Int,
conf: SparkConf,
securityManager: SecurityManager,
clientMode: Boolean = false): RpcEnv (1)

create(
name: String,
bindAddress: String,
advertiseAddress: String,
port: Int,
conf: SparkConf,
securityManager: SecurityManager,
clientMode: Boolean): RpcEnv

1040
RpcEnv — RPC Environment

1. The 6-argument create (with clientMode disabled) simply passes the input
arguments on to the second create making bindAddress and advertiseAddress the
same.

create creates a RpcEnvConfig (with the input arguments) and creates a NettyRpcEnv .

Copied (almost verbatim) from SPARK-10997 Netty-based RPC env should

support a "client-only" mode and the commit:
"Client mode" means the RPC env will not listen for incoming connections.
This allows certain processes in the Spark stack (such as Executors or tha
YARN client-mode AM) to act as pure clients when using the netty-based RPC
backend, reducing the number of sockets Spark apps need to use and also the
number of open ports.
Note The AM connects to the driver in "client mode", and that connection is used for
all driver — AM communication, and so the AM is properly notified when the
connection goes down.
In "general", non-YARN case, clientMode flag is therefore enabled for
executors and disabled for the driver.
In Spark on YARN in client deploy mode, clientMode flag is however
enabled explicitly when Spark on YARN’s ApplicationMaster creates the
sparkYarnAM RPC Environment.

create is used when:

1. SparkEnv creates a RpcEnv (for the driver and executors).

2. Spark on YARN’s ApplicationMaster creates the sparkYarnAM RPC

Environment (with clientMode enabled).
3. CoarseGrainedExecutorBackend creates the temporary
driverPropsFetcher RPC Environment (to fetch the current Spark
Note properties from the driver).

4. org.apache.spark.deploy.Client standalone application creates the

driverClient RPC Environment.

5. Spark Standalone’s master creates the sparkMaster RPC Environment.

6. Spark Standalone’s worker creates the sparkWorker RPC Environment.

7. Spark Standalone’s DriverWrapper creates the Driver RPC Environment.

Settings

1041
RpcEnv — RPC Environment

Table 1. Spark Properties

Spark Property Default Value Description

Timeout to use for RPC remote

spark.rpc.lookupTimeout 120s endpoint lookup. Refer to Endpoint
Lookup Timeout

Number of attempts to send a

spark.rpc.numRetries 3 message to and receive a response
from a remote endpoint.

spark.rpc.retry.wait 3s Time to wait between retries.

spark.rpc.askTimeout 120s
Timeout for RPC ask calls. Refer to
Ask Operation Timeout.

Network timeout to use for RPC

spark.network.timeout 120s remote endpoint lookup. Fallback for
spark.rpc.askTimeout.

1042
RpcEndpoint

RpcEndpoint
RpcEndpoint is a contract to define an RPC endpoint that can receive messages using

callbacks, i.e. functions to execute when a message arrives.

package org.apache.spark.rpc

trait RpcEndpoint {
def onConnected(remoteAddress: RpcAddress): Unit
def onDisconnected(remoteAddress: RpcAddress): Unit
def onError(cause: Throwable): Unit
def onNetworkError(cause: Throwable, remoteAddress: RpcAddress): Unit
def onStart(): Unit
def onStop(): Unit
def receive: PartialFunction[Any, Unit]
def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit]
val rpcEnv: RpcEnv
}

RpcEndpoint lives in RpcEnv after being registered by a name.

A RpcEndpoint can be registered to one and only one RpcEnv.

The lifecycle of a RpcEndpoint is onStart , receive and onStop in sequence.

receive can be called concurrently.

Tip If you want receive to be thread-safe, use ThreadSafeRpcEndpoint.

onError method is called for any exception thrown.

Table 1. RpcEndpoint Contract

Method Description
receive Receives and processes a message

Note RpcEndpoint is a private[spark] contract.

Activating RPC Endpoint (Just Before Handling Messages) 

—  onStart Method

Caution FIXME

1043
RpcEndpoint

stop Method

Caution FIXME

1044
RpcEndpointRef

RpcEndpointRef — Reference to RPC Endpoint

RpcEndpointRef is a reference to a RpcEndpoint in a RpcEnv.

RpcEndpointRef is a serializable entity and so you can send it over a network or save it for

later use (it can however be deserialized using the owning RpcEnv only).

A RpcEndpointRef has an address (a Spark URL), and a name.

You can send asynchronous one-way messages to the corresponding RpcEndpoint using
send method.

You can send a semi-synchronous message, i.e. "subscribe" to be notified when a response
arrives, using ask method. You can also block the current calling thread for a response
using askWithRetry method.

spark.rpc.numRetries (default: 3 ) - the number of times to retry connection attempts.

spark.rpc.retry.wait (default: 3s ) - the number of milliseconds to wait on each retry.

It also uses lookup timeouts.

send Method

Caution FIXME

askWithRetry Method

Caution FIXME

1045
RpcEnvFactory

RpcEnvFactory
RpcEnvFactory is the contract to create a RPC Environment.

As of this commit in Spark 2, the one and only RpcEnvFactory is Netty-based

Note
NettyRpcEnvFactory .

RpcEnvFactory Contract

trait RpcEnvFactory {
def create(config: RpcEnvConfig): RpcEnv
}

Note RpcEnvFactory is a private[spark] contract.

Table 1. RpcEnvFactory Contract

Method Description
create Used when RpcEnv creates a RPC Environment.

1046
Netty-based RpcEnv

Netty-based RpcEnv
Read up RpcEnv — RPC Environment on the concept of RPC Environment in
Tip
Spark.

The class org.apache.spark.rpc.netty.NettyRpcEnv is the implementation of RpcEnv using

Netty - "an asynchronous event-driven network application framework for rapid development
of maintainable high performance protocol servers & clients".

Netty-based RPC Environment is created by NettyRpcEnvFactory when spark.rpc is netty

or org.apache.spark.rpc.netty.NettyRpcEnvFactory .

It uses Java’s built-in serialization (the implementation of JavaSerializerInstance ).

Caution FIXME What other choices of JavaSerializerInstance are available in Spark?

NettyRpcEnv is only started on the driver. See Client Mode.

The default port to listen to is 7077 .

When NettyRpcEnv starts, the following INFO message is printed out in the logs:

INFO Utils: Successfully started service 'NettyRpcEnv' on port 0.

Set DEBUG for org.apache.spark.network.server.TransportServer logger to know

when Shuffle server/NettyRpcEnv starts listening to messages.

Tip DEBUG Shuffle server started on port :

FIXME: The message above in TransportServer has a space before : .

Creating NettyRpcEnv —  create Method

Caution FIXME

Client Mode
Refer to Client Mode = is this an executor or the driver? for introduction about client mode.
This is only for Netty-based RpcEnv.

1047
Netty-based RpcEnv

When created, a Netty-based RpcEnv starts the RPC server and register necessary
endpoints for non-client mode, i.e. when client mode is false .

Caution FIXME What endpoints?

It means that the required services for remote communication with NettyRpcEnv are only
started on the driver (not executors).

Thread Pools

shuffle-server-ID
EventLoopGroup uses a daemon thread pool called shuffle-server-ID , where ID is a

unique integer for NioEventLoopGroup ( NIO ) or EpollEventLoopGroup ( EPOLL ) for the

Shuffle server.

Caution FIXME Review Netty’s NioEventLoopGroup .

FIXME Where are SO_BACKLOG , SO_RCVBUF , SO_SNDBUF channel options

Caution
used?

dispatcher-event-loop-ID
NettyRpcEnv’s Dispatcher uses the daemon fixed thread pool with
spark.rpc.netty.dispatcher.numThreads threads.

Thread names are formatted as dispatcher-event-loop-ID , where ID is a unique,

sequentially assigned integer.

It starts the message processing loop on all of the threads.

netty-rpc-env-timeout
NettyRpcEnv uses the daemon single-thread scheduled thread pool netty-rpc-env-timeout .

"netty-rpc-env-timeout" #87 daemon prio=5 os_prio=31 tid=0x00007f887775a000 nid=0xc503

waiting on condition [0x0000000123397000]

netty-rpc-connection-ID
NettyRpcEnv uses the daemon cached thread pool with up to spark.rpc.connect.threads
threads.

1048
Netty-based RpcEnv

Thread names are formatted as netty-rpc-connection-ID , where ID is a unique,

sequentially assigned integer.

Settings
The Netty-based implementation uses the following properties:

spark.rpc.io.mode (default: NIO ) - NIO or EPOLL for low-level IO. NIO is always

available, while EPOLL is only available on Linux. NIO uses

io.netty.channel.nio.NioEventLoopGroup while EPOLL

io.netty.channel.epoll.EpollEventLoopGroup .

spark.shuffle.io.numConnectionsPerPeer always equals 1

spark.rpc.io.threads (default: 0 ; maximum: 8 ) - the number of threads to use for

the Netty client and server thread pools.

spark.shuffle.io.serverThreads (default: the value of spark.rpc.io.threads )

spark.shuffle.io.clientThreads (default: the value of spark.rpc.io.threads )

spark.rpc.netty.dispatcher.numThreads (default: the number of processors available to

JVM)

spark.rpc.connect.threads (default: 64 ) - used in cluster mode to communicate with a

remote RPC endpoint

spark.port.maxRetries (default: 16 or 100 for testing when spark.testing is set)

controls the maximum number of binding attempts/retries to a port before giving up.

Endpoints
endpoint-verifier ( RpcEndpointVerifier ) - a RpcEndpoint for remote RpcEnvs to

query whether an RpcEndpoint exists or not. It uses Dispatcher that keeps track of
registered endpoints and responds true / false to CheckExistence message.

endpoint-verifier is used to check out whether a given endpoint exists or not before the

endpoint’s reference is given back to clients.

One use case is when an AppClient connects to standalone Masters before it registers the
application it acts for.

Caution FIXME Who’d like to use endpoint-verifier and how?

Message Dispatcher

1049
Netty-based RpcEnv

A message dispatcher is responsible for routing RPC messages to the appropriate

endpoint(s).

It uses the daemon fixed thread pool dispatcher-event-loop with

spark.rpc.netty.dispatcher.numThreads threads for dispatching messages.

"dispatcher-event-loop-0" #26 daemon prio=5 os_prio=31 tid=0x00007f8877153800 nid=0x71

03 waiting on condition [0x000000011f78b000]

1050
TransportConf — Transport Configuration

TransportConf — Transport Configuration
TransportConf is a class for the transport-related network configuration for modules, e.g.

ExternalShuffleService or YarnShuffleService.

It exposes methods to access settings for a single module as spark.module.prefix or general

network-related settings.

Creating TransportConf from SparkConf 

—  fromSparkConf Method

fromSparkConf(_conf: SparkConf, module: String, numUsableCores: Int = 0): TransportConf

Note fromSparkConf belongs to SparkTransportConf object.

fromSparkConf creates a TransportConf for module from the given SparkConf.

Internally, fromSparkConf calculates the default number of threads for both the Netty client
and server thread pools.

fromSparkConf uses spark.[module].io.serverThreads and spark.

[module].io.clientThreads if specified for the number of threads to use. If not defined,

fromSparkConf sets them to the default number of threads calculated earlier.

Calculating Default Number of Threads (8 Maximum) 

—  defaultNumThreads Internal Method

defaultNumThreads(numUsableCores: Int): Int

Note defaultNumThreads belongs to SparkTransportConf object.

defaultNumThreads calculates the default number of threads for both the Netty client and

server thread pools that is 8 maximum or numUsableCores is smaller. If numUsableCores is

not specified, defaultNumThreads uses the number of processors available to the Java
virtual machine.

Note 8 is the maximum number of threads for Netty and is not configurable.

Note defaultNumThreads uses Java’s Runtime for the number of processors in JVM.

1051
TransportConf — Transport Configuration

spark.module.prefix Settings
The settings can be in the form of spark.[module].[prefix] with the following prefixes:

io.mode (default: NIO ) — the IO mode: nio or epoll .

io.preferDirectBufs (default: true ) — a flag to control whether Spark prefers

allocating off-heap byte buffers within Netty ( true ) or not ( false ).

io.connectionTimeout (default: spark.network.timeout or 120s ) — the connection

timeout in milliseconds.

io.backLog (default: -1 for no backlog) — the requested maximum length of the

queue of incoming connections.

io.numConnectionsPerPeer (default: 1 ) — the number of concurrent connections

between two nodes for fetching data.

io.serverThreads (default: 0 i.e. 2x#cores) — the number of threads used in the

server thread pool.

io.clientThreads (default: 0 i.e. 2x#cores) — the number of threads used in the client

thread pool.

io.receiveBuffer (default: -1 ) — the receive buffer size (SO_RCVBUF).

io.sendBuffer (default: -1 ) — the send buffer size (SO_SNDBUF).

sasl.timeout (default: 30s ) — the timeout (in milliseconds) for a single round trip of

SASL token exchange.

io.maxRetries (default: 3 ) — the maximum number of times Spark will try IO

exceptions (such as connection timeouts) per request. If set to 0 , Spark will not do any
retries.

io.retryWait (default: 5s ) — the time (in milliseconds) that Spark will wait in order to

perform a retry after an IOException . Only relevant if io.maxRetries > 0.

io.lazyFD (default: true ) — controls whether to initialize FileDescriptor lazily

( true ) or not ( false ). If true , file descriptors are created only when data is going to
be transferred. This can reduce the number of open files.

General Network-Related Settings

spark.storage.memoryMapThreshold

1052
TransportConf — Transport Configuration

spark.storage.memoryMapThreshold (default: 2m ) is the minimum size of a block that we

should start using memory map rather than reading in through normal IO operations.

This prevents Spark from memory mapping very small blocks. In general, memory mapping
has high overhead for blocks close to or below the page size of the OS.

spark.network.sasl.maxEncryptedBlockSize
spark.network.sasl.maxEncryptedBlockSize (default: 64k ) is the maximum number of bytes

to be encrypted at a time when SASL encryption is enabled.

spark.network.sasl.serverAlwaysEncrypt
spark.network.sasl.serverAlwaysEncrypt (default: false ) controls whether the server

should enforce encryption on SASL-authenticated connections ( true ) or not ( false ).

1053
Utils Helper Object

Utils Helper Object

Utils is a Scala object that…​FIXME

getLocalDir Method

getLocalDir(conf: SparkConf): String

getLocalDir …​FIXME

getLocalDir is used when:

Utils is requested to fetchFile

SparkEnv is created (on the driver)

spark-shell is launched
Note Spark on YARN’s Client is requested to prepareLocalResources and
create __spark_conf__.zip archive with configuration files and Spark
configuration
PySpark’s PythonBroadcast is requested to readObject
PySpark’s EvalPythonExec is requested to doExecute

fetchFile Method

fetchFile(
url: String,
targetDir: File,
conf: SparkConf,
securityMgr: SecurityManager,
hadoopConf: Configuration,
timestamp: Long,
useCache: Boolean): File

fetchFile …​FIXME

1054
Utils Helper Object

fetchFile is used when:

SparkContext is requested to addFile

Note
Executor is requested to updateDependencies

Spark Standalone’s DriverRunner is requested to downloadUserJar

getOrCreateLocalRootDirsImpl Internal Method

getOrCreateLocalRootDirsImpl(conf: SparkConf): Array[String]

getOrCreateLocalRootDirsImpl …​FIXME

getOrCreateLocalRootDirsImpl is used exclusively when Utils is requested to

Note
getOrCreateLocalRootDirs

getOrCreateLocalRootDirs Internal Method

getOrCreateLocalRootDirs(conf: SparkConf): Array[String]

getOrCreateLocalRootDirs …​FIXME

getOrCreateLocalRootDirs is used when:

Utils is requested to getLocalDir

Note
Worker is requested to handle a LaunchExecutor message

1055
Securing Web UI

Securing Web UI
Tip Read the official document Web UI.

To secure Web UI you implement a security filter and use spark.ui.filters setting to refer
to the class.

Examples of filters implementing basic authentication:

Servlet filter for HTTP basic auth

neolitec/BasicAuthenticationFilter.java

1056
Deployment Environments — Run Modes

Deployment Environments — Run Modes

Spark Deployment Environments (aka Run Modes):

local

clustered

Spark Standalone

Spark on Apache Mesos

Spark on Hadoop YARN

A Spark application is composed of the driver and executors that can run locally (on a single
JVM) or using cluster resources (like CPU, RAM and disk that are managed by a cluster
manager).

You can specify where to run the driver using the deploy mode (using --deploy-
Note
mode option of spark-submit or spark.submit.deployMode Spark property).

Master URLs
Spark supports the following master URLs (see private object SparkMasterRegex):

local , local[N] and local[*] for Spark local

local[N, maxRetries] for Spark local-with-retries

local-cluster[N, cores, memory] for simulating a Spark cluster of N executors

(threads), cores CPUs and memory locally (aka Spark local-cluster)

spark://host:port,host1:port1,…​ for connecting to Spark Standalone cluster(s)

mesos:// for Spark on Mesos cluster

yarn for Spark on YARN

You can specify the master URL of a Spark application as follows:

1. spark-submit’s --master command-line option,

2. spark.master Spark property,

3. When creating a SparkContext (using setMaster method),

4. When creating a SparkSession (using master method of the builder interface).

1057
Deployment Environments — Run Modes

1058
Spark local (pseudo-cluster)

Spark local (pseudo-cluster)

You can run Spark in local mode. In this non-distributed single-JVM deployment mode,
Spark spawns all the execution components - driver, executor, LocalSchedulerBackend, and
master - in the same single JVM. The default parallelism is the number of threads as
specified in the master URL. This is the only mode where a driver is used for execution.

Figure 1. Architecture of Spark local

The local mode is very convenient for testing, debugging or demonstration purposes as it
requires no earlier setup to launch Spark applications.

This mode of operation is also called Spark in-process or (less commonly) a local version
of Spark.

SparkContext.isLocal returns true when Spark runs in local mode.

scala> sc.isLocal
res0: Boolean = true

Spark shell defaults to local mode with local[*] as the the master URL.

1059
Spark local (pseudo-cluster)

scala> sc.master
res0: String = local[*]

Tasks are not re-executed on failure in local mode (unless local-with-retries master URL is
used).

The task scheduler in local mode works with LocalSchedulerBackend task scheduler
backend.

Master URL
You can run Spark in local mode using local , local[n] or the most general local[*] for
the master URL.

The URL says how many threads can be used in total:

local uses 1 thread only.

local[n] uses n threads.

local[*] uses as many threads as the number of processors available to the Java

virtual machine (it uses Runtime.getRuntime.availableProcessors() to know the

number).

FIXME What happens when there’s less cores than n in the master URL?
Caution
It is a question from twitter.

local[N, maxFailures] (called local-with-retries) with N being * or the number of

threads to use (as explained above) and maxFailures being the value of
spark.task.maxFailures.

Task Submission a.k.a. reviveOffers

1060
Spark local (pseudo-cluster)

Figure 2. TaskSchedulerImpl.submitTasks in local mode

When ReviveOffers or StatusUpdate messages are received, LocalEndpoint places an
offer to TaskSchedulerImpl (using TaskSchedulerImpl.resourceOffers ).

If there is one or more tasks that match the offer, they are launched (using
executor.launchTask method).

The number of tasks to be launched is controlled by the number of threads as specified in

master URL. The executor uses threads to spawn the tasks.

1061
LocalSchedulerBackend

LocalSchedulerBackend
LocalSchedulerBackend is a scheduler backend and a ExecutorBackend for Spark local run

mode.

LocalSchedulerBackend acts as a "cluster manager" for local mode to offer resources on the

single worker it manages, i.e. it calls TaskSchedulerImpl.resourceOffers(offers) with

offers being a single-element collection with WorkerOffer.

WorkerOffer represents a resource offer with CPU cores available on an

Note
executor.

When an executor sends task status updates (using ExecutorBackend.statusUpdate ), they

are passed along as StatusUpdate to LocalEndpoint.

Figure 1. Task status updates flow in local mode

When LocalSchedulerBackend starts up, it registers a new RpcEndpoint called
LocalSchedulerBackendEndpoint that is backed by LocalEndpoint. This is announced on
LiveListenerBus as driver (using SparkListenerExecutorAdded message).

The application ids are in the format of local-[current time millis] .

It communicates with LocalEndpoint using RPC messages.

The default parallelism is controlled using spark.default.parallelism property.

1062
LocalEndpoint

LocalEndpoint
LocalEndpoint is the communication channel between Task Scheduler and

LocalSchedulerBackend. It is a (thread-safe) RpcEndpoint that hosts an executor (with id

driver and hostname localhost ) for Spark local mode.

When a LocalEndpoint starts up (as part of Spark local’s initialization) it prints out the
following INFO messages to the logs:

INFO Executor: Starting executor ID driver on host localhost

INFO Executor: Using REPL class URI: http://192.168.1.4:56131

reviveOffers Method

Caution FIXME

Creating LocalEndpoint Instance

Caution FIXME

RPC Messages
LocalEndpoint accepts the following RPC message types:

ReviveOffers (receive-only, non-blocking) - read Task Submission a.k.a. reviveOffers.

StatusUpdate (receive-only, non-blocking) that passes the message to TaskScheduler

(using statusUpdate ) and if the task’s status is finished, it revives offers (see
ReviveOffers ).

KillTask (receive-only, non-blocking) that kills the task that is currently running on the

executor.

StopExecutor (receive-reply, blocking) that stops the executor.

1063
Spark on cluster

Spark Clustered
Spark can be run in distributed mode on a cluster. The following (open source) cluster
managers (aka task schedulers aka resource managers) are currently supported:

Spark’s own built-in Standalone cluster manager

Hadoop YARN

Apache Mesos

Here is a very brief list of pros and cons of using one cluster manager versus the other
options supported by Spark:

1. Spark Standalone is included in the official distribution of Apache Spark.

2. Hadoop YARN has a very good support for HDFS with data locality.

3. Apache Mesos makes resource offers that a framework can accept or reject. It is Spark
(as a Mesos framework) to decide what resources to accept. It is a push-based
resource management model.

4. Hadoop YARN responds to a YARN framework’s resource requests. Spark (as a YARN
framework) requests CPU and memory from YARN. It is a pull-based resource
management model.

5. Hadoop YARN supports Kerberos for a secured HDFS.

Running Spark on a cluster requires workload and resource management on distributed

systems.

Spark driver requests resources from a cluster manager. Currently only CPU and memory
are requested resources. It is a cluster manager’s responsibility to spawn Spark executors in
the cluster (on its workers).

FIXME
Spark execution in cluster - Diagram of the communication between
driver, cluster manager, workers with executors and tasks. See Cluster
Mode Overview.

Caution Show Spark’s driver with the main code in Scala in the box
Nodes with executors with tasks
Hosts drivers

Manages a cluster

1064
Spark on cluster

The workers are in charge of communicating the cluster manager the availability of their
resources.

Communication with a driver is through a RPC interface (at the moment Akka), except
Mesos in fine-grained mode.

Executors remain alive after jobs are finished for future ones. This allows for better data
utilization as intermediate data is cached in memory.

Spark reuses resources in a cluster for:

efficient data sharing

fine-grained partitioning

low-latency scheduling

Reusing also means the the resources can be hold onto for a long time.

Spark reuses long-running executors for speed (contrary to Hadoop MapReduce using
short-lived containers for each task).

Spark Application Submission to Cluster

When you submit a Spark application to the cluster this is what happens (see the answers to
the answer to What are workers, executors, cores in Spark Standalone cluster? on
StackOverflow):

The Spark driver is launched to invoke the main method of the Spark application.

The driver asks the cluster manager for resources to run the application, i.e. to launch
executors that run tasks.

The cluster manager launches executors.

The driver runs the Spark application and sends tasks to the executors.

Executors run the tasks and save the results.

Right after SparkContext.stop() is executed from the driver or the main method has
exited all the executors are terminated and the cluster resources are released by the
cluster manager.

"There’s not a good reason to run more than one worker per machine." by Sean
Note Owen in What is the relationship between workers, worker instances, and
executors?

1065
Spark on cluster

One executor per node may not always be ideal, esp. when your nodes have
Caution lots of RAM. On the other hand, using fewer executors has benefits like
more efficient broadcasts.

Two modes of launching executors

Warning Review core/src/main/scala/org/apache/spark/deploy/master/Master.scala

Others
Spark application can be split into the part written in Scala, Java, and Python with the
cluster itself in which the application is going to run.

Spark application runs on a cluster with the help of cluster manager.

A Spark application consists of a single driver process and a set of executor processes
scattered across nodes on the cluster.

Both the driver and the executors usually run as long as the application. The concept of
dynamic resource allocation has changed it.

Caution FIXME Figure

A node is a machine, and there’s not a good reason to run more than one worker per
machine. So two worker nodes typically means two machines, each a Spark worker.

Workers hold many executors for many applications. One application has executors on
many workers.

1066
Spark on YARN

Spark on YARN
You can submit Spark applications to a Hadoop YARN cluster using yarn master URL.

spark-submit --master yarn mySparkApp.jar

Since Spark 2.0.0, yarn master URL is the only proper master URL and you
Note can use --deploy-mode to choose between client (default) or cluster
modes.

Figure 1. Submitting Spark Application to YARN Cluster (aka Creating SparkContext with
yarn Master URL and client Deploy Mode)
Without specifying the deploy mode, it is assumed client .

spark-submit --master yarn --deploy-mode client mySparkApp.jar

There are two deploy modes for YARN — client (default) or cluster.

Tip Deploy modes are all about where the Spark driver runs.

In client mode the Spark driver (and SparkContext) runs on a client node outside a YARN
cluster whereas in cluster mode it runs inside a YARN cluster, i.e. inside a YARN container
alongside ApplicationMaster (that acts as the Spark application in YARN).

1067
Spark on YARN

spark-submit --master yarn --deploy-mode cluster mySparkApp.jar

In that sense, a Spark application deployed to YARN is a YARN-compatible execution

framework that can be deployed to a YARN cluster (alongside other Hadoop workloads). On
YARN, a Spark executor maps to a single YARN container.

In order to deploy applications to YARN clusters, you need to use Spark with
Note
YARN support.

Spark on YARN supports multiple application attempts and supports data locality for data in
HDFS. You can also take advantage of Hadoop’s security and run Spark in a secure Hadoop
environment using Kerberos authentication (aka Kerberized clusters).

There are few settings that are specific to YARN (see Settings). Among them, you can
particularly like the support for YARN resource queues (to divide cluster resources and
allocate shares to different teams and users based on advanced policies).

You can start spark-submit with --verbose command-line option to have some
Tip
settings displayed, including YARN-specific. See spark-submit and YARN options.

The memory in the YARN resource requests is --executor-memory + what’s set for
spark.yarn.executor.memoryOverhead, which defaults to 10% of --executor-memory .

If YARN has enough resources it will deploy the executors distributed across the cluster,
then each of them will try to process the data locally ( NODE_LOCAL in Spark Web UI), with as
many splits in parallel as you defined in spark.executor.cores.

Multiple Application Attempts

Spark on YARN supports multiple application attempts in cluster mode.

See YarnRMClient.getMaxRegAttempts.

Caution FIXME

spark-submit and YARN options

When you submit your Spark applications using spark-submit you can use the following
YARN-specific command-line options:

--archives

--executor-cores

--keytab

1068
Spark on YARN

--num-executors

--principal

--queue

Tip Read about the corresponding settings in Settings in this document.

Memory Requirements
When Client submits a Spark application to a YARN cluster, it makes sure that the
application will not request more than the maximum memory capability of the YARN cluster.

The memory for ApplicationMaster is controlled by custom settings per deploy mode.

For client deploy mode it is a sum of spark.yarn.am.memory (default: 512m ) with an optional
overhead as spark.yarn.am.memoryOverhead.

For cluster deploy mode it is a sum of spark.driver.memory (default: 1g ) with an optional

overhead as spark.yarn.driver.memoryOverhead.

If the optional overhead is not set, it is computed as 10% of the main memory
(spark.yarn.am.memory for client mode or spark.driver.memory for cluster mode) or 384m
whatever is larger.

Spark with YARN support

You need to have Spark that has been compiled with YARN support, i.e. the class
org.apache.spark.deploy.yarn.Client must be on the CLASSPATH.

Otherwise, you will see the following error in the logs and Spark will exit.

Error: Could not load YARN classes. This copy of Spark may not have been compiled with
YARN support.

Master URL
Since Spark 2.0.0, the only proper master URL is yarn .

./bin/spark-submit --master yarn ...

Before Spark 2.0.0, you could have used yarn-client or yarn-cluster , but it is now
deprecated. When you use the deprecated master URLs, you should see the following
warning in the logs:

1069
Spark on YARN

Warning: Master yarn-client is deprecated since 2.0. Please use master "yarn" with spe
cified deploy mode instead.

Keytab

Caution FIXME

When a principal is specified a keytab must be specified, too.

The settings spark.yarn.principal and spark.yarn.principal will be set to respective values

and UserGroupInformation.loginUserFromKeytab will be called with their values as input
arguments.

Environment Variables

SPARK_DIST_CLASSPATH
SPARK_DIST_CLASSPATH is a distribution-defined CLASSPATH to add to processes.

It is used to populate CLASSPATH for ApplicationMaster and executors.

Settings

Caution FIXME Where and how are they used?

Further reading or watching

(video) Spark on YARN: a Deep Dive — Sandy Ryza (Cloudera)

(video) Spark on YARN: The Road Ahead — Marcelo Vanzin (Cloudera) from Spark
Summit 2015

1070
YarnShuffleService — ExternalShuffleService on YARN

YarnShuffleService — ExternalShuffleService
on YARN
YarnShuffleService is an external shuffle service for Spark on YARN. It is YARN

NodeManager’s auxiliary service that implements

org.apache.hadoop.yarn.server.api.AuxiliaryService .

There is the ExternalShuffleService for Spark and despite their names they
Note
don’t share code.

FIXME What happens when the spark.shuffle.service.enabled flag is

Caution
enabled?

YarnShuffleService is configured in yarn-site.xml configuration file and is initialized on

each YARN NodeManager node when the node(s) starts.

After the external shuffle service is configured in YARN you enable it in a Spark application
using spark.shuffle.service.enabled flag.

Note YarnShuffleService was introduced in SPARK-3797.

Enable INFO logging level for org.apache.spark.network.yarn.YarnShuffleService

logger in YARN logging system to see what happens inside.

log4j.logger.org.apache.spark.network.yarn.YarnShuffleService=INFO
Tip
YARN saves logs in /usr/local/Cellar/hadoop/2.7.2/libexec/logs directory on
Mac OS X with brew, e.g. /usr/local/Cellar/hadoop/2.7.2/libexec/logs/yarn-
jacek-nodemanager-japila.local.log .

Advantages
The advantages of using the YARN Shuffle Service:

With dynamic allocation enabled executors can be discarded and a Spark application
could still get at the shuffle data the executors wrote out.

It allows individual executors to go into GC pause (or even crash) and still allow other
Executors to read shuffle data and make progress.

Creating YarnShuffleService Instance

1071
YarnShuffleService — ExternalShuffleService on YARN

When YarnShuffleService is created, it calls YARN’s AuxiliaryService with spark_shuffle

service name.

You should see the following INFO message in the logs:

INFO org.apache.spark.network.yarn.YarnShuffleService: Initializing YARN shuffle servi

ce for Spark
INFO org.apache.hadoop.yarn.server.nodemanager.containermanager.AuxServices: Adding au
xiliary service spark_shuffle, "spark_shuffle"

getRecoveryPath
Caution FIXME

serviceStop

void serviceStop()

serviceStop is part of YARN’s AuxiliaryService contract and is called when…​FIXME

Caution FIXME The contract

When called, serviceStop simply closes shuffleServer and blockHandler .

Caution FIXME What are shuffleServer and blockHandler ? What’s their lifecycle?

When an exception occurs, you should see the following ERROR message in the logs:

ERROR org.apache.spark.network.yarn.YarnShuffleService: Exception when stopping service

stopContainer

void stopContainer(ContainerTerminationContext context)

stopContainer is part of YARN’s AuxiliaryService contract and is called when…​FIXME

Caution FIXME The contract

When called, stopContainer simply prints out the following INFO message in the logs and
exits.

1072
YarnShuffleService — ExternalShuffleService on YARN

INFO org.apache.spark.network.yarn.YarnShuffleService: Stopping container [containerId]

It obtains the containerId from context using getContainerId method.

initializeContainer

void initializeContainer(ContainerInitializationContext context)

initializeContainer is part of YARN’s AuxiliaryService contract and is called

when…​FIXME

Caution FIXME The contract

When called, initializeContainer simply prints out the following INFO message in the logs
and exits.

INFO org.apache.spark.network.yarn.YarnShuffleService: Initializing container [contain

erId]

It obtains the containerId from context using getContainerId method.

stopApplication

void stopApplication(ApplicationTerminationContext context)

stopApplication is part of YARN’s AuxiliaryService contract and is called when…​FIXME

Caution FIXME The contract

stopApplication requests the ShuffleSecretManager to unregisterApp when authentication

is enabled and ExternalShuffleBlockHandler to applicationRemoved .

When called, stopApplication obtains YARN’s ApplicationId for the application (using the
input context ).

You should see the following INFO message in the logs:

INFO org.apache.spark.network.yarn.YarnShuffleService: Stopping application [appId]

If isAuthenticationEnabled , secretManager.unregisterApp is executed for the application id.

1073
YarnShuffleService — ExternalShuffleService on YARN

It requests ExternalShuffleBlockHandler to applicationRemoved (with cleanupLocalDirs

flag disabled).

Caution FIXME What does ExternalShuffleBlockHandler#applicationRemoved do?

When an exception occurs, you should see the following ERROR message in the logs:

ERROR org.apache.spark.network.yarn.YarnShuffleService: Exception when stopping applic

ation [appId]

initializeApplication

void initializeApplication(ApplicationInitializationContext context)

initializeApplication is part of YARN’s AuxiliaryService contract and is called

when…​FIXME

Caution FIXME The contract

initializeApplication requests the ShuffleSecretManager to registerApp when

authentication is enabled.

When called, initializeApplication obtains YARN’s ApplicationId for the application

(using the input context ) and calls context.getApplicationDataForService for
shuffleSecret .

You should see the following INFO message in the logs:

INFO org.apache.spark.network.yarn.YarnShuffleService: Initializing application [appId]

If isAuthenticationEnabled , secretManager.registerApp is executed for the application id

and shuffleSecret .

When an exception occurs, you should see the following ERROR message in the logs:

ERROR org.apache.spark.network.yarn.YarnShuffleService: Exception when initializing ap

plication [appId]

serviceInit

void serviceInit(Configuration conf)

1074
YarnShuffleService — ExternalShuffleService on YARN

serviceInit is part of YARN’s AuxiliaryService contract and is called when…​FIXME

Caution FIXME

When called, serviceInit creates a TransportConf for the shuffle module that is used to
create ExternalShuffleBlockHandler (as blockHandler ).

It checks spark.authenticate key in the configuration (defaults to false ) and if only

authentication is enabled, it sets up a SaslServerBootstrap with a ShuffleSecretManager
and adds it to a collection of TransportServerBootstraps .

It creates a TransportServer as shuffleServer to listen to spark.shuffle.service.port

(default: 7337 ). It reads spark.shuffle.service.port key in the configuration.

You should see the following INFO message in the logs:

INFO org.apache.spark.network.yarn.YarnShuffleService: Started YARN shuffle service fo

r Spark on port [port]. Authentication is [authEnabled]. Registered executor file is
[registeredExecutorFile]

Installation

YARN Shuffle Service Plugin

Add the YARN Shuffle Service plugin from the common/network-yarn module to YARN
NodeManager’s CLASSPATH.

Tip Use yarn classpath command to know YARN’s CLASSPATH.

cp common/network-yarn/target/scala-2.11/spark-2.0.0-SNAPSHOT-yarn-shuffle.jar \
/usr/local/Cellar/hadoop/2.7.2/libexec/share/hadoop/yarn/lib/

yarn-site.xml — NodeManager Configuration File

If external shuffle service is enabled, you need to add spark_shuffle to
yarn.nodemanager.aux-services in the yarn-site.xml file on all nodes.

yarn-site.xml — NodeManager Configuration properties

1075
YarnShuffleService — ExternalShuffleService on YARN

<?xml version="1.0"?>
<configuration>
<property>
<name>yarn.nodemanager.aux-services</name>
<value>spark_shuffle</value>
</property>
<property>
<name>yarn.nodemanager.aux-services.spark_shuffle.class</name>
<value>org.apache.spark.network.yarn.YarnShuffleService</value>
</property>
<!-- optional -->
<property>
<name>spark.shuffle.service.port</name>
<value>10000</value>
</property>
<property>
<name>spark.authenticate</name>
<value>true</value>
</property>
</configuration>

yarn.nodemanager.aux-services property is for the auxiliary service name being

spark_shuffle with yarn.nodemanager.aux-services.spark_shuffle.class property being

org.apache.spark.network.yarn.YarnShuffleService .

Exception — Attempting to Use External Shuffle Service in

Spark Application in Spark on YARN
When you enable an external shuffle service in a Spark application when using Spark on
YARN but do not install YARN Shuffle Service you will see the following exception in the
logs:

1076
YarnShuffleService — ExternalShuffleService on YARN

Exception in thread "ContainerLauncher-0" java.lang.Error: org.apache.spark.SparkExcep

tion: Exception while starting container container_1465448245611_0002_01_000002 on hos
t 192.168.99.1
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1
148)
at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:
617)
at java.lang.Thread.run(Thread.java:745)
Caused by: org.apache.spark.SparkException: Exception while starting container contain
er_1465448245611_0002_01_000002 on host 192.168.99.1
at org.apache.spark.deploy.yarn.ExecutorRunnable.startContainer(ExecutorRunnab
le.scala:126)
at org.apache.spark.deploy.yarn.ExecutorRunnable.run(ExecutorRunnable.scala:71
)
at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1
142)
... 2 more
Caused by: org.apache.hadoop.yarn.exceptions.InvalidAuxServiceException: The auxServic
e:spark_shuffle does not exist
at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)
at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAcce
ssorImpl.java:62)
at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstru
ctorAccessorImpl.java:45)
at java.lang.reflect.Constructor.newInstance(Constructor.java:423)
at org.apache.hadoop.yarn.api.records.impl.pb.SerializedExceptionPBImpl.instan
tiateException(SerializedExceptionPBImpl.java:168)
at org.apache.hadoop.yarn.api.records.impl.pb.SerializedExceptionPBImpl.deSeri
alize(SerializedExceptionPBImpl.java:106)
at org.apache.hadoop.yarn.client.api.impl.NMClientImpl.startContainer(NMClient
Impl.java:207)
at org.apache.spark.deploy.yarn.ExecutorRunnable.startContainer(ExecutorRunnab
le.scala:123)
... 4 more

1077
ExecutorRunnable

ExecutorRunnable
ExecutorRunnable starts a YARN container with CoarseGrainedExecutorBackend

standalone application.

ExecutorRunnable is created when YarnAllocator launches Spark executors in allocated

YARN containers (and for debugging purposes when ApplicationMaster requests cluster
resources for executors).

Figure 1. ExecutorRunnable and YarnAllocator in YARN Resource Container

If external shuffle service is used, it is set in the ContainerLaunchContext context as a
service under the name of spark_shuffle .

Table 1. ExecutorRunnable’s Internal Properties

Name Description
rpc YarnRPC for…​FIXME

nmClient NMClient for…​FIXME

Despite the name ExecutorRunnable is not a java.lang.Runnable anymore after

Note
SPARK-12447.

Enable INFO or DEBUG logging level for

org.apache.spark.deploy.yarn.ExecutorRunnable logger to see what happens
inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.yarn.ExecutorRunnable=DEBUG

Refer to Logging.

Creating ExecutorRunnable Instance

ExecutorRunnable takes the following when created:

1078
ExecutorRunnable

1. YARN Container to run a Spark executor in

2. YarnConfiguration

3. sparkConf  — SparkConf

4. masterAddress

5. executorId

6. hostname of the YARN container

7. executorMemory

8. executorCores

9. appId

10. SecurityManager

11. localResources  —  Map[String, LocalResource]

ExecutorRunnable initializes the internal registries and counters.

executorMemory and executorCores input arguments are from YarnAllocator

Note
but really are spark.executor.memory and spark.executor.cores properties.

Note Most of the input parameters are exactly as YarnAllocator was created with.

Building Command to Run

CoarseGrainedExecutorBackend in YARN Container 
—  prepareCommand Internal Method

prepareCommand(
masterAddress: String,
slaveId: String,
hostname: String,
executorMemory: Int,
executorCores: Int,
appId: String): List[String]

prepareCommand prepares the command that is used to start

org.apache.spark.executor.CoarseGrainedExecutorBackend application in a YARN container.

All the input parameters of prepareCommand become the command-line arguments of

CoarseGrainedExecutorBackend application.

prepareCommand builds the command that will be executed in a YARN container.

1079
ExecutorRunnable

Note JVM options are defined using -Dkey=value format.

prepareCommand builds -Xmx JVM option using executorMemory (in MB).

prepareCommand uses executorMemory that is given when ExecutorRunnable is

Note
created.

prepareCommand adds the optional spark.executor.extraJavaOptions property to the JVM

options (if defined).

prepareCommand adds the optional SPARK_JAVA_OPTS environment variable to the JVM

options (if defined).

prepareCommand adds the optional spark.executor.extraLibraryPath to the library path

(changing the path to be YARN NodeManager-aware).

prepareCommand adds -Djava.io.tmpdir=<LOG_DIR>./tmp to the JVM options.

prepareCommand adds all the Spark properties for executors to the JVM options.

prepareCommand uses SparkConf that is given when ExecutorRunnable is

Note
created.

prepareCommand adds -Dspark.yarn.app.container.log.dir=<LOG_DIR> to the JVM options.

prepareCommand adds -XX:MaxPermSize=256m unless already defined or IBM JVM or Java 8

are used.

prepareCommand reads the list of URIs representing the user classpath and adds --user-

class-path and file:[path] for every entry.

prepareCommand adds -XX:OnOutOfMemoryError to the JVM options unless already defined.

In the end, prepareCommand combines the parts together to build the entire command with
the following (in order):

1. Extra library path

2. JAVA_HOME/bin/java

3. -server

4. JVM options

5. org.apache.spark.executor.CoarseGrainedExecutorBackend

6. --driver-url followed by masterAddress

7. --executor-id followed by executorId

1080
ExecutorRunnable

8. --hostname followed by hostname

9. --cores followed by executorCores

10. --app-id followed by appId

11. --user-class-path with the arguments

12. 1><LOG_DIR>/stdout

13. 2><LOG_DIR>/stderr

prepareCommand uses the arguments for --driver-url , --executor-id , --

Note
hostname , --cores and --app-id as given when ExecutorRunnable is created.

You can see the result of prepareCommand as command in the INFO message in
Note the logs when ApplicationMaster registers itself with YARN ResourceManager
(to print it out once and avoid flooding the logs when starting Spark executors).

prepareCommand is used when ExecutorRunnable starts

CoarseGrainedExecutorBackend in a YARN resource container and (only for
Note
debugging purposes) when ExecutorRunnable builds launch context diagnostic
information (to print it out as an INFO message to the logs).

Collecting Environment Variables for

CoarseGrainedExecutorBackend Containers 
—  prepareEnvironment Internal Method

prepareEnvironment(): HashMap[String, String]

prepareEnvironment collects environment-related entries.

prepareEnvironment populates class path (passing in YarnConfiguration, SparkConf, and

spark.executor.extraClassPath property)

Caution FIXME How does populateClasspath use the input env ?

prepareEnvironment collects the executor environment variables set on the current

SparkConf, i.e. the Spark properties with the prefix spark.executorEnv. , and
YarnSparkHadoopUtil.addPathToEnvironment(env, key, value).

Note SPARK_YARN_USER_ENV is deprecated.

prepareEnvironment reads YARN’s yarn.http.policy property (with

YarnConfiguration.YARN_HTTP_POLICY_DEFAULT) to choose a secure HTTPS scheme

for container logs when HTTPS_ONLY .

1081
ExecutorRunnable

With the input container defined and SPARK_USER environment variable available,
prepareEnvironment registers SPARK_LOG_URL_STDERR and SPARK_LOG_URL_STDOUT

environment entries with stderr?start=-4096 and stdout?start=-4096 added to

[httpScheme][address]/node/containerlogs/[containerId]/[user] , respectively.

In the end, prepareEnvironment collects all the System environment variables with SPARK
prefix.

prepareEnvironment is used when ExecutorRunnable starts

CoarseGrainedExecutorBackend in a container and (for debugging purposes)
Note
builds launch context diagnostic information (to print it out as an INFO message
to the logs).

Starting ExecutorRunnable (with

CoarseGrainedExecutorBackend) —  run Method

run(): Unit

When called, you should see the following DEBUG message in the logs:

DEBUG ExecutorRunnable: Starting Executor Container

run creates a YARN NMClient (to communicate with YARN NodeManager service), inits it

with YarnConfiguration and starts it.

run uses YarnConfiguration that was given when ExecutorRunnable was

Note
created.

In the end, run starts CoarseGrainedExecutorBackend in the YARN container.

run is used exclusively when YarnAllocator schedules ExecutorRunnables in

Note
allocated YARN resource containers.

Starting YARN Resource Container —  startContainer

Method

startContainer(): java.util.Map[String, ByteBuffer]

startContainer uses YARN NodeManager’s NMClient API to start a

CoarseGrainedExecutorBackend in a YARN container.

1082
ExecutorRunnable

startContainer follows the design pattern to request YARN NodeManager to start a YARN reso
container:

val ctx = Records.newRecord(classOf[ContainerLaunchContext]).asInstanceOf[ContainerLaunchCont

ctx.setLocalResources(...)
ctx.setEnvironment(...)
Tip ctx.setTokens(...)
ctx.setCommands(...)
ctx.setApplicationACLs(...)
ctx.setServiceData(...)
nmClient.startContainer(container, ctx)

startContainer creates a YARN ContainerLaunchContext.

YARN ContainerLaunchContext represents all of the information for the YARN

Note
NodeManager to launch a resource container.

startContainer then sets local resources and environment to the ContainerLaunchContext .

startContainer uses local resources given when ExecutorRunnable was

Note
created.

startContainer sets security tokens to the ContainerLaunchContext (using Hadoop’s

UserGroupInformation and the current user’s credentials).

startContainer sets the command (to launch CoarseGrainedExecutorBackend ) to the

ContainerLaunchContext .

startContainer sets the application ACLs to the ContainerLaunchContext .

If spark.shuffle.service.enabled property is enabled, startContainer registers the

ContainerLaunchContext with the YARN shuffle service started on the YARN NodeManager

under spark_shuffle service name.

In the end, startContainer requests the YARN NodeManager to start the YARN container
with the ContainerLaunchContext context.

startContainer uses nmClient internal reference to send the request with the
Note
YARN resource container given when ExecutorRunnable was created.

If any exception happens, startContainer reports SparkException .

Exception while starting container [containerId] on host [hostname]

Note startContainer is used exclusively when ExecutorRunnable is started.

1083
ExecutorRunnable

Building Launch Context Diagnostic Information (with

Command, Environment and Resources) 
—  launchContextDebugInfo Method

launchContextDebugInfo(): String

launchContextDebugInfo prepares the command to launch CoarseGrainedExecutorBackend

(as commands value) and collects environment variables for CoarseGrainedExecutorBackend

containers (as env value).

launchContextDebugInfo returns the launch context debug info.

===============================================================================
YARN executor launch context:
env:
[key] -> [value]
...

command:
[commands]

resources:
[key] -> [value]
===============================================================================

resources entry is the input localResources given when ExecutorRunnable

Note
was created.

launchContextDebugInfo is used when ApplicationMaster registers itself with

Note
YARN ResourceManager.

1084
Client

Client
Client is a handle to a YARN cluster to submit ApplicationMaster (that represents a Spark

application submitted to a YARN cluster).

Figure 1. Client and Hadoop’s YarnClient Interactions

Depending on the deploy mode it uses ApplicationMaster or ApplicationMaster’s wrapper
ExecutorLauncher by their class names in a ContainerLaunchContext (that represents all of
the information needed by the YARN NodeManager to launch a container).

Client was initially used as a standalone application to submit Spark

Note
applications to a YARN cluster, but is currently considered obsolete.

1085
Client

Table 1. Client’s Internal Properties

Name Initial Value Description

FIXME
spark.yarn.executor.memoryOverhead
and falls back to 10% of the NOTE: 10% and
executorMemoryOverhead
spark.executor.memory or 384 384 are constants
whatever is larger. and cannot be
changed.

Enable INFO or DEBUG logging level for org.apache.spark.deploy.yarn.Client

logger to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.yarn.Client=DEBUG

Refer to Logging.

isUserClassPathFirst Method

Caution FIXME

getUserClasspath Method

Caution FIXME

ClientArguments

Caution FIXME

Setting Up Environment to Launch ApplicationMaster

Container —  setupLaunchEnv Method

Caution FIXME

launcherBackend Property
launcherBackend …​FIXME

loginFromKeytab Method

1086
Client

Caution FIXME

Creating Client Instance

Creating an instance of Client does the following:

Creates an internal instance of YarnClient (using YarnClient.createYarnClient ) that

becomes yarnClient .

Creates an internal instance of YarnConfiguration (using YarnConfiguration and the

input hadoopConf ) that becomes yarnConf .

Sets the internal isClusterMode that says whether spark.submit.deployMode is cluster

deploy mode.

Sets the internal amMemory to spark.driver.memory when isClusterMode is enabled or

spark.yarn.am.memory otherwise.

Sets the internal amMemoryOverhead to spark.yarn.driver.memoryOverhead when

isClusterMode is enabled or spark.yarn.am.memoryOverhead otherwise. If neither is

available, the maximum of 10% of amMemory and 384 is chosen.

Sets the internal amCores to spark.driver.cores when isClusterMode is enabled or

spark.yarn.am.cores otherwise.

Sets the internal executorMemory to spark.executor.memory.

Sets the internal executorMemoryOverhead to spark.yarn.executor.memoryOverhead. If

unavailable, it is set to the maximum of 10% of executorMemory and 384 .

Creates an internal instance of ClientDistributedCacheManager (as distCacheMgr ).

Sets the variables: loginFromKeytab to false with principal , keytab , and

credentials to null .

Creates an internal instance of LauncherBackend (as launcherBackend).

Sets the internal fireAndForget flag to the result of isClusterMode and not
spark.yarn.submit.waitAppCompletion.

Sets the internal variable appId to null .

Sets the internal appStagingBaseDir to spark.yarn.stagingDir or the home directory of

Hadoop.

1087
Client

Submitting Spark Application to YARN 

—  submitApplication Method

submitApplication(): ApplicationId

submitApplication submits a Spark application (represented by ApplicationMaster) to a

YARN cluster (i.e. to the YARN ResourceManager) and returns the application’s
ApplicationId.

Note submitApplication is also used in the currently-deprecated Client.run.

Internally, it executes LauncherBackend.connect first and then executes

Client.setupCredentials to set up credentials for future calls.

It then inits the internal yarnClient (with the internal yarnConf ) and starts it. All this happens
using Hadoop API.

FIXME How to configure YarnClient ? What is YARN’s

Caution
YarnClient.getYarnClusterMetrics ?

You should see the following INFO in the logs:

INFO Client: Requesting a new application from cluster with [count] NodeManagers

It then YarnClient.createApplication() to create a new application in YARN and obtains the

application id.

The LauncherBackend instance changes state to SUBMITTED with the application id.

Caution FIXME Why is this important?

submitApplication verifies whether the cluster has resources for the ApplicationManager

(using verifyClusterResources).

It then creates YARN ContainerLaunchContext followed by creating YARN

ApplicationSubmissionContext .

You should see the following INFO message in the logs:

INFO Client: Submitting application [appId] to ResourceManager

submitApplication submits the new YARN ApplicationSubmissionContext for

ApplicationMaster to YARN (using Hadoop’s YarnClient.submitApplication).

1088
Client

It returns the YARN ApplicationId for the Spark application (represented by

ApplicationMaster).

submitApplication is used when Client runs or YarnClientSchedulerBackend

Note
is started.

Creating YARN ApplicationSubmissionContext 

—  createApplicationSubmissionContext Method

createApplicationSubmissionContext(
newApp: YarnClientApplication,
containerContext: ContainerLaunchContext): ApplicationSubmissionContext

createApplicationSubmissionContext creates YARN’s ApplicationSubmissionContext.

YARN’s ApplicationSubmissionContext represents all of the information needed

Note by the YARN ResourceManager to launch the ApplicationMaster for a Spark
application.

createApplicationSubmissionContext uses YARN’s YarnClientApplication (as the input

newApp ) to create a ApplicationSubmissionContext .

createApplicationSubmissionContext sets the following information in the

ApplicationSubmissionContext :

1089
Client

spark.app.name configuration setting or

The name of the Spark application
Spark if not set

Queue (to which the Spark application

spark.yarn.queue configuration setting
is submitted)

ContainerLaunchContext (that
describes the Container with which
the input containerContext
the ApplicationMaster for the Spark
application is launched)

Type of the Spark application SPARK

Tags for the Spark application spark.yarn.tags configuration setting

Number of max attempts of the Spark spark.yarn.maxAppAttempts configuration

application to be submitted. setting

The attemptFailuresValidityInterval spark.yarn.am.attemptFailuresValidityInterval

in milliseconds for the Spark application configuration setting

Resource Capabilities for See Resource Capabilities for

ApplicationMaster for the Spark ApplicationMaster — Memory and Virtual
application CPU Cores section below

Rolled Log Aggregation for the Spark See Rolled Log Aggregation Configuration
application for Spark Application section below

You will see the DEBUG message in the logs when the setting is not set:

DEBUG spark.yarn.maxAppAttempts is not set. Cluster's default value will be used.

Resource Capabilities for ApplicationMaster — Memory and

Virtual CPU Cores

YARN’s Resource models a set of computer resources in the cluster. Currently,

Note
YARN supports resources with memory and virtual CPU cores capabilities only.

The requested YARN’s Resource for the ApplicationMaster for a Spark application is the
sum of amMemory and amMemoryOverhead for the memory and amCores for the virtual CPU
cores.

Besides, if spark.yarn.am.nodeLabelExpression is set, a new YARN ResourceRequest is

created (for the ApplicationMaster container) that includes:

1090
Client

Resource Name * (star) that represents no locality.

Priority 0

The resource capabilities as defined

Capability
above.

Number of containers 1

spark.yarn.am.nodeLabelExpression
Node label expression
configuration setting

spark.yarn.am.nodeLabelExpression
ResourceRequest of AM container
configuration setting

It sets the resource request to this new YARN ResourceRequest detailed in the table above.

Rolled Log Aggregation for Spark Application

YARN’s LogAggregationContext represents all of the information needed by the

Note
YARN NodeManager to handle the logs for an application.

If spark.yarn.rolledLog.includePattern is defined, it creates a YARN LogAggregationContext

with the following patterns:

spark.yarn.rolledLog.includePattern
Include Pattern
configuration setting

spark.yarn.rolledLog.excludePattern
Exclude Pattern
configuration setting

Verifying Maximum Memory Capability of YARN Cluster 

—  verifyClusterResources Internal Method

verifyClusterResources(newAppResponse: GetNewApplicationResponse): Unit

verifyClusterResources is a private helper method that submitApplication uses to ensure

that the Spark application (as a set of ApplicationMaster and executors) is not going to
request more than the maximum memory capability of the YARN cluster. If so, it throws an
IllegalArgumentException .

1091
Client

verifyClusterResources queries the input GetNewApplicationResponse (as

newAppResponse ) for the maximum memory.

INFO Client: Verifying our application has not requested more

than the maximum memory capability of the cluster
([maximumMemory] MB per container)

If the maximum memory capability is above the required executor or ApplicationMaster

memory, you should see the following INFO message in the logs:

INFO Client: Will allocate AM container, with [amMem] MB memory

including [amMemoryOverhead] MB overhead

If however the executor memory (as a sum of spark.executor.memory and

spark.yarn.executor.memoryOverhead settings) is more than the maximum memory
capability, verifyClusterResources throws an IllegalArgumentException with the following
message:

Required executor memory ([executorMemory]+

[executorMemoryOverhead] MB) is above the max threshold
([maximumMemory] MB) of this cluster! Please check the values of
'yarn.scheduler.maximum-allocation-mb' and/or
'yarn.nodemanager.resource.memory-mb'.

If the required memory for ApplicationMaster is more than the maximum memory capability,
verifyClusterResources throws an IllegalArgumentException with the following message:

Required AM memory ([amMemory]+[amMemoryOverhead] MB) is above

the max threshold ([maximumMemory] MB) of this cluster! Please
increase the value of 'yarn.scheduler.maximum-allocation-mb'.

Creating YARN ContainerLaunchContext to Launch

ApplicationMaster —  createContainerLaunchContext Internal
Method

createContainerLaunchContext(newAppResponse: GetNewApplicationResponse): ContainerLaun

chContext

1092
Client

The input GetNewApplicationResponse is Hadoop YARN’s

Note
GetNewApplicationResponse.

When a Spark application is submitted to YARN, it calls the private helper method
createContainerLaunchContext that creates a YARN ContainerLaunchContext request for

YARN NodeManager to launch ApplicationMaster (in a container).

When called, you should see the following INFO message in the logs:

INFO Setting up container launch context for our AM

It gets at the application id (from the input newAppResponse ).

It calculates the path of the application’s staging directory.

Caution FIXME What’s appStagingBaseDir ?

It does a custom step for a Python application.

It sets up an environment to launch ApplicationMaster container and

prepareLocalResources. A ContainerLaunchContext record is created with the environment
and the local resources.

The JVM options are calculated as follows:

-Xmx (that was calculated when the Client was created)

-Djava.io.tmpdir= - FIXME: tmpDir

Caution FIXME tmpDir ?

Using UseConcMarkSweepGC when SPARK_USE_CONC_INCR_GC is enabled.

Caution FIXME SPARK_USE_CONC_INCR_GC ?

In cluster deploy mode, …​FIXME

In client deploy mode, …​FIXME

Caution FIXME

-Dspark.yarn.app.container.log.dir= …​FIXME

Perm gen size option…​FIXME

--class is set if in cluster mode based on --class command-line argument.

1093
Client

Caution FIXME

If --jar command-line argument was specified, it is set as --jar .

In cluster deploy mode, org.apache.spark.deploy.yarn.ApplicationMaster is created while in

client deploy mode it is org.apache.spark.deploy.yarn.ExecutorLauncher.

If --arg command-line argument was specified, it is set as --arg .

The path for --properties-file is built based on

YarnSparkHadoopUtil.expandEnvironment(Environment.PWD), LOCALIZED_CONF_DIR,

SPARK_CONF_FILE .

The entire ApplicationMaster argument line (as amArgs ) is of the form:

[amClassName] --class [userClass] --jar [userJar] --arg [userArgs] --properties-file [

propFile]

The entire command line is of the form:

FIXME prefixEnv ? How is path calculated?

Caution
ApplicationConstants.LOG_DIR_EXPANSION_VAR ?

[JAVA_HOME]/bin/java -server [javaOpts] [amArgs] 1> [LOG_DIR]/stdout 2> [LOG_DIR]/stde

rr

The command line to launch a ApplicationMaster is set to the ContainerLaunchContext

record (using setCommands ).

You should see the following DEBUG messages in the logs:

DEBUG Client: ========================================================================

=======
DEBUG Client: YARN AM launch context:
DEBUG Client: user class: N/A
DEBUG Client: env:
DEBUG Client: [launchEnv]
DEBUG Client: resources:
DEBUG Client: [localResources]
DEBUG Client: command:
DEBUG Client: [commands]
DEBUG Client: ========================================================================
=======

A SecurityManager is created and set as the application’s ACLs.

1094
Client

Caution FIXME setApplicationACLs ? Set up security tokens?

createContainerLaunchContext is used when Client submits a Spark

Note
application to a YARN cluster.

prepareLocalResources Method

Caution FIXME

prepareLocalResources(
destDir: Path,
pySparkArchives: Seq[String]): HashMap[String, LocalResource]

prepareLocalResources is…​FIXME

Caution FIXME Describe credentialManager

When called, prepareLocalResources prints out the following INFO message to the logs:

INFO Client: Preparing resources for our AM container

Caution FIXME What’s a delegation token?

prepareLocalResources then obtains security tokens from credential providers and gets the

nearest time of the next renewal (for renewable credentials).

After all the security delegation tokens are obtained and only when there are any, you should
see the following DEBUG message in the logs:

DEBUG Client: [token1]

DEBUG Client: [token2]
...
DEBUG Client: [tokenN]

Caution FIXME Where is credentials assigned?

If a keytab is used to log in and the nearest time of the next renewal is in the future,
prepareLocalResources sets the internal spark.yarn.credentials.renewalTime and

spark.yarn.credentials.updateTime times for renewal and update security tokens.

It gets the replication factor (using spark.yarn.submit.file.replication setting) or falls back to

the default value for the input destDir .

1095
Client

The replication factor is only used for copyFileToRemote later. Perhaps it should
Note
not be mentioned here (?)

It creates the input destDir (on a HDFS-compatible file system) with 0700 permission
( rwx------ ), i.e. inaccessible to all but its owner and the superuser so the owner only can
read, write and execute. It uses Hadoop’s Path.getFileSystem to access Hadoop’s
FileSystem that owns destDir (using the constructor’s hadoopConf  — Hadoop’s
Configuration).

See org.apache.hadoop.fs.FileSystem to know a list of HDFS-compatible file

Tip
systems, e.g. Amazon S3 or Windows Azure.

If a keytab is used to log in, …​FIXME

Caution FIXME if (loginFromKeytab)

If the location of the single archive containing Spark jars (spark.yarn.archive) is set, it is
distributed (as ARCHIVE) to spark_libs .

Else if the location of the Spark jars (spark.yarn.jars) is set, …​FIXME

Caution FIXME Describe case Some(jars)

If neither spark.yarn.archive nor spark.yarn.jars is set, you should see the following WARN
message in the logs:

WARN Client: Neither spark.yarn.jars nor spark.yarn.archive is set, falling back to up

loading libraries under SPARK_HOME.

It then finds the directory with jar files under SPARK_HOME (using
YarnCommandBuilderUtils.findJarsDir ).

Caution FIXME YarnCommandBuilderUtils.findJarsDir

And all the jars are zipped to a temporary archive, e.g. spark_libs2944590295025097383.zip
that is distribute as ARCHIVE to spark_libs (only when they differ).

If a user jar ( --jar ) was specified on command line, the jar is distribute as FILE to
app.jar .

It then distributes additional resources specified in SparkConf for the application, i.e. jars
(under spark.yarn.dist.jars), files (under spark.yarn.dist.files), and archives (under
spark.yarn.dist.archives).

1096
Client

The additional files to distribute can be defined using spark-submit using

Note
command-line options --jars, --files, and --archives.

Caution FIXME Describe distribute

It sets spark.yarn.secondary.jars for the jars that have localized path (non-local paths) or
their path (for local paths).

It updates Spark configuration (with internal configuration settings using the internal
distCacheMgr reference).

FIXME Where are they used? It appears they are required for
Caution ApplicationMaster when it prepares local resources, but what is the
sequence of calls to lead to ApplicationMaster ?

It uploads spark_conf.zip to the input destDir and sets spark.yarn.cache.confArchive

It creates configuration archive and copyFileToRemote(destDir, localConfArchive,

replication, force = true, destName = Some(LOCALIZED_CONF_ARCHIVE)) .

FIXME copyFileToRemote(destDir, localConfArchive, replication, force =

Caution
true, destName = Some(LOCALIZED_CONF_ARCHIVE)) ?

It adds a cache-related resource (using the internal distCacheMgr ).

Caution FIXME What resources? Where? Why is this needed?

Ultimately, it clears the cache-related internal configuration settings 

— spark.yarn.cache.filenames, spark.yarn.cache.sizes, spark.yarn.cache.timestamps,
spark.yarn.cache.visibilities, spark.yarn.cache.types, spark.yarn.cache.confArchive — from
the SparkConf configuration since they are internal and should not "pollute" the web UI’s
environment page.

The localResources are returned.

Caution FIXME How is localResources calculated?

It is exclusively used when Client creates a ContainerLaunchContext to launch a

Note
ApplicationMaster container.

Creating __spark_conf__.zip Archive With Configuration

Files and Spark Configuration —  createConfArchive Internal
Method

createConfArchive(): File

1097
Client

createConfArchive is a private helper method that prepareLocalResources uses to create

an archive with the local config files —  log4j.properties and metrics.properties (before
distributing it and the other files for ApplicationMaster and executors to use on a YARN
cluster).

The archive will also contain all the files under HADOOP_CONF_DIR and YARN_CONF_DIR
environment variables (if defined).

Additionally, the archive contains a spark_conf.properties with the current Spark

configuration.

The archive is a temporary file with the spark_conf prefix and .zip extension with the files
above.

Copying File to Remote File System —  copyFileToRemote

Method

copyFileToRemote(
destDir: Path,
srcPath: Path,
replication: Short,
force: Boolean = false,
destName: Option[String] = None): Path

copyFileToRemote is a private[yarn] method to copy srcPath to the remote file system

destDir (if needed) and return the destination path resolved following symlinks and mount

points.

Note It is exclusively used in prepareLocalResources.

Unless force is enabled (it is disabled by default), copyFileToRemote will only copy
srcPath when the source (of srcPath ) and target (of destDir ) file systems are the same.

You should see the following INFO message in the logs:

INFO Client: Uploading resource [srcPath] -> [destPath]

copyFileToRemote copies srcPath to destDir and sets 644 permissions, i.e. world-wide

readable and owner writable.

If force is disabled or the files are the same, copyFileToRemote will only print out the
following INFO message to the logs:

1098
Client

INFO Client: Source and destination file systems are the same. Not copying [srcPath]

Ultimately, copyFileToRemote returns the destination path resolved following symlinks and
mount points.

Populating CLASSPATH for ApplicationMaster and

Executors —  populateClasspath Method

populateClasspath(
args: ClientArguments,
conf: Configuration,
sparkConf: SparkConf,
env: HashMap[String, String],
extraClassPath: Option[String] = None): Unit

populateClasspath is a private[yarn] helper method that populates the CLASSPATH (for

ApplicationMaster and executors).

The input args is null when preparing environment for ExecutorRunnable

Note
and the constructor’s args for Client .

It merely adds the following entries to the CLASSPATH key in the input env :

1. The optional extraClassPath (which is first changed to include paths on YARN cluster
machines).

extraClassPath corresponds to spark.driver.extraClassPath for the driver

Note
and spark.executor.extraClassPath for executors.

2. YARN’s own Environment.PWD

3. __spark_conf__ directory under YARN’s Environment.PWD

4. If the deprecated spark.yarn.user.classpath.first is set, …​FIXME

Caution FIXME

5. __spark_libs__/* under YARN’s Environment.PWD

6. (unless the optional spark.yarn.archive is defined) All the local jars in spark.yarn.jars
(which are first changed to be paths on YARN cluster machines).

7. All the entries from YARN’s yarn.application.classpath or

YarnConfiguration.DEFAULT_YARN_APPLICATION_CLASSPATH (if yarn.application.classpath

is not set)

1099
Client

8. All the entries from YARN’s mapreduce.application.classpath or

MRJobConfig.DEFAULT_MAPREDUCE_APPLICATION_CLASSPATH (if

mapreduce.application.classpath not set).

9. SPARK_DIST_CLASSPATH (which is first changed to include paths on YARN cluster

machines).

You should see the result of executing populateClasspath when you enable DEBUG logging leve

Tip DEBUG Client: env:

DEBUG Client: CLASSPATH -> <CPS>/__spark_conf__<CPS>/__spark_libs__/*<CPS>$HADOOP_CON

Changing Path to be YARN NodeManager-aware 

—  getClusterPath Method

getClusterPath(conf: SparkConf, path: String): String

getClusterPath replaces any occurences of spark.yarn.config.gatewayPath in path to the

value of spark.yarn.config.replacementPath.

Adding CLASSPATH Entry to Environment 

—  addClasspathEntry Method

addClasspathEntry(path: String, env: HashMap[String, String]): Unit

addClasspathEntry is a private helper method to add the input path to CLASSPATH key in

the input env .

Distributing Files to Remote File System —  distribute

Internal Method

distribute(
path: String,
resType: LocalResourceType = LocalResourceType.FILE,
destName: Option[String] = None,
targetDir: Option[String] = None,
appMasterOnly: Boolean = false): (Boolean, String)

1100
Client

distribute is an internal helper method that prepareLocalResources uses to find out

whether the input path is of local: URI scheme and return a localized path for a
non- local path, or simply the input path for a local one.

distribute returns a pair with the first element being a flag for the input path being local

or non-local, and the other element for the local or localized path.

For local path that was not distributed already, distribute copies the input path to
remote file system (if needed) and adds path to the application’s distributed cache.

Joining Path Components using Path.SEPARATOR 

—  buildPath Method

buildPath(components: String*): String

buildPath is a helper method to join all the path components using the directory separator,

i.e. org.apache.hadoop.fs.Path.SEPARATOR.

isClusterMode Internal Flag

isClusterMode is an internal flag that says whether the Spark application runs in cluster or

client deploy mode. The flag is enabled for cluster deploy mode, i.e. true .

Since a Spark application requires different settings per deploy mode,

Note isClusterMode flag effectively "splits" Client on two parts per deploy mode — 
one responsible for client and the other for cluster deploy mode.

Caution FIXME Replace the internal fields used below with their true meanings.

1101
Client

Table 2. Internal Attributes of Client per Deploy Mode ( isClusterMode

Internal attribute cluster deploy mode client deploy
amMemory spark.driver.memory spark.yarn.am.memory

amMemoryOverhead spark.yarn.driver.memoryOverhead spark.yarn.am.memoryOver

amCores spark.driver.cores spark.yarn.am.cores

javaOpts spark.driver.extraJavaOptions spark.yarn.am.extraJavaOp

spark.driver.extraLibraryPath and
libraryPaths spark.yarn.am.extraLibraryP
spark.driver.libraryPath

--class
command-line args.userClass
argument for
ApplicationMaster

Application master
org.apache.spark.deploy.yarn.ApplicationMaster org.apache.spark.deploy.ya
class

When the isClusterMode flag is enabled, the internal reference to YARN’s YarnClient is
used to stop application.

When the isClusterMode flag is enabled (and spark.yarn.submit.waitAppCompletion is

disabled), so is fireAndForget internal flag.

SPARK_YARN_MODE flag
SPARK_YARN_MODE flag controls…​FIXME

Any environment variable with the SPARK_ prefix is propagated to all (remote)
Note
processes.

Caution FIXME Where is SPARK_ prefix rule enforced?

SPARK_YARN_MODE is a system property (i.e. available using System.getProperty )

Note and a environment variable (i.e. available using System.getenv or sys.env ).
See YarnSparkHadoopUtil.

It is enabled (i.e. true ) when SparkContext is created for Spark on YARN in client deploy
mode, when Client sets up an environment to launch ApplicationMaster container (and,
what is currently considered deprecated, a Spark application was deployed to a YARN
cluster).

1102
Client

Caution FIXME Why is this needed? git blame it.

SPARK_YARN_MODE flag is checked when YarnSparkHadoopUtil or SparkHadoopUtil are

accessed.

It is cleared later when Client is requested to stop.

Internal Hadoop’s YarnClient —  yarnClient Property

val yarnClient = YarnClient.createYarnClient

yarnClient is a private internal reference to Hadoop’s YarnClient that Client uses to

create and submit a YARN application (for your Spark application), killApplication.

yarnClient is inited and started when Client submits a Spark application to a YARN

cluster.

yarnClient is stopped when Client stops.

Launching Client Standalone Application —  main Method

main method is invoked while a Spark application is being deployed to a YARN cluster.

Note It is executed by spark-submit with --master yarn command-line argument.

When you start the main method when starting the Client standalone application, say using
org.apache.spark.deploy.yarn.Client , you will see the following WARN message in the logs unl

Note
WARN Client: WARNING: This client is deprecated and will be removed in a future version of

main turns SPARK_YARN_MODE flag on.

It then instantiates SparkConf, parses command-line arguments (using ClientArguments)

and passes the call on to Client.run method.

Stopping Client (with LauncherBackend and YarnClient) 

—  stop Method

stop(): Unit

stop closes the internal LauncherBackend and stops the internal YarnClient.

1103
Client

It also clears SPARK_YARN_MODE flag (to allow switching between cluster types).

Running Client —  run Method

run submits a Spark application to a YARN ResourceManager (RM).

If LauncherBackend is not connected to a RM, i.e. LauncherBackend.isConnected returns

false , and fireAndForget is enabled, …​FIXME

FIXME When could LauncherBackend lost the connection since it was

Caution
connected in submitApplication?

Caution FIXME What is fireAndForget ?

Otherwise, when LauncherBackend is connected or fireAndForget is disabled,

monitorApplication is called. It returns a pair of yarnApplicationState and
finalApplicationStatus that is checked against three different state pairs and throw a

SparkException :

YarnApplicationState.KILLED or FinalApplicationStatus.KILLED lead to

SparkException with the message "Application [appId] is killed".

YarnApplicationState.FAILED or FinalApplicationStatus.FAILED lead to

SparkException with the message "Application [appId] finished with failed status".

FinalApplicationStatus.UNDEFINED leads to SparkException with the message "The

final status of application [appId] is undefined".

FIXME What are YarnApplicationState and FinalApplicationStatus

Caution
statuses?

monitorApplication Method

monitorApplication(
appId: ApplicationId,
returnOnRunning: Boolean = false,
logApplicationReport: Boolean = true): (YarnApplicationState, FinalApplicationStatus)

monitorApplication continuously reports the status of a Spark application appId every

spark.yarn.report.interval until the application state is one of the following

YarnApplicationState:

RUNNING (when returnOnRunning is enabled)

1104
Client

FINISHED

FAILED

KILLED

It is used in run, YarnClientSchedulerBackend.waitForApplication and

Note
MonitorThread.run .

It gets the application’s report from the YARN ResourceManager to obtain

YarnApplicationState of the ApplicationMaster.

Tip It uses Hadoop’s YarnClient.getApplicationReport(appId) .

Unless logApplicationReport is disabled, it prints the following INFO message to the logs:

INFO Client: Application report for [appId] (state: [state])

If logApplicationReport and DEBUG log level are enabled, it prints report details every time
interval to the logs:

16/04/23 13:21:36 INFO Client:

client token: N/A
diagnostics: N/A
ApplicationMaster host: N/A
ApplicationMaster RPC port: -1
queue: default
start time: 1461410495109
final status: UNDEFINED
tracking URL: http://japila.local:8088/proxy/application_1461410200840_0001/
user: jacek

For INFO log level it prints report details only when the application state changes.

When the application state changes, LauncherBackend is notified (using

LauncherBackend.setState ).

Note The application state is an instance of Hadoop’s YarnApplicationState .

For states FINISHED , FAILED or KILLED , cleanupStagingDir is called and the method
finishes by returning a pair of the current state and the final application status.

If returnOnRunning is enabled (it is disabled by default) and the application state turns
RUNNING , the method returns a pair of the current state RUNNING and the final application

status.

1105
Client

cleanupStagingDir won’t be called when returnOnRunning is enabled and an

Note application turns RUNNING. I guess it is likely a left-over since the Client is
deprecated now.

The current state is recorded for future checks (in the loop).

cleanupStagingDir Method
cleanupStagingDir clears the staging directory of an application.

It is used in submitApplication when there is an exception and

Note
monitorApplication when an application finishes and the method quits.

It uses spark.yarn.stagingDir setting or falls back to a user’s home directory for the staging
directory. If cleanup is enabled, it deletes the entire staging directory for the application.

You should see the following INFO message in the logs:

INFO Deleting staging directory [stagingDirPath]

reportLauncherState Method

reportLauncherState(state: SparkAppHandle.State): Unit

reportLauncherState merely passes the call on to LauncherBackend.setState .

Caution What does setState do?

1106
YarnRMClient

YarnRMClient
YarnRMClient is responsible for registering and unregistering a Spark application (in the

form of ApplicationMaster) with YARN ResourceManager (and hence RM in the name).

Figure 1. Registering ApplicationMaster with YARN ResourceManager

YarnRMClient is just a wrapper for AMRMClient[ContainerRequest] that is started when

registering ApplicationMaster (and never stopped explicitly!).

YarnRMClient tracks the application attempt identifiers and the maximum number of

attempts to register ApplicationMaster .

Table 1. YarnRMClient’s Internal Registries and Counters

Name Description
AMRMClient using ContainerRequest for YARN
ResourceManager.
Created (initialized and started) when YarnRMClient
amClient registers ApplicationMaster .
Used when YarnRMClient creates a YarnAllocator
(after registering ApplicationMaster ) and to unregister
ApplicationMaster .

uiHistoryAddress

Flag to say whether YarnRMClient is connected to YARN

registered ResourceManager (i.e. true ) or not. Disabled by
default. Used when unregistering ApplicationMaster .

Enable INFO logging level for org.apache.spark.deploy.yarn.YarnRMClient logger

to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.yarn.YarnRMClient=INFO

Refer to Logging.

1107
YarnRMClient

Registering ApplicationMaster with YARN

ResourceManager (and Creating YarnAllocator) 
—  register Method

register(
driverUrl: String,
driverRef: RpcEndpointRef,
conf: YarnConfiguration,
sparkConf: SparkConf,
uiAddress: String,
uiHistoryAddress: String,
securityMgr: SecurityManager,
localResources: Map[String, LocalResource]): YarnAllocator

register creates a AMRMClient, initializes it (using the input YarnConfiguration) and starts

immediately.

AMRMClient is used in YARN to register an application’s ApplicationMaster

Note
with the YARN ResourceManager.

register connects to YARN ResourceManager using the following design

pattern:

Tip val amClient: AMRMClient[ContainerRequest] = AMRMClient.createAMRMClient()

amClient.init(conf)
amClient.start()

register saves the input uiHistoryAddress as uiHistoryAddress.

You should see the following INFO message in the logs (in stderr in YARN):

INFO YarnRMClient: Registering the ApplicationMaster

register then uses AMRMClient to register the Spark application’s ApplicationMaster

(using the local hostname, the port 0 and the input uiAddress ).

The input uiAddress is the web UI of the Spark application and is specified
Note using the SparkContext (when the application runs in cluster deploy mode) or
using spark.driver.appUIAddress property.

registered flag is enabled.

In the end, register creates a new YarnAllocator (using the input parameters of
register and the internal AMRMClient).

1108
YarnRMClient

register is used exclusively when ApplicationMaster registers itself with the

Note
YARN ResourceManager.

Unregistering ApplicationMaster from YARN

ResourceManager —  unregister Method

unregister(status: FinalApplicationStatus, diagnostics: String = ""): Unit

unregister unregisters the ApplicationMaster of a Spark application.

It basically checks that ApplicationMaster is registered and only when it is requests the
internal AMRMClient to unregister.

unregister is called when ApplicationMaster wants to unregister.

Maximum Number of Attempts to Register

ApplicationMaster —  getMaxRegAttempts Method

getMaxRegAttempts(sparkConf: SparkConf, yarnConf: YarnConfiguration): Int

getMaxRegAttempts uses SparkConf and YARN’s YarnConfiguration to read configuration

settings and return the maximum number of application attempts before ApplicationMaster
registration with YARN is considered unsuccessful (and so the Spark application).

It reads YARN’s yarn.resourcemanager.am.max-attempts (available as

YarnConfiguration.RM_AM_MAX_ATTEMPTS) or falls back to
YarnConfiguration.DEFAULT_RM_AM_MAX_ATTEMPTS (which is 2 ).

The return value is the minimum of the configuration settings of YARN and Spark.

Getting ApplicationAttemptId of Spark Application 

—  getAttemptId Method

getAttemptId(): ApplicationAttemptId

getAttemptId returns YARN’s ApplicationAttemptId (of the Spark application to which the

container was assigned).

Internally, it uses YARN-specific methods like ConverterUtils.toContainerId and

ContainerId.getApplicationAttemptId.

1109
YarnRMClient

getAmIpFilterParams Method

Caution FIXME

1110
ApplicationMaster

ApplicationMaster (aka ExecutorLauncher)

ApplicationMaster is the YARN ApplicationMaster for a Spark application submitted to a

YARN cluster (which is commonly called Spark on YARN).

Figure 1. ApplicationMaster’s Dependencies

ApplicationMaster is a standalone application that YARN NodeManager runs in a YARN

container to manage a Spark application running in a YARN cluster.

From the official documentation of Apache Hadoop YARN (with some minor
changes of mine):
The per-application ApplicationMaster is actually a framework-specific
Note
library and is tasked with negotiating cluster resources from the YARN
ResourceManager and working with the YARN NodeManager(s) to
execute and monitor the tasks.

ApplicationMaster (and ExecutorLauncher ) is launched as a result of Client creating a

ContainerLaunchContext to launch a Spark application on YARN.

Figure 2. Launching ApplicationMaster

ContainerLaunchContext represents all of the information needed by the YARN
Note
NodeManager to launch a container.

1111
ApplicationMaster

ExecutorLauncher is a custom ApplicationMaster for client deploy mode only for the purpose
distinguishing client and cluster deploy modes when using ps or jps .

$ jps -lm
Note
71253 org.apache.spark.deploy.yarn.ExecutorLauncher --arg
192.168.99.1:50188 --properties-file /tmp/hadoop-jacek/nm-local-
dir/usercache/jacek/appcache/.../__spark_conf__/__spark_conf__.prope

When created ApplicationMaster takes a YarnRMClient (to handle communication with

YARN ResourceManager for YARN containers for ApplicationMaster and executors).

ApplicationMaster uses YarnAllocator to manage YARN containers with executors.

Table 1. ApplicationMaster’s Internal Properties

Name Initial Value Description
RpcEndpointRef to the YarnAM
RPC endpoint initialized when
ApplicationMaster
runAMEndpoint.
CAUTION: FIXME When, in a
Spark application’s lifecycle, does
amEndpoint (uninitialized) runAMEndpoint really happen?

Used exclusively when

ApplicationMaster registers the
web UI security filters (in client
deploy mode when the driver runs
outside ApplicationMaster ).

Used to register the

ApplicationMaster and request
containers for executors from
YARN and later unregister
ApplicationMaster from YARN
ResourceManager.
client YarnRMClient
Used to get an application attempt
id and the allowed number of
attempts to register
ApplicationMaster .

Used to get filter parameters to

secure ApplicationMaster’s UI.

sparkConf New SparkConf FIXME

1112
ApplicationMaster

finished false Flag to…​FIXME

Flag to…​FIXME
yarnConf Hadoop’s
YarnConfiguration Created using
SparkHadoopUtil.newConfiguration

exitCode 0 FIXME

userClassThread (uninitialized) FIXME

Used only in cluster deploy

mode (when the driver and
ApplicationMaster run together in
a YARN container) as a
communication bus between
ApplicationMaster and the
separate Driver thread that runs
a Spark application.
Used to inform ApplicationMaster
when a Spark application’s
SparkContext has been initialized
SparkContext
sparkContextPromise successfully or failed.
Scala’s Promise
Non- null value allows
ApplicationMaster to access the
driver’s RpcEnv (available as
rpcEnv).
NOTE: A successful initialization of
a Spark application’s
SparkContext is when YARN-
specific TaskScheduler , i.e.
YarnClusterScheduler , gets
informed that the Spark application
has started. What a clever solution!

RpcEnv which is:

sparkYarnAM RPC
environment from a Spark
application submitted to YARN
rpcEnv (uninitialized) in client deploy mode.
sparkDriver RPC
environment from the Spark
application submitted to YARN
in cluster deploy mode.

true (when --
isClusterMode class was Flag…​FIXME
specified)

1113
ApplicationMaster

maxNumExecutorFailures FIXME

maxNumExecutorFailures Property

Caution FIXME

Computed using the optional spark.yarn.max.executor.failures if set. Otherwise, it is twice

spark.executor.instances or spark.dynamicAllocation.maxExecutors (with dynamic allocation
enabled) with the minimum of 3 .

Creating ApplicationMaster Instance

ApplicationMaster takes the following when created:

ApplicationMasterArguments

YarnRMClient

ApplicationMaster initializes the internal registries and counters.

Caution FIXME Review the initialization again

reporterThread Method

Caution FIXME

Launching Progress Reporter Thread 

—  launchReporterThread Method

Caution FIXME

Setting Internal SparkContext Reference 

—  sparkContextInitialized Method

sparkContextInitialized(sc: SparkContext): Unit

sparkContextInitialized passes the call on to the

ApplicationMaster.sparkContextInitialized that sets the internal sparkContextRef

reference (to be sc ).

1114
ApplicationMaster

Clearing Internal SparkContext Reference 

—  sparkContextStopped Method

sparkContextStopped(sc: SparkContext): Boolean

sparkContextStopped passes the call on to the ApplicationMaster.sparkContextStopped that

clears the internal sparkContextRef reference (i.e. sets it to null ).

Registering web UI Security Filters —  addAmIpFilter

Method

addAmIpFilter(): Unit

addAmIpFilter is a helper method that …​???

It starts by reading Hadoop’s environmental variable

ApplicationConstants.APPLICATION_WEB_PROXY_BASE_ENV that it passes to
YarnRMClient to compute the configuration for the AmIpFilter for web UI.

In cluster deploy mode (when ApplicationMaster runs with web UI), it sets
spark.ui.filters system property as

org.apache.hadoop.yarn.server.webproxy.amfilter.AmIpFilter . It also sets system properties

from the key-value configuration of AmIpFilter (computed earlier) as

spark.org.apache.hadoop.yarn.server.webproxy.amfilter.AmIpFilter.param.[key] being

[value] .

In client deploy mode (when ApplicationMaster runs on another JVM or even host than web
UI), it simply sends a AddWebUIFilter to ApplicationMaster (namely to AMEndpoint RPC
Endpoint).

finish Method

Caution FIXME

allocator Internal Reference to YarnAllocator

allocator is the internal reference to YarnAllocator that ApplicationMaster uses to request

new or release outstanding containers for executors.

allocator is created when ApplicationMaster is registered (using the internal

YarnRMClient reference).

1115
ApplicationMaster

Launching ApplicationMaster Standalone Application 

—  main Method
ApplicationMaster is started as a standalone application inside a YARN container on a

node.

ApplicationMaster standalone application is launched as a result of sending a

Note ContainerLaunchContext request to launch ApplicationMaster for a Spark
application to YARN ResourceManager.

Figure 3. Submitting ApplicationMaster to YARN NodeManager

When executed, main first parses command-line parameters and then uses
SparkHadoopUtil.runAsSparkUser to run the main code with a Hadoop
UserGroupInformation as a thread local variable (distributed to child threads) for

authenticating HDFS and YARN calls.

Enable DEBUG logging level for org.apache.spark.deploy.SparkHadoopUtil logger

to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.SparkHadoopUtil=DEBUG

Refer to Logging.

You should see the following message in the logs:

1116
ApplicationMaster

DEBUG running as user: [user]

SparkHadoopUtil.runAsSparkUser function executes a block that creates a

ApplicationMaster (passing the ApplicationMasterArguments instance and a new

YarnRMClient) and then runs it.

Running ApplicationMaster —  run Method

run(): Int

run reads the application attempt id.

(only in cluster deploy mode) run sets cluster deploy mode-specific settings and sets
the application attempt id (from YARN).

run sets a CallerContext for APPMASTER .

FIXME Why is CallerContext required? It’s only executed when

Caution hadoop.caller.context.enabled is enabled and
org.apache.hadoop.ipc.CallerContext class is on CLASSPATH.

You should see the following INFO message in the logs:

INFO ApplicationAttemptId: [appAttemptId]

run creates a Hadoop FileSystem (using the internal YarnConfiguration).

run registers the cleanup shutdown hook.

run creates a SecurityManager.

(only when spark.yarn.credentials.file is defined) run creates a

ConfigurableCredentialManager to get a AMCredentialRenewer and schedules login from

keytab.

Caution FIXME Security stuff begs for more details.

In the end, run registers ApplicationMaster (with YARN ResourceManager) for the Spark
application — either calling runDriver (in cluster deploy mode) or runExecutorLauncher
(for client deploy mode).

run exits with 0 exit code.

1117
ApplicationMaster

In case of an exception, you should see the following ERROR message in the logs and run
finishes with FAILED final application status.

ERROR Uncaught exception: [exception]

run is used exclusively when ApplicationMaster is launched as a standalone

Note
application (inside a YARN container on a YARN cluster).

Creating sparkYarnAM RPC Environment and Registering

ApplicationMaster with YARN ResourceManager (Client
Deploy Mode) —  runExecutorLauncher Internal Method

runExecutorLauncher(securityMgr: SecurityManager): Unit

runExecutorLauncher creates sparkYarnAM RPC environment (on spark.yarn.am.port port,

the internal SparkConf and clientMode enabled).

Read the note in Creating RpcEnv to learn the meaning of clientMode input
argument.
Tip
clientMode is enabled for so-called a client-mode ApplicationMaster which is
when a Spark application is submitted to YARN in client deploy mode.

runExecutorLauncher then waits until the driver accepts connections and creates

RpcEndpointRef to communicate.

runExecutorLauncher registers web UI security filters.

Caution FIXME Why is this needed? addAmIpFilter

In the end, runExecutorLauncher registers ApplicationMaster with YARN ResourceManager

and requests resources and then pauses until reporterThread finishes.

runExecutorLauncher is used exclusively when ApplicationMaster is started in

Note
client deploy mode.

Running Spark Application’s Driver and Registering

ApplicationMaster with YARN ResourceManager (Cluster
Deploy Mode) —  runDriver Internal Method

runDriver(securityMgr: SecurityManager): Unit

1118
ApplicationMaster

runDriver starts a Spark application on a separate thread, registers YarnAM endpoint in

the application’s RpcEnv followed by registering ApplicationMaster with YARN

ResourceManager. In the end, runDriver waits for the Spark application to finish.

Internally, runDriver registers web UI security filters and starts a Spark application (on a
separate Thread).

You should see the following INFO message in the logs:

INFO Waiting for spark context initialization...

runDriver waits spark.yarn.am.waitTime time till the Spark application’s SparkContext is

available and accesses the current RpcEnv (and saves it as the internal rpcEnv).

runDriver uses SparkEnv to access the current RpcEnv that the Spark
Note
application’s SparkContext manages.

runDriver creates RpcEndpointRef to the driver’s YarnScheduler endpoint and registers

YarnAM endpoint (using spark.driver.host and spark.driver.port properties for the driver’s

host and port and isClusterMode enabled).

runDriver registers ApplicationMaster with YARN ResourceManager and requests cluster

resources (using the Spark application’s RpcEnv, the driver’s RPC endpoint reference,
webUrl if web UI is enabled and the input securityMgr ).

runDriver pauses until the Spark application finishes.

runDriver uses Java’s Thread.join on the internal Thread reference to the

Note
Spark application running on it.

If the Spark application has not started in spark.yarn.am.waitTime time, runDriver reports a
IllegalStateException :

SparkContext is null but app is still running!

If TimeoutException is reported while waiting for the Spark application to start, you should
see the following ERROR message in the logs and runDriver finishes with FAILED final
application status and the error code 13 .

ERROR SparkContext did not initialize after waiting for [spark.yarn.am.waitTime] ms. P
lease check earlier log output for errors. Failing the application.

runDriver is used exclusively when ApplicationMaster is started in cluster

Note
deploy mode.

1119
ApplicationMaster

Starting Spark Application (in Separate Driver Thread) 

—  startUserApplication Method

startUserApplication(): Thread

startUserApplication starts a Spark application as a separate Driver thread.

Internally, when startUserApplication is executed, you should see the following INFO
message in the logs:

INFO Starting the user application in a separate Thread

startUserApplication takes the user-specified jars and maps them to use the file:

protocol.

startUserApplication then creates a class loader to load the main class of the Spark

application given the precedence of the Spark system jars and the user-specified jars.

startUserApplication works on custom configurations for Python and R applications (which

I don’t bother including here).

startUserApplication loads the main class (using the custom class loader created above

with the user-specified jars) and creates a reference to the main method.

The main class is specified as userClass in ApplicationMasterArguments when

Note
ApplicationMaster was created.

startUserApplication starts a Java Thread (with the name Driver) that invokes the main

method (with the application arguments from userArgs from ApplicationMasterArguments).

The Driver thread uses the internal sparkContextPromise to notify ApplicationMaster
about the execution status of the main method (success or failure).

When the main method (of the Spark application) finishes successfully, the Driver thread
will finish with SUCCEEDED final application status and code status 0 and you should see
the following DEBUG message in the logs:

DEBUG Done running users class

Any exceptions in the Driver thread are reported with corresponding ERROR message in
the logs, FAILED final application status, appropriate code status.

1120
ApplicationMaster

// SparkUserAppException
ERROR User application exited with status [exitCode]

// non-SparkUserAppException
ERROR User class threw exception: [cause]

A Spark application’s exit codes are passed directly to finish ApplicationMaster

Note
and recorded as exitCode for future reference.

startUserApplication is used exclusively when ApplicationMaster runs a

Note Spark application’s driver and registers itself with YARN ResourceManager for
cluster deploy mode.

Registering ApplicationMaster with YARN

ResourceManager and Requesting YARN Cluster
Resources —  registerAM Internal Method

registerAM(
_sparkConf: SparkConf,
_rpcEnv: RpcEnv,
driverRef: RpcEndpointRef,
uiAddress: String,
securityMgr: SecurityManager): Unit

Figure 4. Registering ApplicationMaster with YARN ResourceManager

1121
ApplicationMaster

Internally, registerAM first takes the application and attempt ids, and creates the URL of
Spark History Server for the Spark application, i.e. [address]/history/[appId]/[attemptId] ,
by substituting Hadoop variables (using the internal YarnConfiguration) in the optional
spark.yarn.historyServer.address setting.

registerAM then creates a RpcEndpointAddress for the driver’s CoarseGrainedScheduler

RPC endpoint available at spark.driver.host and spark.driver.port.

registerAM prints YARN launch context diagnostic information (with command, environment

and resources) for executors (with spark.executor.memory, spark.executor.cores and

dummy <executorId> and <hostname> )

registerAM requests YarnRMClient to register ApplicationMaster (with YARN

ResourceManager) and the internal YarnAllocator to allocate required cluster resources

(given placement hints about where to allocate resource containers for executors to be as
close to the data as possible).

registerAM uses YarnRMClient that was given when ApplicationManager was

Note
created.

In the end, registerAM launches reporter thread.

registerAM is used when ApplicationMaster runs a Spark application in

Note
cluster deploy mode and client deploy mode.

Command-Line Parameters 
—  ApplicationMasterArguments class
ApplicationMaster uses ApplicationMasterArguments class to handle command-line

parameters.

ApplicationMasterArguments is created right after main method has been executed for args

command-line parameters.

It accepts the following command-line parameters:

--jar JAR_PATH  — the path to the Spark application’s JAR file

--class CLASS_NAME  — the name of the Spark application’s main class

--arg ARG  — an argument to be passed to the Spark application’s main class. There

can be multiple --arg arguments that are passed in order.

--properties-file FILE  — the path to a custom Spark properties file.

--primary-py-file FILE  — the main Python file to run.

1122
ApplicationMaster

--primary-r-file FILE  — the main R file to run.

When an unsupported parameter is found the following message is printed out to standard
error output and ApplicationMaster exits with the exit code 1 .

Unknown/unsupported param [unknownParam]

Usage: org.apache.spark.deploy.yarn.ApplicationMaster [options]

Options:
--jar JAR_PATH Path to your application's JAR file
--class CLASS_NAME Name of your application's main class
--primary-py-file A main Python file
--primary-r-file A main R file
--arg ARG Argument to be passed to your application's main class.
Multiple invocations are possible, each will be passed in order
.
--properties-file FILE Path to a custom Spark properties file.

localResources Property
When ApplicationMaster is instantiated, it computes internal localResources collection of
YARN’s LocalResource by name based on the internal spark.yarn.cache.* configuration
settings.

localResources: Map[String, LocalResource]

You should see the following INFO message in the logs:

INFO ApplicationMaster: Preparing Local resources

It starts by reading the internal Spark configuration settings (that were earlier set when
Client prepared local resources to distribute):

spark.yarn.cache.filenames

spark.yarn.cache.sizes

spark.yarn.cache.timestamps

spark.yarn.cache.visibilities

spark.yarn.cache.types

For each file name in spark.yarn.cache.filenames it maps spark.yarn.cache.types to an

appropriate YARN’s LocalResourceType and creates a new YARN LocalResource.

1123
ApplicationMaster

Note LocalResource represents a local resource required to run a container.

If spark.yarn.cache.confArchive is set, it is added to localResources as ARCHIVE resource

type and PRIVATE visibility.

Note spark.yarn.cache.confArchive is set when Client prepares local resources.

ARCHIVE is an archive file that is automatically unarchived by the

Note
NodeManager.

PRIVATE visibility means to share a resource among all applications of the

Note
same user on the node.

Ultimately, it removes the cache-related settings from the Spark configuration and system
properties.

You should see the following INFO message in the logs:

INFO ApplicationMaster: Prepared Local resources [resources]

Cluster Mode Settings

When in cluster deploy mode, ApplicationMaster sets the following system properties (in
run):

spark.ui.port to 0

spark.master as yarn

spark.submit.deployMode as cluster

spark.yarn.app.id as YARN-specific application id

Caution FIXME Why are the system properties required? Who’s expecting them?

isClusterMode Internal Flag

FIXME Since org.apache.spark.deploy.yarn.ExecutorLauncher is used for

Caution client deploy mode, the isClusterMode flag could be set there (not
depending on --class which is correct yet not very obvious).

isClusterMode is an internal flag that is enabled (i.e. true ) for cluster mode.

1124
ApplicationMaster

Specifically, it says whether the main class of the Spark application (through --class
command-line argument) was specified or not. That is how the developers decided to inform
ApplicationMaster about being run in cluster mode when Client creates YARN’s

ContainerLaunchContext (to launch the ApplicationMaster for a Spark application).

isClusterMode is used to set additional system properties in run and runDriver (the flag is

enabled) or runExecutorLauncher (when disabled).

Besides, isClusterMode controls the default final status of a Spark application being
FinalApplicationStatus.FAILED (when the flag is enabled) or

FinalApplicationStatus.UNDEFINED .

isClusterMode also controls whether to set system properties in addAmIpFilter (when the

flag is enabled) or send a AddWebUIFilter instead.

Unregistering ApplicationMaster from YARN

ResourceManager —  unregister Method
unregister unregisters the ApplicationMaster for the Spark application from the YARN

ResourceManager.

unregister(status: FinalApplicationStatus, diagnostics: String = null): Unit

It is called from the cleanup shutdown hook (that was registered in

Note ApplicationMaster when it started running) and only when the application’s
final result is successful or it was the last attempt to run the application.

It first checks that the ApplicationMaster has not already been unregistered (using the
internal unregistered flag). If so, you should see the following INFO message in the logs:

INFO ApplicationMaster: Unregistering ApplicationMaster with [status]

There can also be an optional diagnostic message in the logs:

(diag message: [msg])

The internal unregistered flag is set to be enabled, i.e. true .

It then requests YarnRMClient to unregister.

Cleanup Shutdown Hook

1125
ApplicationMaster

When ApplicationMaster starts running, it registers a shutdown hook that unregisters the
Spark application from the YARN ResourceManager and cleans up the staging directory.

Internally, it checks the internal finished flag, and if it is disabled, it marks the Spark
application as failed with EXIT_EARLY .

If the internal unregistered flag is disabled, it unregisters the Spark application and cleans
up the staging directory afterwards only when the final status of the ApplicationMaster’s
registration is FinalApplicationStatus.SUCCEEDED or the number of application attempts is
more than allowed.

The shutdown hook runs after the SparkContext is shut down, i.e. the shutdown priority is
one less than SparkContext’s.

The shutdown hook is registered using Spark’s own ShutdownHookManager.addShutdownHook .

ExecutorLauncher
ExecutorLauncher comes with no extra functionality when compared to ApplicationMaster .

It serves as a helper class to run ApplicationMaster under another class name in client
deploy mode.

With the two different class names (pointing at the same class ApplicationMaster ) you
should be more successful to distinguish between ExecutorLauncher (which is really a
ApplicationMaster ) in client deploy mode and the ApplicationMaster in cluster deploy

mode using tools like ps or jps .

Note Consider ExecutorLauncher a ApplicationMaster for client deploy mode.

Obtain Application Attempt Id —  getAttemptId Method

getAttemptId(): ApplicationAttemptId

getAttemptId returns YARN’s ApplicationAttemptId (of the Spark application to which the

container was assigned).

Internally, it queries YARN by means of YarnRMClient.

Waiting Until Driver is Network-Accessible and Creating

RpcEndpointRef to Communicate 
—  waitForSparkDriver Internal Method

1126
ApplicationMaster

waitForSparkDriver(): RpcEndpointRef

waitForSparkDriver waits until the driver is network-accessible, i.e. accepts connections on

a given host and port, and returns a RpcEndpointRef to the driver.

When executed, you should see the following INFO message in the logs:

INFO yarn.ApplicationMaster: Waiting for Spark driver to be reachable.

waitForSparkDriver takes the driver’s host and port (using ApplicationMasterArguments

passed in when ApplicationMaster was created).

FIXME waitForSparkDriver expects the driver’s host and port as the 0-th
Caution
element in ApplicationMasterArguments.userArgs . Why?

waitForSparkDriver tries to connect to the driver’s host and port until the driver accepts the

connection but no longer than spark.yarn.am.waitTime setting or finished internal flag is

enabled.

You should see the following INFO message in the logs:

INFO yarn.ApplicationMaster: Driver now available: [driverHost]:[driverPort]

While waitForSparkDriver tries to connect (while the socket is down), you can see the
following ERROR message and waitForSparkDriver pauses for 100 ms and tries to connect
again (until the waitTime elapses).

ERROR Failed to connect to driver at [driverHost]:[driverPort], retrying ...

Once waitForSparkDriver could connect to the driver, waitForSparkDriver sets

spark.driver.host and spark.driver.port properties to driverHost and driverPort ,
respectively (using the internal SparkConf).

In the end, waitForSparkDriver runAMEndpoint.

If waitForSparkDriver did not manage to connect (before waitTime elapses or finished

internal flag was enabled), waitForSparkDriver reports a SparkException :

Failed to connect to driver!

1127
ApplicationMaster

waitForSparkDriver is used exclusively when client-mode ApplicationMaster

Note creates the sparkYarnAM RPC environment and registers itself with YARN
ResourceManager.

Creating RpcEndpointRef to Driver’s YarnScheduler

Endpoint and Registering YarnAM Endpoint 
—  runAMEndpoint Internal Method

runAMEndpoint(host: String, port: String, isClusterMode: Boolean): RpcEndpointRef

runAMEndpoint sets up a RpcEndpointRef to the driver’s YarnScheduler endpoint and

registers YarnAM endpoint.

sparkDriver RPC environment when the driver lives in YARN cluster (in
Note
cluster deploy mode)

Figure 5. Registering YarnAM Endpoint

Internally, runAMEndpoint gets a RpcEndpointRef to the driver’s YarnScheduler endpoint
(available on the host and port ).

YarnScheduler RPC endpoint is registered when the Spark coarse-grained

Note
scheduler backends for YARN are created.

1128
ApplicationMaster

runAMEndpoint then registers the RPC endpoint as YarnAM (and AMEndpoint

implementation with ApplicationMaster 's RpcEnv, YarnScheduler endpoint reference, and

isClusterMode flag).

runAMEndpoint is used when ApplicationMaster waits for the driver (in client
Note
deploy mode) and runs the driver (in cluster deploy mode).

1129
AMEndpoint — ApplicationMaster RPC Endpoint

AMEndpoint — ApplicationMaster RPC
Endpoint
onStart Callback
When onStart is called, AMEndpoint communicates with the driver (the driver remote
RPC Endpoint reference) by sending a one-way RegisterClusterManager message with a
reference to itself.

After RegisterClusterManager has been sent (and received by YarnSchedulerEndpoint) the

communication between the RPC endpoints of ApplicationMaster (YARN) and
YarnSchedulerBackend (the Spark driver) is considered established.

RPC Messages

AddWebUIFilter

AddWebUIFilter(
filterName: String,
filterParams: Map[String, String],
proxyBase: String)

When AddWebUIFilter arrives, you should see the following INFO message in the logs:

INFO ApplicationMaster$AMEndpoint: Add WebUI Filter. [addWebUIFilter]

It then passes the AddWebUIFilter message on to the driver’s scheduler backend (through
YarnScheduler RPC Endpoint).

RequestExecutors

RequestExecutors(
requestedTotal: Int,
localityAwareTasks: Int,
hostToLocalTaskCount: Map[String, Int])

When RequestExecutors arrives, AMEndpoint requests YarnAllocator for executors given

locality preferences.

1130
AMEndpoint — ApplicationMaster RPC Endpoint

If the requestedTotal number of executors is different than the current number,

resetAllocatorInterval is executed.

In case when YarnAllocator is not available yet, you should see the following WARN
message in the logs:

WARN Container allocator is not ready to request executors yet.

The response is false then.

resetAllocatorInterval
When RequestExecutors message arrives, it calls resetAllocatorInterval procedure.

resetAllocatorInterval(): Unit

resetAllocatorInterval requests allocatorLock monitor lock and sets the internal

nextAllocationInterval attribute to be initialAllocationInterval internal attribute. It then

wakes up all threads waiting on allocatorLock .

Note A thread waits on a monitor by calling one of the Object.wait methods.

1131
YarnClusterManager — ExternalClusterManager for YARN

YarnClusterManager — 
ExternalClusterManager for YARN
YarnClusterManager is the only currently known ExternalClusterManager in Spark. It creates

a TaskScheduler and a SchedulerBackend for YARN.

canCreate Method
YarnClusterManager can handle the yarn master URL only.

createTaskScheduler Method
createTaskScheduler creates a YarnClusterScheduler for cluster deploy mode and a

YarnScheduler for client deploy mode.

It throws a SparkException for unknown deploy modes.

Unknown deploy mode '[deployMode]' for Yarn

createSchedulerBackend Method
createSchedulerBackend creates a YarnClusterSchedulerBackend for cluster deploy mode

and a YarnClientSchedulerBackend for client deploy mode.

It throws a SparkException for unknown deploy modes.

Unknown deploy mode '[deployMode]' for Yarn

Initializing YarnClusterManager —  initialize Method

initialize simply initializes the input TaskSchedulerImpl .

1132
TaskSchedulers for YARN

TaskSchedulers for YARN

There are two TaskSchedulers for Spark on YARN per deploy mode:

YarnScheduler for client deploy mode

YarnClusterScheduler for cluster deploy mode

1133
YarnScheduler

YarnScheduler — TaskScheduler for Client

Deploy Mode
YarnScheduler is the TaskScheduler for Spark on YARN in client deploy mode.

It is a custom TaskSchedulerImpl with ability to compute racks per hosts, i.e. it comes with a
specialized getRackForHost.

It also sets org.apache.hadoop.yarn.util.RackResolver logger to WARN if not set already.

Enable INFO or DEBUG logging levels for

org.apache.spark.scheduler.cluster.YarnScheduler logger to see what happens
inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.scheduler.cluster.YarnScheduler=DEBUG

Refer to Logging.

Tracking Racks per Hosts and Ports (getRackForHost

method)
getRackForHost attempts to compute the rack for a host.

Note getRackForHost overrides the parent TaskSchedulerImpl’s getRackForHost

It simply uses Hadoop’s org.apache.hadoop.yarn.util.RackResolver to resolve a hostname to

its network location, i.e. a rack.

1134
YarnClusterScheduler

YarnClusterScheduler — TaskScheduler for
Cluster Deploy Mode
YarnClusterScheduler is the TaskScheduler for Spark on YARN in cluster deploy mode.

It is a custom YarnScheduler that makes sure that appropriate initialization of

ApplicationMaster is performed, i.e. SparkContext is initialized and stopped.

While being created, you should see the following INFO message in the logs:

INFO YarnClusterScheduler: Created YarnClusterScheduler

Enable INFO logging level for

org.apache.spark.scheduler.cluster.YarnClusterScheduler to see what happens
inside YarnClusterScheduler .
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.scheduler.cluster.YarnClusterScheduler=INFO

Refer to Logging.

postStartHook Callback
postStartHook calls ApplicationMaster.sparkContextInitialized before the parent’s

postStartHook .

You should see the following INFO message in the logs:

INFO YarnClusterScheduler: YarnClusterScheduler.postStartHook done

Stopping YarnClusterScheduler (stop method)

stop calls the parent’s stop followed by ApplicationMaster.sparkContextStopped.

1135
SchedulerBackends for YARN

SchedulerBackends for YARN

There are currently two SchedulerBackends for Spark on YARN per deploy mode:

YarnClientSchedulerBackend for client deploy mode

YarnSchedulerBackend for cluster deploy mode

They are concrete YarnSchedulerBackends.

1136
YarnSchedulerBackend

YarnSchedulerBackend — Foundation for
Coarse-Grained Scheduler Backends for YARN
YarnSchedulerBackend is a CoarseGrainedSchedulerBackend that acts as the foundation for

the concrete deploy mode-specific Spark scheduler backends for YARN, i.e.
YarnClientSchedulerBackend and YarnClusterSchedulerBackend for client deploy mode
and cluster deploy mode, respectively.

YarnSchedulerBackend registers itself as YarnScheduler RPC endpoint in the RPC

Environment.

Figure 1. YarnSchedulerBackend in YARN Container

YarnSchedulerBackend is ready to accept task launch requests right after the sufficient

executors are registered (that varies on dynamic allocation being enabled or not).

With no extra configuration, YarnSchedulerBackend is ready for task launch

Note
requests when 80% of all the requested executors are available.

YarnSchedulerBackend is an private[spark] abstract class and is never

Note created directly (but only indirectly through the concrete implementations
YarnClientSchedulerBackend and YarnClusterSchedulerBackend).

Table 1. YarnSchedulerBackend’s Internal Properties

Name Initial Value

Ratio for minimum number of registered executors

to claim YarnSchedulerBackend is ready for task
launch requests.
Minimum expecte
0.8 (when executors that is
minRegisteredRatio spark.scheduler.minRegisteredResourcesRatio that sufficient res
property is undefined) available
task launch reque

1137
YarnSchedulerBackend

minRegisteredRatio from the parent

CoarseGrainedSchedulerBackend

yarnSchedulerEndpoint YarnSchedulerEndpoint object

Created
yarnSchedulerEndpointRef
RPC endpoint reference to YarnScheduler RPC
YarnSchedulerBac
endpoint
created

Total expected nu
executors that is
that sufficient res
available
totalExpectedExecutors 0
task launch reque
Updated to the fin
Spark on YARN s
mode

askTimeout FIXME FIXME

appId FIXME FIXME

YARN’s
a Spark applicatio
Only defined in
mode
Set when
attemptId (undefined) YarnClusterSched
starts
using YARN’s
ApplicationMaste

Used for
which is part of
SchedulerBacken

Controls
YarnSchedulerBac
another
RPC message ar
allows resetting in
after the initial
ApplicationManag
new one was reg
shouldResetOnAmRegister
can only happen
deploy mode

1138
YarnSchedulerBackend

Disabled (i.e.
YarnSchedulerBa
created

Resetting YarnSchedulerBackend —  reset Method

Note reset is part of CoarseGrainedSchedulerBackend Contract.

reset resets the parent CoarseGrainedSchedulerBackend scheduler backend and

ExecutorAllocationManager (accessible by SparkContext.executorAllocationManager ).

doRequestTotalExecutors Method

def doRequestTotalExecutors(requestedTotal: Int): Boolean

doRequestTotalExecutors is part of the CoarseGrainedSchedulerBackend

Note
Contract.

Figure 2. Requesting Total Executors in YarnSchedulerBackend (doRequestTotalExecutors

method)
doRequestTotalExecutors simply sends a blocking RequestExecutors message to

YarnScheduler RPC Endpoint with the input requestedTotal and the internal
localityAwareTasks and hostToLocalTaskCount attributes.

Caution FIXME The internal attributes are already set. When and how?

Starting the Backend —  start Method

start creates a SchedulerExtensionServiceBinding object (using SparkContext , appId ,

and attemptId ) and starts it (using SchedulerExtensionServices.start(binding) ).

A SchedulerExtensionServices object is created when YarnSchedulerBackend is

Note
initialized and available as services .

Ultimately, it calls the parent’s CoarseGrainedSchedulerBackend.start.

1139
YarnSchedulerBackend

start throws IllegalArgumentException when the internal appId has not been
set yet.
Note
java.lang.IllegalArgumentException: requirement failed: application ID unset

Stopping the Backend —  stop Method

stop calls the parent’s CoarseGrainedSchedulerBackend.requestTotalExecutors (using

(0, 0, Map.empty) parameters).

FIXME Explain what 0, 0, Map.empty means after the method’s described

Caution
for the parent.

It calls the parent’s CoarseGrainedSchedulerBackend.stop.

Ultimately, it stops the internal SchedulerExtensionServiceBinding object (using

services.stop() ).

Caution FIXME Link the description of services.stop() here.

Recording Application and Attempt Ids —  bindToYarn

Method

bindToYarn(appId: ApplicationId, attemptId: Option[ApplicationAttemptId]): Unit

bindToYarn sets the internal appId and attemptId to the value of the input parameters,

appId and attemptId , respectively.

Note start requires appId .

Requesting YARN for Spark Application’s Current Attempt

Id —  applicationAttemptId Method

applicationAttemptId(): Option[String]

Note applicationAttemptId is part of SchedulerBackend Contract.

applicationAttemptId requests the internal YARN’s ApplicationAttemptId for the Spark

application’s current attempt id.

1140
YarnSchedulerBackend

Creating YarnSchedulerBackend Instance

This section is only to take notes about the required components to instantiate
Note
the base services.

YarnSchedulerBackend takes the following when created:

1. TaskSchedulerImpl

2. SparkContext

YarnSchedulerBackend initializes the internal properties.

Checking if Enough Executors Are Available 

—  sufficientResourcesRegistered Method

sufficientResourcesRegistered(): Boolean

sufficientResourcesRegistered is part of the CoarseGrainedSchedulerBackend

Note
contract that makes sure that sufficient resources are available.

sufficientResourcesRegistered is positive, i.e. true , when totalRegisteredExecutors is

exactly or above minRegisteredRatio of totalExpectedExecutors.

1141
YarnClientSchedulerBackend

YarnClientSchedulerBackend  — 
SchedulerBackend for YARN in Client Deploy
Mode
YarnClientSchedulerBackend is the YarnSchedulerBackend used when a Spark application is

submitted to a YARN cluster in client deploy mode.

client deploy mode is the default deploy mode of Spark applications

Note
submitted to a YARN cluster.

YarnClientSchedulerBackend submits a Spark application when started and waits for the

Spark application until it finishes (successfully or not).

Table 1. YarnClientSchedulerBackend’s Internal Properties

Name Initial Value Description
Client to submit and monitor a Spark
application (when
YarnClientSchedulerBackend is started).
client (undefined) Created when
YarnClientSchedulerBackend is started
and stopped when
YarnClientSchedulerBackend stops.

monitorThread (undefined) MonitorThread

Enable DEBUG logging level for

org.apache.spark.scheduler.cluster.YarnClientSchedulerBackend logger to see what
happens inside YarnClientSchedulerBackend .

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.scheduler.cluster.YarnClientSchedulerBackend=DEBUG

Refer to Logging.

1142
YarnClientSchedulerBackend

Enable DEBUG logging level for org.apache.hadoop logger to see what happens
inside Hadoop YARN.

Add the following line to conf/log4j.properties :

log4j.logger.org.apache.hadoop=DEBUG
Tip

Refer to Logging.
Use with caution though as there will be a flood of messages in the logs every
second.

Starting YarnClientSchedulerBackend —  start Method

start(): Unit

start is part of SchedulerBackend contract executed when

Note
TaskSchedulerImpl starts.

start creates Client (to communicate with YARN ResourceManager) and submits a Spark

application to a YARN cluster.

After the application is launched, start starts a MonitorThread state monitor thread. In the
meantime it also calls the supertype’s start .

Figure 1. Starting YarnClientSchedulerBackend

Internally, start takes spark.driver.host and spark.driver.port properties for the driver’s host
and port, respectively.

If web UI is enabled, start sets spark.driver.appUIAddress as webUrl .

You should see the following DEBUG message in the logs:

1143
YarnClientSchedulerBackend

DEBUG YarnClientSchedulerBackend: ClientArguments called with: --arg [hostport]

hostport is spark.driver.host and spark.driver.port properties separated by : ,

Note
e.g. 192.168.99.1:64905 .

start creates a ClientArguments (passing in a two-element array with --arg and

hostport ).

start sets the total expected number of executors to the initial number of executors.

Caution FIXME Why is this part of subtypes since they both set it to the same value?

start creates a Client (with the ClientArguments and SparkConf ).

start submits the Spark application to YARN (through Client) and saves ApplicationId

(with undefined ApplicationAttemptId ).

start starts YarnSchedulerBackend (that in turn starts the top-level

CoarseGrainedSchedulerBackend).

Caution FIXME Would be very nice to know why start does so in a NOTE.

start waits until the Spark application is running.

(only when spark.yarn.credentials.file is defined) start starts

ConfigurableCredentialManager .

Caution FIXME Why? Include a NOTE to make things easier.

start creates and starts monitorThread (to monitor the Spark application and stop the

current SparkContext when it stops).

stop
stop is part of the SchedulerBackend Contract.

It stops the internal helper objects, i.e. monitorThread and client as well as "announces"
the stop to other services through Client.reportLauncherState . In the meantime it also calls
the supertype’s stop .

stop makes sure that the internal client has already been created (i.e. it is not null ),

but not necessarily started.

stop stops the internal monitorThread using MonitorThread.stopMonitor method.

1144
YarnClientSchedulerBackend

It then "announces" the stop using

Client.reportLauncherState(SparkAppHandle.State.FINISHED).

Later, it passes the call on to the suppertype’s stop and, once the supertype’s stop has
finished, it calls YarnSparkHadoopUtil.stopExecutorDelegationTokenRenewer followed by
stopping the internal client.

Eventually, when all went fine, you should see the following INFO message in the logs:

INFO YarnClientSchedulerBackend: Stopped

Waiting Until Spark Application Runs 

—  waitForApplication Internal Method

waitForApplication(): Unit

waitForApplication waits until the current application is running (using

Client.monitorApplication).

If the application has FINISHED , FAILED , or has been KILLED , a SparkException is thrown
with the following message:

Yarn application has already ended! It might have been killed or unable to launch appl
ication master.

You should see the following INFO message in the logs for RUNNING state:

INFO YarnClientSchedulerBackend: Application [appId] has started running.

Note waitForApplication is used when YarnClientSchedulerBackend is started.

asyncMonitorApplication

asyncMonitorApplication(): MonitorThread

asyncMonitorApplication internal method creates a separate daemon MonitorThread thread

called "Yarn application state monitor".

Note asyncMonitorApplication does not start the daemon thread.

1145
YarnClientSchedulerBackend

MonitorThread
MonitorThread internal class is to monitor a Spark application submitted to a YARN cluster

in client deploy mode.

When started, MonitorThread requests Client> to monitor a Spark application (with

logApplicationReport disabled).

Client.monitorApplication is a blocking operation and hence it is wrapped in

Note
MonitorThread to be executed on a separate thread.

When the call to Client.monitorApplication has finished, it is assumed that the application
has exited. You should see the following ERROR message in the logs:

ERROR Yarn application has already exited with state [state]!

That leads to stopping the current SparkContext (using SparkContext.stop).

1146
YarnClusterSchedulerBackend

YarnClusterSchedulerBackend -
SchedulerBackend for YARN in Cluster Deploy
Mode
YarnClusterSchedulerBackend is a custom YarnSchedulerBackend for Spark on YARN in

cluster deploy mode.

This is a scheduler backend that supports multiple application attempts and URLs for
driver’s logs to display as links in the web UI in the Executors tab for the driver.

It uses spark.yarn.app.attemptId under the covers (that the YARN resource manager
sets?).

YarnClusterSchedulerBackend is a private[spark] Scala class. You can find the

Note
sources in org.apache.spark.scheduler.cluster.YarnClusterSchedulerBackend.

Enable DEBUG logging level for

org.apache.spark.scheduler.cluster.YarnClusterSchedulerBackend logger to see what
happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.scheduler.cluster.YarnClusterSchedulerBackend=DEBUG

Refer to Logging.

Creating YarnClusterSchedulerBackend
Creating a YarnClusterSchedulerBackend object requires a TaskSchedulerImpl and
SparkContext objects.

Starting YarnClusterSchedulerBackend (start method)

YarnClusterSchedulerBackend comes with a custom start method.

Note start is part of the SchedulerBackend Contract.

Internally, it first queries ApplicationMaster for attemptId and records the application and
attempt ids.

It then calls the parent’s start and sets the parent’s totalExpectedExecutors to the initial
number of executors.

1147
YarnClusterSchedulerBackend

Calculating Driver Log URLs (getDriverLogUrls method)

getDriverLogUrls in YarnClusterSchedulerBackend calculates the URLs for the driver’s logs

- standard output (stdout) and standard error (stderr).

Note getDriverLogUrls is part of the SchedulerBackend Contract.

Internally, it retrieves the container id and through environment variables computes the base
URL.

You should see the following DEBUG in the logs:

DEBUG Base URL for logs: [baseUrl]

1148
YarnSchedulerEndpoint RPC Endpoint

YarnSchedulerEndpoint RPC Endpoint

YarnSchedulerEndpoint is a thread-safe RPC endpoint for communication between

YarnSchedulerBackend on the driver and ApplicationMaster on YARN (inside a YARN

container).

Caution FIXME Picture it.

It uses the reference to the remote ApplicationMaster RPC Endpoint to send messages to.

Enable INFO logging level for

org.apache.spark.scheduler.cluster.YarnSchedulerBackend$YarnSchedulerEndpoint logger to see w
happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.scheduler.cluster.YarnSchedulerBackend$YarnSchedulerEndpoint=IN

Refer to Logging.

RPC Messages

RequestExecutors

RequestExecutors(
requestedTotal: Int,
localityAwareTasks: Int,
hostToLocalTaskCount: Map[String, Int])
extends CoarseGrainedClusterMessage

RequestExecutors is to inform ApplicationMaster about the current requirements for the total

number of executors (as requestedTotal ), including already pending and running executors.

1149
YarnSchedulerEndpoint RPC Endpoint

Figure 1. RequestExecutors Message Flow (client deploy mode)

When a RequestExecutors arrives, YarnSchedulerEndpoint simply passes it on to
ApplicationMaster (via the internal RPC endpoint reference). The result of the forward call is
sent back in response.

Any issues communicating with the remote ApplicationMaster RPC endpoint are reported
as ERROR messages in the logs:

ERROR Sending RequestExecutors to AM was unsuccessful

RemoveExecutor

KillExecutors

AddWebUIFilter

AddWebUIFilter(
filterName: String,
filterParams: Map[String, String],
proxyBase: String)

AddWebUIFilter triggers setting spark.ui.proxyBase system property and adding the

filterName filter to web UI.

AddWebUIFilter is sent by ApplicationMaster when it adds AmIpFilter to web UI.

It firstly sets spark.ui.proxyBase system property to the input proxyBase (if not empty).

1150
YarnSchedulerEndpoint RPC Endpoint

If it defines a filter, i.e. the input filterName and filterParams are both not empty, you
should see the following INFO message in the logs:

INFO Add WebUI Filter. [filterName], [filterParams], [proxyBase]

It then sets spark.ui.filters to be the input filterName in the internal conf SparkConf
attribute.

All the filterParams are also set as spark.[filterName].param.[key] and [value] .

The filter is added to web UI using JettyUtils.addFilters(ui.getHandlers, conf) .

Caution FIXME Review JettyUtils.addFilters(ui.getHandlers, conf) .

RegisterClusterManager Message

RegisterClusterManager(am: RpcEndpointRef)

When RegisterClusterManager message arrives, the following INFO message is printed out
to the logs:

INFO YarnSchedulerBackend$YarnSchedulerEndpoint: ApplicationMaster registered as [am]

The internal reference to the remote ApplicationMaster RPC Endpoint is set (to am ).

If the internal shouldResetOnAmRegister flag is enabled, YarnSchedulerBackend is reset. It

is disabled initially, so shouldResetOnAmRegister is enabled.

shouldResetOnAmRegister controls whether to reset YarnSchedulerBackend when

Note another RegisterClusterManager RPC message arrives that could be because
the ApplicationManager failed and a new one was registered.

RetrieveLastAllocatedExecutorId
When RetrieveLastAllocatedExecutorId is received, YarnSchedulerEndpoint responds with
the current value of currentExecutorIdCounter.

It is used by YarnAllocator to initialize the internal executorIdCounter (so it

Note
gives proper identifiers for new executors when ApplicationMaster restarts)

onDisconnected Callback

1151
YarnSchedulerEndpoint RPC Endpoint

onDisconnected clears the internal reference to the remote ApplicationMaster RPC Endpoint

(i.e. it sets it to None ) if the remote address matches the reference’s.

Note It is a callback method to be called when…​FIXME

You should see the following WARN message in the logs if that happens:

WARN ApplicationMaster has disassociated: [remoteAddress]

onStop Callback
onStop shuts askAmThreadPool down immediately.

Note onStop is a callback method to be called when…​FIXME

Internal Reference to ApplicationMaster RPC Endpoint

(amEndpoint variable)
amEndpoint is a reference to a remote ApplicationMaster RPC Endpoint.

It is set to the current ApplicationMaster RPC Endpoint when RegisterClusterManager

arrives and cleared when the connection to the endpoint disconnects.

askAmThreadPool Thread Pool

askAmThreadPool is a thread pool called yarn-scheduler-ask-am-thread-pool that creates

new threads as needed and reuses previously constructed threads when they are available.

1152
YarnAllocator

YarnAllocator — YARN Resource Container

Allocator
YarnAllocator requests resources from a YARN cluster (in a form of containers from YARN

ResourceManager) and manages the container allocations by allocating them to Spark

executors and releasing them when no longer needed by a Spark application.

YarnAllocator manages resources using AMRMClient (that YarnRMClient passes in when

creating a YarnAllocator ).

Figure 1. Creating YarnAllocator

YarnAllocator is part of the internal state of ApplicationMaster (via the internal allocator

reference).

Figure 2. ApplicationMaster uses YarnAllocator (via allocator attribute)

YarnAllocator later launches Spark executors in allocated YARN resource containers.

1153
YarnAllocator

Figure 3. YarnAllocator Runs ExecutorRunnables in Allocated YARN Containers

Table 1. YarnAllocator’s Internal Registries and Counters
Name Description
The YARN Resource that sets capacity requirement (i.e.
memory and virtual cores) of a single executor.

NOTE: Resource models a set of computer resources in

the cluster. Currently both memory and virtual CPU cores
resource (vcores).
Created when YarnAllocator is created and is the sum of
executorMemory and memoryOverhead for the amount of
memory and executorCores for the number of virtual
cores.

Used to set executor id when launching Spark executors in

allocated YARN resource containers.
executorIdCounter
Set to the last allocated executor id (received through a
RPC system when YarnAllocator is created).

Current desired total number of executors (as YARN

resource containers).
Set to the initial number of executors when YarnAllocator
is created.
targetNumExecutors is eventually reached after
YarnAllocator updates YARN container allocation
targetNumExecutors
requests.
May later be changed when YarnAllocator is requested
for total number of executors given locality preferences.

Used when requesting missing resource containers and

launching Spark executors in the allocated resource
containers.

Current number of…​FIXME

Used to update YARN container allocation requests and

get the current number of executors running.
numExecutorsRunning

1154
YarnAllocator

Incremented when launching Spark executors in allocated

YARN resource containers and decremented when
releasing a resource container for a Spark executor.

currentNodeBlacklist List of…​FIXME

Unneeded containers that are of no use anymore by their

globally unique identifier ContainerId (for a Container in
the cluster).
NOTE: Hadoop YARN’s Container represents an allocated
releasedContainers
resource in the cluster. The YARN ResourceManager is
the sole authority to allocate any Container to
applications. The allocated Container is always on a
single node and has a unique ContainerId . It has a
specific amount of Resource allocated.

allocatedHostToContainersMap Lookup table

allocatedContainerToHostMap Lookup Table

pendingLossReasonRequests

releasedExecutorLossReasons

executorIdToContainer

numUnexpectedContainerRelease

containerIdToExecutorId

hostToLocalTaskCounts Lookup table

failedExecutorsTimeStamps

executorMemory

memoryOverhead

executorCores

launchContainers

labelExpression

nodeLabelConstructor

containerPlacementStrategy

launcherPool ContainerLauncher Thread Pool

1155
YarnAllocator

Number of locality-aware tasks to be used as container

placement hint when YarnAllocator is requested for
executors given locality preferences.

numLocalityAwareTasks Set to 0 when YarnAllocator is created.

Used as an input to
containerPlacementStrategy.localityOfRequestedContainers
when YarnAllocator updates YARN container allocation
requests.

Enable INFO or DEBUG logging level for

org.apache.spark.deploy.yarn.YarnAllocator logger to see what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.deploy.yarn.YarnAllocator=DEBUG

Refer to Logging.

Creating YarnAllocator Instance

YarnAllocator takes the following when created:

1. driverUrl

2. driverRef  — RpcEndpointRef to the driver’s FIXME

3. YarnConfiguration

4. sparkConf  — SparkConf

5. amClient AMRMClient for ContainerRequest

6. ApplicationAttemptId

7. SecurityManager

8. localResources  —  Map[String, LocalResource]

All the input parameters for YarnAllocator (but appAttemptId and amClient ) are passed
directly from the input parameters of YarnRMClient .

YarnAllocator sets the org.apache.hadoop.yarn.util.RackResolver logger to WARN (unless

set to some log level already).

YarnAllocator initializes the internal registries and counters.

1156
YarnAllocator

It sets the following internal counters:

numExecutorsRunning to 0

numUnexpectedContainerRelease to 0L

numLocalityAwareTasks to 0

targetNumExecutors to the initial number of executors

It creates an empty queue of failed executors.

It sets the internal executorFailuresValidityInterval to

spark.yarn.executor.failuresValidityInterval.

It sets the internal executorMemory to spark.executor.memory.

It sets the internal memoryOverhead to spark.yarn.executor.memoryOverhead. If unavailable,

it is set to the maximum of 10% of executorMemory and 384 .

It sets the internal executorCores to spark.executor.cores.

It creates the internal resource to Hadoop YARN’s Resource with both executorMemory +
memoryOverhead memory and executorCores CPU cores.

It creates the internal launcherPool called ContainerLauncher with maximum

spark.yarn.containerLauncherMaxThreads threads.

It sets the internal launchContainers to spark.yarn.launchContainers.

It sets the internal labelExpression to spark.yarn.executor.nodeLabelExpression.

It sets the internal nodeLabelConstructor to…​FIXME

Caution FIXME nodeLabelConstructor?

It sets the internal containerPlacementStrategy to…​FIXME

Caution FIXME LocalityPreferredContainerPlacementStrategy?

getNumExecutorsRunning Method

Caution FIXME

updateInternalState Method

Caution FIXME

1157
YarnAllocator

killExecutor Method

Caution FIXME

Specifying Current Total Number of Executors with Locality

Preferences 
—  requestTotalExecutorsWithPreferredLocalities
Method

requestTotalExecutorsWithPreferredLocalities(
requestedTotal: Int,
localityAwareTasks: Int,
hostToLocalTaskCount: Map[String, Int],
nodeBlacklist: Set[String]): Boolean

requestTotalExecutorsWithPreferredLocalities returns whether the current desired total

number of executors is different than the input requestedTotal .

requestTotalExecutorsWithPreferredLocalities should instead have been called

Note shouldRequestTotalExecutorsWithPreferredLocalities since it answers the
question whether to request new total executors or not.

requestTotalExecutorsWithPreferredLocalities sets the internal numLocalityAwareTasks and

hostToLocalTaskCounts attributes to the input localityAwareTasks and

hostToLocalTaskCount arguments, respectively.

If the input requestedTotal is different than the internal targetNumExecutors you should see
the following INFO message in the logs:

INFO YarnAllocator: Driver requested a total number of [requestedTotal] executor(s).

requestTotalExecutorsWithPreferredLocalities saves the input requestedTotal to be the

current desired total number of executors.

requestTotalExecutorsWithPreferredLocalities updates blacklist information to YARN

ResouceManager for this application in order to avoid allocating new Containers on the
problematic nodes.

Caution FIXME Describe the blacklisting

requestTotalExecutorsWithPreferredLocalities is executed in response to

Note
RequestExecutors message to ApplicationMaster .

1158
YarnAllocator

Adding or Removing Container Requests to Launch

Executors —  updateResourceRequests Method

updateResourceRequests(): Unit

updateResourceRequests requests new or cancels outstanding executor containers from the

YARN ResourceManager.

In YARN, you have to request containers for resources first (using

Note
AMRMClient.addContainerRequest) before calling AMRMClient.allocate.

It gets the list of outstanding YARN’s ContainerRequests (using the constructor’s

AMRMClient[ContainerRequest]) and aligns their number to current workload.

updateResourceRequests consists of two main branches:

1. missing executors, i.e. when the number of executors allocated already or pending does
not match the needs and so there are missing executors.

2. executors to cancel, i.e. when the number of pending executor allocations is positive,
but the number of all the executors is more than Spark needs.

updateResourceRequests is used when YarnAllocator requests new resource

Note
containers.

Case 1. Missing Executors

You should see the following INFO message in the logs:

INFO YarnAllocator: Will request [count] executor containers, each with [vCores] cores
and [memory] MB memory including [memoryOverhead] MB overhead

It then splits pending container allocation requests per locality preference of pending tasks
(in the internal hostToLocalTaskCounts registry).

Caution FIXME Review splitPendingAllocationsByLocality

It removes stale container allocation requests (using YARN’s

AMRMClient.removeContainerRequest).

Caution FIXME Stale?

You should see the following INFO message in the logs:

1159
YarnAllocator

INFO YarnAllocator: Canceled [cancelledContainers] container requests (locality no lon

ger needed)

It computes locality of requested containers (based on the internal numLocalityAwareTasks,

hostToLocalTaskCounts and allocatedHostToContainersMap lookup table).

FIXME Review containerPlacementStrategy.localityOfRequestedContainers +

Caution
the code that follows.

For any new container needed updateResourceRequests adds a container request (using
YARN’s AMRMClient.addContainerRequest).

You should see the following INFO message in the logs:

INFO YarnAllocator: Submitted container request (host: [host], capability: [resource])

Case 2. Cancelling Pending Executor Allocations

When there are executors to cancel (case 2.), you should see the following INFO message
in the logs:

INFO Canceling requests for [numToCancel] executor container(s) to have a new desired
total [targetNumExecutors] executors.

It checks whether there are pending allocation requests and removes the excess (using
YARN’s AMRMClient.removeContainerRequest). If there are no pending allocation requests,
you should see the WARN message in the logs:

WARN Expected to find pending requests, but found none.

Handling Allocated Containers for Executors 

—  handleAllocatedContainers Internal Method

handleAllocatedContainers(allocatedContainers: Seq[Container]): Unit

handleAllocatedContainers handles allocated YARN containers, i.e. runs Spark executors

on matched containers or releases unneeded containers.

A YARN Container represents an allocated resource in the cluster. The

Note allocated Container is always on a single node and has a unique
ContainerId . It has a specific amount of Resource allocated.

1160
YarnAllocator

Internally, handleAllocatedContainers matches requests to host, rack, and any host (a

container allocation).

If handleAllocatedContainers did not manage to allocate some containers, you should see
the following DEBUG message in the logs:

DEBUG Releasing [size] unneeded containers that were allocated to us

handleAllocatedContainers releases the unneeded containers (if there are any).

handleAllocatedContainers runs the allocated and matched containers.

You should see the following INFO message in the logs:

INFO Received [allocatedContainersSize] containers from YARN, launching executors on [

containersToUseSize] of them.

handleAllocatedContainers is used exclusively when YarnAllocator allocates

Note
YARN resource containers for Spark executors.

Running ExecutorRunnables (with

CoarseGrainedExecutorBackends) in Allocated YARN
Resource Containers —  runAllocatedContainers
Internal Method

runAllocatedContainers(containersToUse: ArrayBuffer[Container]): Unit

runAllocatedContainers traverses the YARN Container collection (as the input

containersToUse ) and schedules execution of ExecutorRunnables per YARN container on

ContainerLauncher thread pool.

Figure 4. YarnAllocator Runs ExecutorRunnables in Allocated YARN Containers

A Container in YARN represents allocated resources (memory and cores) in the
Note
cluster.

1161
YarnAllocator

Internally, runAllocatedContainers increments executorIdCounter internal counter.

runAllocatedContainers asserts that the amount of memory of a container not

Note
less than the requested memory for executors. And only memory!

You should see the following INFO message in the logs:

INFO YarnAllocator: Launching container [containerId] for on host [executorHostname]

runAllocatedContainers checks if the number of executors running is less than the number

of required executors.

If there are executors still missing (and runAllocatedContainers is not in testing mode),
runAllocatedContainers schedules execution of a ExecutorRunnable on ContainerLauncher

thread pool and updates internal state. When executing a ExecutorRunnable

runAllocatedContainers first creates a ExecutorRunnable and starts it.

When runAllocatedContainers catches a non-fatal exception and you should see the
following ERROR message in the logs and immediately releases the container (using the
internal AMRMClient).

ERROR Failed to launch executor [executorId] on container [containerId]

If YarnAllocator has reached target number of executors, you should see the following
INFO message in the logs:

INFO Skip launching executorRunnable as running Executors count: [numExecutorsRunning]

reached target Executors count: [targetNumExecutors].

runAllocatedContainers is used exclusively when YarnAllocator handles

Note
allocated YARN containers.

Releasing YARN Container —  internalReleaseContainer

Internal Procedure
All unnecessary YARN containers (that were allocated but are either of no use or no longer
needed) are released using the internal internalReleaseContainer procedure.

internalReleaseContainer(container: Container): Unit

1162
YarnAllocator

internalReleaseContainer records container in the internal releasedContainers registry

and releases it to the YARN ResourceManager (calling

AMRMClient[ContainerRequest].releaseAssignedContainer using the internal amClient ).

Deciding on Use of YARN Container 

—  matchContainerToRequest Internal Method
When handleAllocatedContainers handles allocated containers for executors, it uses
matchContainerToRequest to match the containers to ContainerRequests (and hence to

workload and location preferences).

matchContainerToRequest(
allocatedContainer: Container,
location: String,
containersToUse: ArrayBuffer[Container],
remaining: ArrayBuffer[Container]): Unit

matchContainerToRequest puts allocatedContainer in containersToUse or remaining

collections per available outstanding ContainerRequests that match the priority of the input
allocatedContainer , the input location , and the memory and vcore capabilities for Spark

executors.

Note The input location can be host, rack, or * (star), i.e. any host.

It gets the outstanding ContainerRequests (from the YARN ResourceManager).

If there are any outstanding ContainerRequests that meet the requirements, it simply takes
the first one and puts it in the input containersToUse collection. It also removes the
ContainerRequest so it is not submitted again (it uses the internal

AMRMClient[ContainerRequest] ).

Otherwise, it puts the input allocatedContainer in the input remaining collection.

processCompletedContainers Method

processCompletedContainers(completedContainers: Seq[ContainerStatus]): Unit

processCompletedContainers accepts a collection of YARN’s ContainerStatus'es.

1163
YarnAllocator

ContainerStatus represents the current status of a YARN Container and

provides details such as:

Id
Note State
Exit status of a completed container.

Diagnostic message for a failed container.

For each completed container in the collection, processCompletedContainers removes it from

the internal releasedContainers registry.

It looks the host of the container up (in the internal allocatedContainerToHostMap lookup
table). The host may or may not exist in the lookup table.

Caution FIXME The host may or may not exist in the lookup table?

The ExecutorExited exit reason is computed.

When the host of the completed container has been found, the internal
numExecutorsRunning counter is decremented.

You should see the following INFO message in the logs:

INFO Completed container [containerId] [host] (state: [containerState], exit status: [

containerExitStatus])

For ContainerExitStatus.SUCCESS and ContainerExitStatus.PREEMPTED exit statuses of the

container (which are not considered application failures), you should see one of the two
possible INFO messages in the logs:

INFO Executor for container [id] exited because of a YARN event (e.g., pre-emption) an
d not because of an error in the running job.

INFO Container [id] [host] was preempted.

Other exit statuses of the container are considered application failures and reported as a
WARN message in the logs:

WARN Container killed by YARN for exceeding memory limits. [diagnostics] Consider boos
ting spark.yarn.executor.memoryOverhead.

1164
YarnAllocator

or

WARN Container marked as failed: [id] [host]. Exit status: [containerExitStatus]. Diag
nostics: [containerDiagnostics]

The host is looked up in the internal allocatedHostToContainersMap lookup table. If found,

the container is removed from the containers registered for the host or the host itself is
removed from the lookup table when this container was the last on the host.

The container is removed from the internal allocatedContainerToHostMap lookup table.

The container is removed from the internal containerIdToExecutorId translation table. If an

executor is found, it is removed from the internal executorIdToContainer translation table.

If the executor was recorded in the internal pendingLossReasonRequests lookup table, the
exit reason (as calculated earlier as ExecutorExited ) is sent back for every pending RPC
message recorded.

If no executor was found, the executor and the exit reason are recorded in the internal
releasedExecutorLossReasons lookup table.

In case the container was not in the internal releasedContainers registry, the internal
numUnexpectedContainerRelease counter is increased and a RemoveExecutor RPC
message is sent to the driver (as specified when YarnAllocator was created) to notify about
the failure of the executor.

Requesting and Allocating YARN Resource Containers to

Spark Executors (and Cancelling Outstanding Containers) 
—  allocateResources Method

allocateResources(): Unit

allocateResources claims new resource containers from YARN ResourceManager and

cancels any outstanding resource container requests.

In YARN, you first have to submit requests for YARN resource containers to
Note YARN ResourceManager (using AMRMClient.addContainerRequest) before
claiming them by calling AMRMClient.allocate.

Internally, allocateResources submits requests for new containers and cancels previous
container requests.

allocateResources then claims the containers (using the internal reference to YARN’s

AMRMClient) with progress indicator of 0.1f .

1165
YarnAllocator

You can see the exact moment in the YARN console for the Spark application with the
progress bar at 10%.

Figure 5. YARN Console after Allocating YARN Containers (Progress at 10%)

allocateResources gets the list of allocated containers from the YARN ResourceManager.

If the number of allocated containers is greater than 0 , you should see the following
DEBUG message in the logs (in stderr on YARN):

DEBUG YarnAllocator: Allocated containers: [allocatedContainersSize]. Current executor

count: [numExecutorsRunning]. Cluster resources: [availableResources].

allocateResources launches executors on the allocated YARN resource containers.

allocateResources gets the list of completed containers' statuses from YARN

ResourceManager.

If the number of completed containers is greater than 0 , you should see the following
DEBUG message in the logs (in stderr on YARN):

DEBUG YarnAllocator: Completed [completedContainersSize] containers

allocateResources processes completed containers.

You should see the following DEBUG message in the logs (in stderr on YARN):

DEBUG YarnAllocator: Finished processing [completedContainersSize] completed container

s. Current running executor count: [numExecutorsRunning].

allocateResources is used when ApplicationMaster is registered to the YARN

Note
ResourceManager and launches progress Reporter thread.

1166
Introduction to Hadoop YARN

Introduction to Hadoop YARN

Apache Hadoop 2.0 introduced a framework for job scheduling and cluster resource
management and negotiation called Hadoop YARN (Yet Another Resource Negotiator).

YARN is a general-purpose application scheduling framework for distributed applications

that was initially aimed at improving MapReduce job management but quickly turned itself
into supporting non-MapReduce applications equally, like Spark on YARN.

YARN comes with two components — ResourceManager and NodeManager — running on

their own machines.

ResourceManager is the master daemon that communicates with YARN clients, tracks
resources on the cluster (on NodeManagers), and orchestrates work by assigning tasks
to NodeManagers. It coordinates work of ApplicationMasters and NodeManagers.

NodeManager is a worker process that offers resources (memory and CPUs) as

resource containers. It launches and tracks processes spawned on them.

Containers run tasks, including ApplicationMasters. YARN offers container allocation.

YARN currently defines two resources: vcores and memory. vcore is a usage share of a
CPU core.

YARN ResourceManager keeps track of the cluster’s resources while NodeManagers tracks
the local host’s resources.

It can optionally work with two other components:

History Server for job history

Proxy Server for viewing application status and logs from outside the cluster.

YARN ResourceManager accepts application submissions, schedules them, and tracks their
status (through ApplicationMasters). A YARN NodeManager registers with the
ResourceManager and provides its local CPUs and memory for resource negotiation.

In a real YARN cluster, there are one ResourceManager (two for High Availability) and
multiple NodeManagers.

YARN ResourceManager
YARN ResourceManager manages the global assignment of compute resources to
applications, e.g. memory, cpu, disk, network, etc.

1167
Introduction to Hadoop YARN

YARN NodeManager
Each NodeManager tracks its own local resources and communicates its resource
configuration to the ResourceManager, which keeps a running total of the cluster’s
available resources.

By keeping track of the total, the ResourceManager knows how to allocate

resources as they are requested.

YARN ApplicationMaster
YARN ResourceManager manages the global assignment of compute resources to
applications, e.g. memory, cpu, disk, network, etc.

An application is a YARN client program that is made up of one or more tasks.

For each running application, a special piece of code called an ApplicationMaster helps
coordinate tasks on the YARN cluster. The ApplicationMaster is the first process run
after the application starts.

An application in YARN comprises three parts:

The application client, which is how a program is run on the cluster.

An ApplicationMaster which provides YARN with the ability to perform allocation on

behalf of the application.

One or more tasks that do the actual work (runs in a process) in the container
allocated by YARN.

An application running tasks on a YARN cluster consists of the following steps:

The application starts and talks to the ResourceManager (running on the master)
for the cluster.

The ResourceManager makes a single container request on behalf of the

application.

The ApplicationMaster starts running within that container.

The ApplicationMaster requests subsequent containers from the ResourceManager

that are allocated to run tasks for the application. Those tasks do most of the status
communication with the ApplicationMaster.

Once all tasks are finished, the ApplicationMaster exits. The last container is de-
allocated from the cluster.

1168
Introduction to Hadoop YARN

The application client exits. (The ApplicationMaster launched in a container is more

specifically called a managed AM).

The ResourceManager, NodeManager, and ApplicationMaster work together to manage

the cluster’s resources and ensure that the tasks, as well as the corresponding
application, finish cleanly.

YARN’s Model of Computation (aka YARN components)

ApplicationMaster is a lightweight process that coordinates the execution of tasks of an
application and asks the ResourceManager for resource containers for tasks.

It monitors tasks, restarts failed ones, etc. It can run any type of tasks, be them MapReduce
tasks or Spark tasks.

An ApplicationMaster is like a queen bee that starts creating worker bees (in their own
containers) in the YARN cluster.

Others
A host is the Hadoop term for a computer (also called a node, in YARN terminology).

A cluster is two or more hosts connected by a high-speed local network.

It can technically also be a single host used for debugging and simple testing.

Master hosts are a small number of hosts reserved to control the rest of the cluster.
Worker hosts are the non-master hosts in the cluster.

A master host is the communication point for a client program. A master host sends
the work to the rest of the cluster, which consists of worker hosts.

The YARN configuration file is an XML file that contains properties. This file is placed in
a well-known location on each host in the cluster and is used to configure the
ResourceManager and NodeManager. By default, this file is named yarn-site.xml .

A container in YARN holds resources on the YARN cluster.

A container hold request consists of vcore and memory.

Once a hold has been granted on a host, the NodeManager launches a process called
a task.

Distributed Cache for application jar files.

Preemption (for high-priority applications)

1169
Introduction to Hadoop YARN

Queues and nested queues

User authentication via Kerberos

Hadoop YARN
YARN could be considered a cornerstone of Hadoop OS (operating system) for big
distributed data with HDFS as the storage along with YARN as a process scheduler.

YARN is essentially a container system and scheduler designed primarily for use with a
Hadoop-based cluster.

The containers in YARN are capable of running various types of tasks.

Resource manager, node manager, container, application master, jobs

focused on data storage and offline batch analysis

Hadoop is storage and compute platform:

MapReduce is the computing part.

HDFS is the storage.

Hadoop is a resource and cluster manager (YARN)

Spark runs on YARN clusters, and can read from and save data to HDFS.

leverages data locality

Spark needs distributed file system and HDFS (or Amazon S3, but slower) is a great
choice.

HDFS allows for data locality.

Excellent throughput when Spark and Hadoop are both distributed and co-located on
the same (YARN or Mesos) cluster nodes.

HDFS offers (important for initial loading of data):

high data locality

high throughput when co-located with Spark

low latency because of data locality

very reliable because of replication

When reading data from HDFS, each InputSplit maps to exactly one Spark partition.

1170
Introduction to Hadoop YARN

HDFS is distributing files on data-nodes and storing a file on the filesystem, it will be
split into partitions.

ContainerExecutors
LinuxContainerExecutor and Docker

WindowsContainerExecutor

LinuxContainerExecutor and Docker

YARN-3611 Support Docker Containers In LinuxContainerExecutor is an umbrella JIRA
issue for Hadoop YARN to support Docker natively.

Further reading or watching

Introduction to YARN

Untangling Apache Hadoop YARN, Part 1

Quick Hadoop Startup in a Virtual Environment

(video) HUG Meetup Apr 2016: The latest of Apache Hadoop YARN and running your
docker apps on YARN

1171
Setting up YARN Cluster

Setting up YARN Cluster

YARN uses the following environment variables:

YARN_CONF_DIR

HADOOP_CONF_DIR

HADOOP_HOME

1172
Kerberos

Kerberos
Microsoft incorporated Kerberos authentication into Windows 2000

Two open source Kerberos implementations exist: the MIT reference implementation
and the Heimdal Kerberos implementation.

YARN supports user authentication via Kerberos (so do the other services: HDFS, HBase,
Hive).

Service Delegation Tokens

Caution FIXME

Further reading or watching

(video training) Introduction to Hadoop Security

Hadoop Security

Kerberos: The Definitive Guide

1173
ConfigurableCredentialManager

ConfigurableCredentialManager
Caution FIXME

Creating ConfigurableCredentialManager Instance

Caution FIXME

credentialRenewer Method

Caution FIXME

Obtaining Security Tokens from Credential Providers 

—  obtainCredentials Method

Caution FIXME

1174
ClientDistributedCacheManager

ClientDistributedCacheManager
ClientDistributedCacheManager is a mere wrapper to hold the collection of cache-related

resource entries CacheEntry (as distCacheEntries ) to add resources to and later update
Spark configuration with files to distribute.

Caution FIXME What is a resource? Is this a file only?

Adding Cache-Related Resource (addResource method)

addResource(
fs: FileSystem,
conf: Configuration,
destPath: Path,
localResources: HashMap[String, LocalResource],
resourceType: LocalResourceType,
link: String,
statCache: Map[URI, FileStatus],
appMasterOnly: Boolean = false): Unit

Updating Spark Configuration with Resources to Distribute

(updateConfiguration method)

updateConfiguration(conf: SparkConf): Unit

updateConfiguration sets the following internal Spark configuration settings in the input

conf Spark configuration:

spark.yarn.cache.filenames

spark.yarn.cache.sizes

spark.yarn.cache.timestamps

spark.yarn.cache.visibilities

spark.yarn.cache.types

It uses the internal distCacheEntries with resources to distribute.

Note It is later used in ApplicationMaster when it prepares local resources.

1175
ClientDistributedCacheManager

1176
YarnSparkHadoopUtil

YarnSparkHadoopUtil
YarnSparkHadoopUtil is…​FIXME

YarnSparkHadoopUtil can only be created when SPARK_YARN_MODE flag is enabled.

Note YarnSparkHadoopUtil belongs to org.apache.spark.deploy.yarn package.

Enable DEBUG logging level for

org.apache.spark.deploy.yarn.YarnSparkHadoopUtil logger to see what happens
inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.yarn.YarnSparkHadoopUtil=DEBUG

Refer to Logging.

startCredentialUpdater Method

Caution FIXME

Getting YarnSparkHadoopUtil Instance —  get Method

Caution FIXME

addPathToEnvironment Method

addPathToEnvironment(env: HashMap[String, String], key: String, value: String): Unit

Caution FIXME

startExecutorDelegationTokenRenewer

Caution FIXME

stopExecutorDelegationTokenRenewer

1177
YarnSparkHadoopUtil

Caution FIXME

getApplicationAclsForYarn Method

Caution FIXME

MEMORY_OVERHEAD_FACTOR
MEMORY_OVERHEAD_FACTOR is a constant that equals to 10% for memory overhead.

MEMORY_OVERHEAD_MIN
MEMORY_OVERHEAD_MIN is a constant that equals to 384L for memory overhead.

Resolving Environment Variable —  expandEnvironment

Method

expandEnvironment(environment: Environment): String

expandEnvironment resolves environment variable using YARN’s Environment.$ or

Environment.$$ methods (depending on the version of Hadoop used).

Computing YARN’s ContainerId —  getContainerId

Method

getContainerId: ContainerId

getContainerId is a private[spark] method that gets YARN’s ContainerId from the YARN

environment variable ApplicationConstants.Environment.CONTAINER_ID and converts it to the

return object using YARN’s ConverterUtils.toContainerId .

Calculating Initial Number of Executors 

—  getInitialTargetExecutorNumber Method

getInitialTargetExecutorNumber(conf: SparkConf, numExecutors: Int = 2): Int

getInitialTargetExecutorNumber calculates the initial number of executors for Spark on

YARN. It varies by whether dynamic allocation is enabled or not.

1178
YarnSparkHadoopUtil

Note The default number of executors (aka DEFAULT_NUMBER_EXECUTORS ) is 2 .

With dynamic allocation enabled, getInitialTargetExecutorNumber is

spark.dynamicAllocation.initialExecutors or spark.dynamicAllocation.minExecutors to fall
back to 0 if the others are undefined.

With dynamic allocation disabled, getInitialTargetExecutorNumber is the value of

spark.executor.instances property or SPARK_EXECUTOR_INSTANCES environment variable, or the
default value (of the input parameter numExecutors ) 2 .

getInitialTargetExecutorNumber is used to calculate totalExpectedExecutors to

Note
start Spark on YARN in client or cluster modes.

1179
Settings

Settings
The following settings (aka system properties) are specific to Spark on YARN.

Spark Property Default Value Description

Port that
ApplicationMaster
spark.yarn.am.port 0 uses to create the
sparkYarnAM RPC
environment.

spark.yarn.am.waitTime 100s
In milliseconds unless
the unit is specified.

spark.yarn.app.id

(in MiBs) is an optional

setting for the executor
memory overhead (in
addition to
10% of spark.executor.memory
spark.yarn.executor.memoryOverhead spark.executor.memory when requesting YARN
but not less than 384 resource containers
from a YARN cluster.
Used when Client
calculates memory
overhead for executors

spark.yarn.credentials.renewalTime
spark.yarn.credentials.renewalTime (default: Long.MaxValue ms) is an internal setting for

the time of the next credentials renewal.

See prepareLocalResources.

spark.yarn.credentials.updateTime
spark.yarn.credentials.updateTime (default: Long.MaxValue ms) is an internal setting for the

time of the next credentials update.

spark.yarn.rolledLog.includePattern
spark.yarn.rolledLog.includePattern

1180
Settings

spark.yarn.rolledLog.excludePattern
spark.yarn.rolledLog.excludePattern

spark.yarn.am.nodeLabelExpression
spark.yarn.am.nodeLabelExpression

spark.yarn.am.attemptFailuresValidityInterval
spark.yarn.am.attemptFailuresValidityInterval

spark.yarn.tags
spark.yarn.tags

spark.yarn.am.extraLibraryPath
spark.yarn.am.extraLibraryPath

spark.yarn.am.extraJavaOptions
spark.yarn.am.extraJavaOptions

spark.yarn.scheduler.initial-allocation.interval
spark.yarn.scheduler.initial-allocation.interval (default: 200ms ) controls the initial

allocation interval.

It is used when ApplicationMaster is instantiated.

spark.yarn.scheduler.heartbeat.interval-ms
spark.yarn.scheduler.heartbeat.interval-ms (default: 3s ) is the heartbeat interval to YARN

ResourceManager.

It is used when ApplicationMaster is instantiated.

spark.yarn.max.executor.failures
spark.yarn.max.executor.failures is an optional setting that sets the maximum number of

executor failures before…​TK

It is used when ApplicationMaster is instantiated.

1181
Settings

Caution FIXME

spark.yarn.maxAppAttempts
spark.yarn.maxAppAttempts is the maximum number of attempts to register

ApplicationMaster before deploying a Spark application to YARN is deemed failed.

It is used when YarnRMClient computes getMaxRegAttempts .

spark.yarn.user.classpath.first
Caution FIXME

spark.yarn.archive
spark.yarn.archive is the location of the archive containing jars files with Spark classes. It

cannot be a local: URI.

It is used to populate CLASSPATH for ApplicationMaster and executors.

spark.yarn.queue
spark.yarn.queue (default: default ) is the name of the YARN resource queue that Client

uses to submit a Spark application to.

You can specify the value using spark-submit’s --queue command-line argument.

The value is used to set YARN’s ApplicationSubmissionContext.setQueue.

spark.yarn.jars
spark.yarn.jars is the location of the Spark jars.

--conf spark.yarn.jar=hdfs://master:8020/spark/spark-assembly-2.0.0-hadoop2.7.2.jar

It is used to populate the CLASSPATH for ApplicationMaster and ExecutorRunnables

(when spark.yarn.archive is not defined).

Note spark.yarn.jar setting is deprecated as of Spark 2.0.

spark.yarn.report.interval

1182
Settings

spark.yarn.report.interval (default: 1s ) is the interval (in milliseconds) between reports

of the current application status.

It is used in Client.monitorApplication.

spark.yarn.dist.jars
spark.yarn.dist.jars (default: empty) is a collection of additional jars to distribute.

It is used when Client distributes additional resources as specified using --jars command-
line option for spark-submit.

spark.yarn.dist.files
spark.yarn.dist.files (default: empty) is a collection of additional files to distribute.

It is used when Client distributes additional resources as specified using --files

command-line option for spark-submit.

spark.yarn.dist.archives
spark.yarn.dist.archives (default: empty) is a collection of additional archives to distribute.

It is used when Client distributes additional resources as specified using --archives

command-line option for spark-submit.

spark.yarn.principal
spark.yarn.principal  — See the corresponding --principal command-line option for spark-

submit.

spark.yarn.keytab
spark.yarn.keytab  — See the corresponding --keytab command-line option for spark-

submit.

spark.yarn.submit.file.replication
spark.yarn.submit.file.replication is the replication factor (number) for files uploaded by

Spark to HDFS.

spark.yarn.config.gatewayPath

1183
Settings

spark.yarn.config.gatewayPath (default: null ) is the root of configuration paths that is

present on gateway nodes, and will be replaced with the corresponding path in cluster
machines.

It is used when Client resolves a path to be YARN NodeManager-aware.

spark.yarn.config.replacementPath
spark.yarn.config.replacementPath (default: null ) is the path to use as a replacement for

spark.yarn.config.gatewayPath when launching processes in the YARN cluster.

It is used when Client resolves a path to be YARN NodeManager-aware.

spark.yarn.historyServer.address
spark.yarn.historyServer.address is the optional address of the History Server.

spark.yarn.access.namenodes
spark.yarn.access.namenodes (default: empty) is a list of extra NameNode URLs for which to

request delegation tokens. The NameNode that hosts fs.defaultFS does not need to be
listed here.

spark.yarn.cache.types
spark.yarn.cache.types is an internal setting…​

spark.yarn.cache.visibilities
spark.yarn.cache.visibilities is an internal setting…​

spark.yarn.cache.timestamps
spark.yarn.cache.timestamps is an internal setting…​

spark.yarn.cache.filenames
spark.yarn.cache.filenames is an internal setting…​

spark.yarn.cache.sizes
spark.yarn.cache.sizes is an internal setting…​

1184
Settings

spark.yarn.cache.confArchive
spark.yarn.cache.confArchive is an internal setting…​

spark.yarn.secondary.jars
spark.yarn.secondary.jars is…​

spark.yarn.executor.nodeLabelExpression
spark.yarn.executor.nodeLabelExpression is a node label expression for executors.

spark.yarn.containerLauncherMaxThreads
spark.yarn.containerLauncherMaxThreads (default: 25 )…​FIXME

spark.yarn.executor.failuresValidityInterval
spark.yarn.executor.failuresValidityInterval (default: -1L ) is an interval (in milliseconds)

after which Executor failures will be considered independent and not accumulate towards
the attempt count.

spark.yarn.submit.waitAppCompletion
spark.yarn.submit.waitAppCompletion (default: true ) is a flag to control whether to wait for

the application to finish before exiting the launcher process in cluster mode.

spark.yarn.am.cores
spark.yarn.am.cores (default: 1 ) sets the number of CPU cores for ApplicationMaster’s

JVM.

spark.yarn.driver.memoryOverhead
spark.yarn.driver.memoryOverhead (in MiBs)

spark.yarn.am.memoryOverhead
spark.yarn.am.memoryOverhead (in MiBs)

spark.yarn.am.memory

1185
Settings

spark.yarn.am.memory (default: 512m ) sets the memory size of ApplicationMaster’s JVM (in

MiBs)

spark.yarn.stagingDir
spark.yarn.stagingDir is a staging directory used while submitting applications.

spark.yarn.preserve.staging.files
spark.yarn.preserve.staging.files (default: false ) controls whether to preserve

temporary files in a staging directory (as pointed by spark.yarn.stagingDir).

spark.yarn.credentials.file
spark.yarn.credentials.file …​

spark.yarn.launchContainers
spark.yarn.launchContainers (default: true ) is a flag used for testing only so

YarnAllocator does not run launch ExecutorRunnables on allocated YARN containers.

1186
Spark Standalone

Spark Standalone cluster

Spark Standalone cluster (aka Spark deploy cluster or standalone cluster) is Spark’s own
built-in cluster environment. Since Spark Standalone is available in the default distribution of
Apache Spark it is the easiest way to run your Spark applications in a clustered environment
in many cases.

Standalone Master (often written standalone Master) is the resource manager for the Spark
Standalone cluster (read Standalone Master for in-depth coverage).

Standalone Worker (aka standalone slave) is the worker in the Spark Standalone cluster
(read Standalone Worker for in-depth coverage).

Spark Standalone cluster is one of the three available clustering options in

Note
Spark (refer to Running Spark on cluster).

FIXME A figure with SparkDeploySchedulerBackend sending messages to

AppClient and AppClient RPC Endpoint and later to Master.

Caution SparkDeploySchedulerBackend -→ AppClient -→ AppClient RPC Endpoint -

→ Master
Add SparkDeploySchedulerBackend as AppClientListener in the picture

In Standalone cluster mode Spark allocates resources based on cores. By default, an

application will grab all the cores in the cluster (read Settings).

Standalone cluster mode is subject to the constraint that only one executor can be allocated
on each worker per application.

Once a Spark Standalone cluster has been started, you can access it using spark://
master URL (read Master URLs).

Caution FIXME That might be very confusing!

You can deploy, i.e. spark-submit , your applications to Spark Standalone in client or
cluster deploy mode (read Deployment modes).

Deployment modes
Caution FIXME

Refer to --deploy-mode in spark-submit script.

1187
Spark Standalone

SparkContext initialization in Standalone cluster

When you create a SparkContext using spark:// master URL…​FIXME

Keeps track of task ids and executor ids, executors per host, hosts per rack

You can give one or many comma-separated masters URLs in spark:// URL.

A pair of backend and scheduler is returned.

The result is two have a pair of a backend and a scheduler.

Application Management using spark-submit

Caution FIXME

➜ spark git:(master) ✗ ./bin/spark-submit --help

...
Usage: spark-submit --kill [submission ID] --master [spark://...]
Usage: spark-submit --status [submission ID] --master [spark://...]
...

Refer to Command-line Options in spark-submit .

Round-robin Scheduling Across Nodes

If enabled (using spark.deploy.spreadOut), standalone Master attempts to spread out an
application’s executors on as many workers as possible (instead of trying to consolidate it
onto a small number of nodes).

Note It is enabled by default.

scheduleExecutorsOnWorkers

Caution FIXME

scheduleExecutorsOnWorkers(
app: ApplicationInfo,
usableWorkers: Array[WorkerInfo],
spreadOutApps: Boolean): Array[Int]

scheduleExecutorsOnWorkers schedules executors on workers.

1188
Spark Standalone

SPARK_WORKER_INSTANCES (and
SPARK_WORKER_CORES)
There is really no need to run multiple workers per machine in Spark 1.5 (perhaps in 1.4,
too). You can run multiple executors on the same machine with one worker.

Use SPARK_WORKER_INSTANCES (default: 1 ) in spark-env.sh to define the number of worker

instances.

If you use SPARK_WORKER_INSTANCES , make sure to set SPARK_WORKER_CORES explicitly to limit

the cores per worker, or else each worker will try to use all the cores.

You can set up the number of cores as an command line argument when you start a worker
daemon using --cores .

Multiple executors per worker in Standalone mode

Caution It can be a duplicate of the above section.

Since the change SPARK-1706 Allow multiple executors per worker in Standalone mode in
Spark 1.4 it’s currently possible to start multiple executors in a single JVM process of a
worker.

To launch multiple executors on a machine you start multiple standalone workers, each with
its own JVM. It introduces unnecessary overhead due to these JVM processes, provided
that there are enough cores on that worker.

If you are running Spark in standalone mode on memory-rich nodes it can be beneficial to
have multiple worker instances on the same node as a very large heap size has two
disadvantages:

Garbage collector pauses can hurt throughput of Spark jobs.

Heap size of >32 GB can’t use CompressedOoops. So 35 GB is actually less than 32

GB.

Mesos and YARN can, out of the box, support packing multiple, smaller executors onto the
same physical host, so requesting smaller executors doesn’t mean your application will have
fewer overall resources.

SparkDeploySchedulerBackend
SparkDeploySchedulerBackend is the Scheduler Backend for Spark Standalone, i.e. it is used

when you create a SparkContext using spark:// master URL.

1189
Spark Standalone

It requires a Task Scheduler, a Spark context, and a collection of master URLs.

It is a specialized CoarseGrainedSchedulerBackend that uses AppClient and is a

AppClientListener .

Figure 1. SparkDeploySchedulerBackend.start() (while SparkContext starts)

Caution FIXME AppClientListener & LauncherBackend & ApplicationDescription

It uses AppClient to talk to executors.

AppClient
AppClient is an interface to allow Spark applications to talk to a Standalone cluster (using a

RPC Environment). It takes an RPC Environment, a collection of master URLs, a

ApplicationDescription , and a AppClientListener .

It is solely used by SparkDeploySchedulerBackend.

AppClient registers AppClient RPC endpoint (using ClientEndpoint class) to a given RPC

Environment.

AppClient uses a daemon cached thread pool ( askAndReplyThreadPool ) with threads' name

in the format of appclient-receive-and-reply-threadpool-ID , where ID is a unique integer

for asynchronous asks and replies. It is used for requesting executors (via
RequestExecutors message) and kill executors (via KillExecutors ).

sendToMaster sends one-way ExecutorStateChanged and UnregisterApplication messages

to master.

Initialization - AppClient.start() method

1190
Spark Standalone

When AppClient starts, AppClient.start() method is called that merely registers AppClient
RPC Endpoint.

Others
killExecutors

start

stop

AppClient RPC Endpoint

AppClient RPC endpoint is started as part of AppClient’s initialization (that is in turn part of
SparkDeploySchedulerBackend’s initialization, i.e. the scheduler backend for Spark
Standalone).

It is a ThreadSafeRpcEndpoint that knows about the RPC endpoint of the primary active
standalone Master (there can be a couple of them, but only one can be active and hence
primary).

When it starts, it sends RegisterApplication message to register an application and itself.

RegisterApplication RPC message

An AppClient registers the Spark application to a single master (regardless of the number of
the standalone masters given in the master URL).

Figure 2. AppClient registers application to standalone Master

It uses a dedicated thread pool appclient-register-master-threadpool to asynchronously
send RegisterApplication messages, one per standalone master.

INFO AppClient$ClientEndpoint: Connecting to master spark://localhost:7077...

1191
Spark Standalone

An AppClient tries connecting to a standalone master 3 times every 20 seconds per master
before giving up. They are not configurable parameters.

The appclient-register-master-threadpool thread pool is used until the registration is finished,

i.e. AppClient is connected to the primary standalone Master or the registration fails. It is
then shutdown .

RegisteredApplication RPC message

RegisteredApplication is a one-way message from the primary master to confirm

successful application registration. It comes with the application id and the master’s RPC
endpoint reference.

The AppClientListener gets notified about the event via listener.connected(appId) with
appId being an application id.

ApplicationRemoved RPC message

ApplicationRemoved is received from the primary master to inform about having removed the

application. AppClient RPC endpoint is stopped afterwards.

It can come from the standalone Master after a kill request from Web UI, application has
finished properly or the executor where the application was still running on has been killed,
failed, lost or exited.

ExecutorAdded RPC message

ExecutorAdded is received from the primary master to inform about…​FIXME

Caution FIXME the message

INFO Executor added: %s on %s (%s) with %d cores

ExecutorUpdated RPC message

ExecutorUpdated is received from the primary master to inform about…​FIXME

Caution FIXME the message

INFO Executor updated: %s is now %s%s

MasterChanged RPC message

MasterChanged is received from the primary master to inform about…​FIXME

1192
Spark Standalone

Caution FIXME the message

INFO Master has changed, new master is at

StopAppClient RPC message

StopAppClient is a reply-response message from the SparkDeploySchedulerBackend to

stop the AppClient after the SparkContext has been stopped (and so should the running
application on the standalone cluster).

It stops the AppClient RPC endpoint.

RequestExecutors RPC message

RequestExecutors is a reply-response message from the SparkDeploySchedulerBackend

that is passed on to the master to request executors for the application.

KillExecutors RPC message

KillExecutors is a reply-response message from the SparkDeploySchedulerBackend that

is passed on to the master to kill executors assigned to the application.

Settings

spark.deploy.spreadOut
spark.deploy.spreadOut (default: true ) controls whether standalone Master should

perform round-robin scheduling across the nodes.

1193
Standalone Master — Cluster Manager of Spark Standalone

Standalone Master — Cluster Manager of Spark

Standalone
Master (Standalone Master or standalone Master) is the cluster manager (the master) of

a Spark Standalone cluster.

Master is created exclusively when requested to startRpcEnvAndEndpoint (which is when

Master standalone application is launched or LocalSparkCluster is requested to start ).

A standalone Master is pretty much the Master RPC Endpoint that you can access using
RPC port (low-level operation communication) or Web UI.

Application ids follows the pattern app-yyyyMMddHHmmss .

Master keeps track of the following:

workers ( workers )

mapping between ids and applications ( idToApp )

waiting applications ( waitingApps )

applications ( apps )

mapping between ids and workers ( idToWorker )

mapping between RPC address and workers ( addressToWorker )

endpointToApp

addressToApp

completedApps

nextAppNumber

mapping between application ids and their Web UIs ( appIdToUI )

drivers ( drivers )

completedDrivers

drivers currently spooled for scheduling ( waitingDrivers )

nextDriverNumber

The following INFO shows up when the Master endpoint starts up ( Master#onStart is
called):

1194
Standalone Master — Cluster Manager of Spark Standalone

INFO Master: Starting Spark master at spark://japila.local:7077

INFO Master: Running Spark version 1.6.0-SNAPSHOT

Master can be started and stopped using custom management scripts for standalone

Master.

Table 1. Master’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
FIXME
forwardMessageThread
Used when…​FIXME

FIXME
hadoopConf
Used when…​FIXME

Master WebUI
FIXME MasterWebUI

MasterWebUI is the Web UI server for the standalone master. Master starts Web UI to listen

to http://[master’s hostname]:webUIPort , e.g. http://localhost:8080 .

INFO Utils: Successfully started service 'MasterUI' on port 8080.

INFO MasterWebUI: Started MasterWebUI at http://192.168.1.4:8080

States
Master can be in the following states:

STANDBY - the initial state while Master is initializing

ALIVE - start scheduling resources among applications.

RECOVERING

COMPLETING_RECOVERY

Caution FIXME

RPC Environment
The org.apache.spark.deploy.master.Master class starts sparkMaster RPC environment.

1195
Standalone Master — Cluster Manager of Spark Standalone

INFO Utils: Successfully started service 'sparkMaster' on port 7077.

It then registers Master endpoint.

Figure 1. sparkMaster - the RPC Environment for Spark Standalone’s master

Master endpoint is a ThreadSafeRpcEndpoint and LeaderElectable (see Leader Election).

The Master endpoint starts the daemon single-thread scheduler pool master-forward-
message-thread . It is used for worker management, i.e. removing any timed-out workers.

"master-forward-message-thread" #46 daemon prio=5 os_prio=31 tid=0x00007ff322abb000 ni

d=0x7f03 waiting on condition [0x000000011cad9000]

Metrics
Master uses Spark Metrics System (via MasterSource ) to report metrics about internal
status.

The name of the source is master.

It emits the following metrics:

workers - the number of all workers (any state)

aliveWorkers - the number of alive workers

apps - the number of applications

waitingApps - the number of waiting applications

The name of the other source is applications

1196
Standalone Master — Cluster Manager of Spark Standalone

FIXME

Review org.apache.spark.metrics.MetricsConfig
Caution
How to access the metrics for master? See Master#onStart
Review masterMetricsSystem and applicationMetricsSystem

REST Server
The standalone Master starts the REST Server service for alternative application submission
that is supposed to work across Spark versions. It is enabled by default (see
spark.master.rest.enabled) and used by spark-submit for the standalone cluster mode, i.e. -
-deploy-mode is cluster .

RestSubmissionClient is the client.

The server includes a JSON representation of SubmitRestProtocolResponse in the HTTP

body.

The following INFOs show up when the Master Endpoint starts up ( Master#onStart is
called) with REST Server enabled:

INFO Utils: Successfully started service on port 6066.

INFO StandaloneRestServer: Started REST server for submitting applications on port 6066

Recovery Mode
A standalone Master can run with recovery mode enabled and be able to recover state
among the available swarm of masters. By default, there is no recovery, i.e. no persistence
and no election.

Only a master can schedule tasks so having one always on is important for
Note cases where you want to launch new tasks. Running tasks are unaffected by
the state of the master.

Master uses spark.deploy.recoveryMode to set up the recovery mode (see

spark.deploy.recoveryMode).

The Recovery Mode enables election of the leader master among the masters.

Check out the exercise Spark Standalone - Using ZooKeeper for High-Availability
Tip
of Master.

1197
Standalone Master — Cluster Manager of Spark Standalone

Leader Election
Master endpoint is LeaderElectable , i.e. FIXME

Caution FIXME

RPC Messages
Master communicates with drivers, executors and configures itself using RPC messages.

The following message types are accepted by master (see Master#receive or

Master#receiveAndReply methods):

ElectedLeader for Leader Election

CompleteRecovery

RevokedLeadership

RegisterApplication

ExecutorStateChanged

DriverStateChanged

Heartbeat

MasterChangeAcknowledged

WorkerSchedulerStateResponse

UnregisterApplication

CheckForWorkerTimeOut

RegisterWorker

RequestSubmitDriver

RequestKillDriver

RequestDriverStatus

RequestMasterState

BoundPortsRequest

RequestExecutors

KillExecutors

1198
Standalone Master — Cluster Manager of Spark Standalone

RegisterApplication event
A RegisterApplication event is sent by AppClient to the standalone Master. The event
holds information about the application being deployed ( ApplicationDescription ) and the
driver’s endpoint reference.

ApplicationDescription describes an application by its name, maximum number of cores,

executor’s memory, command, appUiUrl, and user with optional eventLogDir and
eventLogCodec for Event Logs, and the number of cores per executor.

Caution FIXME Finish

A standalone Master receives RegisterApplication with a ApplicationDescription and the

driver’s RpcEndpointRef.

INFO Registering app " + description.name

Application ids in Spark Standalone are in the format of app-[yyyyMMddHHmmss]-[4-digit

nextAppNumber] .

Master keeps track of the number of already-scheduled applications ( nextAppNumber ).

ApplicationDescription (AppClient) -→ ApplicationInfo (Master) - application structure

enrichment

ApplicationSource metrics + applicationMetricsSystem

INFO Registered app " + description.name + " with ID " + app.id

Caution FIXME persistenceEngine.addApplication(app)

schedule() schedules the currently available resources among waiting apps.

FIXME When is schedule() method called?

It’s only executed when the Master is in RecoveryState.ALIVE state.

Worker in WorkerState.ALIVE state can accept applications.

A driver has a state, i.e. driver.state and when it’s in DriverState.RUNNING state the driver
has been assigned to a worker for execution.

LaunchDriver RPC message

Warning It seems a dead message. Disregard it for now.

1199
Standalone Master — Cluster Manager of Spark Standalone

A LaunchDriver message is sent by an active standalone Master to a worker to launch a

driver.

Figure 2. Master finds a place for a driver (posts LaunchDriver)

You should see the following INFO in the logs right before the message is sent out to a
worker:

INFO Launching driver [driver.id] on worker [worker.id]

The message holds information about the id and name of the driver.

A driver can be running on a single worker while a worker can have many drivers running.

When a worker receives a LaunchDriver message, it prints out the following INFO:

INFO Asked to launch driver [driver.id]

It then creates a DriverRunner and starts it. It starts a separate JVM process.

Workers' free memory and cores are considered when assigning some to waiting drivers
(applications).

Caution FIXME Go over waitingDrivers …​

DriverRunner
Warning It seems a dead piece of code. Disregard it for now.

A DriverRunner manages the execution of one driver.

It is a java.lang.Process

When started, it spawns a thread DriverRunner for [driver.id] that:

1. Creates the working directory for this driver.

2. Downloads the user jar FIXME downloadUserJar

3. Substitutes variables like WORKER_URL or USER_JAR that are set when…​FIXME

Internals of org.apache.spark.deploy.master.Master

1200
Standalone Master — Cluster Manager of Spark Standalone

You can debug a Standalone master using the following command:

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005 -cp /Users/jacek/dev/

Tip

The above command suspends ( suspend=y ) the process until a JPDA debugging client, e.g. you

When Master starts, it first creates the default SparkConf configuration whose values it
then overrides using environment variables and command-line options.

A fully-configured master instance requires host , port (default: 7077 ), webUiPort

(default: 8080 ) settings defined.

Tip When in troubles, consult Spark Tips and Tricks document.

It starts RPC Environment with necessary endpoints and lives until the RPC environment
terminates.

Worker Management
Master uses master-forward-message-thread to schedule a thread every
spark.worker.timeout to check workers' availability and remove timed-out workers.

It is that Master sends CheckForWorkerTimeOut message to itself to trigger verification.

When a worker hasn’t responded for spark.worker.timeout , it is assumed dead and the
following WARN message appears in the logs:

WARN Removing [worker.id] because we got no heartbeat in [spark.worker.timeout] seconds

System Environment Variables

Master uses the following system environment variables (directly or indirectly):

SPARK_LOCAL_HOSTNAME - the custom host name

SPARK_LOCAL_IP - the custom IP to use when SPARK_LOCAL_HOSTNAME is not set

SPARK_MASTER_HOST (not SPARK_MASTER_IP as used in start-master.sh script above!) -

the master custom host

SPARK_MASTER_PORT (default: 7077 ) - the master custom port

SPARK_MASTER_IP (default: hostname command’s output)

1201
Standalone Master — Cluster Manager of Spark Standalone

SPARK_MASTER_WEBUI_PORT (default: 8080 ) - the port of the master’s WebUI. Overriden

by spark.master.ui.port if set in the properties file.

SPARK_PUBLIC_DNS (default: hostname) - the custom master hostname for WebUI’s http

URL and master’s address.

SPARK_CONF_DIR (default: $SPARK_HOME/conf ) - the directory of the default properties file

spark-defaults.conf from which all properties that start with spark. prefix are loaded.

Settings
FIXME
Caution
Where are `RETAINED_’s properties used?

Master uses the following properties:

spark.cores.max (default: 0 ) - total expected number of cores. When set, an

application could get executors of different sizes (in terms of cores).

spark.worker.timeout (default: 60 ) - time (in seconds) when no heartbeat from a

worker means it is lost. See Worker Management.

spark.deploy.retainedApplications (default: 200 )

spark.deploy.retainedDrivers (default: 200 )

spark.dead.worker.persistence (default: 15 )

spark.deploy.recoveryMode (default: NONE ) - possible modes: ZOOKEEPER , FILESYSTEM ,

or CUSTOM . Refer to Recovery Mode.

spark.deploy.recoveryMode.factory - the class name of the custom

StandaloneRecoveryModeFactory .

spark.deploy.recoveryDirectory (default: empty) - the directory to persist recovery state

spark.deploy.spreadOut to perform round-robin scheduling across the nodes.

spark.deploy.defaultCores (default: Int.MaxValue , i.e. unbounded) - the number of

maxCores for applications that don’t specify it.

spark.master.rest.enabled (default: true ) - master’s REST Server for alternative

application submission that is supposed to work across Spark versions.

spark.master.rest.port (default: 6066 ) - the port of master’s REST Server

1202
Standalone Master — Cluster Manager of Spark Standalone

Creating Master Instance

Master takes the following when created:

RpcEnv

RpcAddress

Port of the web UI

SecurityManager

SparkConf

Master initializes the internal registries and counters.

startRpcEnvAndEndpoint Method

startRpcEnvAndEndpoint(
host: String,
port: Int,
webUiPort: Int,
conf: SparkConf): (RpcEnv, Int, Option[Int])

startRpcEnvAndEndpoint …​FIXME

startRpcEnvAndEndpoint is used when:

Master standalone application is launched

Note
LocalSparkCluster is requested to start

Launching Main Standalone Application —  main Method

main(argStrings: Array[String]): Unit

main …​FIXME

Table 2. Main’s Command-Line Arguments

Argument Required? Description

$ ./bin/spark-class org.apache.spark.deploy.master.Main
...FIXME

1203
Standalone Master — Cluster Manager of Spark Standalone

Note main is used when…​FIXME

1204
Standalone Worker

Standalone Worker
Standalone Worker (aka standalone slave) is a logical node in a Spark Standalone cluster.

Worker is a ThreadSafeRpcEndpoint that uses Worker for the RPC endpoint name when

registered.

You can have one or many standalone workers in a standalone cluster. They can be started
and stopped using management scripts.

Worker is created when…​FIXME

When started, Worker …​FIXME

Table 1. Worker’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
Working directory of the executors that the Worker
manages
Initialized when Worker is requested to createWorkDir
(when Worker RPC Endpoint is requested to start on a
RPC environment).
workDir
Used when Worker is requested to
handleRegisterResponse and receives a WorkDirCleanup
message.

Used when Worker is requested to onStart (to create a

WorkerWebUI ), receives LaunchExecutor or
LaunchDriver messages.

receive Method

receive: PartialFunction[Any, Unit]

Note receive is part of RpcEndpoint Contract to process messages.

receive …​FIXME

handleRegisterResponse Internal Method

handleRegisterResponse(msg: RegisterWorkerResponse): Unit

1205
Standalone Worker

handleRegisterResponse …​FIXME

Note handleRegisterResponse is used when…​FIXME

Launching Worker Standalone Application —  main

Method

main(argStrings: Array[String]): Unit

main …​FIXME

Starting RPC Environment And Registering Worker RPC

Endpoint —  startRpcEnvAndEndpoint Method

startRpcEnvAndEndpoint(
host: String,
port: Int,
webUiPort: Int,
cores: Int,
memory: Int,
masterUrls: Array[String],
workDir: String,
workerNumber: Option[Int] = None,
conf: SparkConf = new SparkConf): RpcEnv

startRpcEnvAndEndpoint …​FIXME

startRpcEnvAndEndpoint creates a RpcEnv for the input host and port .

startRpcEnvAndEndpoint creates a Worker RPC endpoint (for the RPC environment and the

input webUiPort , cores , memory , masterUrls , workDir and conf ).

startRpcEnvAndEndpoint requests the RpcEnv to register the Worker RPC endpoint under

the name Worker.

startRpcEnvAndEndpoint is used when:

Note Worker is launched from a command line

LocalSparkCluster is requested to start

Creating Worker Instance

Worker takes the following when created:

1206
Standalone Worker

RpcEnv

Port of the administrative web UI

Number of cores

Amount of memory

standalone Master’s RpcAddresses

RPC endpoint name

Path to the working directory

SparkConf

SecurityManager

Worker initializes the internal registries and counters.

createWorkDir Internal Method

createWorkDir(): Unit

createWorkDir sets workDir to be either workDirPath if defined or sparkHome with work

subdirectory.

In the end, createWorkDir creates workDir directory (including any necessary but
nonexistent parent directories).

createWorkDir reports…​FIXME

createWorkDir is used exclusively when Worker RPC Endpoint is requested to

Note
start on a RPC environment.

onStart Method

onStart(): Unit

onStart is part of RpcEndpoint Contract to activate an endpoint and start

Note
accepting messages.

onStart …​FIXME

1207
Standalone Worker

1208
web UI

master’s Administrative web UI

Spark Standalone cluster comes with administrative web UI. It is available under
http://localhost:8080 by default.

Executor Summary
Executor Summary page displays information about the executors for the application id
given as the appId request parameter.

Figure 1. Executor Summary Page

The State column displays the state of an executor as tracked by the master.

When an executor is added to the pool of available executors, it enters LAUNCHING state. It
can then enter either RUNNING or FAILED states.

An executor (as ExecutorRunner ) sends ExecutorStateChanged message to a worker (that it

then sends forward to a master) as a means of announcing an executor’s state change:

ExecutorRunner.fetchAndRunExecutor sends EXITED , KILLED or FAILED .

ExecutorRunner.killProcess

A Worker sends ExecutorStateChanged messages for the following cases:

1209
web UI

When LaunchExecutor is received, an executor (as ExecutorRunner ) is started and

RUNNING state is announced.

When LaunchExecutor is received, an executor (as ExecutorRunner ) fails to start and

FAILED state is announced.

If no application for the appId could be found, Not Found page is displayed.

Figure 2. Application Not Found Page

1210
ApplicationPage

ApplicationPage
ApplicationPage is a WebUIPage with app prefix.

ApplicationPage is created exclusively when Spark Standalone’s MasterWebUI is initialized.

ApplicationPage takes a MasterWebUI when created:

1211
LocalSparkCluster — Single-JVM Spark Standalone Cluster

LocalSparkCluster — Single-JVM Spark
Standalone Cluster
LocalSparkCluster is responsible for local-cluster master URL.

local-cluster master URL matches local-

cluster[numWorkers,coresPerWorker,memoryPerWorker] pattern where
Note
numWorkers, coresPerWorker and memoryPerWorker are all numbers
separated by the comma.

LocalSparkCluster can be particularly useful to test distributed operation and fault recovery

without spinning up a lot of processes.

LocalSparkCluster is created when SparkContext is created for local-cluster master URL

(and so requested to create the SchedulerBackend and the TaskScheduler).

Table 1. LocalSparkCluster’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
FIXME
localHostname
Used when…​FIXME

FIXME
masterRpcEnvs
Used when…​FIXME

FIXME
workerRpcEnvs
Used when…​FIXME

Enable INFO logging level for org.apache.spark.deploy.LocalSparkCluster logger

to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.LocalSparkCluster=INFO

Refer to Logging.

Creating LocalSparkCluster Instance

LocalSparkCluster takes the following when created:

Number of workers

1212
LocalSparkCluster — Single-JVM Spark Standalone Cluster

CPU cores per worker

Memory per worker

SparkConf

LocalSparkCluster initializes the internal registries and counters.

start Method

start(): Array[String]

start …​FIXME

Note start is used when…​FIXME

stop Method

stop(): Unit

stop …​FIXME

Note stop is used when…​FIXME

1213
Submission Gateways

Submission Gateways
Caution FIXME

From SparkSubmit.submit :

In standalone cluster mode, there are two submission gateways:

1. The traditional legacy RPC gateway using o.a.s.deploy.Client as a wrapper

2. The new REST-based gateway introduced in Spark 1.3

The latter is the default behaviour as of Spark 1.3, but Spark submit will fail over to use the
legacy gateway if the master endpoint turns out to be not a REST server.

1214
Management Scripts for Standalone Master

Management Scripts for Standalone Master

You can start a Spark Standalone master (aka standalone Master) using sbin/start-
master.sh and stop it using sbin/stop-master.sh.

sbin/start-master.sh
sbin/start-master.sh script starts a Spark master on the machine the script is executed on.

./sbin/start-master.sh

The script prepares the command line to start the class

org.apache.spark.deploy.master.Master and by default runs as follows:

org.apache.spark.deploy.master.Master \
--ip japila.local --port 7077 --webui-port 8080

The command sets SPARK_PRINT_LAUNCH_COMMAND environment variable to print

Note out the launch command to standard error output. Refer to Print Launch
Command of Spark Scripts.

It has support for starting Tachyon using --with-tachyon command line option. It assumes
tachyon/bin/tachyon command be available in Spark’s home directory.

The script uses the following helper scripts:

sbin/spark-config.sh

bin/load-spark-env.sh

conf/spark-env.sh contains environment variables of a Spark executable.

Ultimately, the script calls sbin/spark-daemon.sh start to kick off

org.apache.spark.deploy.master.Master with parameter 1 and --ip , --port , and --

webui-port command-line options.

Command-line Options
You can use the following command-line options:

--host or -h the hostname to listen on; overrides SPARK_MASTER_HOST.

--ip or -i (deprecated) the IP to listen on

1215
Management Scripts for Standalone Master

--port or -p - command-line version of SPARK_MASTER_PORT that overrides it.

--webui-port - command-line version of SPARK_MASTER_WEBUI_PORT that

overrides it.

--properties-file (default: $SPARK_HOME/conf/spark-defaults.conf ) - the path to a

custom Spark properties file. Refer to spark-defaults.conf.

--help - prints out help

sbin/stop-master.sh
You can stop a Spark Standalone master using sbin/stop-master.sh script.

./sbin/stop-master.sh

Caution FIXME Review the script

It effectively sends SIGTERM to the master’s process.

You should see the ERROR in master’s logs:

ERROR Master: RECEIVED SIGNAL 15: SIGTERM

1216
Management Scripts for Standalone Workers

Management Scripts for Standalone Workers

sbin/start-slave.sh script starts a Spark worker (aka slave) on the machine the script is

executed on. The script launches SPARK_WORKER_INSTANCES workers (which defaults

to 1 ).

./sbin/start-slave.sh [masterURL]

The mandatory masterURL parameter is of the form spark://hostname:port , e.g.

spark://localhost:7077 . It is also possible to specify a comma-separated master URLs of

the form spark://hostname1:port1,hostname2:port2,…​ with each element to be

hostname:port .

Internally, the script starts sparkWorker RPC environment.

The order of importance of Spark configuration settings is as follows (from least to the most
important):

System environment variables

Command-line options

Spark properties

1217
Management Scripts for Standalone Workers

Table 1. System environment variables

Name Default Description

SPARK_WORKER_INSTANCES 1
The number of worker instances to
run on a node

The base port number to listen on

for the first worker. If set,
SPARK_WORKER_PORT subsequent workers will increment
this number. If unset, Spark will pick
a random port.

The base port for the web UI of the

first worker. Subsequent workers will
SPARK_WORKER_WEBUI_PORT 8081 increment this number. If the port is
used, the successive ports are tried
until a free one is found.

SPARK_WORKER_CORES
The number of cores to use by a
single executor

SPARK_WORKER_MEMORY 1G
The amount of memory to use, e.g.
1000M , 2G

The working directory of worker

processes, i.e. web UI, the
SPARK_WORKER_DIR $SPARK_HOME/work executors and drivers of Spark
applications, that includes both logs
and scratch space

The script uses the following helper scripts:

sbin/spark-config.sh

bin/load-spark-env.sh

Command-line Options
You can use the following command-line options:

--host or -h sets the hostname to be available under.

--port or -p - command-line version of SPARK_WORKER_PORT environment

variable.

--cores or -c (default: the number of processors available to the JVM) - command-

line version of SPARK_WORKER_CORES environment variable.

1218
Management Scripts for Standalone Workers

--memory or -m - command-line version of SPARK_WORKER_MEMORY

environment variable.

--work-dir or -d - command-line version of SPARK_WORKER_DIR environment

variable.

--webui-port - command-line version of SPARK_WORKER_WEBUI_PORT

environment variable.

--properties-file (default: conf/spark-defaults.conf ) - the path to a custom Spark

properties file. Refer to spark-defaults.conf.

--help

Spark properties
After loading the default SparkConf, if --properties-file or SPARK_WORKER_OPTS define
spark.worker.ui.port , the value of the property is used as the port of the worker’s web UI.

SPARK_WORKER_OPTS=-Dspark.worker.ui.port=21212 ./sbin/start-slave.sh spark://localhost

:7077

or

$ cat worker.properties
spark.worker.ui.port=33333

$ ./sbin/start-slave.sh spark://localhost:7077 --properties-file worker.properties

sbin/spark-daemon.sh
Ultimately, the script calls sbin/spark-daemon.sh start to kick off
org.apache.spark.deploy.worker.Worker with --webui-port , --port and the master URL.

Internals of org.apache.spark.deploy.worker.Worker
Upon starting, a Spark worker creates the default SparkConf.

It parses command-line arguments for the worker using WorkerArguments class.

SPARK_LOCAL_HOSTNAME - custom host name

SPARK_LOCAL_IP - custom IP to use (when SPARK_LOCAL_HOSTNAME is not set or hostname

resolves to incorrect IP)

1219
Management Scripts for Standalone Workers

It starts sparkWorker RPC Environment and waits until the RpcEnv terminates.

RPC environment
The org.apache.spark.deploy.worker.Worker class starts its own sparkWorker RPC
environment with Worker endpoint.

sbin/start-slaves.sh script starts slave instances

The ./sbin/start-slaves.sh script starts slave instances on each machine specified in the
conf/slaves file.

It has support for starting Tachyon using --with-tachyon command line option. It assumes
tachyon/bin/tachyon command be available in Spark’s home directory.

The script uses the following helper scripts:

sbin/spark-config.sh

bin/load-spark-env.sh

conf/spark-env.sh

The script uses the following environment variables (and sets them when unavailable):

SPARK_PREFIX

SPARK_HOME

SPARK_CONF_DIR

SPARK_MASTER_PORT

SPARK_MASTER_IP

The following command will launch 3 worker instances on each node. Each worker instance
will use two cores.

SPARK_WORKER_INSTANCES=3 SPARK_WORKER_CORES=2 ./sbin/start-slaves.sh

1220
Checking Status

Checking Status of Spark Standalone

jps
Since you’re using Java tools to run Spark, use jps -lm as the tool to get status of any
JVMs on a box, Spark’s ones including. Consult jps documentation for more details beside
-lm command-line options.

If you however want to filter out the JVM processes that really belong to Spark you should
pipe the command’s output to OS-specific tools like grep .

$ jps -lm
999 org.apache.spark.deploy.master.Master --ip japila.local --port 7077 --webui-port 8
080
397
669 org.jetbrains.idea.maven.server.RemoteMavenServer
1198 sun.tools.jps.Jps -lm

$ jps -lm | grep -i spark

999 org.apache.spark.deploy.master.Master --ip japila.local --port 7077 --webui-port 8
080

spark-daemon.sh status
You can also check out ./sbin/spark-daemon.sh status .

When you start Spark Standalone using scripts under sbin , PIDs are stored in /tmp
directory by default. ./sbin/spark-daemon.sh status can read them and do the "boilerplate"
for you, i.e. status a PID.

$ jps -lm | grep -i spark

999 org.apache.spark.deploy.master.Master --ip japila.local --port 7077 --webui-port 8
080

$ ls /tmp/spark-*.pid
/tmp/spark-jacek-org.apache.spark.deploy.master.Master-1.pid

$ ./sbin/spark-daemon.sh status org.apache.spark.deploy.master.Master 1

org.apache.spark.deploy.master.Master is running.

1221
Example 2-workers-on-1-node Standalone Cluster (one executor per worker)

Example 2-workers-on-1-node Standalone

Cluster (one executor per worker)
The following steps are a recipe for a Spark Standalone cluster with 2 workers on a single
machine.

The aim is to have a complete Spark-clustered environment at your laptop.

Consult the following documents:

Tip Operating Spark master

Starting Spark workers on node using sbin/start-slave.sh

You can use the Spark Standalone cluster in the following ways:
Use spark-shell with --master MASTER_URL
Important
Use SparkConf.setMaster(MASTER_URL) in your Spark application
For our learning purposes, MASTER_URL is spark://localhost:7077 .

1. Start a standalone master server.

./sbin/start-master.sh

Notes:

Read Operating Spark Standalone master

Use SPARK_CONF_DIR for the configuration directory (defaults to $SPARK_HOME/conf ).

Use spark.deploy.retainedApplications (default: 200 )

Use spark.deploy.retainedDrivers (default: 200 )

Use spark.deploy.recoveryMode (default: NONE )

Use spark.deploy.defaultCores (default: Int.MaxValue )

2. Open master’s web UI at http://localhost:8080 to know the current setup - no workers

and applications.

1222
Example 2-workers-on-1-node Standalone Cluster (one executor per worker)

Figure 1. Master’s web UI with no workers and applications

3. Start the first worker.

./sbin/start-slave.sh spark://japila.local:7077

The command above in turn executes

Note org.apache.spark.deploy.worker.Worker --webui-port 8081
spark://japila.local:7077

4. Check out master’s web UI at http://localhost:8080 to know the current setup - one
worker.

1223
Example 2-workers-on-1-node Standalone Cluster (one executor per worker)

Figure 2. Master’s web UI with one worker ALIVE

Note the number of CPUs and memory, 8 and 15 GBs, respectively (one gigabyte left
for the OS — oh, how generous, my dear Spark!).

5. Let’s stop the worker to start over with custom configuration. You use ./sbin/stop-
slave.sh to stop the worker.

./sbin/stop-slave.sh

6. Check out master’s web UI at http://localhost:8080 to know the current setup - one
worker in DEAD state.

1224
Example 2-workers-on-1-node Standalone Cluster (one executor per worker)

Figure 3. Master’s web UI with one worker DEAD

7. Start a worker using --cores 2 and --memory 4g for two CPU cores and 4 GB of RAM.

./sbin/start-slave.sh spark://japila.local:7077 --cores 2 --

memory 4g

Note The command translates to org.apache.spark.deploy.worker.Worker --

webui-port 8081 spark://japila.local:7077 --cores 2 --memory 4g

8. Check out master’s web UI at http://localhost:8080 to know the current setup - one
worker ALIVE and another DEAD.

1225
Example 2-workers-on-1-node Standalone Cluster (one executor per worker)

Figure 4. Master’s web UI with one worker ALIVE and one DEAD
9. Configuring cluster using conf/spark-env.sh

There’s the conf/spark-env.sh.template template to start from.

We’re going to use the following conf/spark-env.sh :

conf/spark-env.sh

SPARK_WORKER_CORES=2 (1)
SPARK_WORKER_INSTANCES=2 (2)
SPARK_WORKER_MEMORY=2g

i. the number of cores per worker

ii. the number of workers per node (a machine)

10. Start the workers.

./sbin/start-slave.sh spark://japila.local:7077

As the command progresses, it prints out starting

org.apache.spark.deploy.worker.Worker, logging to for each worker. You defined two
workers in conf/spark-env.sh using SPARK_WORKER_INSTANCES , so you should see two
lines.

1226
Example 2-workers-on-1-node Standalone Cluster (one executor per worker)

$ ./sbin/start-slave.sh spark://japila.local:7077
starting org.apache.spark.deploy.worker.Worker, logging to
../logs/spark-jacek-org.apache.spark.deploy.worker.Worker-1-
japila.local.out
starting org.apache.spark.deploy.worker.Worker, logging to
../logs/spark-jacek-org.apache.spark.deploy.worker.Worker-2-
japila.local.out

11. Check out master’s web UI at http://localhost:8080 to know the current setup - at least
two workers should be ALIVE.

Figure 5. Master’s web UI with two workers ALIVE

Use jps on master to see the instances given they all run on the same
machine, e.g. localhost ).

$ jps
Note 6580 Worker
4872 Master
6874 Jps
6539 Worker

12. Stop all instances - the driver and the workers.

1227
Example 2-workers-on-1-node Standalone Cluster (one executor per worker)

./sbin/stop-all.sh

1228
StandaloneSchedulerBackend

StandaloneSchedulerBackend
Caution FIXME

Starting StandaloneSchedulerBackend —  start Method

start(): Unit

Caution FIXME

1229
Spark on Mesos

Spark on Mesos

Figure 1. Spark on Mesos Architecture

Running Spark on Mesos

A Mesos cluster needs at least one Mesos Master to coordinate and dispatch tasks onto
Mesos Slaves.

$ mesos-master --registry=in_memory --ip=127.0.0.1

I0401 00:12:01.955883 1916461824 main.cpp:237] Build: 2016-03-17 14:20:58 by brew
I0401 00:12:01.956457 1916461824 main.cpp:239] Version: 0.28.0
I0401 00:12:01.956538 1916461824 main.cpp:260] Using 'HierarchicalDRF' allocator
I0401 00:12:01.957381 1916461824 main.cpp:471] Starting Mesos master
I0401 00:12:01.964118 1916461824 master.cpp:375] Master 9867c491-5370-48cc-8e25-e1aff1
d86542 (localhost) started on 127.0.0.1:5050
...

Visit the management console at http://localhost:5050.

1230
Spark on Mesos

Figure 2. Mesos Management Console

Run Mesos Slave onto which Master will dispatch jobs.

$ mesos-slave --master=127.0.0.1:5050
I0401 00:15:05.850455 1916461824 main.cpp:223] Build: 2016-03-17 14:20:58 by brew
I0401 00:15:05.850772 1916461824 main.cpp:225] Version: 0.28.0
I0401 00:15:05.852812 1916461824 containerizer.cpp:149] Using isolation: posix/cpu,pos
ix/mem,filesystem/posix
I0401 00:15:05.866186 1916461824 main.cpp:328] Starting Mesos slave
I0401 00:15:05.869470 218980352 slave.cpp:193] Slave started on 1)@10.1.47.199:5051
...
I0401 00:15:05.906355 218980352 slave.cpp:832] Detecting new master
I0401 00:15:06.762917 220590080 slave.cpp:971] Registered with master [email protected]
:5050; given slave ID 9867c491-5370-48cc-8e25-e1aff1d86542-S0
...

Switch to the management console at http://localhost:5050/#/slaves to see the slaves

available.

Figure 3. Mesos Management Console (Slaves tab) with one slave running

1231
Spark on Mesos

You have to export MESOS_NATIVE_JAVA_LIBRARY environment variable

before connecting to the Mesos cluster.
Important
$ export MESOS_NATIVE_JAVA_LIBRARY=/usr/local/lib/libmesos.dylib

The preferred approach to launch Spark on Mesos and to give the location of Spark
binaries is through spark.executor.uri setting.

--conf spark.executor.uri=/Users/jacek/Downloads/spark-1.5.2-bin-hadoop2.6.tgz

Note
For us, on a bleeding edge of Spark development, it is very convenient to use
spark.mesos.executor.home setting, instead.

-c spark.mesos.executor.home=`pwd`

$ ./bin/spark-shell --master mesos://127.0.0.1:5050 -c spark.mesos.executor.home=`pwd`

...
I0401 00:17:41.806743 581939200 sched.cpp:222] Version: 0.28.0
I0401 00:17:41.808825 579805184 sched.cpp:326] New master detected at [email protected]
:5050
I0401 00:17:41.808976 579805184 sched.cpp:336] No credentials provided. Attempting to
register without authentication
I0401 00:17:41.809605 579268608 sched.cpp:703] Framework registered with 9867c491-5370
-48cc-8e25-e1aff1d86542-0001
Spark context available as sc (master = mesos://127.0.0.1:5050, app id = 9867c491-5370
-48cc-8e25-e1aff1d86542-0001).
...

In Frameworks tab you should see a single active framework for spark-shell .

Figure 4. Mesos Management Console (Frameworks tab) with Spark shell active
Tip Consult slave logs under /tmp/mesos/slaves when facing troubles.

Ensure that the versions of Spark of spark-shell and as pointed out by

Important
spark.executor.uri are the same or compatible.

1232
Spark on Mesos

scala> sc.parallelize(0 to 10, 8).count

res0: Long = 11

Figure 5. Completed tasks in Mesos Management Console

Stop Spark shell.

scala> Stopping spark context.

I1119 16:01:37.831179 206073856 sched.cpp:1771] Asked to stop the driver
I1119 16:01:37.831310 698224640 sched.cpp:1040] Stopping framework '91979713-a32d-4e08
-aaea-5dffbfd44e5d-0002'

CoarseMesosSchedulerBackend
CoarseMesosSchedulerBackend is the scheduler backend for Spark on Mesos.

It requires a Task Scheduler, Spark context, mesos:// master URL, and Security Manager.

It is a specialized CoarseGrainedSchedulerBackend and implements Mesos’s

org.apache.mesos.Scheduler interface.

It accepts only two failures before blacklisting a Mesos slave (it is hardcoded and not
configurable).

It tracks:

the number of tasks already submitted ( nextMesosTaskId )

the number of cores per task ( coresByTaskId )

1233
Spark on Mesos

the total number of cores acquired ( totalCoresAcquired )

slave ids with executors ( slaveIdsWithExecutors )

slave ids per host ( slaveIdToHost )

task ids per slave ( taskIdToSlaveId )

How many times tasks on each slave failed ( failuresBySlaveId )

createSchedulerDriver instantiates Mesos’s

Tip
org.apache.mesos.MesosSchedulerDriver

CoarseMesosSchedulerBackend starts the MesosSchedulerUtils-mesos-driver daemon

thread with Mesos’s org.apache.mesos.MesosSchedulerDriver.

Settings
spark.cores.max (default: Int.MaxValue ) - maximum number of cores to acquire

spark.mesos.extra.cores (default: 0 ) - extra cores per slave ( extraCoresPerSlave )

FIXME

spark.mesos.constraints (default: (empty)) - offer constraints FIXME

slaveOfferConstraints

spark.mesos.rejectOfferDurationForUnmetConstraints (default: 120s ) - reject offers with

mismatched constraints in seconds

spark.mesos.executor.home (default: SPARK_HOME ) - the home directory of Spark for

executors. It is only required when no spark.executor.uri is set.

MesosExternalShuffleClient
FIXME

(Fine)MesosSchedulerBackend
When spark.mesos.coarse is false , Spark on Mesos uses MesosSchedulerBackend

reviveOffers
It calls mesosDriver.reviveOffers() .

Caution FIXME

1234
Spark on Mesos

Settings
spark.mesos.coarse (default: true ) controls whether the scheduler backend for Mesos

works in coarse- ( CoarseMesosSchedulerBackend ) or fine-grained mode

( MesosSchedulerBackend ).

FIXME Review

Caution MesosClusterScheduler.scala
MesosExternalShuffleService

Schedulers in Mesos
Available scheduler modes:

fine-grained mode

coarse-grained mode - spark.mesos.coarse=true

The main difference between these two scheduler modes is the number of tasks per Spark
executor per single Mesos executor. In fine-grained mode, there is a single task in a single
Spark executor that shares a single Mesos executor with the other Spark executors. In
coarse-grained mode, there is a single Spark executor per Mesos executor with many Spark
tasks.

Coarse-grained mode pre-starts all the executor backends, e.g. Executor Backends, so it
has the least overhead comparing to fine-grain mode. Since the executors are up before
tasks get launched, it is better for interactive sessions. It also means that the resources are
locked up in a task.

Spark on Mesos supports dynamic allocation in the Mesos coarse-grained scheduler since
Spark 1.5. It can add/remove executors based on load, i.e. kills idle executors and adds
executors when tasks queue up. It needs an external shuffle service on each node.

Mesos Fine-Grained Mode offers a better resource utilization. It has a slower startup for
tasks and hence it is fine for batch and relatively static streaming.

Commands
The following command is how you could execute a Spark application on Mesos:

./bin/spark-submit --master mesos://iq-cluster-master:5050 --total-executor-cores 2 --

executor-memory 3G --conf spark.mesos.role=dev ./examples/src/main/python/pi.py 100

1235
Spark on Mesos

Other Findings
From Four reasons to pay attention to Apache Mesos:

Spark workloads can also be sensitive to the physical characteristics of the

infrastructure, such as memory size of the node, access to fast solid state disk, or
proximity to the data source.

to run Spark workloads well you need a resource manager that not only can handle the
rapid swings in load inherent in analytics processing, but one that can do to smartly.
Matching of the task to the RIGHT resources is crucial and awareness of the physical
environment is a must. Mesos is designed to manage this problem on behalf of
workloads like Spark.

1236
MesosCoarseGrainedSchedulerBackend

MesosCoarseGrainedSchedulerBackend — 
Coarse-Grained Scheduler Backend for Mesos
Caution FIXME

executorLimitOption Property
executorLimitOption is an internal attribute to…​FIXME

resourceOffers Method

Caution FIXME

resourceOffers is part of Mesos' Scheduler callback interface to be

Note
implemented by frameworks' schedulers.

handleMatchedOffers Internal Method

Caution FIXME

handleMatchedOffers is used exclusively when

Note
MesosCoarseGrainedSchedulerBackend resourceOffers.

buildMesosTasks Internal Method

Caution FIXME

buildMesosTasks is used exclusively when MesosCoarseGrainedSchedulerBackend

Note
launches Spark executors on accepted offers.

createCommand Method

Caution FIXME

createCommand is used exclusively when MesosCoarseGrainedSchedulerBackend

Note
builds Mesos tasks for given offers.

1237
MesosCoarseGrainedSchedulerBackend

1238
About Mesos

About Mesos
Apache Mesos is an Apache Software Foundation open source cluster management and
scheduling framework. It abstracts CPU, memory, storage, and other compute resources
away from machines (physical or virtual).

Mesos provides API for resource management and scheduling across multiple nodes (in
datacenter and cloud environments).

Tip Visit Apache Mesos to learn more about the project.

Mesos is a distributed system kernel with a pool of resources.

"If a service fails, kill and replace it".

An Apache Mesos cluster consists of three major components: masters, agents, and
frameworks.

Concepts
A Mesos master manages agents. It is responsible for tracking, pooling and distributing
agents' resources, managing active applications, and task delegation.

A Mesos agent is the worker with resources to execute tasks.

A Mesos framework is an application running on a Apache Mesos cluster. It runs on agents

as tasks.

The Mesos master offers resources to frameworks that can accept or reject them based on
specific constraints.

A resource offer is an offer with CPU cores, memory, ports, disk.

Frameworks: Chronos, Marathon, Spark, HDFS, YARN (Myriad), Jenkins, Cassandra.

Mesos API

Mesos is a scheduler of schedulers

Mesos assigns jobs

Mesos typically runs with an agent on every virtual machine or bare metal server under
management (https://www.joyent.com/blog/mesos-by-the-pound)

Mesos uses Zookeeper for master election and discovery. Apache Auroa is a scheduler
that runs on Mesos.

1239
About Mesos

Mesos slaves, masters, schedulers, executors, tasks

Mesos makes use of event-driven message passing.

Mesos is written in C++, not Java, and includes support for Docker along with other
frameworks. Mesos, then, is the core of the Mesos Data Center Operating System, or
DCOS, as it was coined by Mesosphere.

This Operating System includes other handy components such as Marathon and
Chronos. Marathon provides cluster-wide “init” capabilities for application in containers
like Docker or cgroups. This allows one to programmatically automate the launching of
large cluster-based applications. Chronos acts as a Mesos API for longer-running batch
type jobs while the core Mesos SDK provides an entry point for other applications like
Hadoop and Spark.

The true goal is a full shared, generic and reusable on demand distributed architecture.

Infinity to package and integrate the deployment of clusters

Out of the box it will include Cassandra, Kafka, Spark, and Akka.

an early access project

Apache Myriad = Integrate YARN with Mesos

making the execution of YARN work on Mesos scheduled systems transparent,

multi-tenant, and smoothly managed

to allow Mesos to centrally schedule YARN work via a Mesos based framework,
including a REST API for scaling up or down

includes a Mesos executor for launching the node manager

1240
Execution Model

Execution Model
FIXME This is the single place for explaining jobs, stages, tasks. Move
Caution
relevant parts from the other places.

1241
Unified Memory Management

Unified Memory Management

Unified Memory Management was introduced in SPARK-10000: Consolidate storage and
execution memory management.

It uses the custom memory manager UnifiedMemoryManager.

Further reading or watching

(video) Deep Dive: Apache Spark Memory Management

(video) Deep Dive into Project Tungsten (…​WGI)

(video) Spark Performance: What’s Next (…​WYX4)

SPARK-10000: Unified Memory Management

1242
Spark History Server

Spark History Server

Spark History Server is the web UI for completed and running (aka incomplete) Spark
applications. It is an extension of Spark’s web UI.

Figure 1. History Server’s web UI

Enable collecting events in your Spark applications using spark.eventLog.enabled
Tip
Spark property.

You can start History Server by executing start-history-server.sh shell script and stop it
using stop-history-server.sh .

start-history-server.sh accepts --properties-file [propertiesFile] command-line

option that specifies the properties file with the custom Spark properties.

$ ./sbin/start-history-server.sh --properties-file history.properties

If not specified explicitly, Spark History Server uses the default configuration file, i.e. spark-
defaults.conf.

Enable INFO logging level for org.apache.spark.deploy.history logger to see

what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.history=INFO

Refer to Logging.

Starting History Server —  start-history-server.sh

1243
Spark History Server

Starting History Server —  start-history-server.sh

script
You can start a HistoryServer instance by executing $SPARK_HOME/sbin/start-history-
server.sh script (where SPARK_HOME is the directory of your Spark installation).

$ ./sbin/start-history-server.sh
starting org.apache.spark.deploy.history.HistoryServer, logging to .../spark/logs/spar
k-jacek-org.apache.spark.deploy.history.HistoryServer-1-japila.out

Internally, start-history-server.sh script starts

org.apache.spark.deploy.history.HistoryServer standalone application for execution (using
spark-daemon.sh shell script).

$ ./bin/spark-class org.apache.spark.deploy.history.HistoryServer

Using the more explicit approach with spark-class to start Spark History Server
Tip could be easier to trace execution by seeing the logs printed out to the standard
output and hence terminal directly.

When started, it prints out the following INFO message to the logs:

INFO HistoryServer: Started daemon with process name: [processName]

It registers signal handlers (using SignalUtils ) for TERM , HUP , INT to log their execution:

ERROR HistoryServer: RECEIVED SIGNAL [signal]

It inits security if enabled (using spark.history.kerberos.enabled setting).

Caution FIXME Describe initSecurity

It creates a SecurityManager .

It creates a ApplicationHistoryProvider (by reading spark.history.provider).

It creates a HistoryServer and requests it to bind to spark.history.ui.port port.

The host’s IP can be specified using SPARK_LOCAL_IP environment variable

Tip (defaults to 0.0.0.0 ).

You should see the following INFO message in the logs:

1244
Spark History Server

INFO HistoryServer: Bound HistoryServer to [host], and started at [webUrl]

It registers a shutdown hook to call stop on the HistoryServer instance.

Tip Use stop-history-server.sh shell script to to stop a running History Server.

Stopping History Server —  stop-history-server.sh

script
You can stop a running instance of HistoryServer using $SPARK_HOME/sbin/stop-history-
server.sh shell script.

$ ./sbin/stop-history-server.sh
stopping org.apache.spark.deploy.history.HistoryServer

Settings

1245
Spark History Server

Table 1. Spark Properties

Setting Default Value

spark.history.ui.port 18080

spark.history.fs.logDirectory file:/tmp/spark-events

spark.history.retainedApplications 50

spark.history.ui.maxApplications (unbounded)

spark.history.kerberos.enabled false

spark.history.kerberos.principal (empty)

spark.history.kerberos.keytab (empty)

spark.history.provider org.apache.spark.deploy.history.FsHistoryProvider

1246
HistoryServer — WebUI For Active And Completed Spark Applications

HistoryServer — WebUI For Active And

Completed Spark Applications
HistoryServer is the web UI for running (active) and completed Spark applications.

HistoryServer is created when…​FIXME

HistoryServer uses the HttpServlet to handle requests to /* URI that FIXME.

Table 1. HistoryServer’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
ApplicationCache
appCache
Used when…​FIXME

Java Servlets' HttpServlet

loaderServlet Used exclusively when HistoryServer is requested to
initialize (and attaches the servlet to the web UI to handle
/* URI)

Enable INFO logging level for org.apache.spark.deploy.history.HistoryServer

logger to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.history.HistoryServer=INFO

Refer to Logging.

attachSparkUI Method

attachSparkUI(
appId: String,
attemptId: Option[String],
ui: SparkUI,
completed: Boolean): Unit

Note attachSparkUI is part of ApplicationCacheOperations Contract to…​FIXME.

attachSparkUI …​FIXME

1247
HistoryServer — WebUI For Active And Completed Spark Applications

Initializing HistoryServer —  initialize Method

initialize(): Unit

Note initialize is part of WebUI Contract to initialize web components.

initialize …​FIXME

Launching HistoryServer Standalone Application —  main

Method

main(argStrings: Array[String]): Unit

main …​FIXME

Creating HistoryServer Instance

HistoryServer takes the following when created:

SparkConf

ApplicationHistoryProvider

SecurityManager

Port number

HistoryServer initializes the internal registries and counters.

Requesting Spark Application UI —  getAppUI Method

getAppUI(appId: String, attemptId: Option[String]): Option[LoadedAppUI]

Note getAppUI is part of ApplicationCacheOperations Contract to…​FIXME.

getAppUI …​FIXME

withSparkUI Method

withSparkUI[T](appId: String, attemptId: Option[String])(fn: SparkUI => T): T

1248
HistoryServer — WebUI For Active And Completed Spark Applications

Note withSparkUI is part of UIRoot Contract to…​FIXME.

withSparkUI …​FIXME

loadAppUi Internal Method

loadAppUi(appId: String, attemptId: Option[String]): Boolean

loadAppUi …​FIXME

Note loadAppUi is used exclusively when HistoryServer is created.

doGet Method

doGet(req: HttpServletRequest, res: HttpServletResponse): Unit

Note doGet is part of Java Servlet’s HttpServlet to handle HTTP GET requests.

doGet …​FIXME

Note doGet is used when…​FIXME

1249
SQLHistoryListener

SQLHistoryListener
SQLHistoryListener is a custom SQLListener for History Server. It attaches SQL tab to

History Server’s web UI only when the first SparkListenerSQLExecutionStart arrives and
shuts onExecutorMetricsUpdate off. It also handles ends of tasks in a slightly different way.

Support for SQL UI in History Server was added in SPARK-11206 Support SQL
Note
UI on the history server.

Caution FIXME Add the link to the JIRA.

onOtherEvent

onOtherEvent(event: SparkListenerEvent): Unit

When SparkListenerSQLExecutionStart event comes, onOtherEvent attaches SQL tab to

web UI and passes the call to the parent SQLListener.

onTaskEnd

Caution FIXME

Creating SQLHistoryListener Instance

SQLHistoryListener is created using a ( private[sql] ) SQLHistoryListenerFactory class

(which is SparkHistoryListenerFactory ).

The SQLHistoryListenerFactory class is registered when SparkUI creates a web UI for

History Server as a Java service in META-
INF/services/org.apache.spark.scheduler.SparkHistoryListenerFactory :

org.apache.spark.sql.execution.ui.SQLHistoryListenerFactory

Note Loading the service uses Java’s ServiceLoader.load method.

onExecutorMetricsUpdate
onExecutorMetricsUpdate does nothing.

1250
SQLHistoryListener

1251
FsHistoryProvider — File-System-Based History Provider

FsHistoryProvider — File-System-Based
History Provider
FsHistoryProvider is the default ApplicationHistoryProvider for Spark History Server.

FsHistoryProvider is created exclusively when HistoryServer is started as a standalone

application and spark.history.provider configuration property was not defined.

Enable INFO or DEBUG logging levels for

org.apache.spark.deploy.history.FsHistoryProvider logger to see what happens
inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.history.FsHistoryProvider=DEBUG

Refer to Logging.

rebuildAppStore Internal Method

rebuildAppStore(
store: KVStore,
eventLog: FileStatus,
lastUpdated: Long): Unit

rebuildAppStore …​FIXME

Note rebuildAppStore is used when…​FIXME

getAppUI Method

getAppUI(appId: String, attemptId: Option[String]): Option[LoadedAppUI]

Note getAppUI is part of ApplicationHistoryProvider Contract to…​FIXME.

getAppUI …​FIXME

Creating FsHistoryProvider Instance

FsHistoryProvider takes the following when created:

1252
FsHistoryProvider — File-System-Based History Provider

SparkConf

Clock (default: SystemClock )

FsHistoryProvider initializes the internal registries and counters.

1253
ApplicationHistoryProvider

ApplicationHistoryProvider
ApplicationHistoryProvider is the base of the history providers of Spark applications.

package org.apache.spark.deploy.history

abstract class ApplicationHistoryProvider {

// only required methods that have no implementation
// the others follow
def getListing(): Iterator[ApplicationInfo]
def getAppUI(appId: String, attemptId: Option[String]): Option[LoadedAppUI]
def writeEventLogs(appId: String, attemptId: Option[String], zipStream: ZipOutputStr
eam): Unit
def getApplicationInfo(appId: String): Option[ApplicationInfo]
}

Note ApplicationHistoryProvider is a private[history] contract.

Table 1. (Subset of) ApplicationHistoryProvider Contract

Method Description
getListing

SparkUI (the UI of a Spark application)

getAppUI
Used exclusively when HistoryServer is requested for
the UI of a Spark application

writeEventLogs Writes events to a stream

getApplicationInfo

ApplicationHistoryProvider is a Scala abstract class and cannot be created directly, but

only as one of the implementations.

FsHistoryProvider is the one and only known implementation of

Note
ApplicationHistoryProvider contract in Apache Spark.

1254
HistoryServerArguments

HistoryServerArguments
HistoryServerArguments is the command-line parser for the History Server.

When HistoryServerArguments is executed with a single command-line parameter it is

assumed to be the event logs directory.

$ ./sbin/start-history-server.sh /tmp/spark-events

This is however deprecated since Spark 1.1.0 and you should see the following WARN
message in the logs:

WARN HistoryServerArguments: Setting log directory through the command line is depreca
ted as of Spark 1.1.0. Please set this through spark.history.fs.logDirectory instead.

The same WARN message shows up for --dir and -d command-line options.

--properties-file [propertiesFile] command-line option specifies the file with the custom

Spark properties.

When not specified explicitly, History Server uses the default configuration file,
Note
i.e. spark-defaults.conf.

Enable WARN logging level for

org.apache.spark.deploy.history.HistoryServerArguments logger to see what
happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.history.HistoryServerArguments=WARN

Refer to Logging.

1255
ApplicationCacheOperations

ApplicationCacheOperations
ApplicationCacheOperations is the contract of…​FIXME

package org.apache.spark.deploy.history

trait ApplicationCacheOperations {
// only required methods that have no implementation
// the others follow
def getAppUI(appId: String, attemptId: Option[String]): Option[LoadedAppUI]
def attachSparkUI(
appId: String,
attemptId: Option[String],
ui: SparkUI,
completed: Boolean): Unit
def detachSparkUI(appId: String, attemptId: Option[String], ui: SparkUI): Unit
}

Note ApplicationCacheOperations is a private[history] contract.

Table 1. (Subset of) ApplicationCacheOperations Contract

Method Description
SparkUI (the UI of a Spark application)
getAppUI
Used exclusively when ApplicationCache is requested
for loadApplicationEntry

attachSparkUI

detachSparkUI

HistoryServer is the one and only known implementation of

Note
ApplicationCacheOperations contract in Apache Spark.

1256
ApplicationCache

ApplicationCache
ApplicationCache is…​FIXME

ApplicationCache is created exclusively when HistoryServer is created.

ApplicationCache uses Google Guava 14.0.1 library for the internal appLoader.

Table 1. ApplicationCache’s Internal Properties (e.g. Registries, Counters and Flags)

Name Description
Google Guava’s CacheLoader with a custom load which
appLoader is simply loadApplicationEntry.
Used when…​FIXME

removalListener

Google Guava’s LoadingCache of CacheKey keys and

CacheEntry entries

Used when ApplicationCache is requested for the

appCache following:
Cached UI of a Spark application given appId and
attemptId IDs

FIXME (other uses)

metrics

Creating ApplicationCache Instance

ApplicationCache takes the following when created:

ApplicationCacheOperations

retainedApplications

Clock

ApplicationCache initializes the internal registries and counters.

loadApplicationEntry Internal Method

loadApplicationEntry(appId: String, attemptId: Option[String]): CacheEntry

1257
ApplicationCache

loadApplicationEntry …​FIXME

loadApplicationEntry is used exclusively when ApplicationCache is requested

Note
to load a cached entry.

Loading Cached Spark Application UI —  load Method

load(key: CacheKey): CacheEntry

load is part of Google Guava’s CacheLoader to retrieve a CacheEntry , based

Note
on a CacheKey , for LoadingCache.

load simply relays to loadApplicationEntry with the appId and attemptId of the input

CacheKey .

Requesting Cached UI of Spark Application (CacheEntry) 

—  get Method

get(appId: String, attemptId: Option[String] = None): CacheEntry

get …​FIXME

get is used exclusively when ApplicationCache is requested to execute a

Note
closure while holding an application’s UI read lock.

Executing Closure While Holding Application’s UI Read

Lock —  withSparkUI Method

withSparkUI[T](appId: String, attemptId: Option[String])(fn: SparkUI => T): T

withSparkUI …​FIXME

withSparkUI is used when HistoryServer is requested to withSparkUI and

Note
loadAppUi.

1258
Logging

Logging
Spark uses log4j for logging.

Logging Levels
The valid logging levels are log4j’s Levels (from most specific to least):

OFF (most specific, no logging)

FATAL (most specific, little data)

ERROR

WARN

INFO

DEBUG

TRACE (least specific, a lot of data)

ALL (least specific, all data)

conf/log4j.properties
You can set up the default logging for Spark shell in conf/log4j.properties . Use
conf/log4j.properties.template as a starting point.

Setting Default Log Level Programatically

Refer to Setting Default Log Level Programatically in SparkContext — Entry Point to Spark
Core.

Setting Log Levels in Spark Applications

In standalone Spark applications or while in Spark Shell session, use the following:

import org.apache.log4j.{Level, Logger}

Logger.getLogger(classOf[RackResolver]).getLevel
Logger.getLogger("org").setLevel(Level.OFF)
Logger.getLogger("akka").setLevel(Level.OFF)

1259
Logging

sbt
When running a Spark application from within sbt using run task, you can use the following
build.sbt to configure logging levels:

fork in run := true

javaOptions in run ++= Seq(
"-Dlog4j.debug=true",
"-Dlog4j.configuration=log4j.properties")
outputStrategy := Some(StdoutOutput)

With the above configuration log4j.properties file should be on CLASSPATH which can be
in src/main/resources directory (that is included in CLASSPATH by default).

When run starts, you should see the following output in sbt:

[spark-activator]> run
[info] Running StreamingApp
log4j: Trying to find [log4j.properties] using context classloader sun.misc.Launcher$A
ppClassLoader@1b6d3586.
log4j: Using URL [file:/Users/jacek/dev/oss/spark-activator/target/scala-2.11/classes/
log4j.properties] for automatic log4j configuration.
log4j: Reading configuration from URL file:/Users/jacek/dev/oss/spark-activator/target
/scala-2.11/classes/log4j.properties

Disabling Logging
Use the following conf/log4j.properties to disable logging completely:

log4j.logger.org=OFF

1260
Performance Tuning

Performance Tuning
Goal: Improve Spark’s performance where feasible.

From Investigating Spark’s performance:

measure performance bottlenecks using new metrics, including block-time analysis

a live demo of a new performance analysis tool

CPU — not I/O (network) — is often a critical bottleneck

community dogma = network and disk I/O are major bottlenecks

a TPC-DS workload, of two sizes: a 20 machine cluster with 850GB of data, and a 60
machine cluster with 2.5TB of data.

network is almost irrelevant for performance of these workloads

network optimization could only reduce job completion time by, at most, 2%

10Gbps networking hardware is likely not necessary

serialized compressed data

From Making Sense of Spark Performance - Kay Ousterhout (UC Berkeley) at Spark
Summit 2015:

reduceByKey is better

mind serialization time

impacts CPU - time to serialize and network - time to send the data over the wire

Tungsten - recent initiative from Databrics - aims at reducing CPU time

jobs become more bottlenecked by IO

1261
SparkListener — Intercepting Events from Spark Scheduler

Spark Listeners — Intercepting Events from

Spark Scheduler
SparkListener is a mechanism in Spark to intercept events from the Spark scheduler that

are emitted over the course of execution of a Spark application.

SparkListener extends SparkListenerInterface with all the callback methods being no-

op/do-nothing.

Spark relies on SparkListeners internally to manage communication between internal

components in the distributed environment for a Spark application, e.g. web UI, event
persistence (for History Server), dynamic allocation of executors, keeping track of executors
(using HeartbeatReceiver ) and others.

You can develop your own custom SparkListener and register it using
SparkContext.addSparkListener method or spark.extraListeners Spark property.

With SparkListener you can focus on Spark events of your liking and process a subset of
all scheduling events.

Developing a custom SparkListener is an excellent introduction to low-level

Tip details of Spark’s Execution Model. Check out the exercise Developing Custom
SparkListener to monitor DAGScheduler in Scala.

Enable INFO logging level for org.apache.spark.SparkContext logger to see when custom
Spark listeners are registered.

Tip INFO SparkContext: Registered listener org.apache.spark.scheduler.StatsReportListener

See SparkContext  — Entry Point to Spark (Core).

SparkListenerInterface — Internal Contract for Spark

Listeners
SparkListenerInterface is an private[spark] contract for Spark listeners to intercept

events from the Spark scheduler.

SparkListener and SparkFirehoseListener Spark listeners are direct

Note implementations of SparkListenerInterface contract to help developing more
sophisticated Spark listeners.

Table 1. SparkListenerInterface Methods (in alphabetical order)

1262
SparkListener — Intercepting Events from Spark Scheduler

Method Event Reason

onApplicationEnd SparkListenerApplicationEnd SparkContext does

postApplicationEnd

onApplicationStart SparkListenerApplicationStart SparkContext does

postApplicationStart

BlockManagerMasterEndpoint
onBlockManagerAdded SparkListenerBlockManagerAdded
registered a BlockManager

BlockManagerMasterEndpoint
onBlockManagerRemoved SparkListenerBlockManagerRemoved removed a BlockManager
is when…​FIXME)

BlockManagerMasterEndpoint
receives a UpdateBlockInfo
onBlockUpdated SparkListenerBlockUpdated (which is when BlockManager
reports a block status update to
driver).

SparkContext does
onEnvironmentUpdate SparkListenerEnvironmentUpdate
postEnvironmentUpdate

onExecutorMetricsUpdate SparkListenerExecutorMetricsUpdate

DriverEndpoint RPC endpoint (o

CoarseGrainedSchedulerBackend
receives RegisterExecutor
onExecutorAdded SparkListenerExecutorAdded message,
MesosFineGrainedSchedulerBackend
does resourceOffers
LocalSchedulerBackendEndpoint
starts.

onExecutorBlacklisted SparkListenerExecutorBlacklisted FIXME

DriverEndpoint RPC endpoint (o

CoarseGrainedSchedulerBackend
onExecutorRemoved SparkListenerExecutorRemoved does removeExecutor
MesosFineGrainedSchedulerBackend
does removeExecutor

onExecutorUnblacklisted SparkListenerExecutorUnblacklisted FIXME

DAGScheduler does
cleanUpAfterSchedulerStop
onJobEnd SparkListenerJobEnd handleTaskCompletion
failJobAndIndependentStages
markMapStageJobAsFinished.

1263
SparkListener — Intercepting Events from Spark Scheduler

DAGScheduler handles
onJobStart SparkListenerJobStart JobSubmitted and
MapStageSubmitted messages

onNodeBlacklisted SparkListenerNodeBlacklisted FIXME

onNodeUnblacklisted SparkListenerNodeUnblacklisted FIXME

DAGScheduler marks a stage as

onStageCompleted SparkListenerStageCompleted
finished.

DAGScheduler submits the

onStageSubmitted SparkListenerStageSubmitted missing tasks of a stage (in a
Spark job).

DAGScheduler handles a task

onTaskEnd SparkListenerTaskEnd
completion

DAGScheduler handles
onTaskGettingResult SparkListenerTaskGettingResult
GettingResultEvent event

DAGScheduler is informed that a

onTaskStart SparkListenerTaskStart
task is about to start.

SparkContext unpersists an RDD

onUnpersistRDD SparkListenerUnpersistRDD
i.e. removes RDD blocks from
BlockManagerMaster (that can be
triggered explicitly or

Catch-all callback that is often

onOtherEvent SparkListenerEvent used in Spark SQL to handle
custom events.

Built-In Spark Listeners

1264
SparkListener — Intercepting Events from Spark Scheduler

Table 2. Built-In Spark Listeners

Spark Listener Description

Logs JSON-encoded events to a file that can later be

EventLoggingListener
read by History Server

StatsReportListener

SparkFirehoseListener
Allows users to receive all SparkListenerEvent events
by overriding the single onEvent method only.

ExecutorAllocationListener

HeartbeatReceiver

StreamingJobProgressListener

ExecutorsListener Prepares information for Executors tab in web UI

StorageStatusListener,
RDDOperationGraphListener,
EnvironmentListener, For web UI
BlockStatusListener and
StorageListener

SpillListener

ApplicationEventListener

StreamingQueryListenerBus

SQLListener /
Support for History Server
SQLHistoryListener

StreamingListenerBus

JobProgressListener

1265
LiveListenerBus

LiveListenerBus
LiveListenerBus is used to announce application-wide events in a Spark application. It

asynchronously passes listener events to registered Spark listeners.

Figure 1. LiveListenerBus, SparkListenerEvents, and Senders

LiveListenerBus is a single-JVM SparkListenerBus that uses listenerThread to poll events.

Emitters are supposed to use post method to post SparkListenerEvent events.

The event queue is java.util.concurrent.LinkedBlockingQueue with capacity of

Note
10000 SparkListenerEvent events.

LiveListenerBus takes a SparkConf when created.

LiveListenerBus is created and started when SparkContext is initialized.

Starting LiveListenerBus  —  start method

start(sc: SparkContext): Unit

start starts processing events.

Internally, it saves the input SparkContext for later use and starts listenerThread. It makes
sure that it only happens when LiveListenerBus has not been started before (i.e. started
is disabled).

If however LiveListenerBus has already been started, a IllegalStateException is thrown:

[name] already started!

Posting SparkListenerEvent Events —  post method

1266
LiveListenerBus

post(event: SparkListenerEvent): Unit

post puts the input event onto the internal eventQueue queue and releases the internal

eventLock semaphore. If the event placement was not successful (and it could happen

since it is tapped at 10000 events) onDropEvent method is called.

The event publishing is only possible when stopped flag has been enabled.

Caution FIXME Who’s enabling the stopped flag and when/why?

If LiveListenerBus has been stopped, the following ERROR appears in the logs:

ERROR [name] has already stopped! Dropping event [event]

Event Dropped Callback —  onDropEvent method

onDropEvent(event: SparkListenerEvent): Unit

onDropEvent is called when no further events can be added to the internal eventQueue

queue (while posting a SparkListenerEvent event).

It simply prints out the following ERROR message to the logs and ensures that it happens
only once.

ERROR Dropping SparkListenerEvent because no remaining room in event queue. This likel
y means one of the SparkListeners is too slow and cannot keep up with the rate at whic
h tasks are being started by the scheduler.

Note It uses the internal logDroppedEvent atomic variable to track the state.

Stopping LiveListenerBus  —  stop method

stop(): Unit

stop releases the internal eventLock semaphore and waits until listenerThread dies. It can

only happen after all events were posted (and polling eventQueue gives nothing).

It checks that started flag is enabled (i.e. true ) and throws a IllegalStateException
otherwise.

1267
LiveListenerBus

Attempted to stop [name] that has not yet started!

stopped flag is enabled.

listenerThread for Event Polling

LiveListenerBus uses SparkListenerBus single-daemon thread that ensures that the polling

events from the event queue is only after the listener was started and only one event at a
time.

Caution FIXME There is some logic around no events in the queue.

Settings
Table 1. Spark Properties
Spark Property Default Value Description
The comma-separated list of fully-
qualified class names of Spark listeners
spark.extraListeners (empty)
that should be registered (when
SparkContext is initialized)

Registering SparkListenerInterface with Application Status

Queue —  addToStatusQueue Method

addToStatusQueue(listener: SparkListenerInterface): Unit

addToStatusQueue simply adds the SparkListenerInterface to eventLog queue.

Note addToStatusQueue is used when…​FIXME

Registering SparkListenerInterface with Queue 

—  addToQueue Method

addToQueue(listener: SparkListenerInterface, queue: String): Unit

addToQueue …​FIXME

Note addToQueue is used when…​FIXME

1268
LiveListenerBus

1269
ReplayListenerBus

ReplayListenerBus
ReplayListenerBus is a custom SparkListenerBus that can replay JSON-encoded

SparkListenerEvent events.

Note ReplayListenerBus is used in FsHistoryProvider.

ReplayListenerBus is a private[spark] class in org.apache.spark.scheduler

Note
package.

Replaying JSON-encoded SparkListenerEvents from

Stream —  replay Method

replay(
logData: InputStream,
sourceName: String,
maybeTruncated: Boolean = false): Unit

replay reads JSON-encoded SparkListenerEvent events from logData (one event per

line) and posts them to all registered SparkListenerInterface listeners.

replay uses JsonProtocol to convert JSON-encoded events to SparkListenerEvent

objects.

Note replay uses jackson from json4s library to parse the AST for JSON.

When there is an exception parsing a JSON event, you may see the following WARN
message in the logs (for the last line) or a JsonParseException .

WARN Got JsonParseException from log file $sourceName at line [lineNumber], the file m
ight not have finished writing cleanly.

Any other non-IO exceptions end up with the following ERROR messages in the logs:

ERROR Exception parsing Spark event log: [sourceName]

ERROR Malformed line #[lineNumber]: [currentLine]

Note The sourceName input argument is only used for messages.

1270
ReplayListenerBus

1271
SparkListenerBus — Internal Contract for Spark Event Buses

SparkListenerBus — Internal Contract for

Spark Event Buses
SparkListenerBus is a private[spark] ListenerBus for SparkListenerInterface listeners that

process SparkListenerEvent events.

SparkListenerBus comes with a custom doPostEvent method that simply relays

SparkListenerEvent events to appropriate SparkListenerInterface methods.

There are two custom SparkListenerBus listeners: LiveListenerBus and

Note
ReplayListenerBus.

1272
SparkListenerBus — Internal Contract for Spark Event Buses

Table 1. SparkListenerEvent to SparkListenerInterface’s Method "mapping"

SparkListenerEvent SparkListenerInterface’s Method
SparkListenerStageSubmitted onStageSubmitted

SparkListenerStageCompleted onStageCompleted

SparkListenerJobStart onJobStart

SparkListenerJobEnd onJobEnd

SparkListenerJobEnd onJobEnd

SparkListenerTaskStart onTaskStart

SparkListenerTaskGettingResult onTaskGettingResult

SparkListenerTaskEnd onTaskEnd

SparkListenerEnvironmentUpdate onEnvironmentUpdate

SparkListenerBlockManagerAdded onBlockManagerAdded

SparkListenerBlockManagerRemoved onBlockManagerRemoved

SparkListenerUnpersistRDD onUnpersistRDD

SparkListenerApplicationStart onApplicationStart

SparkListenerApplicationEnd onApplicationEnd

SparkListenerExecutorMetricsUpdate onExecutorMetricsUpdate

SparkListenerExecutorAdded onExecutorAdded

SparkListenerExecutorRemoved onExecutorRemoved

SparkListenerBlockUpdated onBlockUpdated

SparkListenerLogStart event ignored

other event types onOtherEvent

ListenerBus Event Bus Contract

ListenerBus[L <: AnyRef, E]

1273
SparkListenerBus — Internal Contract for Spark Event Buses

ListenerBus is an event bus that post events (of type E ) to all registered listeners (of type

L ).

It manages listeners of type L , i.e. it can add to and remove listeners from an internal
listeners collection.

addListener(listener: L): Unit

removeListener(listener: L): Unit

It can post events of type E to all registered listeners (using postToAll method). It simply
iterates over the internal listeners collection and executes the abstract doPostEvent
method.

doPostEvent(listener: L, event: E): Unit

Note doPostEvent is provided by more specialized ListenerBus event buses.

In case of exception while posting an event to a listener you should see the following
ERROR message in the logs and the exception.

ERROR Listener [listener] threw an exception

There are three custom ListenerBus listeners: SparkListenerBus,

Note
StreamingQueryListenerBus, and StreamingListenerBus.

Enable ERROR logging level for org.apache.spark.util.ListenerBus logger to see

what happens inside.

Add the following line to conf/log4j.properties :

Tip
log4j.logger.org.apache.spark.util.ListenerBus=ERROR

Refer to Logging.

1274
EventLoggingListener — Spark Listener for Persisting Events

EventLoggingListener — Spark Listener for

Persisting Events
EventLoggingListener is a SparkListener that persists JSON-encoded events to a file.

When event logging is enabled, EventLoggingListener writes events to a log file under
spark.eventLog.dir directory. All Spark events are logged (except
SparkListenerBlockUpdated and SparkListenerExecutorMetricsUpdate).

Tip Use Spark History Server to view the event logs in a browser.

Events can optionally be compressed.

In-flight log files are with .inprogress extension.

EventLoggingListener is a private[spark] class in org.apache.spark.scheduler package.

Enable INFO logging level for org.apache.spark.scheduler.EventLoggingListener

logger to see what happens inside EventLoggingListener .
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.scheduler.EventLoggingListener=INFO

Refer to Logging.

Creating EventLoggingListener Instance

EventLoggingListener requires an application id ( appId ), the application’s optional attempt

id ( appAttemptId ), logBaseDir , a SparkConf (as sparkConf ) and Hadoop’s Configuration

(as hadoopConf ).

When initialized with no Hadoop’s Configuration it calls

Note
SparkHadoopUtil.get.newConfiguration(sparkConf).

Starting EventLoggingListener —  start method

start(): Unit

start checks whether logBaseDir is really a directory, and if it is not, it throws a

IllegalArgumentException with the following message:

1275
EventLoggingListener — Spark Listener for Persisting Events

Log directory [logBaseDir] does not exist.

The log file’s working name is created based on appId with or without the compression
codec used and appAttemptId , i.e. local-1461696754069 . It also uses .inprogress
extension.

If overwrite is enabled, you should see the WARN message:

WARN EventLoggingListener: Event log [path] already exists. Overwriting...

The working log .inprogress is attempted to be deleted. In case it could not be deleted, the
following WARN message is printed out to the logs:

WARN EventLoggingListener: Error deleting [path]

The buffered output stream is created with metadata with Spark’s version and
SparkListenerLogStart class' name as the first line.

{"Event":"SparkListenerLogStart","Spark Version":"2.0.0-SNAPSHOT"}

At this point, EventLoggingListener is ready for event logging and you should see the
following INFO message in the logs:

INFO EventLoggingListener: Logging events to [logPath]

Note start is executed while SparkContext is created.

Logging Event as JSON —  logEvent method

logEvent(event: SparkListenerEvent, flushLogger: Boolean = false)

logEvent logs event as JSON.

Caution FIXME

Stopping EventLoggingListener —  stop method

stop(): Unit

1276
EventLoggingListener — Spark Listener for Persisting Events

stop closes PrintWriter for the log file and renames the file to be without .inprogress

extension.

If the target log file exists (one without .inprogress extension), it overwrites the file if
spark.eventLog.overwrite is enabled. You should see the following WARN message in the
logs:

WARN EventLoggingListener: Event log [target] already exists. Overwriting...

If the target log file exists and overwrite is disabled, an java.io.IOException is thrown with
the following message:

Target log file already exists ([logPath])

Note stop is executed while SparkContext is stopped.

Compressing Logged Events

If event compression is enabled, events are compressed using CompressionCodec.

Tip Refer to CompressionCodec to learn about the available compression codecs.

Settings

1277
EventLoggingListener — Spark Listener for Persisting Events

Table 1. Spark Properties

Spark Property Default Value Description

spark.eventLog.enabled false
Enables ( true ) or disables ( false )
persisting Spark events.

Directory where events are logged,

/tmp/spark-
e.g. hdfs://namenode:8021/directory .
spark.eventLog.dir
events
The directory must exist before Spark
starts up.

spark.eventLog.buffer.kb 100
Size of the buffer to use when writing
to output streams.

Enables ( true ) or disables ( false )

spark.eventLog.overwrite false deleting (or at least overwriting) an
existing .inprogress log file.

spark.eventLog.compress false
Enables ( true ) or disables ( false )
event compression.

Internal flag for testing purposes that

spark.eventLog.testing false enables adding JSON events to the
internal loggedEvents array.

1278
StatsReportListener — Logging Summary Statistics

StatsReportListener — Logging Summary
Statistics
org.apache.spark.scheduler.StatsReportListener (see the listener’s scaladoc) is a

SparkListener that logs summary statistics when each stage completes.

StatsReportListener listens to SparkListenerTaskEnd and SparkListenerStageCompleted

events and prints them out at INFO logging level.

Enable INFO logging level for org.apache.spark.scheduler.StatsReportListener

logger to see Spark events.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.scheduler.StatsReportListener=INFO

Refer to Logging.

Intercepting Stage Completed Events 

—  onStageCompleted Callback

Caution FIXME

Example

$ ./bin/spark-shell -c spark.extraListeners=org.apache.spark.scheduler.StatsReportList
ener
...
INFO SparkContext: Registered listener org.apache.spark.scheduler.StatsReportListener
...

scala> spark.read.text("README.md").count
...
INFO StatsReportListener: Finished stage: Stage(0, 0); Name: 'count at <console>:24';
Status: succeeded; numTasks: 1; Took: 212 msec
INFO StatsReportListener: task runtime:(count: 1, mean: 198.000000, stdev: 0.000000, m
ax: 198.000000, min: 198.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 198.0 ms 198.0 ms 198.0 ms 198.0
ms 198.0 ms 198.0 ms 198.0 ms 198.0 ms 198.0 ms
INFO StatsReportListener: shuffle bytes written:(count: 1, mean: 59.000000, stdev: 0.0
00000, max: 59.000000, min: 59.000000)

1279
StatsReportListener — Logging Summary Statistics

INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%

95% 100%
INFO StatsReportListener: 59.0 B 59.0 B 59.0 B 59.0 B 59.0 B 59.0 B 59.0 B
59.0 B 59.0 B
INFO StatsReportListener: fetch wait time:(count: 1, mean: 0.000000, stdev: 0.000000,
max: 0.000000, min: 0.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 0.0 ms 0.0 ms 0.0 ms 0.0 ms 0.0 ms 0.0 ms 0.0 ms
0.0 ms 0.0 ms
INFO StatsReportListener: remote bytes read:(count: 1, mean: 0.000000, stdev: 0.000000
, max: 0.000000, min: 0.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 0.0 B 0.0 B 0.0 B 0.0 B 0.0 B 0.0 B 0.0 B
0.0 B 0.0 B
INFO StatsReportListener: task result size:(count: 1, mean: 1885.000000, stdev: 0.0000
00, max: 1885.000000, min: 1885.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 1885.0 B 1885.0 B 1885.0 B 1885.0
B 1885.0 B 1885.0 B 1885.0 B 1885.0 B 1885.0 B
INFO StatsReportListener: executor (non-fetch) time pct: (count: 1, mean: 73.737374, s
tdev: 0.000000, max: 73.737374, min: 73.737374)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 74 % 74 % 74 % 74 % 74 % 74 % 74 %
74 % 74 %
INFO StatsReportListener: fetch wait time pct: (count: 1, mean: 0.000000, stdev: 0.000
000, max: 0.000000, min: 0.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 0 % 0 % 0 % 0 % 0 % 0 % 0 %
0 % 0 %
INFO StatsReportListener: other time pct: (count: 1, mean: 26.262626, stdev: 0.000000,
max: 26.262626, min: 26.262626)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 26 % 26 % 26 % 26 % 26 % 26 % 26 %
26 % 26 %
INFO StatsReportListener: Finished stage: Stage(1, 0); Name: 'count at <console>:24';
Status: succeeded; numTasks: 1; Took: 34 msec
INFO StatsReportListener: task runtime:(count: 1, mean: 33.000000, stdev: 0.000000, ma
x: 33.000000, min: 33.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 33.0 ms 33.0 ms 33.0 ms 33.0 ms 33.0 ms 33.0 ms 33.0 m
s 33.0 ms 33.0 ms
INFO StatsReportListener: shuffle bytes written:(count: 1, mean: 0.000000, stdev: 0.00
0000, max: 0.000000, min: 0.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 0.0 B 0.0 B 0.0 B 0.0 B 0.0 B 0.0 B 0.0 B

1280
StatsReportListener — Logging Summary Statistics

0.0 B 0.0 B
INFO StatsReportListener: fetch wait time:(count: 1, mean: 0.000000, stdev: 0.000000,
max: 0.000000, min: 0.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 0.0 ms 0.0 ms 0.0 ms 0.0 ms 0.0 ms 0.0 ms 0.0 ms
0.0 ms 0.0 ms
INFO StatsReportListener: remote bytes read:(count: 1, mean: 0.000000, stdev: 0.000000
, max: 0.000000, min: 0.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 0.0 B 0.0 B 0.0 B 0.0 B 0.0 B 0.0 B 0.0 B
0.0 B 0.0 B
INFO StatsReportListener: task result size:(count: 1, mean: 1960.000000, stdev: 0.0000
00, max: 1960.000000, min: 1960.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 1960.0 B 1960.0 B 1960.0 B 1960.0
B 1960.0 B 1960.0 B 1960.0 B 1960.0 B 1960.0 B
INFO StatsReportListener: executor (non-fetch) time pct: (count: 1, mean: 75.757576, s
tdev: 0.000000, max: 75.757576, min: 75.757576)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 76 % 76 % 76 % 76 % 76 % 76 % 76 %
76 % 76 %
INFO StatsReportListener: fetch wait time pct: (count: 1, mean: 0.000000, stdev: 0.000
000, max: 0.000000, min: 0.000000)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 0 % 0 % 0 % 0 % 0 % 0 % 0 %
0 % 0 %
INFO StatsReportListener: other time pct: (count: 1, mean: 24.242424, stdev: 0.000000,
max: 24.242424, min: 24.242424)
INFO StatsReportListener: 0% 5% 10% 25% 50% 75% 90%
95% 100%
INFO StatsReportListener: 24 % 24 % 24 % 24 % 24 % 24 % 24 %
24 % 24 %
res0: Long = 99

1281
JsonProtocol

JsonProtocol
Caution FIXME

taskInfoFromJson Method

Caution FIXME

taskMetricsFromJson Method

Caution FIXME

taskMetricsToJson Method

Caution FIXME

sparkEventFromJson Method

Caution FIXME

1282
Debugging Spark

Debugging Spark
Using spark-shell and IntelliJ IDEA
Start spark-shell with SPARK_SUBMIT_OPTS environment variable that configures the JVM’s
JDWP.

SPARK_SUBMIT_OPTS="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005"
./bin/spark-shell

Attach IntelliJ IDEA to the JVM process using Run > Attach to Local Process menu.

Using sbt
Use sbt -jvm-debug 5005 , connect to the remote JVM at the port 5005 using IntelliJ IDEA,
place breakpoints on the desired lines of the source code of Spark.

➜ sparkme-app sbt -jvm-debug 5005

Listening for transport dt_socket at address: 5005
...

Run Spark context and the breakpoints get triggered.

scala> val sc = new SparkContext(conf)

15/11/14 22:58:46 INFO SparkContext: Running Spark version 1.6.0-SNAPSHOT

Tip Read Debugging chapter in IntelliJ IDEA 15.0 Help.

1283
Building Apache Spark from Sources

Building Apache Spark from Sources

You can download pre-packaged versions of Apache Spark from the project’s web site. The
packages are built for a different Hadoop versions for Scala 2.11.

Since [SPARK-6363][BUILD] Make Scala 2.11 the default Scala version the
Note
default version of Scala in Apache Spark is 2.11.

The build process for Scala 2.11 takes less than 15 minutes (on a decent machine like my
shiny MacBook Pro with 8 cores and 16 GB RAM) and is so simple that it’s unlikely to refuse
the urge to do it yourself.

You can use sbt or Maven as the build command.

Using sbt as the build tool

The build command with sbt as the build tool is as follows:

./build/sbt -Phadoop-2.7,yarn,mesos,hive,hive-thriftserver -DskipTests clean assembly

Using Java 8 to build Spark using sbt takes ca 10 minutes.

➜ spark git:(master) ✗ ./build/sbt -Phadoop-2.7,yarn,mesos,hive,hive-thriftserver -Ds

kipTests clean assembly
...
[success] Total time: 496 s, completed Dec 7, 2015 8:24:41 PM

Build Profiles

Caution FIXME Describe yarn profile and others

hive-thriftserver Maven profile for Spark Thrift Server

Caution FIXME

Tip Read Thrift JDBC/ODBC Server — Spark Thrift Server (STS).

Using Apache Maven as the build tool

The build command with Apache Maven is as follows:

1284
Building Apache Spark from Sources

$ ./build/mvn -Phadoop-2.7,yarn,mesos,hive,hive-thriftserver -DskipTests clean install

After a couple of minutes your freshly baked distro is ready to fly!

I’m using Oracle Java 8 to build Spark.

➜ spark git:(master) ✗ java -version

java version "1.8.0_102"
Java(TM) SE Runtime Environment (build 1.8.0_102-b14)
Java HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)

➜ spark git:(master) ✗ ./build/mvn -Phadoop-2.7,yarn,mesos,hive,hive-thriftserver -Ds

kipTests clean install
Java HotSpot(TM) 64-Bit Server VM warning: ignoring option MaxPermSize=512M; support w
as removed in 8.0
Using `mvn` from path: /usr/local/bin/mvn
Java HotSpot(TM) 64-Bit Server VM warning: ignoring option MaxPermSize=512M; support w
as removed in 8.0
[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Build Order:
[INFO]
[INFO] Spark Project Parent POM
[INFO] Spark Project Tags
[INFO] Spark Project Sketch
[INFO] Spark Project Networking
[INFO] Spark Project Shuffle Streaming Service
[INFO] Spark Project Unsafe
[INFO] Spark Project Launcher
[INFO] Spark Project Core
[INFO] Spark Project GraphX
[INFO] Spark Project Streaming
[INFO] Spark Project Catalyst
[INFO] Spark Project SQL
[INFO] Spark Project ML Local Library
[INFO] Spark Project ML Library
[INFO] Spark Project Tools
[INFO] Spark Project Hive
[INFO] Spark Project REPL
[INFO] Spark Project YARN Shuffle Service
[INFO] Spark Project YARN
[INFO] Spark Project Hive Thrift Server
[INFO] Spark Project Assembly
[INFO] Spark Project External Flume Sink
[INFO] Spark Project External Flume
[INFO] Spark Project External Flume Assembly
[INFO] Spark Integration for Kafka 0.8
[INFO] Spark Project Examples
[INFO] Spark Project External Kafka Assembly
[INFO] Spark Integration for Kafka 0.10
[INFO] Spark Integration for Kafka 0.10 Assembly

1285
Building Apache Spark from Sources

[INFO] Spark Project Java 8 Tests

[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Spark Project Parent POM 2.0.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
...
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] Spark Project Parent POM ........................... SUCCESS [ 4.186 s]
[INFO] Spark Project Tags ................................. SUCCESS [ 4.893 s]
[INFO] Spark Project Sketch ............................... SUCCESS [ 5.066 s]
[INFO] Spark Project Networking ........................... SUCCESS [ 11.108 s]
[INFO] Spark Project Shuffle Streaming Service ............ SUCCESS [ 7.051 s]
[INFO] Spark Project Unsafe ............................... SUCCESS [ 7.650 s]
[INFO] Spark Project Launcher ............................. SUCCESS [ 9.905 s]
[INFO] Spark Project Core ................................. SUCCESS [02:09 min]
[INFO] Spark Project GraphX ............................... SUCCESS [ 19.317 s]
[INFO] Spark Project Streaming ............................ SUCCESS [ 42.077 s]
[INFO] Spark Project Catalyst ............................. SUCCESS [01:32 min]
[INFO] Spark Project SQL .................................. SUCCESS [01:47 min]
[INFO] Spark Project ML Local Library ..................... SUCCESS [ 10.049 s]
[INFO] Spark Project ML Library ........................... SUCCESS [01:36 min]
[INFO] Spark Project Tools ................................ SUCCESS [ 3.520 s]
[INFO] Spark Project Hive ................................. SUCCESS [ 52.528 s]
[INFO] Spark Project REPL ................................. SUCCESS [ 7.243 s]
[INFO] Spark Project YARN Shuffle Service ................. SUCCESS [ 7.898 s]
[INFO] Spark Project YARN ................................. SUCCESS [ 15.380 s]
[INFO] Spark Project Hive Thrift Server ................... SUCCESS [ 24.876 s]
[INFO] Spark Project Assembly ............................. SUCCESS [ 2.971 s]
[INFO] Spark Project External Flume Sink .................. SUCCESS [ 7.377 s]
[INFO] Spark Project External Flume ....................... SUCCESS [ 10.752 s]
[INFO] Spark Project External Flume Assembly .............. SUCCESS [ 1.695 s]
[INFO] Spark Integration for Kafka 0.8 .................... SUCCESS [ 13.013 s]
[INFO] Spark Project Examples ............................. SUCCESS [ 31.728 s]
[INFO] Spark Project External Kafka Assembly .............. SUCCESS [ 3.472 s]
[INFO] Spark Integration for Kafka 0.10 ................... SUCCESS [ 12.297 s]
[INFO] Spark Integration for Kafka 0.10 Assembly .......... SUCCESS [ 3.789 s]
[INFO] Spark Project Java 8 Tests ......................... SUCCESS [ 4.267 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 12:29 min
[INFO] Finished at: 2016-07-07T22:29:56+02:00
[INFO] Final Memory: 110M/913M
[INFO] ------------------------------------------------------------------------

Please note the messages that say the version of Spark (Building Spark Project Parent POM
2.0.0-SNAPSHOT), Scala version (maven-clean-plugin:2.6.1:clean (default-clean) @ spark-
parent_2.11) and the Spark modules built.

1286
Building Apache Spark from Sources

The above command gives you the latest version of Apache Spark 2.0.0-SNAPSHOT built
for Scala 2.11.8 (see the configuration of scala-2.11 profile).

Tip You can also know the version of Spark using ./bin/spark-shell --version .

Making Distribution
./make-distribution.sh is the shell script to make a distribution. It uses the same profiles as

for sbt and Maven.

Use --tgz option to have a tar gz version of the Spark distribution.

➜ spark git:(master) ✗ ./make-distribution.sh --tgz -Phadoop-2.7,yarn,mesos,hive,hive

-thriftserver -DskipTests

Once finished, you will have the distribution in the current directory, i.e. spark-2.0.0-
SNAPSHOT-bin-2.7.2.tgz .

1287
Spark and Hadoop

Spark and Hadoop

Hadoop Storage Formats
The currently-supported Hadoop storage formats typically used with HDFS are:

Parquet

RCfile

Avro

ORC

FIXME What are the differences between the formats and how are they used
Caution
in Spark.

Introduction to Hadoop

This page is the place to keep information more general about Hadoop and not
Note related to Spark on YARN or files Using Input and Output (I/O) (HDFS). I don’t
really know what it could be, though. Perhaps nothing at all. Just saying.

From Apache Hadoop's web site:

The Apache Hadoop software library is a framework that allows for the distributed
processing of large data sets across clusters of computers using simple programming
models. It is designed to scale up from single servers to thousands of machines, each
offering local computation and storage. Rather than rely on hardware to deliver high-
availability, the library itself is designed to detect and handle failures at the application
layer, so delivering a highly-available service on top of a cluster of computers, each of
which may be prone to failures.

Originally, Hadoop is an umbrella term for the following (core) modules:

HDFS (Hadoop Distributed File System) is a distributed file system designed to run
on commodity hardware. It is a data storage with files split across a cluster.

MapReduce - the compute engine for batch processing

YARN (Yet Another Resource Negotiator) - the resource manager

Currently, it’s more about the ecosystem of solutions that all use Hadoop infrastructure
for their work.

1288
Spark and Hadoop

People reported to do wonders with the software with Yahoo! saying:

Yahoo has progressively invested in building and scaling Apache Hadoop clusters with
a current footprint of more than 40,000 servers and 600 petabytes of storage spread
across 19 clusters.

Beside numbers Yahoo! reported that:

Deep learning can be defined as first-class steps in Apache Oozie workflows with
Hadoop for data processing and Spark pipelines for machine learning.

You can find some preliminary information about Spark pipelines for machine learning in
the chapter ML Pipelines.

HDFS provides fast analytics – scanning over large amounts of data very quickly, but it was
not built to handle updates. If data changed, it would need to be appended in bulk after a
certain volume or time interval, preventing real-time visibility into this data.

HBase complements HDFS’ capabilities by providing fast and random reads and writes
and supporting updating data, i.e. serving small queries extremely quickly, and allowing
data to be updated in place.

From How does partitioning work for data from files on HDFS?:

When Spark reads a file from HDFS, it creates a single partition for a single input split.
Input split is set by the Hadoop InputFormat used to read this file. For instance, if you
use textFile() it would be TextInputFormat in Hadoop, which would return you a
single partition for a single block of HDFS (but the split between partitions would be
done on line split, not the exact block split), unless you have a compressed text file. In
case of compressed file you would get a single partition for a single file (as compressed
text files are not splittable).

If you have a 30GB uncompressed text file stored on HDFS, then with the default HDFS
block size setting (128MB) it would be stored in 235 blocks, which means that the RDD
you read from this file would have 235 partitions. When you call repartition(1000) your
RDD would be marked as to be repartitioned, but in fact it would be shuffled to 1000
partitions only when you will execute an action on top of this RDD (lazy execution
concept)

With HDFS you can store any data (regardless of format and size). It can easily handle
unstructured data like video or other binary files as well as semi- or fully-structured data
like CSV files or databases.

There is the concept of data lake that is a huge data repository to support analytics.

1289
Spark and Hadoop

HDFS partition files into so called splits and distributes them across multiple nodes in a
cluster to achieve fail-over and resiliency.

MapReduce happens in three phases: Map, Shuffle, and Reduce.

Further reading
Introducing Kudu: The New Hadoop Storage Engine for Fast Analytics on Fast Data

1290
SparkHadoopUtil

SparkHadoopUtil
Enable DEBUG logging level for org.apache.spark.deploy.SparkHadoopUtil logger
to see what happens inside.
Add the following line to conf/log4j.properties :
Tip
log4j.logger.org.apache.spark.deploy.SparkHadoopUtil=DEBUG

Refer to Logging.

Creating SparkHadoopUtil Instance —  get Method

Caution FIXME

substituteHadoopVariables Method

Caution FIXME

transferCredentials Method

Caution FIXME

newConfiguration Method

Caution FIXME

conf Method

Caution FIXME

stopCredentialUpdater Method

Caution FIXME

Running Executable Block As Spark User 

—  runAsSparkUser Method

1291
SparkHadoopUtil

runAsSparkUser(func: () => Unit)

runAsSparkUser runs func function with Hadoop’s UserGroupInformation of the current

user as a thread local variable (and distributed to child threads). It is later used for
authenticating HDFS and YARN calls.

Internally, runAsSparkUser reads the current username (as SPARK_USER environment

variable or the short user name from Hadoop’s UserGroupInformation ).

Caution FIXME How to use SPARK_USER to change the current user name?

You should see the current username printed out in the following DEBUG message in the
logs:

DEBUG YarnSparkHadoopUtil: running as user: [user]

It then creates a remote user for the current user (using

UserGroupInformation.createRemoteUser ), transfers credential tokens and runs the input

func function as the privileged user.

1292
Spark and software in-memory file systems

Spark and software in-memory file systems

It appears that there are a few open source projects that can boost performance of any in-
memory shared state, akin to file system, including RDDs - Tachyon, Apache Ignite, and
Apache Geode.

From tachyon project’s website:

Tachyon is designed to function as a software file system that is compatible with the
HDFS interface prevalent in the big data analytics space. The point of doing this is that
it can be used as a drop in accelerator rather than having to adapt each framework to
use a distributed caching layer explicitly.

From Spark Shared RDDs:

Apache Ignite provides an implementation of Spark RDD abstraction which allows to

easily share state in memory across multiple Spark jobs, either within the same
application or between different Spark applications.

There’s another similar open source project Apache Geode.

1293
Spark and The Others

Spark and The Others

The others are the ones that are similar to Spark, but as I haven’t yet exactly figured out
where and how, they are here.

Note I’m going to keep the noise (enterprisey adornments) to the very minimum.

Ceph is a unified, distributed storage system.

Apache Twill is an abstraction over Apache Hadoop YARN that allows you to use
YARN’s distributed capabilities with a programming model that is similar to running
threads.

1294
Distributed Deep Learning on Spark

Distributed Deep Learning on Spark (using

Yahoo’s Caffe-on-Spark)
Read the article Large Scale Distributed Deep Learning on Hadoop Clusters to learn about
Distributed Deep Learning using Caffe-on-Spark:

To enable deep learning on these enhanced Hadoop clusters, we developed a

comprehensive distributed solution based upon open source software libraries, Apache
Spark and Caffe. One can now submit deep learning jobs onto a (Hadoop YARN)
cluster of GPU nodes (using spark-submit ).

Caffe-on-Spark is a result of Yahoo’s early steps in bringing Apache Hadoop ecosystem

and deep learning together on the same heterogeneous (GPU+CPU) cluster that may
be open sourced depending on interest from the community.

In the comments to the article, some people announced their plans of using it with AWS
GPU cluster.

1295
Spark Packages

Spark Packages
Spark Packages is a community index of packages for Apache Spark.

Spark Packages is a community site hosting modules that are not part of Apache Spark. It
offers packages for reading different files formats (than those natively supported by Spark)
or from NoSQL databases like Cassandra, code testing, etc.

When you want to include a Spark package in your application, you should be using --
packages command line option.

1296
Interactive Notebooks

Interactive Notebooks
This document aims at presenting and eventually supporting me to select the open-source
web-based visualisation tool for Apache Spark with Scala 2.11 support.

Requirements
1. Support for Apache Spark 2.0

2. Support for Scala 2.11 (the default Scala version for Spark 2.0)

3. Web-based

4. Open Source with [ASL 2.0](http://www.apache.org/licenses/LICENSE-2.0) or similar

license

5. Notebook Sharing using GitHub

6. Active Development and Community (the number of commits per week and month,
github, gitter)

7. Autocompletion

Optional Requirements:

1. Sharing SparkContext

Candidates
Apache Zeppelin

Spark Notebook

Beaker

Jupyter Notebook

Jupyter Scala - Lightweight Scala kernel for Jupyter Notebook

Apache Toree

Jupyter Notebook
You can combine code execution, rich text, mathematics, plots and rich media

1297
Interactive Notebooks

Jupyter Notebook (formerly known as the IPython Notebook)- open source, interactive
data science and scientific computational environment supporting over 40 programming
languages.

Further reading or watching

(Quora) Is there a preference in the data science/analyst community between the
iPython Spark notebook and Zeppelin? It looks like both support Scala, Python and
SQL. What are the shortcomings of one vs the other?

1298
Apache Zeppelin

Apache Zeppelin
Apache Zeppelin is a web-based notebook platform that enables interactive data analytics
with interactive data visualizations and notebook sharing. You can make data-driven,
interactive and collaborative documents with SQL, Scala, Python, R in a single notebook
document.

It shares a single SparkContext between languages (so you can pass data between Scala
and Python easily).

This is an excellent tool for prototyping Scala/Spark code with SQL queries to analyze data
(by data visualizations) that could be used by non-Scala developers like data analysts using
SQL and Python.

Zeppelin aims at more analytics and business people (not necessarily for
Note
Spark/Scala developers for whom Spark Notebook may appear a better fit).

Clients talk to the Zeppelin Server using HTTP REST or Websocket endpoints.

Available basic and advanced display systems:

text (default)

HTML

table

Angular

Features
1. Apache License 2.0 licensed

2. Interactive

3. Web-Based

4. Data Visualization (charts)

5. Collaboration by Sharing Notebooks and Paragraphs

6. Multiple Language and Data Processing Backends called Interpreters, including the
built-in Apache Spark integration, Apache Flink, Apache Hive, Apache Cassandra,
Apache Tajo, Apache Phoenix, Apache Ignite, Apache Geode

7. Display Systems

1299
Apache Zeppelin

8. Built-in Scheduler to run notebooks with cron expression

Further reading or watching

1. (video) Data Science Lifecycle with Zeppelin and Spark from Spark Summit Europe
2015 with the creator of the Apache Zeppelin project — Moon soo Lee.

1300
Spark Notebook

Spark Notebook
Spark Notebook is a Scala-centric tool for interactive and reactive data science using
Apache Spark.

This is an excellent tool for prototyping Scala/Spark code with SQL queries to analyze data
(by data visualizations). It seems to have more advanced data visualizations (comparing to
Apache Zeppelin), and seems rather focused on Scala, SQL and Apache Spark.

It can visualize the output of SQL queries directly as tables and charts (which Apache
Zeppelin cannot yet).

Spark Notebook is best suited for Spark/Scala developers. Less development-

Note
oriented people may likely find Apache Zeppelin a better fit.

1301
Spark Tips and Tricks

Spark Tips and Tricks

Print Launch Command of Spark Scripts
SPARK_PRINT_LAUNCH_COMMAND environment variable controls whether the Spark launch

command is printed out to the standard error output, i.e. System.err , or not.

Spark Command: [here comes the command]

========================================

All the Spark shell scripts use org.apache.spark.launcher.Main class internally that checks
SPARK_PRINT_LAUNCH_COMMAND and when set (to any value) will print out the entire command

line to launch it.

$ SPARK_PRINT_LAUNCH_COMMAND=1 ./bin/spark-shell
Spark Command: /Library/Java/JavaVirtualMachines/Current/Contents/Home/bin/java -cp /U
sers/jacek/dev/oss/spark/conf/:/Users/jacek/dev/oss/spark/assembly/target/scala-2.11/s
park-assembly-1.6.0-SNAPSHOT-hadoop2.7.1.jar:/Users/jacek/dev/oss/spark/lib_managed/ja
rs/datanucleus-api-jdo-3.2.6.jar:/Users/jacek/dev/oss/spark/lib_managed/jars/datanucle
us-core-3.2.10.jar:/Users/jacek/dev/oss/spark/lib_managed/jars/datanucleus-rdbms-3.2.9
.jar -Dscala.usejavacp=true -Xms1g -Xmx1g org.apache.spark.deploy.SparkSubmit --master
spark://localhost:7077 --class org.apache.spark.repl.Main --name Spark shell spark-sh
ell
========================================

Show Spark version in Spark shell

In spark-shell, use sc.version or org.apache.spark.SPARK_VERSION to know the Spark
version:

scala> sc.version
res0: String = 1.6.0-SNAPSHOT

scala> org.apache.spark.SPARK_VERSION
res1: String = 1.6.0-SNAPSHOT

Resolving local host name

When you face networking issues when Spark can’t resolve your local hostname or IP
address, use the preferred SPARK_LOCAL_HOSTNAME environment variable as the custom host
name or SPARK_LOCAL_IP as the custom IP that is going to be later resolved to a hostname.

1302
Spark Tips and Tricks

Spark checks them out before using java.net.InetAddress.getLocalHost() (consult

org.apache.spark.util.Utils.findLocalInetAddress() method).

You may see the following WARN messages in the logs when Spark finished the resolving
process:

WARN Your hostname, [hostname] resolves to a loopback address: [host-address]; using..

.
WARN Set SPARK_LOCAL_IP if you need to bind to another address

Starting standalone Master and workers on Windows 7

Windows 7 users can use spark-class to start Spark Standalone as there are no launch
scripts for the Windows platform.

$ ./bin/spark-class org.apache.spark.deploy.master.Master -h localhost

$ ./bin/spark-class org.apache.spark.deploy.worker.Worker spark://localhost:7077

1303
Access private members in Scala in Spark shell

Access private members in Scala in Spark

shell
If you ever wanted to use private[spark] members in Spark using the Scala programming
language, e.g. toy with org.apache.spark.scheduler.DAGScheduler or similar, you will have to
use the following trick in Spark shell - use :paste -raw as described in REPL: support for
package definition.

Open spark-shell and execute :paste -raw that allows you to enter any valid Scala code,
including package .

The following snippet shows how to access private[spark] member

DAGScheduler.RESUBMIT_TIMEOUT :

scala> :paste -raw

// Entering paste mode (ctrl-D to finish)

package org.apache.spark

object spark {
def test = {
import org.apache.spark.scheduler._
println(DAGScheduler.RESUBMIT_TIMEOUT == 200)
}
}

scala> spark.test
true

scala> sc.version
res0: String = 1.6.0-SNAPSHOT

1304
SparkException: Task not serializable

org.apache.spark.SparkException: Task not

serializable
When you run into org.apache.spark.SparkException: Task not serializable exception, it
means that you use a reference to an instance of a non-serializable class inside a
transformation. See the following example:

➜ spark git:(master) ✗ ./bin/spark-shell

Welcome to
____ __
/ __/__ ___ _____/ /__
_\ \/ _ \/ _ `/ __/ '_/
/___/ .__/\_,_/_/ /_/\_\ version 1.6.0-SNAPSHOT
/_/

Using Scala version 2.11.7 (Java HotSpot(TM) 64-Bit Server VM, Java 1.8.0_66)
Type in expressions to have them evaluated.
Type :help for more information.

scala> class NotSerializable(val num: Int)

defined class NotSerializable

scala> val notSerializable = new NotSerializable(10)

notSerializable: NotSerializable = NotSerializable@2700f556

scala> sc.parallelize(0 to 10).map(_ => notSerializable.num).count

org.apache.spark.SparkException: Task not serializable
at org.apache.spark.util.ClosureCleaner$.ensureSerializable(ClosureCleaner.scala:304
)
at org.apache.spark.util.ClosureCleaner$.org$apache$spark$util$ClosureCleaner$$clean
(ClosureCleaner.scala:294)
at org.apache.spark.util.ClosureCleaner$.clean(ClosureCleaner.scala:122)
at org.apache.spark.SparkContext.clean(SparkContext.scala:2055)
at org.apache.spark.rdd.RDD$$anonfun$map$1.apply(RDD.scala:318)
at org.apache.spark.rdd.RDD$$anonfun$map$1.apply(RDD.scala:317)
at org.apache.spark.rdd.RDDOperationScope$.withScope(RDDOperationScope.scala:150)
at org.apache.spark.rdd.RDDOperationScope$.withScope(RDDOperationScope.scala:111)
at org.apache.spark.rdd.RDD.withScope(RDD.scala:310)
at org.apache.spark.rdd.RDD.map(RDD.scala:317)
... 48 elided
Caused by: java.io.NotSerializableException: NotSerializable
Serialization stack:
- object not serializable (class: NotSerializable, value: NotSerializable@2700
f556)
- field (class: $iw, name: notSerializable, type: class NotSerializable)
- object (class $iw, $iw@10e542f3)
- field (class: $iw, name: $iw, type: class $iw)
- object (class $iw, $iw@729feae8)

1305
SparkException: Task not serializable

- field (class: $iw, name: $iw, type: class $iw)

- object (class $iw, $iw@5fc3b20b)
- field (class: $iw, name: $iw, type: class $iw)
- object (class $iw, $iw@36dab184)
- field (class: $iw, name: $iw, type: class $iw)
- object (class $iw, $iw@5eb974)
- field (class: $iw, name: $iw, type: class $iw)
- object (class $iw, $iw@79c514e4)
- field (class: $iw, name: $iw, type: class $iw)
- object (class $iw, $iw@5aeaee3)
- field (class: $iw, name: $iw, type: class $iw)
- object (class $iw, $iw@2be9425f)
- field (class: $line18.$read, name: $iw, type: class $iw)
- object (class $line18.$read, $line18.$read@6311640d)
- field (class: $iw, name: $line18$read, type: class $line18.$read)
- object (class $iw, $iw@c9cd06e)
- field (class: $iw, name: $outer, type: class $iw)
- object (class $iw, $iw@6565691a)
- field (class: $anonfun$1, name: $outer, type: class $iw)
- object (class $anonfun$1, <function1>)
at org.apache.spark.serializer.SerializationDebugger$.improveException(Serialization
Debugger.scala:40)
at org.apache.spark.serializer.JavaSerializationStream.writeObject(JavaSerializer.sc
ala:47)
at org.apache.spark.serializer.JavaSerializerInstance.serialize(JavaSerializer.scala
:101)
at org.apache.spark.util.ClosureCleaner$.ensureSerializable(ClosureCleaner.scala:301
)
... 57 more

Further reading
Job aborted due to stage failure: Task not serializable

Add utility to help with NotSerializableException debugging

Task not serializable: java.io.NotSerializableException when calling function outside

closure only on classes not objects

1306
Running Spark Applications on Windows

Running Spark Applications on Windows

Running Spark applications on Windows in general is no different than running it on other
operating systems like Linux or macOS.

Note A Spark application could be spark-shell or your own custom Spark application.

What makes the huge difference between the operating systems is Hadoop that is used
internally for file system access in Spark.

You may run into few minor issues when you are on Windows due to the way Hadoop works
with Windows' POSIX-incompatible NTFS filesystem.

You do not have to install Apache Hadoop to work with Spark or run Spark
Note
applications.

Tip Read the Apache Hadoop project’s Problems running Hadoop on Windows.

Among the issues is the infamous java.io.IOException when running Spark Shell (below a
stacktrace from Spark 2.0.2 on Windows 10 so the line numbers may be different in your
case).

16/12/26 21:34:11 ERROR Shell: Failed to locate the winutils binary in the hadoop bina
ry path
java.io.IOException: Could not locate executable null\bin\winutils.exe in the Hadoop b
inaries.
at org.apache.hadoop.util.Shell.getQualifiedBinPath(Shell.java:379)
at org.apache.hadoop.util.Shell.getWinUtilsPath(Shell.java:394)
at org.apache.hadoop.util.Shell.<clinit>(Shell.java:387)
at org.apache.hadoop.hive.conf.HiveConf$ConfVars.findHadoopBinary(HiveConf.java:2327
)
at org.apache.hadoop.hive.conf.HiveConf$ConfVars.<clinit>(HiveConf.java:365)
at org.apache.hadoop.hive.conf.HiveConf.<clinit>(HiveConf.java:105)
at java.lang.Class.forName0(Native Method)
at java.lang.Class.forName(Class.java:348)
at org.apache.spark.util.Utils$.classForName(Utils.scala:228)
at org.apache.spark.sql.SparkSession$.hiveClassesArePresent(SparkSession.scala:963)
at org.apache.spark.repl.Main$.createSparkSession(Main.scala:91)

You need to have Administrator rights on your laptop. All the following
commands must be executed in a command-line window ( cmd ) ran as
Administrator, i.e. using Run as administrator option while executing cmd .
Note
Read the official document in Microsoft TechNet — Start a Command Prompt as
an Administrator.

1307
Running Spark Applications on Windows

Download winutils.exe binary from https://github.com/steveloughran/winutils repository.

You should select the version of Hadoop the Spark distribution was compiled
Note with, e.g. use hadoop-2.7.1 for Spark 2 (here is the direct link to winutils.exe
binary).

Save winutils.exe binary to a directory of your choice, e.g. c:\hadoop\bin .

Set HADOOP_HOME to reflect the directory with winutils.exe (without bin ).

set HADOOP_HOME=c:\hadoop

Set PATH environment variable to include %HADOOP_HOME%\bin as follows:

set PATH=%HADOOP_HOME%\bin;%PATH%

Define HADOOP_HOME and PATH environment variables in Control Panel so any

Tip
Windows program would use them.

Create C:\tmp\hive directory.

c:\tmp\hive directory is the default value of hive.exec.scratchdir

configuration property in Hive 0.14.0 and later and Spark uses a custom build of
Hive 1.2.1.
Note
You can change hive.exec.scratchdir configuration property to another
directory as described in Changing hive.exec.scratchdir Configuration
Property in this document.

Execute the following command in cmd that you started using the option Run as
administrator.

winutils.exe chmod -R 777 C:\tmp\hive

Check the permissions (that is one of the commands that are executed under the covers):

winutils.exe ls -F C:\tmp\hive

Open spark-shell and observe the output (perhaps with few WARN messages that you
can simply disregard).

As a verification step, execute the following line to display the content of a DataFrame :

1308
Running Spark Applications on Windows

scala> spark.range(1).withColumn("status", lit("All seems fine. Congratulations!")).sh

ow(false)
+---+--------------------------------+
|id |status |
+---+--------------------------------+
|0 |All seems fine. Congratulations!|
+---+--------------------------------+

Disregard WARN messages when you start spark-shell . They are harmless.

16/12/26 22:05:41 WARN General: Plugin (Bundle) "org.datanucleus" is already registered. En

the same plugin in the classpath. The URL "file:/C:/spark-2.0.2-bin-hadoop2.7/jars/datanucl
and you are trying to register an identical plugin located at URL "file:/C:/spark-2.0.2-bin
3.2.10.jar."
16/12/26 22:05:41 WARN General: Plugin (Bundle) "org.datanucleus.api.jdo" is already regist
Note versions of the same plugin in the classpath. The URL "file:/C:/spark-2.0.2-bin-hadoop2.7/j
registered, and you are trying to register an identical plugin located at URL "file:/C:/spa
hadoop2.7/bin/../jars/datanucleus-api-jdo-3.2.6.jar."
16/12/26 22:05:41 WARN General: Plugin (Bundle) "org.datanucleus.store.rdbms" is already re
versions of the same plugin in the classpath. The URL "file:/C:/spark-2.0.2-bin-hadoop2.7/b
already registered, and you are trying to register an identical plugin located at URL "file
hadoop2.7/jars/datanucleus-rdbms-3.2.9.jar."

If you see the above output, you’re done. You should now be able to run Spark applications
on your Windows. Congrats!

Changing hive.exec.scratchdir Configuration

Property
Create a hive-site.xml file with the following content:

<configuration>
<property>
<name>hive.exec.scratchdir</name>
<value>/tmp/mydir</value>
<description>Scratch space for Hive jobs</description>
</property>
</configuration>

Start a Spark application, e.g. spark-shell , with HADOOP_CONF_DIR environment variable set
to the directory with hive-site.xml .

HADOOP_CONF_DIR=conf ./bin/spark-shell

1309
Running Spark Applications on Windows

1310
One-liners using PairRDDFunctions

Exercise: One-liners using PairRDDFunctions

This is a set of one-liners to give you a entry point into using PairRDDFunctions.

Exercise
How would you go about solving a requirement to pair elements of the same key and
creating a new RDD out of the matched values?

val users = Seq((1, "user1"), (1, "user2"), (2, "user1"), (2, "user3"), (3,"user2"), (3
,"user4"), (3,"user1"))

// Input RDD
val us = sc.parallelize(users)

// ...your code here

// Desired output
Seq("user1","user2"),("user1","user3"),("user1","user4"),("user2","user4"))

1311
Learning Jobs and Partitions Using take Action

Exercise: Learning Jobs and Partitions Using

take Action
The exercise aims for introducing take action and using spark-shell and web UI. It
should introduce you to the concepts of partitions and jobs.

The following snippet creates an RDD of 16 elements with 16 partitions.

scala> val r1 = sc.parallelize(0 to 15, 16)

r1: org.apache.spark.rdd.RDD[Int] = ParallelCollectionRDD[26] at parallelize at <conso
le>:18

scala> r1.partitions.size
res63: Int = 16

scala> r1.foreachPartition(it => println(">>> partition size: " + it.size))

...
>>> partition size: 1
>>> partition size: 1
>>> partition size: 1
>>> partition size: 1
>>> partition size: 1
>>> partition size: 1
>>> partition size: 1
>>> partition size: 1
... // the machine has 8 cores
... // so first 8 tasks get executed immediately
... // with the others after a core is free to take on new tasks.
>>> partition size: 1
...
>>> partition size: 1
...
>>> partition size: 1
...
>>> partition size: 1
>>> partition size: 1
...
>>> partition size: 1
>>> partition size: 1
>>> partition size: 1

All 16 partitions have one element.

When you execute r1.take(1) only one job gets run since it is enough to compute one task
on one partition.

1312
Learning Jobs and Partitions Using take Action

Caution FIXME Snapshot from web UI - note the number of tasks

However, when you execute r1.take(2) two jobs get run as the implementation assumes
one job with one partition, and if the elements didn’t total to the number of elements
requested in take , quadruple the partitions to work on in the following jobs.

Caution FIXME Snapshot from web UI - note the number of tasks

Can you guess how many jobs are run for r1.take(15) ? How many tasks per job?

Caution FIXME Snapshot from web UI - note the number of tasks

Answer: 3.

1313
Spark Standalone - Using ZooKeeper for High-Availability of Master

Spark Standalone - Using ZooKeeper for High-

Availability of Master
Tip Read Recovery Mode to know the theory.

You’re going to start two standalone Masters.

You’ll need 4 terminals (adjust addresses as needed):

Start ZooKeeper.

Create a configuration file ha.conf with the content as follows:

spark.deploy.recoveryMode=ZOOKEEPER
spark.deploy.zookeeper.url=<zookeeper_host>:2181
spark.deploy.zookeeper.dir=/spark

Start the first standalone Master.

./sbin/start-master.sh -h localhost -p 7077 --webui-port 8080 --properties-file ha.conf

Start the second standalone Master.

It is not possible to start another instance of standalone Master on the same

machine using ./sbin/start-master.sh . The reason is that the script assumes
Note
one instance per machine only. We’re going to change the script to make it
possible.

$ cp ./sbin/start-master{,-2}.sh

$ grep "CLASS 1" ./sbin/start-master-2.sh

"${SPARK_HOME}/sbin"/spark-daemon.sh start $CLASS 1 \

$ sed -i -e 's/CLASS 1/CLASS 2/' sbin/start-master-2.sh

$ grep "CLASS 1" ./sbin/start-master-2.sh

$ grep "CLASS 2" ./sbin/start-master-2.sh

"${SPARK_HOME}/sbin"/spark-daemon.sh start $CLASS 2 \

$ ./sbin/start-master-2.sh -h localhost -p 17077 --webui-port 18080 --properties-file

ha.conf

1314
Spark Standalone - Using ZooKeeper for High-Availability of Master

You can check how many instances you’re currently running using jps command as
follows:

$ jps -lm
5024 sun.tools.jps.Jps -lm
4994 org.apache.spark.deploy.master.Master --ip japila.local --port 7077 --webui-port
8080 -h localhost -p 17077 --webui-port 18080 --properties-file ha.conf
4808 org.apache.spark.deploy.master.Master --ip japila.local --port 7077 --webui-port
8080 -h localhost -p 7077 --webui-port 8080 --properties-file ha.conf
4778 org.apache.zookeeper.server.quorum.QuorumPeerMain config/zookeeper.properties

Start a standalone Worker.

./sbin/start-slave.sh spark://localhost:7077,localhost:17077

Start Spark shell.

./bin/spark-shell --master spark://localhost:7077,localhost:17077

Wait till the Spark shell connects to an active standalone Master.

Find out which standalone Master is active (there can only be one). Kill it. Observe how the
other standalone Master takes over and lets the Spark shell register with itself. Check out
the master’s UI.

Optionally, kill the worker, make sure it goes away instantly in the active master’s logs.

1315
Spark’s Hello World using Spark shell and Scala

Exercise: Spark’s Hello World using Spark

shell and Scala
Run Spark shell and count the number of words in a file using MapReduce pattern.

Use sc.textFile to read the file into memory

Use RDD.flatMap for a mapper step

Use reduceByKey for a reducer step

1316
WordCount using Spark shell

WordCount using Spark shell

It is like any introductory big data example should somehow demonstrate how to count
words in distributed fashion.

In the following example you’re going to count the words in README.md file that sits in your
Spark distribution and save the result under README.count directory.

You’re going to use the Spark shell for the example. Execute spark-shell .

val lines = sc.textFile("README.md") (1)

val words = lines.flatMap(_.split("\\s+")) (2)

val wc = words.map(w => (w, 1)).reduceByKey(_ + _) (3)

wc.saveAsTextFile("README.count") (4)

1. Read the text file - refer to Using Input and Output (I/O).

2. Split each line into words and flatten the result.

3. Map each word into a pair and count them by word (key).

4. Save the result into text files - one per partition.

After you have executed the example, see the contents of the README.count directory:

$ ls -lt README.count
total 16
-rw-r--r-- 1 jacek staff 0 9 paź 13:36 _SUCCESS
-rw-r--r-- 1 jacek staff 1963 9 paź 13:36 part-00000
-rw-r--r-- 1 jacek staff 1663 9 paź 13:36 part-00001

The files part-0000x contain the pairs of word and the count.

1317
WordCount using Spark shell

$ cat README.count/part-00000
(package,1)
(this,1)
(Version"](http://spark.apache.org/docs/latest/building-spark.html#specifying-the-hado
op-version),1)
(Because,1)
(Python,2)
(cluster.,1)
(its,1)
([run,1)
...

Further (self-)development
Please read the questions and give answers first before looking at the link given.

1. Why are there two files under the directory?

2. How could you have only one?

3. How to filter out words by name?

4. How to count words?

Please refer to the chapter Partitions to find some of the answers.

1318
Your first complete Spark application (using Scala and sbt)

Your first Spark application (using Scala and

sbt)
This page gives you the exact steps to develop and run a complete Spark application using
Scala programming language and sbt as the build tool.

Tip Refer to Quick Start’s Self-Contained Applications in the official documentation.

The sample application called SparkMe App is…​FIXME

Overview
You’re going to use sbt as the project build tool. It uses build.sbt for the project’s
description as well as the dependencies, i.e. the version of Apache Spark and others.

The application’s main code is under src/main/scala directory, in SparkMeApp.scala file.

With the files in a directory, executing sbt package results in a package that can be
deployed onto a Spark cluster using spark-submit .

In this example, you’re going to use Spark’s local mode.

Project’s build - build.sbt

Any Scala project managed by sbt uses build.sbt as the central place for configuration,
including project dependencies denoted as libraryDependencies .

build.sbt

name := "SparkMe Project"

version := "1.0"
organization := "pl.japila"

scalaVersion := "2.11.7"

libraryDependencies += "org.apache.spark" %% "spark-core" % "1.6.0-SNAPSHOT" (1)

resolvers += Resolver.mavenLocal

1. Use the development version of Spark 1.6.0-SNAPSHOT

SparkMe Application

1319
Your first complete Spark application (using Scala and sbt)

The application uses a single command-line parameter (as args(0) ) that is the file to
process. The file is read and the number of lines printed out.

package pl.japila.spark

import org.apache.spark.{SparkContext, SparkConf}

object SparkMeApp {
def main(args: Array[String]) {
val conf = new SparkConf().setAppName("SparkMe Application")
val sc = new SparkContext(conf)

val fileName = args(0)

val lines = sc.textFile(fileName).cache

val c = lines.count
println(s"There are $c lines in $fileName")
}
}

sbt version - project/build.properties

sbt (launcher) uses project/build.properties file to set (the real) sbt up

sbt.version=0.13.9

With the file the build is more predictable as the version of sbt doesn’t depend on
Tip
the sbt launcher.

Packaging Application
Execute sbt package to package the application.

➜ sparkme-app sbt package

[info] Loading global plugins from /Users/jacek/.sbt/0.13/plugins
[info] Loading project definition from /Users/jacek/dev/sandbox/sparkme-app/project
[info] Set current project to SparkMe Project (in build file:/Users/jacek/dev/sandbox/
sparkme-app/)
[info] Compiling 1 Scala source to /Users/jacek/dev/sandbox/sparkme-app/target/scala-2
.11/classes...
[info] Packaging /Users/jacek/dev/sandbox/sparkme-app/target/scala-2.11/sparkme-projec
t_2.11-1.0.jar ...
[info] Done packaging.
[success] Total time: 3 s, completed Sep 23, 2015 12:47:52 AM

The application uses only classes that comes with Spark so package is enough.

1320
Your first complete Spark application (using Scala and sbt)

In target/scala-2.11/sparkme-project_2.11-1.0.jar there is the final application ready for

deployment.

Submitting Application to Spark (local)

The application is going to be deployed to local[*] . Change it to whatever

Note
cluster you have available (refer to Running Spark in cluster).

spark-submit the SparkMe application and specify the file to process (as it is the only and

required input parameter to the application), e.g. build.sbt of the project.

build.sbt is sbt’s build definition and is only used as an input file for
Note
demonstration purposes. Any file is going to work fine.

➜ sparkme-app ~/dev/oss/spark/bin/spark-submit --master "local[*]" --class pl.japila

.spark.SparkMeApp target/scala-2.11/sparkme-project_2.11-1.0.jar build.sbt
Using Spark's repl log4j profile: org/apache/spark/log4j-defaults-repl.properties
To adjust logging level use sc.setLogLevel("INFO")
15/09/23 01:06:02 WARN NativeCodeLoader: Unable to load native-hadoop library for your
platform... using builtin-java classes where applicable
15/09/23 01:06:04 WARN MetricsSystem: Using default name DAGScheduler for source becau
se spark.app.id is not set.
There are 8 lines in build.sbt

Note Disregard the two above WARN log messages.

You’re done. Sincere congratulations!

1321
Spark (notable) use cases

Spark (notable) use cases

That’s the place where I’m throwing things I’d love exploring further - technology- and
business-centric.

Technology "things":

Spark Streaming on Hadoop YARN cluster processing messages from Apache Kafka
using the new direct API.

Parsing JSONs into Parquet and save it to S3

Business "things":

IoT applications = connected devices and sensors

Predictive Analytics = Manage risk and capture new business opportunities with real-
time analytics and probabilistic forecasting of customers, products and partners.

Anomaly Detection = Detect in real-time problems such as financial fraud, structural

defects, potential medical conditions, and other anomalies.

Personalization = Deliver a unique experience in real-time that is relevant and

engaging based on a deep understanding of the customer and current context.

data lakes, clickstream analytics, real time analytics, and data warehousing on Hadoop

1322
Using Spark SQL to update data in Hive using ORC files

Using Spark SQL to update data in Hive using

ORC files
The example has showed up on Spark’s users mailing list.

FIXME Offer a complete working solution in Scala

Caution FIXME Load ORC files into dataframe

val df = hiveContext.read.format("orc").load(to/path)

Solution was to use Hive in ORC format with partitions:

A table in Hive stored as an ORC file (using partitioning)

Using SQLContext.sql to insert data into the table

Using SQLContext.sql to periodically run ALTER TABLE…​CONCATENATE to merge your many

small files into larger files optimized for your HDFS block size

Since the CONCATENATE command operates on files in place it is transparent to any

downstream processing

Hive solution is just to concatenate the files

it does not alter or change records.

it’s possible to update data in Hive using ORC format

With transactional tables in Hive together with insert, update, delete, it does the
"concatenate " for you automatically in regularly intervals. Currently this works only
with tables in orc.format (stored as orc)

Alternatively, use Hbase with Phoenix as the SQL layer on top

Hive was originally not designed for updates, because it was.purely warehouse
focused, the most recent one can do updates, deletes etc in a transactional way.

Criteria:

Spark Streaming jobs are receiving a lot of small events (avg 10kb)

Events are stored to HDFS, e.g. for Pig jobs

There are a lot of small files in HDFS (several millions)

1323
Using Spark SQL to update data in Hive using ORC files

1324
Developing Custom SparkListener to monitor DAGScheduler in Scala

Exercise: Developing Custom SparkListener to

monitor DAGScheduler in Scala
The example shows how to develop a custom Spark Listener. You should read Spark
Listeners — Intercepting Events from Spark Scheduler first to understand the motivation for
the example.

Requirements
1. IntelliJ IDEA (or eventually sbt alone if you’re adventurous).

2. Access to Internet to download Apache Spark’s dependencies.

Setting up Scala project using IntelliJ IDEA

Create a new project custom-spark-listener .

Add the following line to build.sbt (the main configuration file for the sbt project) that adds
the dependency on Apache Spark.

libraryDependencies += "org.apache.spark" %% "spark-core" % "2.0.1"

build.sbt should look as follows:

name := "custom-spark-listener"
organization := "pl.jaceklaskowski.spark"
version := "1.0"

scalaVersion := "2.11.8"

libraryDependencies += "org.apache.spark" %% "spark-core" % "2.0.1"

Custom Listener -
pl.jaceklaskowski.spark.CustomSparkListener
Create a Scala class —  CustomSparkListener  — for your custom SparkListener . It should
be under src/main/scala directory (create one if it does not exist).

The aim of the class is to intercept scheduler events about jobs being started and tasks
completed.

1325
Developing Custom SparkListener to monitor DAGScheduler in Scala

package pl.jaceklaskowski.spark

import org.apache.spark.scheduler.{SparkListenerStageCompleted, SparkListener, SparkLi

stenerJobStart}

class CustomSparkListener extends SparkListener {

override def onJobStart(jobStart: SparkListenerJobStart) {
println(s"Job started with ${jobStart.stageInfos.size} stages: $jobStart")
}

override def onStageCompleted(stageCompleted: SparkListenerStageCompleted): Unit = {

println(s"Stage ${stageCompleted.stageInfo.stageId} completed with ${stageComplete
d.stageInfo.numTasks} tasks.")
}
}

Creating deployable package

Package the custom Spark listener. Execute sbt package command in the custom-spark-
listener project’s main directory.

$ sbt package
[info] Loading global plugins from /Users/jacek/.sbt/0.13/plugins
[info] Loading project definition from /Users/jacek/dev/workshops/spark-workshop/solut
ions/custom-spark-listener/project
[info] Updating {file:/Users/jacek/dev/workshops/spark-workshop/solutions/custom-spark
-listener/project/}custom-spark-listener-build...
[info] Resolving org.fusesource.jansi#jansi;1.4 ...
[info] Done updating.
[info] Set current project to custom-spark-listener (in build file:/Users/jacek/dev/wo
rkshops/spark-workshop/solutions/custom-spark-listener/)
[info] Updating {file:/Users/jacek/dev/workshops/spark-workshop/solutions/custom-spark
-listener/}custom-spark-listener...
[info] Resolving jline#jline;2.12.1 ...
[info] Done updating.
[info] Compiling 1 Scala source to /Users/jacek/dev/workshops/spark-workshop/solutions
/custom-spark-listener/target/scala-2.11/classes...
[info] Packaging /Users/jacek/dev/workshops/spark-workshop/solutions/custom-spark-list
ener/target/scala-2.11/custom-spark-listener_2.11-1.0.jar ...
[info] Done packaging.
[success] Total time: 8 s, completed Oct 27, 2016 11:23:50 AM

You should find the result jar file with the custom scheduler listener ready under
target/scala-2.11 directory, e.g. target/scala-2.11/custom-spark-listener_2.11-1.0.jar .

Activating Custom Listener in Spark shell

1326
Developing Custom SparkListener to monitor DAGScheduler in Scala

Start spark-shell with additional configurations for the extra custom listener and the jar that
includes the class.

$ spark-shell --conf spark.logConf=true --conf spark.extraListeners=pl.jaceklaskowski.

spark.CustomSparkListener --driver-class-path target/scala-2.11/custom-spark-listener_
2.11-1.0.jar

Create a Dataset and execute an action like show to start a job as follows:

scala> spark.read.text("README.md").count
[CustomSparkListener] Job started with 2 stages: SparkListenerJobStart(1,1473946006715
,WrappedArray(org.apache.spark.scheduler.StageInfo@71515592, org.apache.spark.schedule
r.StageInfo@6852819d),{spark.rdd.scope.noOverride=true, spark.rdd.scope={"id":"14","na
me":"collect"}, spark.sql.execution.id=2})
[CustomSparkListener] Stage 1 completed with 1 tasks.
[CustomSparkListener] Stage 2 completed with 1 tasks.
res0: Long = 7

The lines with [CustomSparkListener] came from your custom Spark listener.
Congratulations! The exercise’s over.

BONUS Activating Custom Listener in Spark Application

Tip Read Registering SparkListener —  addSparkListener method.

Questions
1. What are the pros and cons of using the command line version vs inside a Spark
application?

1327
Developing RPC Environment

Developing RPC Environment

FIXME
Create the exercise
It could be easier to have an exercise to register a custom RpcEndpoint
(it can receive network events known to all endpoints, e.g.
Caution RemoteProcessConnected = "a new node connected" or
RemoteProcessDisconnected = a node disconnected). That could be
the only way to know about the current runtime configuration of RpcEnv.
Use SparkEnv.rpcEnv and rpcEnv.setupEndpoint(name,
endpointCreator) to register a RPC Endpoint.

Start simple using the following command:

$ ./bin/spark-shell --conf spark.rpc=doesnotexist

...
15/10/21 12:06:11 INFO SparkContext: Running Spark version 1.6.0-SNAPSHOT
...
15/10/21 12:06:11 ERROR SparkContext: Error initializing SparkContext.
java.lang.ClassNotFoundException: doesnotexist
at scala.reflect.internal.util.AbstractFileClassLoader.findClass(AbstractFileC
lassLoader.scala:62)
at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
at java.lang.Class.forName0(Native Method)
at java.lang.Class.forName(Class.java:348)
at org.apache.spark.util.Utils$.classForName(Utils.scala:173)
at org.apache.spark.rpc.RpcEnv$.getRpcEnvFactory(RpcEnv.scala:38)
at org.apache.spark.rpc.RpcEnv$.create(RpcEnv.scala:49)
at org.apache.spark.SparkEnv$.create(SparkEnv.scala:257)
at org.apache.spark.SparkEnv$.createDriverEnv(SparkEnv.scala:198)
at org.apache.spark.SparkContext.createSparkEnv(SparkContext.scala:272)
at org.apache.spark.SparkContext.<init>(SparkContext.scala:441)
at org.apache.spark.repl.Main$.createSparkContext(Main.scala:79)
at $line3.$read$$iw$$iw.<init>(<console>:12)
at $line3.$read$$iw.<init>(<console>:21)
at $line3.$read.<init>(<console>:23)
at $line3.$read$.<init>(<console>:27)
at $line3.$read$.<clinit>(<console>)
at $line3.$eval$.$print$lzycompute(<console>:7)
at $line3.$eval$.$print(<console>:6)
at $line3.$eval.$print(<console>)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:6
2)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImp
l.java:43)

1328
Developing RPC Environment

at java.lang.reflect.Method.invoke(Method.java:497)
at scala.tools.nsc.interpreter.IMain$ReadEvalPrint.call(IMain.scala:784)
at scala.tools.nsc.interpreter.IMain$Request.loadAndRun(IMain.scala:1039)
at scala.tools.nsc.interpreter.IMain$WrappedRequest$$anonfun$loadAndRunReq$1.a
pply(IMain.scala:636)
at scala.tools.nsc.interpreter.IMain$WrappedRequest$$anonfun$loadAndRunReq$1.a
pply(IMain.scala:635)
at scala.reflect.internal.util.ScalaClassLoader$class.asContext(ScalaClassLoad
er.scala:31)
at scala.reflect.internal.util.AbstractFileClassLoader.asContext(AbstractFileC
lassLoader.scala:19)
at scala.tools.nsc.interpreter.IMain$WrappedRequest.loadAndRunReq(IMain.scala:
635)
at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:567)
at scala.tools.nsc.interpreter.IMain.interpret(IMain.scala:563)
at scala.tools.nsc.interpreter.ILoop.reallyInterpret$1(ILoop.scala:802)
at scala.tools.nsc.interpreter.ILoop.interpretStartingWith(ILoop.scala:836)
at scala.tools.nsc.interpreter.ILoop.command(ILoop.scala:694)
at scala.tools.nsc.interpreter.ILoop.processLine(ILoop.scala:404)
at org.apache.spark.repl.SparkILoop$$anonfun$initializeSpark$1.apply$mcZ$sp(Sp
arkILoop.scala:39)
at org.apache.spark.repl.SparkILoop$$anonfun$initializeSpark$1.apply(SparkILoo
p.scala:38)
at org.apache.spark.repl.SparkILoop$$anonfun$initializeSpark$1.apply(SparkILoo
p.scala:38)
at scala.tools.nsc.interpreter.IMain.beQuietDuring(IMain.scala:213)
at org.apache.spark.repl.SparkILoop.initializeSpark(SparkILoop.scala:38)
at org.apache.spark.repl.SparkILoop.loadFiles(SparkILoop.scala:94)
at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply$mcZ$sp(ILoop.sca
la:922)
at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:911)
at scala.tools.nsc.interpreter.ILoop$$anonfun$process$1.apply(ILoop.scala:911)
at scala.reflect.internal.util.ScalaClassLoader$.savingContextLoader(ScalaClas
sLoader.scala:97)
at scala.tools.nsc.interpreter.ILoop.process(ILoop.scala:911)
at org.apache.spark.repl.Main$.main(Main.scala:49)
at org.apache.spark.repl.Main.main(Main.scala)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:6
2)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImp
l.java:43)
at java.lang.reflect.Method.invoke(Method.java:497)
at org.apache.spark.deploy.SparkSubmit$.org$apache$spark$deploy$SparkSubmit$$r
unMain(SparkSubmit.scala:680)
at org.apache.spark.deploy.SparkSubmit$.doRunMain$1(SparkSubmit.scala:180)
at org.apache.spark.deploy.SparkSubmit$.submit(SparkSubmit.scala:205)
at org.apache.spark.deploy.SparkSubmit$.main(SparkSubmit.scala:120)
at org.apache.spark.deploy.SparkSubmit.main(SparkSubmit.scala)

1329
Developing RPC Environment

1330
Developing Custom RDD

Developing Custom RDD

Caution FIXME

1331
Working with Datasets from JDBC Data Sources (and PostgreSQL)

Working with Datasets from JDBC Data

Sources (and PostgreSQL)
Start spark-shell with the JDBC driver for the database you want to use. In our case, it is
PostgreSQL JDBC Driver.

Download the jar for PostgreSQL JDBC Driver 42.1.1 directly from the Maven
Note
repository.

Execute the command to have the jar downloaded into ~/.ivy2/jars directory by spark-shell

./bin/spark-shell --packages org.postgresql:postgresql:42.1.1

The entire path to the driver file is then like /Users/jacek/.ivy2/jars/org.postgresql_postgresql-4

You should see the following while spark-shell downloads the driver.

Ivy Default Cache set to: /Users/jacek/.ivy2/cache

The jars for the packages stored in: /Users/jacek/.ivy2/jars
:: loading settings :: url = jar:file:/Users/jacek/dev/oss/spark/assembly/target/scala-2.11/j
org.postgresql#postgresql added as a dependency
:: resolving dependencies :: org.apache.spark#spark-submit-parent;1.0
Tip confs: [default]
found org.postgresql#postgresql;42.1.1 in central
downloading https://repo1.maven.org/maven2/org/postgresql/postgresql/42.1.1/postgresql-42.1.1
[SUCCESSFUL ] org.postgresql#postgresql;42.1.1!postgresql.jar(bundle) (205ms)
:: resolution report :: resolve 1887ms :: artifacts dl 207ms
:: modules in use:
org.postgresql#postgresql;42.1.1 from central in [default]
---------------------------------------------------------------------
| | modules || artifacts |
| conf | number| search|dwnlded|evicted|| number|dwnlded|
---------------------------------------------------------------------
| default | 1 | 1 | 1 | 0 || 1 | 1 |
---------------------------------------------------------------------
:: retrieving :: org.apache.spark#spark-submit-parent
confs: [default]
1 artifacts copied, 0 already retrieved (695kB/8ms)

Start ./bin/spark-shell with --driver-class-path command line option and the driver jar.

SPARK_PRINT_LAUNCH_COMMAND=1 ./bin/spark-shell --driver-class-path /Users/jacek/.ivy2/

jars/org.postgresql_postgresql-42.1.1.jar

It will give you the proper setup for accessing PostgreSQL using the JDBC driver.

Execute the following to access projects table in sparkdb .

1332
Working with Datasets from JDBC Data Sources (and PostgreSQL)

// that gives an one-partition Dataset

val opts = Map(
"url" -> "jdbc:postgresql:sparkdb",
"dbtable" -> "projects")
val df = spark.
read.
format("jdbc").
options(opts).
load

Note Use user and password options to specify the credentials if needed.

1333
Working with Datasets from JDBC Data Sources (and PostgreSQL)

// Note the number of partition (aka numPartitions)

scala> df.explain
== Physical Plan ==
*Scan JDBCRelation(projects) [numPartitions=1] [id#0,name#1,website#2] ReadSchema: str
uct<id:int,name:string,website:string>

scala> df.show(truncate = false)

+---+------------+-----------------------+
|id |name |website |
+---+------------+-----------------------+
|1 |Apache Spark|http://spark.apache.org|
|2 |Apache Hive |http://hive.apache.org |
|3 |Apache Kafka|http://kafka.apache.org|
|4 |Apache Flink|http://flink.apache.org|
+---+------------+-----------------------+

// use jdbc method with predicates to define partitions

import java.util.Properties
val df4parts = spark.
read.
jdbc(
url = "jdbc:postgresql:sparkdb",
table = "projects",
predicates = Array("id=1", "id=2", "id=3", "id=4"),
connectionProperties = new Properties())

// Note the number of partitions (aka numPartitions)

scala> df4parts.explain
== Physical Plan ==
*Scan JDBCRelation(projects) [numPartitions=4] [id#16,name#17,website#18] ReadSchema:
struct<id:int,name:string,website:string>

scala> df4parts.show(truncate = false)

+---+------------+-----------------------+
|id |name |website |
+---+------------+-----------------------+
|1 |Apache Spark|http://spark.apache.org|
|2 |Apache Hive |http://hive.apache.org |
|3 |Apache Kafka|http://kafka.apache.org|
|4 |Apache Flink|http://flink.apache.org|
+---+------------+-----------------------+

Troubleshooting
If things can go wrong, they sooner or later go wrong. Here is a list of possible issues and
their solutions.

java.sql.SQLException: No suitable driver

1334
Working with Datasets from JDBC Data Sources (and PostgreSQL)

Ensure that the JDBC driver sits on the CLASSPATH. Use --driver-class-path as described
above ( --packages or --jars do not work).

scala> val df = spark.

| read.
| format("jdbc").
| options(opts).
| load
java.sql.SQLException: No suitable driver
at java.sql.DriverManager.getDriver(DriverManager.java:315)
at org.apache.spark.sql.execution.datasources.jdbc.JDBCOptions$$anonfun$7.apply(JDBC
Options.scala:84)
at org.apache.spark.sql.execution.datasources.jdbc.JDBCOptions$$anonfun$7.apply(JDBC
Options.scala:84)
at scala.Option.getOrElse(Option.scala:121)
at org.apache.spark.sql.execution.datasources.jdbc.JDBCOptions.<init>(JDBCOptions.sc
ala:83)
at org.apache.spark.sql.execution.datasources.jdbc.JDBCOptions.<init>(JDBCOptions.sc
ala:34)
at org.apache.spark.sql.execution.datasources.jdbc.JdbcRelationProvider.createRelati
on(JdbcRelationProvider.scala:32)
at org.apache.spark.sql.execution.datasources.DataSource.resolveRelation(DataSource.
scala:301)
at org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:190)
at org.apache.spark.sql.DataFrameReader.load(DataFrameReader.scala:158)
... 52 elided

PostgreSQL Setup

Note I’m on Mac OS X so YMMV (aka Your Mileage May Vary).

Use the sections to have a properly configured PostgreSQL database.

Installation

Starting Database Server

Create Database

Accessing Database

Creating Table

Dropping Database

Stopping Database Server

Installation

1335
Working with Datasets from JDBC Data Sources (and PostgreSQL)

Install PostgreSQL as described in…​TK

This page serves as a cheatsheet for the author so he does not have to
Caution
search Internet to find the installation steps.

$ initdb /usr/local/var/postgres -E utf8

The files belonging to this database system will be owned by user "jacek".
This user must also own the server process.

The database cluster will be initialized with locale "pl_pl.utf-8".

initdb: could not find suitable text search configuration for locale "pl_pl.utf-8"
The default text search configuration will be set to "simple".

Data page checksums are disabled.

creating directory /usr/local/var/postgres ... ok

creating subdirectories ... ok
selecting default max_connections ... 100
selecting default shared_buffers ... 128MB
selecting dynamic shared memory implementation ... posix
creating configuration files ... ok
creating template1 database in /usr/local/var/postgres/base/1 ... ok
initializing pg_authid ... ok
initializing dependencies ... ok
creating system views ... ok
loading system objects' descriptions ... ok
creating collations ... ok
creating conversions ... ok
creating dictionaries ... ok
setting privileges on built-in objects ... ok
creating information schema ... ok
loading PL/pgSQL server-side language ... ok
vacuuming database template1 ... ok
copying template1 to template0 ... ok
copying template1 to postgres ... ok
syncing data to disk ... ok

WARNING: enabling "trust" authentication for local connections

You can change this by editing pg_hba.conf or using the option -A, or
--auth-local and --auth-host, the next time you run initdb.

Success. You can now start the database server using:

pg_ctl -D /usr/local/var/postgres -l logfile start

Starting Database Server

Note Consult 17.3. Starting the Database Server in the official documentation.

1336
Working with Datasets from JDBC Data Sources (and PostgreSQL)

Enable all logs in PostgreSQL to see query statements.

log_statement = 'all'
Tip
Add log_statement = 'all' to /usr/local/var/postgres/postgresql.conf on Mac
OS X with PostgreSQL installed using brew .

Start the database server using pg_ctl .

$ pg_ctl -D /usr/local/var/postgres -l logfile start

server starting

Alternatively, you can run the database server using postgres .

$ postgres -D /usr/local/var/postgres

Create Database

$ createdb sparkdb

Tip Consult createdb in the official documentation.

Accessing Database
Use psql sparkdb to access the database.

$ psql sparkdb
psql (9.6.2)
Type "help" for help.

sparkdb=#

Execute SELECT version() to know the version of the database server you have connected
to.

1337
Working with Datasets from JDBC Data Sources (and PostgreSQL)

sparkdb=# SELECT version();

version
--------------------------------------------------------------------------------------
------------------------
PostgreSQL 9.6.2 on x86_64-apple-darwin14.5.0, compiled by Apple LLVM version 7.0.2 (
clang-700.1.81), 64-bit
(1 row)

Use \h for help and \q to leave a session.

Creating Table
Create a table using CREATE TABLE command.

CREATE TABLE projects (

id SERIAL PRIMARY KEY,
name text,
website text
);

Insert rows to initialize the table with data.

INSERT INTO projects (name, website) VALUES ('Apache Spark', 'http://spark.apache.org'

);
INSERT INTO projects (name, website) VALUES ('Apache Hive', 'http://hive.apache.org');
INSERT INTO projects VALUES (DEFAULT, 'Apache Kafka', 'http://kafka.apache.org');
INSERT INTO projects VALUES (DEFAULT, 'Apache Flink', 'http://flink.apache.org');

Execute select * from projects; to ensure that you have the following records in
projects table:

sparkdb=# select * from projects;

id | name | website
----+--------------+-------------------------
1 | Apache Spark | http://spark.apache.org
2 | Apache Hive | http://hive.apache.org
3 | Apache Kafka | http://kafka.apache.org
4 | Apache Flink | http://flink.apache.org
(4 rows)

Dropping Database

$ dropdb sparkdb

1338
Working with Datasets from JDBC Data Sources (and PostgreSQL)

Tip Consult dropdb in the official documentation.

Stopping Database Server

pg_ctl -D /usr/local/var/postgres stop

1339
Causing Stage to Fail

Exercise: Causing Stage to Fail

The example shows how Spark re-executes a stage in case of stage failure.

Recipe
Start a Spark cluster, e.g. 1-node Hadoop YARN.

start-yarn.sh

// 2-stage job -- it _appears_ that a stage can be failed only when there is a shuffle
sc.parallelize(0 to 3e3.toInt, 2).map(n => (n % 2, n)).groupByKey.count

Use 2 executors at least so you can kill one and keep the application up and running (on one
executor).

YARN_CONF_DIR=hadoop-conf ./bin/spark-shell --master yarn \

-c spark.shuffle.service.enabled=true \
--num-executors 2

1340
Courses

Spark courses
Spark Fundamentals I from Big Data University.

Data Science and Engineering with Apache Spark from University of California and
Databricks (includes 5 edX courses):

Introduction to Apache Spark

Distributed Machine Learning with Apache Spark

Big Data Analysis with Apache Spark

Advanced Apache Spark for Data Science and Data Engineering

Advanced Distributed Machine Learning with Apache Spark

1341
Books

Books
O’Reilly

Learning Spark (my review at Amazon.com)

Advanced Analytics with Spark

Data Algorithms: Recipes for Scaling Up with Hadoop and Spark

Spark Operations: Operationalizing Apache Spark at Scale (in the works)

Manning

Spark in Action (MEAP)

Streaming Data (MEAP)

Spark GraphX in Action (MEAP)

Packt

Mastering Apache Spark

Spark Cookbook

Learning Real-time Processing with Spark Streaming

Machine Learning with Spark

Fast Data Processing with Spark, 2nd Edition

Fast Data Processing with Spark

Apache Spark Graph Processing

Apress

Big Data Analytics with Spark

Guide to High Performance Distributed Computing (Case Studies with Hadoop,

Scalding and Spark)

1342
Spark SQL — Batch and Streaming Queries Over Structured Data on Massive Scale

Spark SQL — Batch and Streaming Queries

Over Structured Data on Massive Scale
Like Apache Spark in general, Spark SQL in particular is all about distributed in-memory
computations on massive scale.

The primary difference between Spark SQL’s and the "bare" Spark Core’s RDD computation
models is the framework for loading, querying and persisting structured and semi-structured
data using structured queries that can be expressed using good ol' SQL, HiveQL and the
custom high-level SQL-like, declarative, type-safe Dataset API called Structured Query
DSL.

You can find more information about Spark SQL in my Mastering Spark SQL
Tip
gitbook.

1343
Spark Structured Streaming — Streaming Datasets

Spark Structured Streaming — Streaming

Datasets
Spark Structured Streaming is a new computation model introduced in Spark 2.0 for
building end-to-end streaming applications termed as continuous applications.

Structured streaming offers a high-level declarative streaming API built on top of Datasets
(inside Spark SQL’s engine) for continuous incremental execution of structured queries.

You can find more information about Spark Structured Streaming in my separate
Tip
notebook titled Spark Structured Streaming.

1344
Spark Streaming — Streaming RDDs

Spark Streaming — Streaming RDDs

Spark Streaming is the incremental micro-batching stream processing framework for
Spark.

You can find more information about Spark Streaming in my separate book in the
Tip
notebook repository at GitBook.

1345
BlockRDD

BlockRDD
BlockRDD is an RDD that is created when Spark Streaming’s ReceiverInputDStream is

requested to compute and createBlockRDD .

Spark Streaming calls BlockRDD.removeBlocks() while clearing metadata.

Note It appears that BlockRDD is used in Spark Streaming exclusively.

Computing Partition (in TaskContext) —  compute Method

compute(split: Partition, context: TaskContext): Iterator[T]

Note compute is part of RDD Contract to compute a partition (in a TaskContext).

compute …​FIXME

getPartitions Method

getPartitions: Array[Partition]

Note getPartitions is part of RDD Contract to…​FIXME.

getPartitions …​FIXME

getPreferredLocations Method

getPreferredLocations(split: Partition): Seq[String]

Note getPreferredLocations is part of RDD Contract to…​FIXME.

getPreferredLocations …​FIXME

Creating BlockRDD Instance

BlockRDD takes the following when created:

SparkContext

1346
BlockRDD

Collection of BlockIds

BlockRDD initializes the internal registries and counters.

1347
Spark GraphX — Distributed Graph Computations

Spark GraphX - Distributed Graph

Computations
Spark GraphX is a graph processing framework built on top of Spark.

GraphX models graphs as property graphs where vertices and edges can have properties.

Caution FIXME Diagram of a graph with friends.

GraphX comes with its own package org.apache.spark.graphx .

Import org.apache.spark.graphx package to work with GraphX.

Tip import org.apache.spark.graphx._

Graph
Graph abstract class represents a collection of vertices and edges .

abstract class Graph[VD: ClassTag, ED: ClassTag]

vertices attribute is of type VertexRDD while edges is of type EdgeRDD .

Graph can also be described by triplets (that is of type RDD[EdgeTriplet[VD, ED]] ).

import org.apache.spark.graphx._
import org.apache.spark.rdd.RDD
val vertices: RDD[(VertexId, String)] =
sc.parallelize(Seq(
(0L, "Jacek"),
(1L, "Agata"),
(2L, "Julian")))

val edges: RDD[Edge[String]] =

sc.parallelize(Seq(
Edge(0L, 1L, "wife"),
Edge(1L, 2L, "owner")
))

scala> val graph = Graph(vertices, edges)

graph: org.apache.spark.graphx.Graph[String,String] = org.apache.spark.graphx.impl.Gra
phImpl@5973e4ec

1348
Spark GraphX — Distributed Graph Computations

package object graphx

package object graphx defines two type aliases:

VertexId ( Long ) that represents a unique 64-bit vertex identifier.

PartitionID ( Int ) that is an identifier of a graph partition.

Standard GraphX API

Graph class comes with a small set of API.

Transformations

mapVertices

mapEdges

mapTriplets

reverse

subgraph

mask

groupEdges

Joins

outerJoinVertices

Computation

aggregateMessages

Creating Graphs (Graph object)

Graph object comes with the following factory methods to create instances of Graph :

fromEdgeTuples

fromEdges

apply

Note The default implementation of Graph is GraphImpl.

GraphOps - Graph Operations

1349
Spark GraphX — Distributed Graph Computations

GraphImpl
GraphImpl is the default implementation of Graph abstract class.

It lives in org.apache.spark.graphx.impl package.

OLD - perhaps soon to be removed

Apache Spark comes with a library for executing distributed computation on graph data,
GraphX.

Apache Spark graph analytics

GraphX is a pure programming API

missing a graphical UI to visually explore datasets

Could TitanDB be a solution?

From the article Merging datasets using graph analytics:

Such a situation, in which we need to find the best matching in a weighted bipartite
graph, poses what is known as the stable marriage problem. It is a classical problem
that has a well-known solution, the Gale–Shapley algorithm.

A popular model of distributed computation on graphs known as Pregel was

published by Google researchers in 2010. Pregel is based on passing messages along
the graph edges in a series of iterations. Accordingly, it is a good fit for the Gale–
Shapley algorithm, which starts with each “gentleman” (a vertex on one side of the
bipartite graph) sending a marriage proposal to its most preferred single “lady” (a vertex
on the other side of the bipartite graph). The “ladies” then marry their most preferred
suitors, after which the process is repeated until there are no more proposals to be
made.

The Apache Spark distributed computation engine includes GraphX, a library

specifically made for executing distributed computation on graph data. GraphX provides
an elegant Pregel interface but also permits more general computation that is not
restricted to the message-passing pattern.

Further reading or watching

(video) GraphX: Graph Analytics in Spark- Ankur Dave (UC Berkeley)

1350
Spark GraphX — Distributed Graph Computations

1351
Graph Algorithms

Graph Algorithms
GraphX comes with a set of built-in graph algorithms.

PageRank

Triangle Count

Connected Components
Identifies independent disconnected subgraphs.

Collaborative Filtering
What kinds of people like what kinds of products.

1352