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

DOCS-3395: Support downloading logs #3872

Merged
merged 1 commit into from
Jan 21, 2025
Merged

DOCS-3395: Support downloading logs #3872

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions docs/dev/tools/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1228,8 +1228,15 @@ viam machines part restart --machine=123 --part=456
| `--location` | Location name or ID that the machine belongs to or to list machines in | `list`, `status`, `logs`, `part` | **Required** |
| `--machine` | Machine name or ID for which the command is being issued | `status`, `logs`, `part`, `part restart` | **Required** |
| `--errors` | Boolean, return only errors (default: false) | `logs` | Optional |
| `--levels` | Filter logs by levels (debug, info, warn, error). Accepts multiple inputs in comma-separated list. | `logs` | Optional |
| `--part` | Part name or ID for which the command is being issued | `logs`, `part` | Optional |
| `--tail` | Tail (stream) logs, boolean(default false) | `part logs` | Optional |
| `--keyword` | Filter logs by keyword. | `logs` | Optional |
| `--start` | Filter logs to include only those after the start time. Time format example: `2025-01-13T21:30:00Z` (ISO-8601 timestamp in RFC3339). | `logs` | Optional |
| `--end` | Filter logs to include only those before the end time. Time format example: `2025-01-13T21:35:00Z` (ISO-8601 timestamp in RFC3339). | `logs` | Optional |
| `--count` | The number of logs to fetch. | `logs` | Optional |
| `--format` | THe file format for the output file. Options: `text` or `json`. | `logs` | Optional |
| `--output` | The path to the output file to store logs in. | `logs` | Optional |
| `--stream` | If specified, the interval in which to stream the specified data, for example, 100ms or 1s | `part run` | Optional |
| `--data` | Command data for the command being request to run (see [data argument](#using-the---stream-and---data-arguments)) | `part run` | **Required** |
| `--machine-id` | The machine to create an API key for | `api-key` | **Required** |
Expand Down
Loading