granicus.if.org Git - sysstat/blob - README.md

   1 ## sysstat - System performance tools for the Linux operating system...
   2
   3 (C) 1999-2016 Sebastien GODARD (sysstat (at) orange (dot) fr)
   4
   5 The latest version of sysstat can always be found on my web site at:
   6
   7 [http://pagesperso-orange.fr/sebastien.godard/](http://pagesperso-orange.fr/sebastien.godard/)
   8
   9 See the CHANGES file to know the new features/improvements/bug fixes added
  10 in this release of sysstat.
  11
  12 You can also track sysstat development on [GitHub](https://github.com/sysstat/sysstat)
  13 and clone its public repository with:
  14
  15     git clone git://github.com/sysstat/sysstat
  16
  17
  18 ### Installation
  19
  20
  21 The sysstat utilities are a collection of **performance monitoring tools** for
  22 Linux. These include _mpstat, iostat, tapestat, cifsiostat, pidstat,
  23 sar, sadc, sadf_ and _sa_ tools.
  24
  25 The first stage is to configure sysstat for your system:
  26
  27         ./configure
  28
  29 You can set several variables and parameters on the command line.
  30 Please enter `./configure --help` to display them.
  31 There is another way to configure sysstat instead of entering `./configure`:
  32 this is the **Interactive Configuration script** (_iconfig_) which will ask you
  33 for the value of the main sysstat variables and parameters.
  34 Enter `./iconfig` then answer the questions or enter Return to accept
  35 the (sane) default values. For yes/no questions, please answer 'y' or 'n'
  36 (without the quotes): It is case sensitive! You can also enter '?' to get
  37 a help message that will explain the meaning of each variable or parameter.
  38
  39 The next stage is to build the various binary files. Enter:
  40
  41         make
  42
  43 Then log in as root and enter:
  44
  45         make install
  46
  47 (see next section to know the files that are installed).
  48 That's all!
  49
  50 Of course tell me if there are any problems. This is the only way I can improve
  51 'sysstat'. Please also remember to read the FAQ included in this package.
  52
  53 Patches and suggestions for improvements are always welcome!
  54 Send them to "sysstat (at) orange (dot) fr".
  55
  56 #### Support sysstat!
  57
  58 If you are reading this README file then you are probably about to use the sysstat tools
  59 to help you monitor your system and maybe troubleshoot some performance issues. Good choice.
  60 Sysstat is made for you. Moreover sysstat is free software and always will be.
  61
  62 Yet have you ever considered making a donation to sysstat, regardless of how much your
  63 contribution is? This in turn would encourage me to keep up the work as good as it can be...
  64 Oh, and it would certainly also help me explain to my wife why I spend so much time in front
  65 of my computer instead of taking care of the household ;-)
  66
  67 Go to my web page and [click on the Donate button](http://pagesperso-orange.fr/sebastien.godard/) on the left!
  68
  69
  70 ### Files that are installed
  71
  72 Here is the list of files installed by sysstat, when you ask for a
  73 complete installation.
  74 ${PREFIX} is the value of the PREFIX variable defined in the Makefile
  75 (usually set to `/usr/local` or `/usr`).
  76
  77     ${PREFIX}/lib/sa/sadc
  78     ${PREFIX}/lib/sa/sa1
  79     ${PREFIX}/lib/sa/sa2
  80     ${PREFIX}/bin/sar
  81     ${PREFIX}/bin/sadf
  82     ${PREFIX}/bin/iostat
  83     ${PREFIX}/bin/tapestat
  84     ${PREFIX}/bin/mpstat
  85     ${PREFIX}/bin/pidstat
  86     ${PREFIX}/bin/cifsiostat
  87     ${PREFIX}(/share)/man/man8/sadc.8
  88     ${PREFIX}(/share)/man/man8/sa1.8
  89     ${PREFIX}(/share)/man/man8/sa2.8
  90     ${PREFIX}(/share)/man/man1/sar.1
  91     ${PREFIX}(/share)/man/man1/sadf.1
  92     ${PREFIX}(/share)/man/man1/iostat.1
  93     ${PREFIX}(/share)/man/man1/tapestat.1
  94     ${PREFIX}(/share)/man/man1/mpstat.1
  95     ${PREFIX}(/share)/man/man1/pidstat.1
  96     ${PREFIX}(/share)/man/man1/cifsiostat.1
  97     ${PREFIX}/share/locale/*/LC_MESSAGES/sysstat.mo
  98     ${PREFIX}/share/doc/sysstat-x.y.z/*
  99     /var/log/sa
 100     ${INIT_DIR}/sysstat
 101     /lib/systemd/system/sysstat.service                 if OS uses systemd
 102     /lib/systemd/system/sysstat-collect.service if OS uses systemd
 103     /lib/systemd/system/sysstat-collect.timer   if OS uses systemd
 104     /lib/systemd/system/sysstat-summary.service if OS uses systemd
 105     /lib/systemd/system/sysstat-summary.timer   if OS uses systemd
 106     /etc/sysconfig/sysstat
 107     /etc/sysconfig/sysstat.ioconf
 108     /etc/cron.d/sysstat
 109     /etc/rc.d/rc.sysstat                        (depending on your distro)
 110     ${RC_DIR}/rc2.d/S03sysstat
 111     ${RC_DIR}/rc3.d/S03sysstat
 112     ${RC_DIR}/rc5.d/S03sysstat
 113
 114 sysstat may also install some links in `${RC_DIR}/rc[0146].d/` directory
 115 if _chkconfig_ is used.
 116
 117 ### Miscellaneous
 118
 119 The sysstat commands are only front-ends to the kernel proc filesystem...
 120 They cannot display statistics that Linux does not
 121 provide, nor can they be more accurate than Linux is.
 122 The sysstat package no longer supports 2.4.x and older kernels.
 123 Note that all kernels do not necessarily have all the statistics that
 124 sysstat commands can display, depending on their version or their
 125 configuration options.
 126
 127 It has been designed with National Language Support (NLS) in mind, using
 128 the GNU gettext package (available at [http://www.gnu.org](http://www.gnu.org)).
 129 sysstat has been translated into several languages.
 130 Anyway you are welcome if you want to make other translations available ;-)
 131 Please read the README-nls file in the nls directory before.
 132
 133 --
 134
 135 Sebastien GODARD - sysstat (at) orange (dot) fr
 136