LogoLogo
  • Overview
  • publisher
    • Introduction
    • Getting Started
      • Logging in to Publisher
    • Data Sources
      • Connecting a Data Source
      • Managing a Data Source
      • Connectors
        • AWS S3 Permissions
        • Connecting to AWS S3 Storage
        • Google Cloud Storage (GCS) Permissions
        • Connecting to Google Cloud Storage
        • PostgreSQL Permissions
        • Connecting to PostgreSQL
        • PostgreSQL on Azure Permissions
        • Microsoft Azure Blob Storage Permissions
        • Connecting to Microsoft Azure Blob Storage
        • Connecting to HTTPS
        • Connecting to other sources via Trino
          • BigQuery
    • Collections
      • Creating a Collection
      • Sharing a Collection
      • Collection Filters
      • Editing Collection Metadata
      • Updating Collection Contents
    • Access Policies
      • Creating an Access Policy
      • Managing Access Policies
    • Questions
      • Adding Questions
      • Example Question
    • Settings
      • Viewing Current and Past Administrators
      • Adding an Administrator
      • Removing an Administrator
      • Setting Notification Preferences
  • Explorer
    • Introduction
    • Viewing a Collection
    • Browsing Collections
    • Asking Questions
    • Accessing a Private Collection
      • Requesting Access to a Private Collection
    • Filtering Data in Tables
      • Strings
      • Dates
      • Numbers
  • Workbench
    • Introduction
    • Getting Started
      • Logging into Workbench
      • Connecting an Engine
      • Finding or Importing a Workflow
      • Configuring Workflow Inputs
      • Running and Monitoring a Workflow
      • Locating Outputs
    • Engines
      • Adding and Updating an Engine
        • On AWS HealthOmics
        • On Microsoft Azure
        • On Google Cloud Platform
        • On Premises
      • Parameters
        • AWS HealthOmics
        • Google Cloud Platform
        • Microsoft Azure
        • On-Premises
        • Cromwell
        • Amazon Genomics CLI
    • Workflows
      • Finding Workflows
      • Adding a Workflow
      • Supported Languages
      • Repositories
        • Dockstore
    • Instruments
      • Getting Started with Instruments
      • Connecting a Storage Account
      • Using Sample Data in a Workflow
      • Running Workflows Using Samples
      • Family Based Analysis with Pedigree Information
      • Monitor the Workflow
      • CLI Reference
        • Instruments
        • Storage
        • Samples
        • OpenAPI Specification
    • Entities
    • Terminology
  • Passport
    • Introduction
    • Registering an Email Address for a Google Identity
  • Command Line Interface
    • Installation
    • Usage Examples
    • Working with JSON Data
    • Reference
      • workbench
        • runs submit
        • runs list
        • runs describe
        • runs cancel
        • runs delete
        • runs logs
        • runs tasks list
        • runs events list
        • engines list
        • engines describe
        • engines parameters list
        • engines parameters describe
        • engines health-checks list
        • workflows create
        • workflows list
        • workflows describe
        • workflows update
        • workflows delete
        • workflows versions create
        • workflows versions list
        • workflows versions describe
        • workflows versions files
        • workflows versions update
        • workflows versions delete
        • workflows versions defaults create
        • workflows versions defaults list
        • workflows versions defaults describe
        • workflows versions defaults update
        • workflows versions defaults delete
        • namespaces get-default
        • storage add
        • storage delete
        • storage describe
        • storage list
        • storage update
        • storage platforms add
        • storage platforms delete
        • storage platforms describe
        • storage platforms list
        • samples list
        • samples describe
        • samples files list
      • publisher
        • datasources list
  • Analysis
    • Python Library
    • Popular Environments
      • Cromwell
      • CWL Tool
      • Terra
      • Nextflow
      • DNAnexus
Powered by GitBook

© DNAstack. All rights reserved.

On this page
  • Synopsis
  • Description
  • Examples
  • Positional Flags
  • [RUN_ID|LOGURL]
  • Flags
  • --max-bytes=NUMBER
  • --offset=NUMBER
  • --log-type=LOG_TYPE
  • --task-id=TASK_ID
  • --output=PATH

Was this helpful?

  1. Command Line Interface
  2. Reference
  3. workbench

runs logs

Retrieve log bytes for a run or a task

Previousruns deleteNextruns tasks list

Last updated 1 year ago

Was this helpful?

Synopsis

omics workbench runs logs [RUN_ID|LOG_URL]
  [--max-bytes=NUMBER]
  [--offset=NUMBER]
  [--log-type=LOG_TYPE]
  [--task-id=TASK_ID]
  [--output=PATH] 

Description

Retrieve log bytes for a run or a task and stream to the console. The content of Run level logs are engine and environment dependent and may not always be present.Task-level logs often contain the log output generated from the execution of the task itself and can be helpful for debugging a task.

Examples

Retrieve the workflow level stdout logs for a given run and print it to the console.

omics workbench runs logs e5ed2c8f-d570-42db-a897-0861d7f828d2

You can easily switch to streaming the stderr logs instead of the stderr.

omics workbench runs logs --log-type stderr e5ed2c8f-d570-42db-a897-0861d7f828d2

If you would like to retrieve the logs for a given task, you first will need the task_id. The task_id can be retrieved using the command:

TASK_ID=$(omics workbench runs tasks list --run e5ed2c8f-d570-42db-a897-0861d7f828d2 | jq '[.tasks[] | .task_id][0]')

Once you have the task_id, you can then use it in the logs command to retrieve the task level logs.

omics workbench runs logs --task-id "${TASK_ID}" e5ed2c8f-d570-42db-a897-0861d7f828d2

Positional Flags

[RUN_ID|LOGURL]

Flags

--max-bytes=NUMBER

Limit the number of bytes to retrieve from the log stream.

--offset=NUMBER

Skip over N bytes in the log-stream, allowing you to jump into a random part of the log.

--log-type=LOG_TYPE

Toggle whether to write the associated stderr or stdout to the output. If this value flag is not specified the default is stdout.

Valid choices: stdout, stderr

--task-id=TASK_ID

--output=PATH

If specified, attempt to write the stderr or stdout logs to the given file path. If the file exists, the command will exit without overwriting it.

In order to get the logs for a specific task, you can first use the runs tasks list command to retrieve a list of task IDs. tasks?

If specified, retrieve the logs for a given task within a run. The task_id can be retrieved from the command.

runs tasks list
runs tasks list