Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add omics-run-analyzer tool #29

Merged
merged 2 commits into from
Feb 14, 2024
Merged

Add omics-run-analyzer tool #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd9c1a4
Add omics-run-analyzer tool
ahenroid Feb 10, 2024
16014f6
Add Python dependencies, format constants, extend help text
ahenroid Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,31 @@ StartRun request:
}
```

## Using the Omics Run Analyzer tool
### Basic Usage
The `omics-run-analyzer` tool retrieves a workflow run manifest from CloudWatchLogs and generates statistics for the run, including CPU and memory utilization for each workflow task.

#### List completed runs
The following example lists all workflow runs completed in the past 5 days:
```txt
> omics-run-analyzer -t5d
wleepang marked this conversation as resolved.
Show resolved Hide resolved
Workflow run IDs (<completionTime> <UUID>):
1234567 (2024-02-01T12:00:00 12345678-1234-5678-9abc-123456789012)
2345678 (2024-02-03T13:00:00 12345678-1234-5678-9abc-123456789012)
```

#### Analyze a specific workflow run
```txt
> omics-run-analyzer 1234567 -o run-1234567.csv
omics-run-analyzer: wrote run-1234567.csv
```

#### Output workflow run manifest in JSON format
```txt
> omics-run-analyzer 1234567 -s -o run-1234567.json
wleepang marked this conversation as resolved.
Show resolved Hide resolved
omics-run-analyzer: wrote run-1234567.json
```

## Security

See [CONTRIBUTING](https://github.com/awslabs/amazon-omics-tools/blob/main/CONTRIBUTING.md#security-issue-notifications) for more information.
Expand Down
Loading
Loading