src/bootchart/README

   1
   2 Bootchart - a 'startup' graphing tool
   3
   4 --
   5
   6 Bootchart is a tool, usually run at system startup, that collects and graphs
   7 the CPU and disk load of the system as it works. The output of bootchart is
   8 an SVG graph. Normally, bootchart is invoked as `bootchartd` by the kernel
   9 by passing "init=/sbin/bootchartd" to the kernel. Bootchart will then fork
  10 init off to resume normal system startup, while monitoring and logging
  11 startup information in the background.
  12
  13 After collecting a certain amount of data (usually 15-30 seconds) the logging
  14 stops and a graph is generated from the logged information. This graph
  15 contains vital clues to which resources are being used, in which order, and
  16 where possible problems exist in the startup sequence of the system.
  17
  18 Of course, bootchart can also be used at any moment in time to collect and
  19 graph some data for an amount of time. Bootchart does not even require root
  20 privileges to do so, and will happily run as a normal user. Bootchart graphs
  21 are by default written time-stamped in /run/log.
  22
  23 --
  24
  25 This version of bootchart was implemented from scratch and inspired by former
  26 incantations of bootchart:
  27
  28 - The original bash/shell code implemented bootchart. This version logged all
  29 data into a compressed tarball for later processing, and did not create a graph
  30 on it's own.
  31
  32 - The C-code implementation found in Ubuntu. This version replaced above shell
  33 code version with a faster and efficient data logger, but still did not graph
  34 code itself.
  35
  36 - the original Java-based bootchart, the original graphing program that created
  37 a bootchart graph from logged data.
  38
  39 - the pybootchartgui.py program, which created a graph based on the data logged
  40 by either standalone data logger.
  41
  42 The version you are looking at combines these 2 parts into a single program,
  43 which makes running it and creating graphs a bit more efficient and simple.
  44 You can now run a single program at startup instead of 2. There are no timing
  45 problems (the graphing stage will never run if the logging stage didn't
  46 finish). The logged data isn't being written to disc first, then read again.
  47 Also, the data kept in memory is reduced to the absolute minimum needed to
  48 keep memory use low.
  49
  50 --
  51
  52 Requirements: glibc. Your kernel must have procfs support and several
  53 proc output options enabled:
  54   CONFIG_PROC_FS
  55   CONFIG_SCHEDSTATS
  56   CONFIG_SCHED_DEBUG
  57 at a minimum. bootchartd itself does not require any graphics library
  58 to generate the SVG output file.
  59
  60 --
  61
  62 Configuration: please see bootchartd --help, as well as /etc/bootchartd.conf
  63 and/or /usr/share/doc/bootchart/bootchartd.conf.example for a list of
  64 configurable options.
  65
  66 --
  67
  68 Many thanks to those who contributed ideas and code:
  69  - Ziga Mahkovec - Original bootchart author
  70  - Anders Norgaard - PyBootchartgui
  71  - Michael Meeks - bootchart2
  72  - Scott James Remnant - Ubuntu C-based logger
  73  - Arjan van der Ven - for the idea to merge bootgraph.pl functionality
  74
  75 --
  76
  77 For bugs, please contact the author or current maintainer:
  78 Auke Kok <auke-jan.h.kok@intel.com>
  79
  80 --
  81
  82 Download bootchart releases here: http://foo-projects.org/~sofar/bootchart/
  83 Source code is hosted here: git://github.com/sofar/bootchart