Skip to content

build/run: Add Snakemake's --benchmark-extended as a default flag #467

@joverlee521

Description

@joverlee521

Prompted by nextstrain/docs.nextstrain.org#210 (comment), I was reading Snakemake docs on benchmarks and realized there's a new --benchmark-extended flag

Since version 8.11.0, it is possible to have extra benchmark metrics with the command --benchmark-extended:

jobid: Internal job ID,

rule_name: Rule name,

wildcards: Job wildcards,

params: Job parameters,

threads: Number of threads requested for this job,

cpu_usage: Total CPU load,

resources: Resources requested for this job,

input_size_mb: Size of input files (MiB),

The extra benchmark metrics seem nice to have for debugging across all of our workflows that I'm tempted to add it as a default flag for our nextstrain build and nextstrain run commands. nextstrain run does not take additional Snakemake flags, so we must add it in the CLI to support the extra benchmarks. nextstrain build does accept Snakemake flags, so the alternative is to add the --benchmark-extended flag to the nextstrain build invocations in GH Actions.

Metadata

Metadata

Assignees

Labels

proposalProposals that warrant further discussion

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions