Skip to content

Commit

Permalink
Document falsey values of job_metrics
Browse files Browse the repository at this point in the history
  • Loading branch information
natefoo committed Dec 12, 2023
1 parent 91ef184 commit 0598a4b
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/source/admin/galaxy_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4309,6 +4309,8 @@
The syntax, available instrumenters, and documentation of their
options is explained in detail in the documentation:
https://docs.galaxyproject.org/en/master/admin/job_metrics.html
By default, the core plugin is enabled. Setting this option to
false or an empty list disables metrics entirely.
:Default: ``None``
:Type: seq

Expand Down
2 changes: 2 additions & 0 deletions lib/galaxy/config/sample/galaxy.yml.sample
Original file line number Diff line number Diff line change
Expand Up @@ -2337,6 +2337,8 @@ galaxy:
# The syntax, available instrumenters, and documentation of their
# options is explained in detail in the documentation:
# https://docs.galaxyproject.org/en/master/admin/job_metrics.html
# By default, the core plugin is enabled. Setting this option to false
# or an empty list disables metrics entirely.
#job_metrics: null

# This option allows users to see the job metrics (except for
Expand Down
3 changes: 3 additions & 0 deletions lib/galaxy/config/schemas/config_schema.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3145,6 +3145,9 @@ mapping:
https://docs.galaxyproject.org/en/master/admin/job_metrics.html
By default, the core plugin is enabled. Setting this option to false or an empty list disables metrics
entirely.
expose_potentially_sensitive_job_metrics:
type: bool
default: false
Expand Down
1 change: 1 addition & 0 deletions lib/galaxy/job_metrics/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ def __init__(self, conf_file=None, conf_dict=None, **kwargs):
conf_dict = DEFAULT_CONFIG
self.default_job_instrumenter = JobInstrumenter.from_dict(self.plugin_classes, conf_dict, **kwargs)
else:
# allows for setting non-None falsey values to get no metrics config whatsoever
self.default_job_instrumenter = NULL_JOB_INSTRUMENTER
self.job_instrumenters = collections.defaultdict(lambda: self.default_job_instrumenter)

Expand Down

0 comments on commit 0598a4b

Please sign in to comment.