ftlm_batch_report: Usage Message
DESCRIPTION:
ftlm_batch_report [OPTIONS]
NOTE: When generating a report for an option that does not require
a value, it is recommended that a boolean value 1|0 is provided to
explicitly enable or disable it to avoid confusion. For example, using
"-utilPlotShowQueued 1" instead of "-utilPlotShowQueued" to enable
the tokens queued plot, and using "-utilPlotShowQueued 0" to disable
the tokens queued plot. No need to guess the default setup for this
option which may change over time!
OPTIONS:
-h -- Help (usage statement)
-v -- Increase verbosity
-inputFile <INFILE> -- Specify all options in a file (use
$env(VOVDIR)/etc/config/lm/ftlm_batch_report.tmpl
as template), or specify individually as follows
-tag <TAGS> -- Specify a comma-separated list of tags
-feature <FEATURES> -- Specify a comma-separated list of features
-user <USERS> -- Specify a comma-separated list of users
-host <HOSTS> -- Specify a comma-separated list of hosts
-account <ACCOUNTS> -- Specify a comma-separated list of accounts
(projects)
-version <VERSIONS> -- Specify a comma-separated list of versions
-accounting_* <FIELDS> -- Specify a comma-separated list of accounting
fields (custom groups)
-negate_* -- Negate corresponding filter spec (e.g. tag,
feature, user, host, etc, ...)
-interval <INTERVAL> -- Choose time interval of report (default: "last
quarter"). Symbolic values include "today" and
"yesterday", as well as "this" or "last" in
combination with one of "week", "month",
"quarter", or "year". Custom intervals are
acceptable in the following formats:
20120101-20120331
20110101T000000-20110131T235959
-workweek -- Apply workweek filtering to specified reports
-limit <NUM> -- Default limit for returned rows in all tables
(default: 100)
-title <STRING> -- Specify a report title string
-outputFormat
html|csv|raw -- Specify whether to output HTML or CSV
(default: html)
-origin <ORIGIN> -- Choose data origin
ORIGIN : samples, logs (default: samples)
-breakdownByFeature -- Break down reporting by feature instead of by tag
-showAllReports -- Enable all types of reports
-showSql 1|2|3 -- Show SQL debugging output:
1 shows query
2 shows results
3 shows explain
-notUseDataView -- Do not use materialized view for daily report
-showFeatureStats -- Enable daily feature statistics table
-showFeatureStatsPlot -- Enable daily feature statistics plot
-showEfficiencyStats -- Enable efficiency statistics table
-showEfficiencyHistogram -- Enable concurrent utilization chart
-showCheckoutStats -- Enable checkout statistics table
-showCheckoutDetails -- Enable checkout details table
-showCheckoutPieCharts -- Enable checkout pie charts
-showDenialPieCharts -- Enable denial pie charts
-showUtilizationPlot -- Enable utilization plot
-showDenialStats -- Enable denials statistics table
-showDenialDetails -- Enable denials details table
-showDenialPlot -- Enable denials plot
-showHeatmaps -- Enable heatmap(s)
-showUsageComparisonPlot -- Enable usage comparison plot
-showCheckoutDurationHistogram -- Enable checkout duration histogram
-showUsageTrends -- Enable usage trends table
-sort*By <FIELD> -- Sort corresponding table by
-limit* <NUM> -- Limit corresponding table rows
-glitch <TIMESPEC> -- Specify glitch width to ignore
-denPlotBinInterval -- Override dynamic averaging window
-utilPlotYmax -- Override dynamic y-axis max
-utilPlotHeight -- Specify custom plot height
-utilPlotWidth -- Specify custom plot width
-utilPlotBinInterval -- Override dynamic averaging window
-utilPlotHideCapacity -- Hide capacity area on plot
-utilPlotHideDetail -- Hide detail line on plot
-utilPlotHideAverage -- Hide average usage line on plot
-utilPlotShowPeak -- Show peak usage line on plot
-utilPlotShowCurrent -- Show currently usage line on plot
-utilPlotShowReservations -- Show reservation line on plot
-utilPlotShowFuture -- Show future line on plot
-utilPlotShowQueued -- Show separate queued item plot
-utilPlotHideQueuedCapacity -- Hide capacity with queued on plot
-utilPlotShowQueuedPeak -- Show peak with queued on plot
-utilPlotLegendLocation -- Specify location of legend with
respect to plot (s|e, default: s)
-featureStatsPlotShowUsage -- Show usage plot on daily feature stats
-featureStatsPlotShowQueued -- Show queued requests plot on daily
feature stats
-featureStatsPlotShowDenial -- Show denials plot on daily feature
stats
-usageComparisonPlotStack -- Stack items to show total summed usage
-usageComparisonPlotStyle <STYLE> -- Specify plot style (default: line)
Supported styles: line, linefill,
step, stepfill
-usageComparisonPlotType <TYPE> -- The type of smoothing for the plot
(default: max)
Supported types: max, avg
-usageTrendsBreakdown -- Specify report breakdown interval
(default: weekly)
Supported breakdowns: hourly, daily,
weekly, biweekly, monthly,
quarterly
-usageTrendsHideBreakdown -- Hide statistics for breakdown segments
-usageTrendsHideAvg -- Hide average statistics
-usageTrendsHidePeak -- Hide peak statistics
-usageTrendsShowReservations -- Include reservation checkouts in
statistics.
-checkoutStatsShowRes -- Include reservation checkouts in
statistics.
-checkoutStatsShowIdle -- Include idle users in statistics.
-checkoutStatsShowCost -- Include cost data in statistics.
-includeIdleFeatures -- Include idle features in efficiency
statistics.
-includeIdleTime -- Include idle time in efficiency
statistics
-efficiencyHistogramMaxBars -- Specify maximum number of bars to show
on histogram
-heatmapShowNumbers 1|0 -- Show heatmap numbers (default: 1)
-heatmapType <TYPES> -- Specify types of heatmaps
(comma-separated list)
TYPES : usage, checkouts, checkins,
denials (default: usage)
-checkoutPieChartType <TYPES> -- Specify types of pie charts
(comma-separated list)
TYPE : count, duration
(default: count,duration)
-checkoutPieChartHeight -- Specify custom piechart height
-checkoutPieChartWidth -- Specify custom piechart width
-denialPieChartHeight -- Specify custom piechart height
-denialPieChartWidth -- Specify custom piechart width
-reportCheckoutStatsBy <VALUES> -- Specify how to report checkout
statistics by (comma-separated list)
VALUES: tag, taggedfeature, taggeduser,
feature, featureuser, user, userhost,
host, account, version, accounting_*,
user_accounting_*, host_accounting_*
(default: user)
-reportDenialStatsBy <VALUES> -- Specify how to report denials
statistics by (comma-separated list)
VALUES: tag, taggedfeature, taggeduser,
feature, featureuser, user, userhost,
host, accounting_*, user_accounting_*,
host_accounting_* (default: user)
-reportCheckoutPieChartsBy -- Specify how to report checkout pie
<VALUES> charts by (comma-separated list)
VALUES: tag, taggedfeature,
taggeduser, feature, featureuser,
user, userhost, host, account,
version, accounting_*,
user_accounting_*,
host_accounting_* (default: user)
-reportDenialPieChartsBy <VALUES> -- Specify how to report denial pie
charts by (comma-separated list)
VALUES: tag, taggedfeature, taggeduser,
feature, featureuser, user, userhost,
host, accounting_*, user_accounting_*,
host_accounting_* (default: user)
-reportUsageComparisonPlotBy -- Specify how to report usage comparison
<VALUES> plot by (comma-separated list)
VALUES: tag, taggedfeature, taggeduser,
feature, featureuser, user, userhost,
host, account, version, accounting_*,
user_accounting_*, host_accounting_*
(default: user)
-reportUsageTrendsBy <VALUES> -- Specify how to report usage trends by
(comma-separated list)
VALUES: tag, taggedfeature, taggeduser,
feature, featureuser, user, userhost,
host, account, version, accounting_*,
user_accounting_*, host_accounting_n*
(default: user)
-extractImages <INFILE> -- Extract PNG images from the plot data
contained in the specified batch report
HTML file. Image files are exported to
the current working directory.
-replaceImages <INFILE> [OUTFILE] -- Extract PNG images from the plot
data contained in the specified batch
report HTML file, replace the
corresponding dynamic image elements
in the file, and clean up the
plot-rendering javascript code.
This will reduce the size of the
report file, but some dynamic
features will be unavailable.
Default output file will be based
upon the name of the input file,
with '-static' appended to the name
(eg myreport-static.html), and will
be generated in the current working
directory. Image files are also
exported to the current working
directory and will be linked as such
in the output file.
-staticImages 1|0 -- Instructs whether the batch report be
generated as static images for plots.
If set to 1, it is equivalent to first
generating the report normally, then
calling it again with the option
"-replaceImages" to create a batch
report output file that contains
references to static images in one
step. See -replaceImages above for more
details on this functionality.
Requires the -outputFile option.
-outputFile <OUTFILE> -- Specify output file.
Default is to output to stdout.
-script <PATH> -- Specify a legacy script to use
The search path for the script includes
the following directories:
1) .
2) $VOV_REPORT_DIR
3) $VOVDIR/local/lm/reports
4) $VOVDIR/etc/lm/reports
The argument passed to the script is
"tag=$tag&interval=$interval"
which is to be interpreted as a query
string.
Look in $VOVDIR/etc/lm/reports for
examples.
EXAMPLES:
% ftlm_batch_report -h
% ftlm_batch_report -inputFile my_lmreport_ctl.txt
% ftlm_batch_report -script report_tag.tcl -tag ABC -interval "Sep 2008"
% ftlm_batch_report -interval 20110101-20110131 -tag EDA
-feature MATLAB -showFeatureStats 1
% ftlm_batch_report -interval Yesterday -tag EDA
-feature MATLAB -showUtilizationPlot 1
-staticImages 1 -outputFile dailyutilplot.html
