pymetrics(1) [debian man page]

PYMETRICS(1)							   User Commands						      PYMETRICS(1)

NAME

       pymetrics - Python source code metrics

SYNOPSIS

       pymetrics [options] files...

DESCRIPTION

       This manual page documents briefly the pymetrics command

       pymetrics  is  a  program that produces metrics for Python programs. Metrics include McCabe's Cyclomatic Complexity metric, LoC, %Comments,
       etc. Users can also define their own metrics using data from PyMetrics. PyMetrics optionally outputs to stdout, SQL command files  and  CSV
       files.

OPTIONS

       These  programs	follow	the  usual  GNU  command  line	syntax, with long options starting with two dashes (`-').  A summary of options is
       included below.

       -h, --help
	      show this help message and exit

       -s SQLFILENAME, --sql=SQLFILENAME
	      name of output SQL command file. (Default is metricData.sql)

       -t SQLTOKENTABLENAME, --tokentable=SQLTOKENTABLENAME
	      name of output SQL token table. (Default is metricTokens)

       -m SQLMETRICSTABLENAME, --metricstable=SQLMETRICSTABLENAME
	      name of output SQL metrics table. (Default is metricData)

       -c CSVFILENAME, --csv=CSVFILENAME
	      name of output CSV data file. (Default is metricData.csv)

       -f INFILELIST, --files=INFILELIST
	      File containing list of path names to modules for analysis.

       -i INCLUDEMETRICSSTR, --include=INCLUDEMETRICSSTR
	      list of metrics to include in run. This is a comma separated list of metric module names with no	whitespace.  Optionally,  you  can
	      specify  the  class name of the metric by following the module name with a colon (:) and the metric class name. (Default metrics are
	      'simple:SimpleMetric,mccabe:McCabeMetric,sloc:SLOC Metric'. Default metric class name for metric module 'wxYz' is 'WxYzMetric'  when
	      only module name given -- note capitalized metric class name.)

       -l LIBNAME, --library=LIBNAME
	      user-defined name applied to collection of modules (Default is '')

       -e, --exists
	      assume SQL tables exist and does not generate creation code. Using this option sets option -N. (Default is False)

       -N, --noold
	      create new command output files and tables after deleting old results, if any. Ignored if -e is set.  (Default is False)

       -B, --nobasic
	      suppress production of Basic metrics (Default is False)

       -S, --nosql
	      suppress production of output SQL command text file.  (Default is False)

       -C, --nocsv
	      suppress production of CSV output text file. (Default is False)

       -H, --noheadings
	      suppress heading line in csv file. (Default is False)

       -k, --kwcnt
	      generate keyword counts. (Default is False)

       -K, --nokwcnt
	      suppress keyword counts. (Default is True)

       -q, --quiet
	      suppress normal summary output to stdout. (Default is False)

       -z, --zero
	      display zero or empty values in output to stdout.  (Default is to suppress zero/empty output)

       -v, --verbose
	      Produce verbose output - more -v's produce more output. (Default is no verbose output to stdout)

       -d, --debug
	      Provide debug output, not usually generated - internal use only

AUTHOR

       pymetrics was written by Reg. Charney.

       This manual page was written by Andrew Pollock <apollock@debian.org>, for the Debian project (but may be used by others).

pymetrics 0.8.1 						  September 2009						      PYMETRICS(1)

PMWTF(1)						      General Commands Manual							  PMWTF(1)

NAME

       pmwtf - compares archives and report significant differences

SYNOPSIS

       pmwtf  [-dz] [-p precision] [-q thres] [-S starttime] [-T endtime] [-B starttime] [-E endtime] [-x metric] [-X file] [-Z timezone] archive1
       [archive2]

DESCRIPTION

       pmwtf compares the average values for every metric in either one or two archives, in a given time window, for changes that are likely to be
       of interest when searching for performance regressions.

       The  archive log has the base name archive and must have been previously created using pmlogger(1).  The pmlogsummary(1) utility is used to
       obtain the average values used for comparison.

       There are two sorts of invocation of the tool: with either one or two archives.

       In the first case, the only sensible command line requires use of all four time window arguments.  These are specified using the same  time
       window  format described in PCPIntro(1), and are -S and -T for the start and end times of the first time window of interest in the archive,
       and -B and -E for the start and end times of the second time window of interest.

       In the second case, with two archives, the -B and -E options might be unnecessary.  This might be the case, for example, when comparing the
       same time window of two consecutive days (usually two separate archives), or a time window on the same day of different weeks.

       In either case, pmwtf produces a sorted summary of those metrics in the specified window whose values have deviated the most from a minimal
       threshold.  The level of deviation is calculated by dividing the average value of each metric in both logs, and	then  calculating  whether
       the  ratio falls outside of a range considered normal.  This ratio can be adjusted using the -q option, and by default it is 2 (i.e. report
       all metrics with average values that have more than doubled in the two time windows or more than halved in the two time windows).

       Should any metrics be present in one window but missing from the other, a diagnostic will be displayed listing each missing metric and  the
       archive from which it was missing.

       The  remaining options control the specific information to be reported.	Metrics with counter semantics are converted to rates before being
       evaluated.

       -p   Print all floating point numbers with precision digits after the decimal place.

       -x   Compare each metric in each archive in the time windows specified to a given egrep(1) pattern, excluding those  that  match  from  the
	    report output.

       -X   Allows a file to be specified which containing egrep(1) patterns which are applied to the metric names to optionally exclude some from
	    the report.

       -z   Use the local timezone from the given archives.

       -Z   Changes the timezone in the archive labels to timezone in the format of the environment variable TZ as described in environ(5).

FILES

       $PCP_LOG_DIR/pmlogger/hostname
		 Default directory for PCP archives containing performance metric values collected from the host hostname.

PCP ENVIRONMENT

       Environment variables with the prefix PCP_ are used to parameterize the file and directory names used by PCP.  On  each	installation,  the
       file  /etc/pcp.conf contains the local values for these variables.  The $PCP_CONF variable may be used to specify an alternative configura-
       tion file, as described in pcp.conf(5).

SEE ALSO

       PCPIntro(1), pmlogger(1), pmlogsummary(1), egrep(1), pcp.conf(5) and pcp.env(5).

Performance Co-Pilot							PCP								  PMWTF(1)