diff options
author | Philip Knirsch <pknirsch@hamburg.stuttgart.redhat.com> | 2009-02-26 18:38:39 +0100 |
---|---|---|
committer | Philip Knirsch <pknirsch@hamburg.stuttgart.redhat.com> | 2009-02-26 18:38:39 +0100 |
commit | 82e5d550f1f1da442f4844986477c4a7c0bafa55 (patch) | |
tree | e8b211752ab80601fc6748015d08369a526362d2 /doc | |
parent | 6b79fa915df800feeadbeab68e6a36a1a958bc2e (diff) | |
download | tuned-82e5d550f1f1da442f4844986477c4a7c0bafa55.tar.gz tuned-82e5d550f1f1da442f4844986477c4a7c0bafa55.tar.xz tuned-82e5d550f1f1da442f4844986477c4a7c0bafa55.zip |
- Added config file option to enable/disable pluginsv0.1.2
- Switched from ConfigParser to RawConfigParser
- Renamed doc/README.txt to doc/DESIGN.txt
- Added tuned.conf man page
- Updated tuned man page
- Updated package descriptions (#487312)
- Added documentation for utils scripts (#487312)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/DESIGN.txt (renamed from doc/README.txt) | 0 | ||||
-rw-r--r-- | doc/README.utils | 94 | ||||
-rw-r--r-- | doc/tuned.8 | 21 | ||||
-rw-r--r-- | doc/tuned.conf.5 | 37 |
4 files changed, 149 insertions, 3 deletions
diff --git a/doc/README.txt b/doc/DESIGN.txt index 40a1d9f..40a1d9f 100644 --- a/doc/README.txt +++ b/doc/DESIGN.txt diff --git a/doc/README.utils b/doc/README.utils new file mode 100644 index 0000000..66f9937 --- /dev/null +++ b/doc/README.utils @@ -0,0 +1,94 @@ +Systemtap disk and network statistic monitoring tools +===================================================== + +The netdevstat and diskdevstat are 2 systemtap tools that allow the user to +collect detailed information about network and disk aktivity of all +applications running on a system. These 2 tools were insipred by powertop, +which shows the wakeups of applications per second. + +The basic idea is to collect statistic about the running applications in a +form that allows a user to identify applications that behave power +inefficient, meaning instead of doing fewer and bigger IO operations they +do more and smaller ones. Current monitoring tools typically only show +the transfer speeds which isn't very meaningful in that context. + +To run them you need to have systemtap and kernel-debuginfo installed. +If both are installed a simple + + netdevstat + +or + + diskdevstat + +will start the scripts. There are no parameters or options for them. The +output will look similar to top and/or powertop. Here a sample output of +a longer diskdevstat run on a Fedora 10 system running KDE 4.2: + + + PID UID DEV WRITE_CNT WRITE_MIN WRITE_MAX WRITE_AVG READ_CNT READ_MIN READ_MAX READ_AVG COMMAND + 2789 2903 sda1 854 0.000 120.000 39.836 0 0.000 0.000 0.000 plasma +15494 0 sda1 0 0.000 0.000 0.000 758 0.000 0.012 0.000 0logwatch +15520 0 sda1 0 0.000 0.000 0.000 140 0.000 0.009 0.000 perl +15549 0 sda1 0 0.000 0.000 0.000 140 0.000 0.009 0.000 perl +15585 0 sda1 0 0.000 0.000 0.000 108 0.001 0.002 0.000 perl + 2573 0 sda1 63 0.033 3600.015 515.226 0 0.000 0.000 0.000 auditd +15429 0 sda1 0 0.000 0.000 0.000 62 0.009 0.009 0.000 crond +15379 0 sda1 0 0.000 0.000 0.000 62 0.008 0.008 0.000 crond +15473 0 sda1 0 0.000 0.000 0.000 62 0.008 0.008 0.000 crond +15415 0 sda1 0 0.000 0.000 0.000 62 0.008 0.008 0.000 crond +15433 0 sda1 0 0.000 0.000 0.000 62 0.008 0.008 0.000 crond +15425 0 sda1 0 0.000 0.000 0.000 62 0.007 0.007 0.000 crond +15375 0 sda1 0 0.000 0.000 0.000 62 0.008 0.008 0.000 crond +15477 0 sda1 0 0.000 0.000 0.000 62 0.007 0.007 0.000 crond +15469 0 sda1 0 0.000 0.000 0.000 62 0.007 0.007 0.000 crond +15419 0 sda1 0 0.000 0.000 0.000 62 0.008 0.008 0.000 crond +15481 0 sda1 0 0.000 0.000 0.000 61 0.000 0.001 0.000 crond +15355 0 sda1 0 0.000 0.000 0.000 37 0.000 0.014 0.001 laptop_mode + 2153 0 sda1 26 0.003 3600.029 1290.730 0 0.000 0.000 0.000 rsyslogd +15575 0 sda1 0 0.000 0.000 0.000 16 0.000 0.000 0.000 cat +15581 0 sda1 0 0.000 0.000 0.000 12 0.001 0.002 0.000 perl +15582 0 sda1 0 0.000 0.000 0.000 12 0.001 0.002 0.000 perl +15579 0 sda1 0 0.000 0.000 0.000 12 0.000 0.001 0.000 perl +15580 0 sda1 0 0.000 0.000 0.000 12 0.001 0.001 0.000 perl +15354 0 sda1 0 0.000 0.000 0.000 12 0.000 0.170 0.014 sh +15584 0 sda1 0 0.000 0.000 0.000 12 0.001 0.002 0.000 perl +15548 0 sda1 0 0.000 0.000 0.000 12 0.001 0.014 0.001 perl +15577 0 sda1 0 0.000 0.000 0.000 12 0.001 0.003 0.000 perl +15519 0 sda1 0 0.000 0.000 0.000 12 0.001 0.005 0.000 perl +15578 0 sda1 0 0.000 0.000 0.000 12 0.001 0.001 0.000 perl +15583 0 sda1 0 0.000 0.000 0.000 12 0.001 0.001 0.000 perl +15547 0 sda1 0 0.000 0.000 0.000 11 0.000 0.002 0.000 perl +15576 0 sda1 0 0.000 0.000 0.000 11 0.001 0.001 0.000 perl +15518 0 sda1 0 0.000 0.000 0.000 11 0.000 0.001 0.000 perl +15354 0 sda1 0 0.000 0.000 0.000 10 0.053 0.053 0.005 lm_lid.sh + + +Here a quick explanation of each column: + +PID: Process ID of the application +UID: User ID under which the applications is running +DEV: Device on which the IO took place +WRITE_CNT: Total number of write operations +WRITE_MIN: Lowest time in seconds for 2 consecutive writes +WRITE_MAX: Largest time in seconds for 2 consecutive writes +WRITE_AVG: Average time in seconds for 2 consecutive writes +READ_CNT: Total number of read operations +READ_MIN: Lowest time in seconds for 2 consecutive reads +READ_MAX: Largest time in seconds for 2 consecutive reads +READ_AVG: Average time in seconds for 2 consecutive reads +COMMAND: Name of the process + +In this example 3 very obvious applications stand out: + + PID UID DEV WRITE_CNT WRITE_MIN WRITE_MAX WRITE_AVG READ_CNT READ_MIN READ_MAX READ_AVG COMMAND + 2789 2903 sda1 854 0.000 120.000 39.836 0 0.000 0.000 0.000 plasma + 2573 0 sda1 63 0.033 3600.015 515.226 0 0.000 0.000 0.000 auditd + 2153 0 sda1 26 0.003 3600.029 1290.730 0 0.000 0.000 0.000 rsyslogd + +Those are the 3 applications that have a WRITE_CNT > 0, meaning they performed +some form of write during the measurement. Of those, plasma was the worst +offender by a large amount. For one in total number of writes and of course +the average time between writes was also the lowest. This would be the best +candidate to investigate if you're concerned about power inefficient +applications. diff --git a/doc/tuned.8 b/doc/tuned.8 index 85b1209..abd1f6c 100644 --- a/doc/tuned.8 +++ b/doc/tuned.8 @@ -1,4 +1,4 @@ -.TH tuned 8 "25 Feb 2009" +.TH "tuned" "8" "25 Feb 2009" "Phil Knirsch" "adaptive system tuning daemon" .SH NAME tuned \- dynamic adaptive system tuning daemon .SH SYNOPSIS @@ -6,7 +6,10 @@ tuned \- dynamic adaptive system tuning daemon .SH DESCRIPTION \fBtuned\fR is a dynamic adaptive system tuning daemon that tunes system settings dynamically depending on -usage. +usage. It does so by monitoring the usage of several system components +periodically. Based on that information components will then be put into +lower or higher power saving modes to adapt to the current usage. Currently +only ethernet network and ATA harddisk devices are implemented. .SH OPTIONS .TP 12 .BI \-d "\fR, \fP" \--daemon @@ -16,7 +19,19 @@ in the foreground without forking at startup. .BI \-c "\fR, \fP" \--conffile=" conffile" Specify the name and path of the configuration file, default is \fB/etc/tuned.conf\fR. .SH BUGS -There are no known bugs. To file bug reports, see \fBAUTHORS\fP below. +If you are using tuned together with NetworkManager at the moment NetworkManager +will completely stop and start a managed device when tuned switches power +saving levels. This happens because the network device will loose it's physical +link for a very short time when it performs a power saving switch and +NetworkManager can not distinguish this from a connectivity loss. This will be +resolved in future versions of tuned and NM where NM will gain the mechanism to +switch speeds for network devices. +.SH "FILES" +.nf +/etc/tuned.conf +.SH "SEE ALSO" +.LP +tuned.conf(5) .SH AUTHOR Written by Phil Knirsch <pknirsch@redhat.com>. .SH REPORTING BUGS diff --git a/doc/tuned.conf.5 b/doc/tuned.conf.5 new file mode 100644 index 0000000..fea5655 --- /dev/null +++ b/doc/tuned.conf.5 @@ -0,0 +1,37 @@ +.TH "tuned.conf" "5" "26 Feb 2009" "Phil Knirsch" "tuned configuration file" +.SH "NAME" +.LP +\fBtuned.conf\fR \- Configuration file for \fBtuned(8)\fR. +.SH "DESCRIPTION" +.LP +The tuned configuration file is by default found at \fB/etc/tuned.conf\fR. +.SH "PARAMETERS" +.LP +The tuned.conf file must always contain a [main] section. The main section +defines general parameters for the daemon. Each plugin may have a +section with plugin specific parameters. +.SH "[main] OPTIONS" +.LP +The [main] section must exist for tuned. It contains the following +options: + +.IP \fBinterval\fR +Interval for monitoring and tuning in seconds. The default is 10. + +.SH "[plugin] OPTIONS" +.LP +Each plugin can have an individual section with the name of the plugin as +the section name. All plugins support at least the following options: + +.IP \fBenabled\fR +Enabled or disable the plugin. Default is True. Any other value disables it. +.SH "FILES" +.nf +/etc/tuned.conf +.SH "SEE ALSO" +.LP +tuned(8) +.SH AUTHOR +Written by Phil Knirsch <pknirsch@redhat.com>. +.SH REPORTING BUGS +Report bugs to <pknirsch@redhat.com>. |