.TH "resource_monitor_histograms" 1 "" "CCTools 7.0.9 FINAL" "Cooperative Computing Tools"

.SH NAME
.LP
\fBresource_monitor_histograms\fP - create HTML pages and graphs of resource monitor data

.SH SYNOPSIS
.LP
\FC\fBresource_monitor_histograms [options] -L monitor_data_file_list output_directory [workflow_name]\fP\FT
\FC\fBresource_monitor_histograms [options] output_directory < monitor_data_file_list  [workflow_name]\fP\FT

.SH DESCRIPTION
.LP

\fBresource_monitor_histograms\fP is a tool to visualize resource usage as
reported by \fBresource_monitor\fP. \fBresource_monitor_histograms\fP expects
a file listing the paths of summary files (-L option or from standard
input). Results are written to \fBoutput_directory\fP in the form of several
webpages showing histograms and statistics per resource.

.SH ARGUMENTS
.LP

.SS Input Options
.LP
.LP
.TP
.BI \ -L \ <monitor_data_file_list>
.
File with one summary file path per line.


.SS Output Options
.LP
.LP
.TP
.BI \  output_directory \ <>
.
The path in which to store the visualizations. See index.html for the root of the visualization.
.TP
.B \  workflow_name
.
Optional name to include to describe the workflow being visualized.
.TP
.BI \ -f \ <str>
.
Select which fields for the histograms. Default is "cores,memory,disk". Available fields are:


.fam C
.nf
.nh
.IP "" 8
bandwidth
bytes_read
bytes_received
bytes_send
bytes_written
cores
cpu_time
disk
max_concurrent_processes
memory
swap_memory
total_files
total_processes
virtual_memory
wall_time
.fi
.hy
.fam
.P

.SS Debugging Options
.LP
.LP
.TP
\fB-d\fP, \fB-\-debug\fP=\fI<subsystem>\fP
.
Enable debugging for this subsystem.
.TP
\fB-o\fP, \fB-\-debug-file\fP=\fI<file>\fP
.
Write debugging output to this file. By default, debugging is sent to stderr (":stderr"). You may specify logs be sent to stdout (":stdout"), to the system syslog (":syslog"), or to the systemd journal (":journal").
.TP
.B \ --verbose
.
Display runtime progress on stdout.



.SH EXAMPLES
.LP

Most common usage:

.fam C
.nf
.nh
.IP "" 8
% find my_summary_files_directory -name "*.summary" > summary_list
% resource_monitor_histograms -L summary_list my_histograms my_workflow_name
% # open my_histograms/index.html
.fi
.hy
.fam
.P

Splitting on categories, generating only resident memory related histograms:

.fam C
.nf
.nh
.IP "" 8
% resource_monitor_histograms -f memory -L summary_list my_histograms my_workflow_name
% # open my_histograms/index.html
.fi
.hy
.fam
.P

.SH COPYRIGHT
.LP

The Cooperative Computing Tools are Copyright (C) 2003-2004 Douglas Thain and Copyright (C) 2005-2015 The University of Notre Dame.  This software is distributed under the GNU General Public License.  See the file COPYING for details.