sadc.tproj/sa1.8

   1 .\"Portions Copyright (c) 1999-2003 Apple Computer, Inc. All Rights
   2 .\"Reserved.
   3 .\"
   4 .\"This file contains Original Code and/or Modifications of Original Code
   5 .\"as defined in and that are subject to the Apple Public Source License
   6 .\"Version 2.0 (the 'License'). You may not use this file except in
   7 .\"compliance with the License. Please obtain a copy of the License at
   8 .\"http://www.opensource.apple.com/apsl/ and read it before using this
   9 .\"file.
  10 .\"
  11 .\"The Original Code and all software distributed under the License are
  12 .\"distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  13 .\"EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  14 .\"INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  15 .\"FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  16 .\"Please see the License for the specific language governing rights and
  17 .\"limitations under the License.
  18 .\"
  19 .\"     @(#)sa1.8
  20 .Dd Jul 25 2003               \" DATE
  21 .Dt sa1 8      \" Program name and manual section number
  22 .Os "Mac OS X"
  23 .Sh NAME                 \" Section Header - required - don't modify
  24 .Nm sa1
  25 .Nd Generate a system activity daily data file.
  26 .Sh SYNOPSIS             \" Section Header - required - don't modify
  27 .Nm /usr/lib/sa/sa1
  28 .Op Ar t n              \" [t n]
  29 .Sh DESCRIPTION          \" Section Header - required - don't modify
  30 The
  31 .Nm sa1
  32 command is a shell script used to invoke the system
  33 activity data collector,
  34 .Nm sadc .
  35 The binary sample data is collected at intervals
  36 .Ar t
  37 seconds apart, in a loop
  38 .Ar n
  39 times.
  40 The binary sample data is written to the standard
  41 daily data file,
  42 .Ar /var/log/sa/sadd
  43 where the
  44 .Ar dd
  45 represents the current day of the month.
  46 .Pp                      \" Inserts a space
  47 .Nm sa1
  48 is intended to be started by cron.
  49 .Sh EXAMPLE CRON ENTRY
  50 .Bd -literal
  51 # Starting at 8am collect system activity records
  52 # every 20 minutes for 12 hours
  53 # 20 minutes = 1200 seconds
  54 # 12 hours with 3 samples each hour = 36 loops
  55
  56 0 8 * * 1-5 /usr/lib/sa/sa1 1200 36
  57
  58
  59 # After the 12 hour period,
  60 # collect a system activity report
  61
  62 30 20 * * 1-5 /usr/lib/sa/sa2 -A
  63
  64 .Ed
  65 .Pp
  66 .Sh FILES                \" File used or created by the topic of the man page
  67 .Bl -tag -width "/var/log/sa/sadd" -compact
  68 .It Pa /var/log/sa/sadd
  69 Default daily activity file that holds the binary sampling data.
  70 .Ar dd
  71 are digits that represent the day of the month.
  72 .El
  73 .Sh SEE ALSO
  74 .\" List links in ascending order by section, alphabetically within a section.
  75 .Xr crontab 1 ,
  76 .Xr fs_usage 1 ,
  77 .Xr netstat 1 ,
  78 .Xr sar 1 ,
  79 .Xr sc_usage 1 ,
  80 .Xr top 1 ,
  81 .Xr vm_stat 1 ,
  82 .Xr crontab 5 ,
  83 .Xr iostat 8 ,
  84 .Xr sa2 8 ,
  85 .Xr sadc 8