2 # Copyright (C) 2019 - Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 from statistics
import mean
23 from operator
import add
25 import matplotlib
.pyplot
as plt
26 from matplotlib
.backends
.backend_pdf
import PdfPages
27 from matplotlib
.ticker
import PercentFormatter
33 from minio
import Minio
34 from minio
.error
import NoSuchKey
35 from minio
.error
import ResponseError
38 BENCHMARK_TYPES
= ["dummy", "text"]
39 DEFAULT_BUCKET
= "lava"
42 def json_type(string
):
44 Argpase type for json args.
45 We expect a base dictionary.
47 passed_json
= json
.loads(string
)
48 if not isinstance(passed_json
, dict):
49 msg
= "%r is not a dict" % string
50 raise argparse
.ArgumentTypeError(msg
)
53 def graph_get_color(branch
):
55 Get the color matching the branch.
57 color
= {"stable-1.5": "red", "stable-2.0": "green", "master": "blue"}
61 def graph_get_title(branch
, benchmark_type
):
63 Get title for graph based on benchmark type.
65 string
= {"dummy": "Dummy output", "text": "Text output"}
66 return "{} - {}".format(branch
, string
[benchmark_type
])
71 Return minio client configured.
74 "obj.internal.efficios.com", access_key
="jenkins", secret_key
="echo123456"
78 def get_file(client
, prefix
, file_name
, workdir_name
):
80 Return the path of the downloaded file.
83 destination
= os
.path
.join(workdir_name
, file_name
)
84 object_name
= "{}/{}".format(prefix
, file_name
)
86 client
.fget_object(DEFAULT_BUCKET
, object_name
, destination
)
93 def delete_file(client
, prefix
, file_name
):
95 Delete the file on remote.
97 object_name
= "{}/{}".format(prefix
, file_name
)
99 client
.remove_object(DEFAULT_BUCKET
, object_name
)
100 except ResponseError
as err
:
106 def get_git_log(bt_version
, cutoff
, repo_path
):
108 Return an ordered (older to newer) list of commits for the bt_version and
109 cutoff. WARNING: This changes the git repo HEAD.
111 repo
= git
.Repo(repo_path
)
114 "{}..origin/{}".format(cutoff
, bt_version
), "--pretty=format:%H", "--reverse"
118 def parse_result(result_path
):
120 Parse the result file. Return a dataset of User time + System time.
122 with
open(result_path
) as result
:
123 parsed_result
= json
.load(result
)
127 parsed_result
["User time (seconds)"],
128 parsed_result
["System time (seconds)"],
133 def get_benchmark_results(client
, commit
, workdir
):
135 Fetch the benchmark result from a certain commit across all benchmark type.
138 benchmark_valid
= True
139 for b_type
in BENCHMARK_TYPES
:
140 prefix
= "/results/benchmarks/babeltrace/{}/".format(b_type
)
141 result_file
= get_file(client
, prefix
, commit
, workdir
)
144 Benchmark is either corrupted or not complete.
146 return None, benchmark_valid
147 results
[b_type
] = parse_result(result_file
)
148 if all(i
== 0.0 for i
in results
[b_type
]):
149 benchmark_valid
= False
150 print("Invalid benchmark for {}/{}/{}".format(prefix
, b_type
, commit
))
151 # The dataset is valid return immediately.
152 return results
, benchmark_valid
155 def plot_raw_value(branch
, benchmark_type
, x_data
, y_data
, labels
, latest_values
):
157 Plot the graph using the raw value.
163 for pos
in range(len(x_data
)):
165 valid_points
, outliers
= sanitize_dataset(y_data
[pos
])
166 for y
in valid_points
:
167 point_x_data
.append(x
)
168 point_y_data
.append(y
)
170 outlier_x_data
.append(x
)
171 outlier_y_data
.append(y
)
174 point_x_data
, point_y_data
, "o", label
=branch
, color
=graph_get_color(branch
)
176 plt
.plot(outlier_x_data
, outlier_y_data
, "+", label
="outlier", color
="black")
180 ymin
= 0.8 * min([item
for sublist
in y_data
for item
in sublist
])
181 ymax
= 1.2 * max([item
for sublist
in y_data
for item
in sublist
])
182 # Put latest of other branches for reference as horizontal line.
183 for l_branch
, l_result
in latest_values
.items():
184 if not l_result
or l_branch
== branch
:
188 label
="Latest {}".format(l_branch
),
189 color
=graph_get_color(l_branch
),
192 ymax
= 1.2 * l_result
194 plt
.ylim(ymin
=0, ymax
=ymax
)
195 plt
.xticks(x_data
, labels
, rotation
=90, family
="monospace")
196 plt
.title(graph_get_title(branch
, benchmark_type
), fontweight
="bold")
197 plt
.ylabel("User + system time (s)")
198 plt
.xlabel("Latest commits")
202 # Put tick on the right side
203 ax
.tick_params(labeltop
=False, labelright
=True)
209 def plot_delta_between_point(
210 branch
, benchmark_type
, x_data
, y_data
, labels
, latest_values
213 Plot the graph of delta between each sequential commit.
217 # Transform y_data to a list of for which the reference is the first
220 for pos
, y
in enumerate(y_data
):
222 local_y_data
.append(0.0)
224 local_y_data
.append(y
- y_data
[pos
- 1])
226 plt
.plot(x_data
, local_y_data
, "o", label
=branch
, color
=graph_get_color(branch
))
228 # Get max absolute value to align the y axis with zero in the middle.
230 local_abs_max
= abs(max(local_y_data
, key
=abs)) * 1.3
232 plt
.ylim(ymin
=local_abs_max
* -1, ymax
=local_abs_max
)
235 plt
.xticks(x_data
, labels
, rotation
=90, family
="monospace")
237 graph_get_title(branch
, benchmark_type
) + " Delta to previous commit",
240 plt
.ylabel("Seconds")
241 plt
.xlabel("Latest commits")
245 # Put tick on the right side
246 ax
.tick_params(labeltop
=False, labelright
=True)
252 def plot_ratio(branch
, benchmark_type
, x_data
, y_data
, labels
, latest_values
):
254 Plot the graph using a ratio using first point as reference (0%).
260 reference
= y_data
[0]
262 # Transform y_data to a list of ratio for which the reference is the first
264 local_y_data
= list(map(lambda y
: ((y
/ reference
) - 1.0) * 100, y_data
))
266 plt
.plot(x_data
, local_y_data
, "o", label
=branch
, color
=graph_get_color(branch
))
268 # Put latest of other branches for reference as horizontal line.
269 for l_branch
, l_result
in latest_values
.items():
270 if not l_result
or l_branch
== branch
:
272 ratio_l_result
= ((l_result
/ reference
) - 1.0) * 100.0
274 "branch {} branch {} value {} l_result {} reference {}".format(
275 branch
, l_branch
, ratio_l_result
, l_result
, reference
280 label
="Latest {}".format(l_branch
),
281 color
=graph_get_color(l_branch
),
284 # Draw the reference line.
285 plt
.axhline(y
=0, label
="Reference (leftmost point)", linestyle
="-", color
="Black")
287 # Get max absolute value to align the y axis with zero in the middle.
289 local_abs_max
= abs(max(local_y_data
, key
=abs)) * 1.3
291 y_abs_max
= local_abs_max
293 plt
.ylim(ymin
=y_abs_max
* -1, ymax
=y_abs_max
)
296 percent_formatter
= PercentFormatter()
297 ax
.yaxis
.set_major_formatter(percent_formatter
)
298 ax
.yaxis
.set_minor_formatter(percent_formatter
)
299 plt
.xticks(x_data
, labels
, rotation
=90, family
="monospace")
300 plt
.title(graph_get_title(branch
, benchmark_type
), fontweight
="bold")
302 plt
.xlabel("Latest commits")
306 # Put tick on the right side
307 ax
.tick_params(labeltop
=False, labelright
=True)
313 def generate_graph(branches
, report_name
, git_path
):
316 pdf_pages
= PdfPages(report_name
)
318 client
= get_client()
319 branch_results
= dict()
321 # Fetch the results for each branch.
322 for branch
, cutoff
in branches
.items():
323 commits
= get_git_log(branch
, cutoff
, git_path
)
325 with tempfile
.TemporaryDirectory() as workdir
:
326 for commit
in commits
:
327 b_results
, valid
= get_benchmark_results(client
, commit
, workdir
)
328 if not b_results
or not valid
:
330 results
.append((commit
, b_results
))
331 branch_results
[branch
] = results
333 for b_type
in BENCHMARK_TYPES
:
337 # Find the maximum size for a series inside our series dataset.
338 # This is used later to compute the size of the actual plot (pdf).
339 # While there gather the comparison value used to draw comparison line
341 for branch
, results
in branch_results
.items():
342 max_len
= max([max_len
, len(results
)])
344 latest_values
[branch
] = mean(
345 sanitize_dataset(results
[-1][1][b_type
])[0]
348 latest_values
[branch
] = None
350 for branch
, results
in branch_results
.items():
351 # Create a figure instance
352 if max_len
and max_len
> 10:
353 width
= 0.16 * max_len
357 x_data
= list(range(len(results
)))
358 y_data
= [c
[1][b_type
] for c
in results
]
359 labels
= [c
[0][:8] for c
in results
]
361 fig
= plt
.figure(figsize
=(width
, 8.27), dpi
=100)
362 plot_raw_value(branch
, b_type
, x_data
, y_data
, labels
, latest_values
)
363 pdf_pages
.savefig(fig
)
365 # Use the mean of each sanitize dataset here, we do not care for
366 # variance for ratio. At least not yet.
367 y_data
= [mean(sanitize_dataset(c
[1][b_type
])[0]) for c
in results
]
368 fig
= plt
.figure(figsize
=(width
, 8.27), dpi
=100)
369 plot_ratio(branch
, b_type
, x_data
, y_data
, labels
, latest_values
)
370 pdf_pages
.savefig(fig
)
372 fig
= plt
.figure(figsize
=(width
, 8.27), dpi
=100)
373 plot_delta_between_point(
374 branch
, b_type
, x_data
, y_data
, labels
, latest_values
376 pdf_pages
.savefig(fig
)
381 def launch_jobs(branches
, git_path
, wait_for_completion
, debug
, force
):
383 Lauch jobs for all missing results.
385 client
= get_client()
386 for branch
, cutoff
in branches
.items():
387 commits
= get_git_log(branch
, cutoff
, git_path
)
389 with tempfile
.TemporaryDirectory() as workdir
:
390 for commit
in commits
:
391 b_results
= get_benchmark_results(client
, commit
, workdir
)[0]
392 if b_results
and not force
:
395 commit
, wait_for_completion
=wait_for_completion
, debug
=debug
401 Parse arguments and execute as needed.
404 "master": "31976fe2d70a8b6b7f8b31b9e0b3bc004d415575",
405 "stable-2.0": "07f585356018b4ddfbd0e09c49a14e38977c6973",
406 "stable-1.5": "49e98b837a5667130e0d1e062a6bd7985c7c4582",
409 parser
= argparse
.ArgumentParser(description
="Babeltrace benchmark utility")
411 "--generate-jobs", action
="store_true", help="Generate and send jobs"
414 "--force-jobs", action
="store_true", help="Force the queueing of jobs to lava"
417 "--do-not-wait-on-completion",
420 help="Wait for the completion of each jobs sent. This is useful"
421 "for the ci. Otherwise we could end up spaming the lava instance.",
426 help="Generate graphs and save them to pdf",
429 "--report-name", default
="report.pdf", help="The name of the pdf report."
432 "--debug", action
="store_true", default
=False, help="Do not send jobs to lava."
435 "--repo-path", help="The location of the git repo to use.", required
=True
438 "--overwrite-branches-cutoff",
439 help="A dictionary of the form {"
440 "'branch_name': 'commit_hash_cutoff',...}. Allow custom graphing and"
442 required
=False, type=json_type
445 args
= parser
.parse_args()
447 if args
.overwrite_branches_cutoff
:
448 bt_branches
= args
.overwrite_branches_cutoff
450 if not os
.path
.exists(args
.repo_path
):
451 print("Repository location does not exists.")
454 if args
.generate_jobs
:
455 print("Launching jobs for:")
457 for branch
, cutoff
in bt_branches
.items():
458 print("\t Branch {} with cutoff {}".format(branch
, cutoff
))
463 not args
.do_not_wait_on_completion
,
468 if args
.generate_report
:
469 print("Generating pdf report ({}) for:".format(args
.report_name
))
470 for branch
, cutoff
in bt_branches
.items():
471 print("\t Branch {} with cutoff {}".format(branch
, cutoff
))
472 generate_graph(bt_branches
, args
.report_name
, args
.repo_path
)
477 def sanitize_dataset(dataset
):
479 Use IRQ 1.5 [1] to remove outlier from the dataset. This is useful to get a
480 representative mean without outlier in it.
481 [1] https://en.wikipedia.org/wiki/Interquartile_range#Outliers
483 sorted_data
= sorted(dataset
)
484 q1
, q3
= numpy
.percentile(sorted_data
, [25, 75])
486 lower_bound
= q1
- (1.5 * iqr
)
487 upper_bound
= q3
+ (1.5 * iqr
)
491 if lower_bound
<= i
<= upper_bound
:
492 new_dataset
.append(i
)
495 return new_dataset
, outliers
498 if __name__
== "__main__":