src/Pure/Admin/build_status.scala
author wenzelm
Fri May 26 23:21:50 2017 +0200 (2017-05-26)
changeset 65939 9fb044904a4d
parent 65895 744878d72021
child 65940 9c7241798c3b
permissions -rw-r--r--
support for message underline and tooltips;
     1 /*  Title:      Pure/Admin/build_status.scala
     2     Author:     Makarius
     3 
     4 Present recent build status information from database.
     5 */
     6 
     7 package isabelle
     8 
     9 
    10 object Build_Status
    11 {
    12   /* defaults */
    13 
    14   val default_target_dir = Path.explode("build_status")
    15   val default_image_size = (800, 600)
    16   val default_history = 30
    17 
    18   def default_profiles: List[Profile] =
    19     Jenkins.build_status_profiles ::: Isabelle_Cronjob.build_status_profiles
    20 
    21 
    22   /* data profiles */
    23 
    24   sealed case class Profile(description: String, history: Int, sql: String)
    25   {
    26     def days(options: Options): Int = options.int("build_log_history") max history
    27 
    28     def stretch(options: Options): Double =
    29       (days(options) max default_history min (default_history * 5)).toDouble / default_history
    30 
    31     def select(options: Options, columns: List[SQL.Column], only_sessions: Set[String]): SQL.Source =
    32     {
    33       Build_Log.Data.universal_table.select(columns, distinct = true,
    34         sql = "WHERE " +
    35           Build_Log.Data.pull_date + " > " + Build_Log.Data.recent_time(days(options)) + " AND " +
    36           SQL.member(Build_Log.Data.status.ident,
    37             List(
    38               Build_Log.Session_Status.finished.toString,
    39               Build_Log.Session_Status.failed.toString)) +
    40           (if (only_sessions.isEmpty) ""
    41            else " AND " + SQL.member(Build_Log.Data.session_name.ident, only_sessions)) +
    42           " AND " + SQL.enclose(sql) +
    43           " ORDER BY " + Build_Log.Data.pull_date)
    44     }
    45   }
    46 
    47 
    48   /* build status */
    49 
    50   def build_status(options: Options,
    51     progress: Progress = No_Progress,
    52     profiles: List[Profile] = default_profiles,
    53     only_sessions: Set[String] = Set.empty,
    54     verbose: Boolean = false,
    55     target_dir: Path = default_target_dir,
    56     ml_statistics: Boolean = false,
    57     image_size: (Int, Int) = default_image_size)
    58   {
    59     val data =
    60       read_data(options, progress = progress, profiles = profiles,
    61         only_sessions = only_sessions, ml_statistics = ml_statistics, verbose = verbose)
    62 
    63     present_data(data, progress = progress, target_dir = target_dir, image_size = image_size)
    64   }
    65 
    66 
    67   /* read data */
    68 
    69   sealed case class Data(date: Date, entries: List[Data_Entry])
    70   sealed case class Data_Entry(
    71     name: String, hosts: List[String], stretch: Double, sessions: List[Session])
    72   {
    73     def failed_sessions: List[Session] =
    74       sessions.filter(_.head.failed).sortBy(_.name)
    75   }
    76   sealed case class Session(
    77     name: String, threads: Int, entries: List[Entry], ml_statistics: ML_Statistics)
    78   {
    79     require(entries.nonEmpty)
    80 
    81     def head: Entry = entries.head
    82     def order: Long = - head.timing.elapsed.ms
    83 
    84     def finished_entries: List[Entry] = entries.filter(_.finished)
    85 
    86     def check_timing: Boolean = finished_entries.length >= 3
    87     def check_heap: Boolean =
    88       finished_entries.length >= 3 &&
    89       finished_entries.forall(entry =>
    90         entry.maximum_heap > 0 ||
    91         entry.average_heap > 0 ||
    92         entry.stored_heap > 0)
    93   }
    94   sealed case class Entry(
    95     pull_date: Date,
    96     isabelle_version: String,
    97     afp_version: String,
    98     timing: Timing,
    99     ml_timing: Timing,
   100     maximum_heap: Long,
   101     average_heap: Long,
   102     stored_heap: Long,
   103     status: Build_Log.Session_Status.Value)
   104   {
   105     def finished: Boolean = status == Build_Log.Session_Status.finished
   106     def failed: Boolean = status == Build_Log.Session_Status.failed
   107   }
   108 
   109   sealed case class Image(name: String, width: Int, height: Int)
   110   {
   111     def path: Path = Path.basic(name)
   112   }
   113 
   114   def read_data(options: Options,
   115     progress: Progress = No_Progress,
   116     profiles: List[Profile] = default_profiles,
   117     only_sessions: Set[String] = Set.empty,
   118     ml_statistics: Boolean = false,
   119     verbose: Boolean = false): Data =
   120   {
   121     val date = Date.now()
   122     var data_hosts = Map.empty[String, Set[String]]
   123     var data_stretch = Map.empty[String, Double]
   124     var data_entries = Map.empty[String, Map[String, Session]]
   125 
   126     def get_hosts(data_name: String): Set[String] =
   127       data_hosts.getOrElse(data_name, Set.empty)
   128 
   129     val store = Build_Log.store(options)
   130     using(store.open_database())(db =>
   131     {
   132       for (profile <- profiles.sortBy(_.description)) {
   133         progress.echo("input " + quote(profile.description))
   134 
   135         val columns =
   136           List(
   137             Build_Log.Data.pull_date,
   138             Build_Log.Prop.build_host,
   139             Build_Log.Prop.isabelle_version,
   140             Build_Log.Prop.afp_version,
   141             Build_Log.Settings.ISABELLE_BUILD_OPTIONS,
   142             Build_Log.Settings.ML_PLATFORM,
   143             Build_Log.Data.session_name,
   144             Build_Log.Data.threads,
   145             Build_Log.Data.timing_elapsed,
   146             Build_Log.Data.timing_cpu,
   147             Build_Log.Data.timing_gc,
   148             Build_Log.Data.ml_timing_elapsed,
   149             Build_Log.Data.ml_timing_cpu,
   150             Build_Log.Data.ml_timing_gc,
   151             Build_Log.Data.heap_size,
   152             Build_Log.Data.status) :::
   153           (if (ml_statistics) List(Build_Log.Data.ml_statistics) else Nil)
   154 
   155         val Threads_Option = """threads\s*=\s*(\d+)""".r
   156 
   157         val sql = profile.select(options, columns, only_sessions)
   158         if (verbose) progress.echo(sql)
   159 
   160         db.using_statement(sql)(stmt =>
   161         {
   162           val res = stmt.execute_query()
   163           while (res.next()) {
   164             val session_name = res.string(Build_Log.Data.session_name)
   165             val threads =
   166             {
   167               val threads1 =
   168                 res.string(Build_Log.Settings.ISABELLE_BUILD_OPTIONS) match {
   169                   case Threads_Option(Value.Int(i)) => i
   170                   case _ => 1
   171                 }
   172               val threads2 = res.get_int(Build_Log.Data.threads).getOrElse(1)
   173               threads1 max threads2
   174             }
   175             val ml_platform = res.string(Build_Log.Settings.ML_PLATFORM)
   176             val data_name =
   177               profile.description +
   178                 (if (ml_platform.startsWith("x86_64")) ", 64bit" else "") +
   179                 (if (threads == 1) "" else ", " + threads + " threads")
   180 
   181             res.get_string(Build_Log.Prop.build_host).foreach(host =>
   182               data_hosts += (data_name -> (get_hosts(data_name) + host)))
   183 
   184             data_stretch += (data_name -> profile.stretch(options))
   185 
   186             val isabelle_version = res.string(Build_Log.Prop.isabelle_version)
   187 
   188             val ml_stats =
   189               ML_Statistics(
   190                 if (ml_statistics)
   191                   Properties.uncompress(res.bytes(Build_Log.Data.ml_statistics))
   192                 else Nil, heading = session_name + " (Isabelle/" + isabelle_version + ")")
   193 
   194             val entry =
   195               Entry(
   196                 pull_date = res.date(Build_Log.Data.pull_date),
   197                 isabelle_version = isabelle_version,
   198                 afp_version = res.string(Build_Log.Prop.afp_version),
   199                 timing =
   200                   res.timing(
   201                     Build_Log.Data.timing_elapsed,
   202                     Build_Log.Data.timing_cpu,
   203                     Build_Log.Data.timing_gc),
   204                 ml_timing =
   205                   res.timing(
   206                     Build_Log.Data.ml_timing_elapsed,
   207                     Build_Log.Data.ml_timing_cpu,
   208                     Build_Log.Data.ml_timing_gc),
   209                 maximum_heap = ml_stats.maximum_heap_size,
   210                 average_heap = ml_stats.average_heap_size,
   211                 stored_heap = ML_Statistics.heap_scale(res.long(Build_Log.Data.heap_size)),
   212                 status = Build_Log.Session_Status.withName(res.string(Build_Log.Data.status)))
   213 
   214             val sessions = data_entries.getOrElse(data_name, Map.empty)
   215             val entries = sessions.get(session_name).map(_.entries) getOrElse Nil
   216             val session = Session(session_name, threads, entry :: entries, ml_stats)
   217             data_entries += (data_name -> (sessions + (session_name -> session)))
   218           }
   219         })
   220       }
   221     })
   222 
   223     val sorted_entries =
   224       (for {
   225         (name, sessions) <- data_entries.toList
   226         sorted_sessions <- proper_list(sessions.toList.map(_._2).sortBy(_.order))
   227       }
   228       yield {
   229         val hosts = get_hosts(name).toList.sorted
   230         val stretch = data_stretch(name)
   231         Data_Entry(name, hosts, stretch, sorted_sessions)
   232       }).sortBy(_.name)
   233 
   234     Data(date, sorted_entries)
   235   }
   236 
   237 
   238   /* present data */
   239 
   240   def present_data(data: Data,
   241     progress: Progress = No_Progress,
   242     target_dir: Path = default_target_dir,
   243     image_size: (Int, Int) = default_image_size)
   244   {
   245     def clean_name(name: String): String =
   246       name.flatMap(c => if (c == ' ' || c == '/') "_" else if (c == ',') "" else c.toString)
   247 
   248     def print_heap(x: Long): Option[String] =
   249       if (x == 0L) None else Some(x.toString + " M")
   250 
   251     HTML.write_document(target_dir, "index.html",
   252       List(HTML.title("Isabelle build status")),
   253       List(HTML.chapter("Isabelle build status"),
   254         HTML.par(
   255           List(HTML.description(
   256             List(HTML.text("status date:") -> HTML.text(data.date.toString))))),
   257         HTML.par(
   258           List(HTML.itemize(data.entries.map({ case data_entry =>
   259             List(
   260               HTML.link(clean_name(data_entry.name) + "/index.html",
   261                 HTML.text(data_entry.name))) :::
   262             (data_entry.failed_sessions match {
   263               case Nil => Nil
   264               case sessions =>
   265                 HTML.break ::: List(HTML.span(HTML.text("Failed:")) + HTML.error_message_class) :::
   266                 HTML.text(" " +
   267                   commas(sessions.map(s => s.name + " (" + s.head.isabelle_version + ")")))
   268             })
   269           }))))))
   270 
   271     for (data_entry <- data.entries) {
   272       val data_name = data_entry.name
   273 
   274       val (image_width, image_height) = image_size
   275       val image_width_stretch = (image_width * data_entry.stretch).toInt
   276 
   277       progress.echo("output " + quote(data_name))
   278 
   279       val dir = target_dir + Path.basic(clean_name(data_name))
   280       Isabelle_System.mkdirs(dir)
   281 
   282       val session_plots =
   283         Par_List.map((session: Session) =>
   284           Isabelle_System.with_tmp_file(session.name, "data") { data_file =>
   285             Isabelle_System.with_tmp_file(session.name, "gnuplot") { gnuplot_file =>
   286 
   287               def plot_name(kind: String): String = session.name + "_" + kind + ".png"
   288 
   289               File.write(data_file,
   290                 cat_lines(
   291                   session.finished_entries.map(entry =>
   292                     List(entry.pull_date.unix_epoch,
   293                       entry.timing.elapsed.minutes,
   294                       entry.timing.resources.minutes,
   295                       entry.ml_timing.elapsed.minutes,
   296                       entry.ml_timing.resources.minutes,
   297                       entry.maximum_heap,
   298                       entry.average_heap,
   299                       entry.stored_heap).mkString(" "))))
   300 
   301               val max_time =
   302                 ((0.0 /: session.finished_entries){ case (m, entry) =>
   303                   m.max(entry.timing.elapsed.minutes).
   304                     max(entry.timing.resources.minutes).
   305                     max(entry.ml_timing.elapsed.minutes).
   306                     max(entry.ml_timing.resources.minutes) } max 0.1) * 1.1
   307               val timing_range = "[0:" + max_time + "]"
   308 
   309               def gnuplot(plot_name: String, plots: List[String], range: String): Image =
   310               {
   311                 val image = Image(plot_name, image_width_stretch, image_height)
   312 
   313                 File.write(gnuplot_file, """
   314 set terminal png size """ + image.width + "," + image.height + """
   315 set output """ + quote(File.standard_path(dir + image.path)) + """
   316 set xdata time
   317 set timefmt "%s"
   318 set format x "%d-%b"
   319 set xlabel """ + quote(session.name) + """ noenhanced
   320 set key left bottom
   321 plot [] """ + range + " " +
   322                 plots.map(s => quote(data_file.implode) + " " + s).mkString(", ") + "\n")
   323 
   324                 val result =
   325                   Isabelle_System.bash("\"$ISABELLE_GNUPLOT\" " + File.bash_path(gnuplot_file))
   326                 if (!result.ok)
   327                   result.error("Gnuplot failed for " + data_name + "/" + plot_name).check
   328 
   329                 image
   330               }
   331 
   332               val timing_plots =
   333               {
   334                 val plots1 =
   335                   List(
   336                     """ using 1:2 smooth sbezier title "elapsed time (smooth)" """,
   337                     """ using 1:2 smooth csplines title "elapsed time" """)
   338                 val plots2 =
   339                   List(
   340                     """ using 1:3 smooth sbezier title "cpu time (smooth)" """,
   341                     """ using 1:3 smooth csplines title "cpu time" """)
   342                 if (session.threads == 1) plots1 else plots1 ::: plots2
   343               }
   344 
   345               val ml_timing_plots =
   346                 List(
   347                   """ using 1:4 smooth sbezier title "ML elapsed time (smooth)" """,
   348                   """ using 1:4 smooth csplines title "ML elapsed time" """,
   349                   """ using 1:5 smooth sbezier title "ML cpu time (smooth)" """,
   350                   """ using 1:5 smooth csplines title "ML cpu time" """)
   351 
   352               val heap_plots =
   353                 List(
   354                   """ using 1:6 smooth sbezier title "maximum heap (smooth)" """,
   355                   """ using 1:6 smooth csplines title "maximum heap" """,
   356                   """ using 1:7 smooth sbezier title "average heap (smooth)" """,
   357                   """ using 1:7 smooth csplines title "average heap" """,
   358                   """ using 1:8 smooth sbezier title "stored heap (smooth)" """,
   359                   """ using 1:8 smooth csplines title "stored heap" """)
   360 
   361               def jfreechart(plot_name: String, fields: ML_Statistics.Fields): Image =
   362               {
   363                 val image = Image(plot_name, image_width, image_height)
   364                 val chart =
   365                   session.ml_statistics.chart(
   366                     fields._1 + ": " + session.ml_statistics.heading, fields._2)
   367                 Graphics_File.write_chart_png(
   368                   (dir + image.path).file, chart, image.width, image.height)
   369                 image
   370               }
   371 
   372               val images =
   373                 (if (session.check_timing)
   374                   List(
   375                     gnuplot(plot_name("timing"), timing_plots, timing_range),
   376                     gnuplot(plot_name("ml_timing"), ml_timing_plots, timing_range))
   377                  else Nil) :::
   378                 (if (session.check_heap)
   379                   List(gnuplot(plot_name("heap"), heap_plots, "[0:]"))
   380                  else Nil) :::
   381                 (if (session.ml_statistics.content.nonEmpty)
   382                   List(jfreechart(plot_name("heap_chart"), ML_Statistics.heap_fields)) :::
   383                   (if (session.threads > 1)
   384                     List(
   385                       jfreechart(plot_name("tasks_chart"), ML_Statistics.tasks_fields),
   386                       jfreechart(plot_name("workers_chart"), ML_Statistics.workers_fields))
   387                    else Nil)
   388                  else Nil)
   389 
   390               session.name -> images
   391             }
   392           }, data_entry.sessions).toMap
   393 
   394       HTML.write_document(dir, "index.html",
   395         List(HTML.title("Isabelle build status for " + data_name)),
   396         HTML.chapter("Isabelle build status for " + data_name) ::
   397         HTML.par(
   398           List(HTML.description(
   399             List(
   400               HTML.text("status date:") -> HTML.text(data.date.toString),
   401               HTML.text("build host:") -> HTML.text(commas(data_entry.hosts)))))) ::
   402         HTML.par(
   403           List(HTML.itemize(
   404             data_entry.sessions.map(session =>
   405               HTML.link("#session_" + session.name, HTML.text(session.name)) ::
   406               HTML.text(" (" + session.head.timing.message_resources + ")"))))) ::
   407         data_entry.sessions.flatMap(session =>
   408           List(
   409             HTML.section(session.name) + HTML.id("session_" + session.name),
   410             HTML.par(
   411               HTML.description(
   412                 List(
   413                   HTML.text("timing:") -> HTML.text(session.head.timing.message_resources),
   414                   HTML.text("ML timing:") -> HTML.text(session.head.ml_timing.message_resources)) :::
   415                 print_heap(session.head.maximum_heap).map(s =>
   416                   HTML.text("maximum heap:") -> HTML.text(s)).toList :::
   417                 print_heap(session.head.average_heap).map(s =>
   418                   HTML.text("average heap:") -> HTML.text(s)).toList :::
   419                 print_heap(session.head.stored_heap).map(s =>
   420                   HTML.text("stored heap:") -> HTML.text(s)).toList :::
   421                 proper_string(session.head.isabelle_version).map(s =>
   422                   HTML.text("Isabelle version:") -> HTML.text(s)).toList :::
   423                 proper_string(session.head.afp_version).map(s =>
   424                   HTML.text("AFP version:") -> HTML.text(s)).toList) ::
   425               session_plots.getOrElse(session.name, Nil).map(image =>
   426                 HTML.image(image.name) +
   427                   HTML.width(image.width / 2) +
   428                   HTML.height(image.height / 2))))))
   429     }
   430   }
   431 
   432 
   433   /* Isabelle tool wrapper */
   434 
   435   val isabelle_tool =
   436     Isabelle_Tool("build_status", "present recent build status information from database", args =>
   437     {
   438       var target_dir = default_target_dir
   439       var ml_statistics = false
   440       var only_sessions = Set.empty[String]
   441       var options = Options.init()
   442       var image_size = default_image_size
   443       var verbose = false
   444 
   445       val getopts = Getopts("""
   446 Usage: isabelle build_status [OPTIONS]
   447 
   448   Options are:
   449     -D DIR       target directory (default """ + default_target_dir + """)
   450     -M           include full ML statistics
   451     -S SESSIONS  only given SESSIONS (comma separated)
   452     -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
   453     -s WxH       size of PNG image (default """ + image_size._1 + "x" + image_size._2 + """)
   454     -v           verbose
   455 
   456   Present performance statistics from build log database, which is specified
   457   via system options build_log_database_host, build_log_database_user,
   458   build_log_history etc.
   459 """,
   460         "D:" -> (arg => target_dir = Path.explode(arg)),
   461         "M" -> (_ => ml_statistics = true),
   462         "S:" -> (arg => only_sessions = space_explode(',', arg).toSet),
   463         "o:" -> (arg => options = options + arg),
   464         "s:" -> (arg =>
   465           space_explode('x', arg).map(Value.Int.parse(_)) match {
   466             case List(w, h) if w > 0 && h > 0 => image_size = (w, h)
   467             case _ => error("Error bad PNG image size: " + quote(arg))
   468           }),
   469         "v" -> (_ => verbose = true))
   470 
   471       val more_args = getopts(args)
   472       if (more_args.nonEmpty) getopts.usage()
   473 
   474       val progress = new Console_Progress
   475 
   476       build_status(options, progress = progress, only_sessions = only_sessions, verbose = verbose,
   477         target_dir = target_dir, ml_statistics = ml_statistics, image_size = image_size)
   478 
   479   }, admin = true)
   480 }