1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>pyspark.profiler — PySpark master documentation</title>
<link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: 'master',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="PySpark master documentation" href="../../index.html" />
<link rel="up" title="Module code" href="../index.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="../../index.html">PySpark master documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for pyspark.profiler</h1><div class="highlight"><pre>
<span class="c">#</span>
<span class="c"># Licensed to the Apache Software Foundation (ASF) under one or more</span>
<span class="c"># contributor license agreements. See the NOTICE file distributed with</span>
<span class="c"># this work for additional information regarding copyright ownership.</span>
<span class="c"># The ASF licenses this file to You under the Apache License, Version 2.0</span>
<span class="c"># (the "License"); you may not use this file except in compliance with</span>
<span class="c"># the License. You may obtain a copy of the License at</span>
<span class="c">#</span>
<span class="c"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c">#</span>
<span class="c"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c"># distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="c"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c"># See the License for the specific language governing permissions and</span>
<span class="c"># limitations under the License.</span>
<span class="c">#</span>
<span class="kn">import</span> <span class="nn">cProfile</span>
<span class="kn">import</span> <span class="nn">pstats</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">atexit</span>
<span class="kn">from</span> <span class="nn">pyspark.accumulators</span> <span class="kn">import</span> <span class="n">AccumulatorParam</span>
<span class="k">class</span> <span class="nc">ProfilerCollector</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> This class keeps track of different profilers on a per</span>
<span class="sd"> stage basis. Also this is used to create new profilers for</span>
<span class="sd"> the different stages.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">profiler_cls</span><span class="p">,</span> <span class="n">dump_path</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">profiler_cls</span> <span class="o">=</span> <span class="n">profiler_cls</span>
<span class="bp">self</span><span class="o">.</span><span class="n">profile_dump_path</span> <span class="o">=</span> <span class="n">dump_path</span>
<span class="bp">self</span><span class="o">.</span><span class="n">profilers</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">def</span> <span class="nf">new_profiler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span>
<span class="sd">""" Create a new profiler using class `profiler_cls` """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">profiler_cls</span><span class="p">(</span><span class="n">ctx</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">add_profiler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">profiler</span><span class="p">):</span>
<span class="sd">""" Add a profiler for RDD `id` """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">profilers</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">profile_dump_path</span><span class="p">:</span>
<span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">dump_profiles</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">profile_dump_path</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">atexit</span><span class="o">.</span><span class="n">register</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">show_profiles</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">profilers</span><span class="o">.</span><span class="n">append</span><span class="p">([</span><span class="nb">id</span><span class="p">,</span> <span class="n">profiler</span><span class="p">,</span> <span class="bp">False</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">dump_profiles</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">""" Dump the profile stats into directory `path` """</span>
<span class="k">for</span> <span class="nb">id</span><span class="p">,</span> <span class="n">profiler</span><span class="p">,</span> <span class="n">_</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">profilers</span><span class="p">:</span>
<span class="n">profiler</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="nb">id</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">profilers</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">def</span> <span class="nf">show_profiles</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Print the profile stats to stdout """</span>
<span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="p">(</span><span class="nb">id</span><span class="p">,</span> <span class="n">profiler</span><span class="p">,</span> <span class="n">showed</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">profilers</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">showed</span> <span class="ow">and</span> <span class="n">profiler</span><span class="p">:</span>
<span class="n">profiler</span><span class="o">.</span><span class="n">show</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span>
<span class="c"># mark it as showed</span>
<span class="bp">self</span><span class="o">.</span><span class="n">profilers</span><span class="p">[</span><span class="n">i</span><span class="p">][</span><span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="bp">True</span>
<div class="viewcode-block" id="Profiler"><a class="viewcode-back" href="../../pyspark.html#pyspark.Profiler">[docs]</a><span class="k">class</span> <span class="nc">Profiler</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> .. note:: DeveloperApi</span>
<span class="sd"> PySpark supports custom profilers, this is to allow for different profilers to</span>
<span class="sd"> be used as well as outputting to different formats than what is provided in the</span>
<span class="sd"> BasicProfiler.</span>
<span class="sd"> A custom profiler has to define or inherit the following methods:</span>
<span class="sd"> profile - will produce a system profile of some sort.</span>
<span class="sd"> stats - return the collected stats.</span>
<span class="sd"> dump - dumps the profiles to a path</span>
<span class="sd"> add - adds a profile to the existing accumulated profile</span>
<span class="sd"> The profiler class is chosen when creating a SparkContext</span>
<span class="sd"> >>> from pyspark import SparkConf, SparkContext</span>
<span class="sd"> >>> from pyspark import BasicProfiler</span>
<span class="sd"> >>> class MyCustomProfiler(BasicProfiler):</span>
<span class="sd"> ... def show(self, id):</span>
<span class="sd"> ... print("My custom profiles for RDD:%s" % id)</span>
<span class="sd"> ...</span>
<span class="sd"> >>> conf = SparkConf().set("spark.python.profile", "true")</span>
<span class="sd"> >>> sc = SparkContext('local', 'test', conf=conf, profiler_cls=MyCustomProfiler)</span>
<span class="sd"> >>> sc.parallelize(range(1000)).map(lambda x: 2 * x).take(10)</span>
<span class="sd"> [0, 2, 4, 6, 8, 10, 12, 14, 16, 18]</span>
<span class="sd"> >>> sc.parallelize(range(1000)).count()</span>
<span class="sd"> 1000</span>
<span class="sd"> >>> sc.show_profiles()</span>
<span class="sd"> My custom profiles for RDD:1</span>
<span class="sd"> My custom profiles for RDD:3</span>
<span class="sd"> >>> sc.stop()</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span>
<span class="k">pass</span>
<div class="viewcode-block" id="Profiler.profile"><a class="viewcode-back" href="../../pyspark.html#pyspark.Profiler.profile">[docs]</a> <span class="k">def</span> <span class="nf">profile</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="p">):</span>
<span class="sd">""" Do profiling on the function `func`"""</span>
<span class="k">raise</span> <span class="bp">NotImplemented</span>
</div>
<div class="viewcode-block" id="Profiler.stats"><a class="viewcode-back" href="../../pyspark.html#pyspark.Profiler.stats">[docs]</a> <span class="k">def</span> <span class="nf">stats</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""" Return the collected profiling stats (pstats.Stats)"""</span>
<span class="k">raise</span> <span class="bp">NotImplemented</span>
</div>
<div class="viewcode-block" id="Profiler.show"><a class="viewcode-back" href="../../pyspark.html#pyspark.Profiler.show">[docs]</a> <span class="k">def</span> <span class="nf">show</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
<span class="sd">""" Print the profile stats to stdout, id is the RDD id """</span>
<span class="n">stats</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stats</span><span class="p">()</span>
<span class="k">if</span> <span class="n">stats</span><span class="p">:</span>
<span class="k">print</span><span class="p">(</span><span class="s">"="</span> <span class="o">*</span> <span class="mi">60</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="s">"Profile of RDD<id=</span><span class="si">%d</span><span class="s">>"</span> <span class="o">%</span> <span class="nb">id</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="s">"="</span> <span class="o">*</span> <span class="mi">60</span><span class="p">)</span>
<span class="n">stats</span><span class="o">.</span><span class="n">sort_stats</span><span class="p">(</span><span class="s">"time"</span><span class="p">,</span> <span class="s">"cumulative"</span><span class="p">)</span><span class="o">.</span><span class="n">print_stats</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="Profiler.dump"><a class="viewcode-back" href="../../pyspark.html#pyspark.Profiler.dump">[docs]</a> <span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
<span class="sd">""" Dump the profile into path, id is the RDD id """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">path</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="n">stats</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">stats</span><span class="p">()</span>
<span class="k">if</span> <span class="n">stats</span><span class="p">:</span>
<span class="n">p</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s">"rdd_</span><span class="si">%d</span><span class="s">.pstats"</span> <span class="o">%</span> <span class="nb">id</span><span class="p">)</span>
<span class="n">stats</span><span class="o">.</span><span class="n">dump_stats</span><span class="p">(</span><span class="n">p</span><span class="p">)</span>
</div></div>
<span class="k">class</span> <span class="nc">PStatsParam</span><span class="p">(</span><span class="n">AccumulatorParam</span><span class="p">):</span>
<span class="sd">"""PStatsParam is used to merge pstats.Stats"""</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">zero</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">None</span>
<span class="nd">@staticmethod</span>
<span class="k">def</span> <span class="nf">addInPlace</span><span class="p">(</span><span class="n">value1</span><span class="p">,</span> <span class="n">value2</span><span class="p">):</span>
<span class="k">if</span> <span class="n">value1</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">value2</span>
<span class="n">value1</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">value2</span><span class="p">)</span>
<span class="k">return</span> <span class="n">value1</span>
<div class="viewcode-block" id="BasicProfiler"><a class="viewcode-back" href="../../pyspark.html#pyspark.BasicProfiler">[docs]</a><span class="k">class</span> <span class="nc">BasicProfiler</span><span class="p">(</span><span class="n">Profiler</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> BasicProfiler is the default profiler, which is implemented based on</span>
<span class="sd"> cProfile and Accumulator</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span>
<span class="n">Profiler</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">)</span>
<span class="c"># Creates a new accumulator for combining the profiles of different</span>
<span class="c"># partitions of a stage</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_accumulator</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">accumulator</span><span class="p">(</span><span class="bp">None</span><span class="p">,</span> <span class="n">PStatsParam</span><span class="p">)</span>
<div class="viewcode-block" id="BasicProfiler.profile"><a class="viewcode-back" href="../../pyspark.html#pyspark.BasicProfiler.profile">[docs]</a> <span class="k">def</span> <span class="nf">profile</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="p">):</span>
<span class="sd">""" Runs and profiles the method to_profile passed in. A profile object is returned. """</span>
<span class="n">pr</span> <span class="o">=</span> <span class="n">cProfile</span><span class="o">.</span><span class="n">Profile</span><span class="p">()</span>
<span class="n">pr</span><span class="o">.</span><span class="n">runcall</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
<span class="n">st</span> <span class="o">=</span> <span class="n">pstats</span><span class="o">.</span><span class="n">Stats</span><span class="p">(</span><span class="n">pr</span><span class="p">)</span>
<span class="n">st</span><span class="o">.</span><span class="n">stream</span> <span class="o">=</span> <span class="bp">None</span> <span class="c"># make it picklable</span>
<span class="n">st</span><span class="o">.</span><span class="n">strip_dirs</span><span class="p">()</span>
<span class="c"># Adds a new profile to the existing accumulated value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_accumulator</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">st</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="BasicProfiler.stats"><a class="viewcode-back" href="../../pyspark.html#pyspark.BasicProfiler.stats">[docs]</a> <span class="k">def</span> <span class="nf">stats</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_accumulator</span><span class="o">.</span><span class="n">value</span>
</div></div>
<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">"__main__"</span><span class="p">:</span>
<span class="kn">import</span> <span class="nn">doctest</span>
<span class="p">(</span><span class="n">failure_count</span><span class="p">,</span> <span class="n">test_count</span><span class="p">)</span> <span class="o">=</span> <span class="n">doctest</span><span class="o">.</span><span class="n">testmod</span><span class="p">()</span>
<span class="k">if</span> <span class="n">failure_count</span><span class="p">:</span>
<span class="nb">exit</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/spark-logo-hd.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="nav-item nav-item-0"><a href="../../index.html">PySpark master documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright .
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
</html>
|
