torrus/doc/manpages/torrus_schedulerinfo.pod.in

   1 #  Copyright (C) 2004  Stanislav Sinyagin
   2 #
   3 #  This program is free software; you can redistribute it and/or modify
   4 #  it under the terms of the GNU General Public License as published by
   5 #  the Free Software Foundation; either version 2 of the License, or
   6 #  (at your option) any later version.
   7 #
   8 #  This program is distributed in the hope that it will be useful,
   9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 #  GNU General Public License for more details.
  12 #
  13 #  You should have received a copy of the GNU General Public License
  14 #  along with this program; if not, write to the Free Software
  15 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16
  17 # $Id: torrus_schedulerinfo.pod.in,v 1.1 2010-12-27 00:04:39 ivan Exp $
  18 # Stanislav Sinyagin <ssinyagin@yahoo.com>
  19 #
  20 #
  21
  22 =head1 NAME
  23
  24 schedulerinfo - Displays extended scheduler tasks information.
  25
  26 =head1 SYNOPSIS
  27
  28 B<torrus schedulerinfo> --tree=I<TREENAME> [I<options...>]
  29
  30 =head1 DESCRIPTION
  31
  32 This utility displays the extended scheduler tasks information for tree
  33 I<TREENAME> on standard output. This might be useful for scheduler planning
  34 and analysis.
  35
  36 =head1 OPTIONS
  37
  38 =over 4
  39
  40 =item B<--config>
  41
  42 Reports scheduler's configuration. The values are explained below.
  43
  44 =over 8
  45
  46 =item Total collector/monitor leaves: I<N>
  47
  48 Total number of datasources being processed by collector or monitor daemon.
  49
  50 =item Scheduled leaves by type
  51
  52 Torrus supports arbitrary number of collector types, and this report
  53 shows how many datasources belong to every type. Currently the monitor leaves
  54 are not divided into types.
  55
  56 =item Least common period: I<N> seconds
  57
  58 The report below shows how the tasks are distributed across the time line,
  59 and the least common period shows the period of this time line.
  60
  61 =item Tasks execution timeline
  62
  63 This report tells which task and how many datasources are involved in
  64 each task startup event, and how these events are dispersed across the time.
  65 The column I<Interval> shows the time interval from each task execution
  66 event to the next event on the timeline.
  67
  68 =back
  69
  70 =item B<--runtime>
  71
  72 Reports scheduler's runtime statistics, such as running cycle times,
  73 late starts etc. The meaning of the output values is as follows. Values
  74 that have zero values are usually not printed.
  75
  76 =over 8
  77
  78 =item Task: I<Name>, Period: I<N> seconds, Offset: I<M> seconds
  79
  80 Each scheduler task is characterized by its name (usually Collector or
  81 Monitor), period, and timeoffset. Fore example, if period is set to 300
  82 seconds, and offset is 14 seconds, then the task would be executed at
  83 00:00:14, 00:05:14, 00:10:14, and so on for every hour in a day.
  84
  85 =item I<N> running cycles passed
  86
  87 How many times the task was executed since last reset. The counter
  88 is normally reset after L<torrus_compilexml(@mansec_usercmd@)> successfully
  89 compiles the configuration.
  90
  91 =item I<N> late starts
  92
  93 How many times the task has started with a delay from its normal schedule.
  94
  95 =item I<N> too long runs
  96
  97 How many times the task execution time was longer than its period.
  98
  99 =item I<N> overrun periods
 100
 101 How many periods have been missed because of too long executions.
 102
 103 =item I<N> missed periods
 104
 105 How many periods were missed because of any reason (such as other tasks
 106 delaying).
 107
 108 =item Min, Max, Average, Exp Average
 109
 110 The time values are displayed in four columns: Mimimum, Maximum and Average
 111 values since last reset, and Exponential decay value, which may be interpreted
 112 as the average for last several values. With defaults defined in
 113 F<torrus-config.pl>, 95% of the average is calculated from last 3 values.
 114
 115 =item Running Time
 116
 117 How long the task executes each period.
 118
 119 =item Late Start
 120
 121 How long the task start was delayed.
 122
 123 =item Too Long
 124
 125 How much time the too long run took.
 126
 127 =item RRD Queue
 128
 129 In a multithreaded environment, the RRD files are writen in a background
 130 thread. This value shows the length of the RRD update queue at the beginning
 131 of each update cycle.
 132
 133 =back
 134
 135 =item B<--help>
 136
 137 Displays a help message.
 138
 139 =back
 140
 141
 142
 143 =head1 SEE ALSO
 144
 145 L<torrus(@mansec_usercmd@)>,
 146 L<torrus_compilexml(@mansec_usercmd@)>
 147
 148 =head1 NOTES
 149
 150 See more documentation at Torrus home page: http://torrus.org
 151
 152 =head1 AUTHOR
 153
 154 Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>