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

Document logs #245

Merged
merged 3 commits into from
Jun 27, 2024
Merged

Document logs #245

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2239ed
document logs
bryannho Jun 27, 2024
63ee9fd
example ids
bryannho Jun 27, 2024
ee28ceb
clarify
bryannho Jun 27, 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
29 changes: 28 additions & 1 deletion doc/user-guide/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ ploomber-cloud examples flask/some-new-app --clear-cache

## Monitor a deployment

An application deployment can be monitored by using the `watch` command by passing a `project_id` and an optional `job_id`:
An application deployment can be monitored by using the `watch` command by passing a `project-id` and an optional `job-id`:

```sh
ploomber-cloud watch --project-id <project-id> --job-id <job-id>
Expand All @@ -178,6 +178,33 @@ The deployment process started! Track its status at: https://www.platform.ploomb

Here, `project-id` is `muddy-art-3373` and `job-id` is `8d1067be`.

## Retrieve application logs

You can retrieve app logs during or after deployment using the `logs` command. You must pass a `project-id` or `job-id`. Here's an example using `--project-id`:
edublancas marked this conversation as resolved.
Show resolved Hide resolved

```sh
ploomber-cloud logs --project-id <project-id>
```

or using `--job-id`:

```sh
ploomber-cloud logs --job-id <job-id>
```

Note that if you pass both `--project-id` and `--job-id`, the __job-id__ will be prioritized.

By default the command will print both the `docker` logs and `webservice` logs, but you can specify a single set of logs using the `--type` option. Available types are: `docker` or `web`:

```sh
ploomber-cloud logs --project-id <project-id> --type docker
```

```sh
ploomber-cloud logs --project-id <project-id> --type web
```


## Configure an application using a template

You can configure an application using a pre-defined template by running the command `ploomber-cloud templates <template-name>`.
Expand Down
Loading