Warning
This document is for an old release of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.
galaxy.jobs.metrics package¶
This module defines the job metrics collection framework for Galaxy jobs.
The framework consists of two parts - the JobMetrics
class and
individual JobInstrumenter
plugins.
A JobMetrics
object reads any number of plugins from a configuration
source such as an XML file, a YAML file, or a dictionary.
Each JobInstrumenter
plugin object describes how to inject a bits
of shell code into a job scripts (before and after tool commands run) and then
collect the output of these from a job directory.
-
class
galaxy.jobs.metrics.
JobMetrics
(conf_file=None, **kwargs)[source]¶ Bases:
object
Load and store a collection of
JobInstrumenter
objects.-
__init__
(conf_file=None, **kwargs)[source]¶ Load
JobInstrumenter
objects from specified configuration file.
-
format
(plugin, key, value)[source]¶ Find
formatting.JobMetricFormatter
corresponding to instrumented plugin value.
-
-
class
galaxy.jobs.metrics.
JobInstrumenter
(plugin_classes, plugins_source, **kwargs)[source]¶ Bases:
object