/* Title: Pure/Admin/build_status.scala
Author: Makarius
Present recent build status information from database.
*/
package isabelle
object Build_Status
{
/* defaults */
val default_target_dir = Path.explode("build_status")
val default_image_size = (800, 600)
val default_history = 30
def default_profiles: List[Profile] =
Jenkins.build_status_profiles ::: Isabelle_Cronjob.build_status_profiles
/* data profiles */
sealed case class Profile(description: String, history: Int, sql: String)
{
def days(options: Options): Int = options.int("build_log_history") max history
def stretch(options: Options): Double =
(days(options) max default_history min (default_history * 5)).toDouble / default_history
def select(options: Options, columns: List[SQL.Column], only_sessions: Set[String]): SQL.Source =
{
Build_Log.Data.universal_table.select(columns, distinct = true,
sql = "WHERE " +
Build_Log.Data.pull_date + " > " + Build_Log.Data.recent_time(days(options)) + " AND " +
SQL.member(Build_Log.Data.status.ident,
List(
Build_Log.Session_Status.finished.toString,
Build_Log.Session_Status.failed.toString)) +
(if (only_sessions.isEmpty) ""
else " AND " + SQL.member(Build_Log.Data.session_name.ident, only_sessions)) +
" AND " + SQL.enclose(sql) +
" ORDER BY " + Build_Log.Data.pull_date)
}
}
/* build status */
def build_status(options: Options,
progress: Progress = No_Progress,
profiles: List[Profile] = default_profiles,
only_sessions: Set[String] = Set.empty,
verbose: Boolean = false,
target_dir: Path = default_target_dir,
ml_statistics: Boolean = false,
image_size: (Int, Int) = default_image_size)
{
val data =
read_data(options, progress = progress, profiles = profiles,
only_sessions = only_sessions, ml_statistics = ml_statistics, verbose = verbose)
present_data(data, progress = progress, target_dir = target_dir, image_size = image_size)
}
/* read data */
sealed case class Data(date: Date, entries: List[Data_Entry])
sealed case class Data_Entry(
name: String, hosts: List[String], stretch: Double, sessions: List[Session])
{
def failed_sessions: List[Session] =
sessions.filter(_.head.failed).sortBy(_.name)
}
sealed case class Session(
name: String, threads: Int, entries: List[Entry], ml_statistics: ML_Statistics)
{
require(entries.nonEmpty)
def head: Entry = entries.head
def order: Long = - head.timing.elapsed.ms
def finished_entries: List[Entry] = entries.filter(_.finished)
def check_timing: Boolean = finished_entries.length >= 3
def check_heap: Boolean =
finished_entries.length >= 3 &&
finished_entries.forall(entry =>
entry.maximum_heap > 0 ||
entry.average_heap > 0 ||
entry.stored_heap > 0)
}
sealed case class Entry(
pull_date: Date,
isabelle_version: String,
afp_version: String,
timing: Timing,
ml_timing: Timing,
maximum_heap: Long,
average_heap: Long,
stored_heap: Long,
status: Build_Log.Session_Status.Value,
errors: List[String])
{
def finished: Boolean = status == Build_Log.Session_Status.finished
def failed: Boolean = status == Build_Log.Session_Status.failed
def present_errors(name: String): XML.Body =
if (errors.isEmpty) HTML.text(name + " (" + isabelle_version + ")")
else {
HTML.tooltip_errors(HTML.text(name), errors.map(s => HTML.text(Symbol.decode(s)))) ::
HTML.text(" (" + isabelle_version + ")")
}
}
sealed case class Image(name: String, width: Int, height: Int)
{
def path: Path = Path.basic(name)
}
def read_data(options: Options,
progress: Progress = No_Progress,
profiles: List[Profile] = default_profiles,
only_sessions: Set[String] = Set.empty,
ml_statistics: Boolean = false,
verbose: Boolean = false): Data =
{
val date = Date.now()
var data_hosts = Map.empty[String, Set[String]]
var data_stretch = Map.empty[String, Double]
var data_entries = Map.empty[String, Map[String, Session]]
def get_hosts(data_name: String): Set[String] =
data_hosts.getOrElse(data_name, Set.empty)
val store = Build_Log.store(options)
using(store.open_database())(db =>
{
for (profile <- profiles.sortBy(_.description)) {
progress.echo("input " + quote(profile.description))
val columns =
List(
Build_Log.Data.pull_date,
Build_Log.Prop.build_host,
Build_Log.Prop.isabelle_version,
Build_Log.Prop.afp_version,
Build_Log.Settings.ISABELLE_BUILD_OPTIONS,
Build_Log.Settings.ML_PLATFORM,
Build_Log.Data.session_name,
Build_Log.Data.threads,
Build_Log.Data.timing_elapsed,
Build_Log.Data.timing_cpu,
Build_Log.Data.timing_gc,
Build_Log.Data.ml_timing_elapsed,
Build_Log.Data.ml_timing_cpu,
Build_Log.Data.ml_timing_gc,
Build_Log.Data.heap_size,
Build_Log.Data.status,
Build_Log.Data.errors) :::
(if (ml_statistics) List(Build_Log.Data.ml_statistics) else Nil)
val Threads_Option = """threads\s*=\s*(\d+)""".r
val sql = profile.select(options, columns, only_sessions)
if (verbose) progress.echo(sql)
db.using_statement(sql)(stmt =>
{
val res = stmt.execute_query()
while (res.next()) {
val session_name = res.string(Build_Log.Data.session_name)
val threads =
{
val threads1 =
res.string(Build_Log.Settings.ISABELLE_BUILD_OPTIONS) match {
case Threads_Option(Value.Int(i)) => i
case _ => 1
}
val threads2 = res.get_int(Build_Log.Data.threads).getOrElse(1)
threads1 max threads2
}
val ml_platform = res.string(Build_Log.Settings.ML_PLATFORM)
val data_name =
profile.description +
(if (ml_platform.startsWith("x86_64")) ", 64bit" else "") +
(if (threads == 1) "" else ", " + threads + " threads")
res.get_string(Build_Log.Prop.build_host).foreach(host =>
data_hosts += (data_name -> (get_hosts(data_name) + host)))
data_stretch += (data_name -> profile.stretch(options))
val isabelle_version = res.string(Build_Log.Prop.isabelle_version)
val ml_stats =
ML_Statistics(
if (ml_statistics)
Properties.uncompress(res.bytes(Build_Log.Data.ml_statistics))
else Nil, heading = session_name + " (Isabelle/" + isabelle_version + ")")
val entry =
Entry(
pull_date = res.date(Build_Log.Data.pull_date),
isabelle_version = isabelle_version,
afp_version = res.string(Build_Log.Prop.afp_version),
timing =
res.timing(
Build_Log.Data.timing_elapsed,
Build_Log.Data.timing_cpu,
Build_Log.Data.timing_gc),
ml_timing =
res.timing(
Build_Log.Data.ml_timing_elapsed,
Build_Log.Data.ml_timing_cpu,
Build_Log.Data.ml_timing_gc),
maximum_heap = ml_stats.maximum_heap_size,
average_heap = ml_stats.average_heap_size,
stored_heap = ML_Statistics.heap_scale(res.long(Build_Log.Data.heap_size)),
status = Build_Log.Session_Status.withName(res.string(Build_Log.Data.status)),
errors = Build_Log.uncompress_errors(res.bytes(Build_Log.Data.errors)))
val sessions = data_entries.getOrElse(data_name, Map.empty)
val entries = sessions.get(session_name).map(_.entries) getOrElse Nil
val session = Session(session_name, threads, entry :: entries, ml_stats)
data_entries += (data_name -> (sessions + (session_name -> session)))
}
})
}
})
val sorted_entries =
(for {
(name, sessions) <- data_entries.toList
sorted_sessions <- proper_list(sessions.toList.map(_._2).sortBy(_.order))
}
yield {
val hosts = get_hosts(name).toList.sorted
val stretch = data_stretch(name)
Data_Entry(name, hosts, stretch, sorted_sessions)
}).sortBy(_.name)
Data(date, sorted_entries)
}
/* present data */
def present_data(data: Data,
progress: Progress = No_Progress,
target_dir: Path = default_target_dir,
image_size: (Int, Int) = default_image_size)
{
def clean_name(name: String): String =
name.flatMap(c => if (c == ' ' || c == '/') "_" else if (c == ',') "" else c.toString)
def print_heap(x: Long): Option[String] =
if (x == 0L) None else Some(x.toString + " M")
HTML.write_document(target_dir, "index.html",
List(HTML.title("Isabelle build status")),
List(HTML.chapter("Isabelle build status"),
HTML.par(
List(HTML.description(
List(HTML.text("status date:") -> HTML.text(data.date.toString))))),
HTML.par(
List(HTML.itemize(data.entries.map({ case data_entry =>
List(
HTML.link(clean_name(data_entry.name) + "/index.html",
HTML.text(data_entry.name))) :::
(data_entry.failed_sessions match {
case Nil => Nil
case sessions =>
HTML.break :::
List(HTML.span(HTML.error_message, HTML.text("Failed sessions:"))) :::
List(HTML.itemize(sessions.map(s => s.head.present_errors(s.name))))
})
}))))))
for (data_entry <- data.entries) {
val data_name = data_entry.name
val (image_width, image_height) = image_size
val image_width_stretch = (image_width * data_entry.stretch).toInt
progress.echo("output " + quote(data_name))
val dir = target_dir + Path.basic(clean_name(data_name))
Isabelle_System.mkdirs(dir)
val session_plots =
Par_List.map((session: Session) =>
Isabelle_System.with_tmp_file(session.name, "data") { data_file =>
Isabelle_System.with_tmp_file(session.name, "gnuplot") { gnuplot_file =>
def plot_name(kind: String): String = session.name + "_" + kind + ".png"
File.write(data_file,
cat_lines(
session.finished_entries.map(entry =>
List(entry.pull_date.unix_epoch,
entry.timing.elapsed.minutes,
entry.timing.resources.minutes,
entry.ml_timing.elapsed.minutes,
entry.ml_timing.resources.minutes,
entry.maximum_heap,
entry.average_heap,
entry.stored_heap).mkString(" "))))
val max_time =
((0.0 /: session.finished_entries){ case (m, entry) =>
m.max(entry.timing.elapsed.minutes).
max(entry.timing.resources.minutes).
max(entry.ml_timing.elapsed.minutes).
max(entry.ml_timing.resources.minutes) } max 0.1) * 1.1
val timing_range = "[0:" + max_time + "]"
def gnuplot(plot_name: String, plots: List[String], range: String): Image =
{
val image = Image(plot_name, image_width_stretch, image_height)
File.write(gnuplot_file, """
set terminal png size """ + image.width + "," + image.height + """
set output """ + quote(File.standard_path(dir + image.path)) + """
set xdata time
set timefmt "%s"
set format x "%d-%b"
set xlabel """ + quote(session.name) + """ noenhanced
set key left bottom
plot [] """ + range + " " +
plots.map(s => quote(data_file.implode) + " " + s).mkString(", ") + "\n")
val result =
Isabelle_System.bash("\"$ISABELLE_GNUPLOT\" " + File.bash_path(gnuplot_file))
if (!result.ok)
result.error("Gnuplot failed for " + data_name + "/" + plot_name).check
image
}
val timing_plots =
{
val plots1 =
List(
""" using 1:2 smooth sbezier title "elapsed time (smooth)" """,
""" using 1:2 smooth csplines title "elapsed time" """)
val plots2 =
List(
""" using 1:3 smooth sbezier title "cpu time (smooth)" """,
""" using 1:3 smooth csplines title "cpu time" """)
if (session.threads == 1) plots1 else plots1 ::: plots2
}
val ml_timing_plots =
List(
""" using 1:4 smooth sbezier title "ML elapsed time (smooth)" """,
""" using 1:4 smooth csplines title "ML elapsed time" """,
""" using 1:5 smooth sbezier title "ML cpu time (smooth)" """,
""" using 1:5 smooth csplines title "ML cpu time" """)
val heap_plots =
List(
""" using 1:6 smooth sbezier title "maximum heap (smooth)" """,
""" using 1:6 smooth csplines title "maximum heap" """,
""" using 1:7 smooth sbezier title "average heap (smooth)" """,
""" using 1:7 smooth csplines title "average heap" """,
""" using 1:8 smooth sbezier title "stored heap (smooth)" """,
""" using 1:8 smooth csplines title "stored heap" """)
def jfreechart(plot_name: String, fields: ML_Statistics.Fields): Image =
{
val image = Image(plot_name, image_width, image_height)
val chart =
session.ml_statistics.chart(
fields._1 + ": " + session.ml_statistics.heading, fields._2)
Graphics_File.write_chart_png(
(dir + image.path).file, chart, image.width, image.height)
image
}
val images =
(if (session.check_timing)
List(
gnuplot(plot_name("timing"), timing_plots, timing_range),
gnuplot(plot_name("ml_timing"), ml_timing_plots, timing_range))
else Nil) :::
(if (session.check_heap)
List(gnuplot(plot_name("heap"), heap_plots, "[0:]"))
else Nil) :::
(if (session.ml_statistics.content.nonEmpty)
List(jfreechart(plot_name("heap_chart"), ML_Statistics.heap_fields)) :::
(if (session.threads > 1)
List(
jfreechart(plot_name("tasks_chart"), ML_Statistics.tasks_fields),
jfreechart(plot_name("workers_chart"), ML_Statistics.workers_fields))
else Nil)
else Nil)
session.name -> images
}
}, data_entry.sessions).toMap
HTML.write_document(dir, "index.html",
List(HTML.title("Isabelle build status for " + data_name)),
HTML.chapter("Isabelle build status for " + data_name) ::
HTML.par(
List(HTML.description(
List(
HTML.text("status date:") -> HTML.text(data.date.toString),
HTML.text("build host:") -> HTML.text(commas(data_entry.hosts)))))) ::
HTML.par(
List(HTML.itemize(
data_entry.sessions.map(session =>
HTML.link("#session_" + session.name, HTML.text(session.name)) ::
HTML.text(" (" + session.head.timing.message_resources + ")"))))) ::
data_entry.sessions.flatMap(session =>
List(
HTML.section(HTML.id("session_" + session.name), session.name),
HTML.par(
HTML.description(
List(
HTML.text("timing:") -> HTML.text(session.head.timing.message_resources),
HTML.text("ML timing:") -> HTML.text(session.head.ml_timing.message_resources)) :::
print_heap(session.head.maximum_heap).map(s =>
HTML.text("maximum heap:") -> HTML.text(s)).toList :::
print_heap(session.head.average_heap).map(s =>
HTML.text("average heap:") -> HTML.text(s)).toList :::
print_heap(session.head.stored_heap).map(s =>
HTML.text("stored heap:") -> HTML.text(s)).toList :::
proper_string(session.head.isabelle_version).map(s =>
HTML.text("Isabelle version:") -> HTML.text(s)).toList :::
proper_string(session.head.afp_version).map(s =>
HTML.text("AFP version:") -> HTML.text(s)).toList) ::
session_plots.getOrElse(session.name, Nil).map(image =>
HTML.size(image.width / 2, image.height / 2)(HTML.image(image.name)))))))
}
}
/* Isabelle tool wrapper */
val isabelle_tool =
Isabelle_Tool("build_status", "present recent build status information from database", args =>
{
var target_dir = default_target_dir
var ml_statistics = false
var only_sessions = Set.empty[String]
var options = Options.init()
var image_size = default_image_size
var verbose = false
val getopts = Getopts("""
Usage: isabelle build_status [OPTIONS]
Options are:
-D DIR target directory (default """ + default_target_dir + """)
-M include full ML statistics
-S SESSIONS only given SESSIONS (comma separated)
-o OPTION override Isabelle system OPTION (via NAME=VAL or NAME)
-s WxH size of PNG image (default """ + image_size._1 + "x" + image_size._2 + """)
-v verbose
Present performance statistics from build log database, which is specified
via system options build_log_database_host, build_log_database_user,
build_log_history etc.
""",
"D:" -> (arg => target_dir = Path.explode(arg)),
"M" -> (_ => ml_statistics = true),
"S:" -> (arg => only_sessions = space_explode(',', arg).toSet),
"o:" -> (arg => options = options + arg),
"s:" -> (arg =>
space_explode('x', arg).map(Value.Int.parse(_)) match {
case List(w, h) if w > 0 && h > 0 => image_size = (w, h)
case _ => error("Error bad PNG image size: " + quote(arg))
}),
"v" -> (_ => verbose = true))
val more_args = getopts(args)
if (more_args.nonEmpty) getopts.usage()
val progress = new Console_Progress
build_status(options, progress = progress, only_sessions = only_sessions, verbose = verbose,
target_dir = target_dir, ml_statistics = ml_statistics, image_size = image_size)
}, admin = true)
}