Skip to content

Commit

Permalink
Merge pull request #1041 from procrastinate-org/procrastinate-shell-o…
Browse files Browse the repository at this point in the history
…necmd
  • Loading branch information
ewjoachim authored Apr 17, 2024
2 parents cbfb3e2 + 241506c commit d5ae303
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions docs/howto/production/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Found procrastinate_jobs table: OK
The procrastinate shell is a tool to administrate jobs and overview queues and tasks.
It is an interactive shell that you can run with the following command.

*Experimental feature*.
_Experimental feature_.

```console
$ procrastinate shell
Expand All @@ -29,14 +29,24 @@ Documented commands (type help <topic>):
EOF cancel exit help list_locks list_jobs list_queues list_tasks retry
```

:::{note}
Shell commands can also be launched non-interactively by passing a single command.
In that case, the command will be executed, and the shell will exit immediately.

```console
$ procrastinate shell list_jobs
```

:::

As usual, you should use `--app` argument or `PROCRASTINATE_APP` environment
variable to specify the application you want to use (see {doc}`../basics/command_line`).

There are commands to list all the jobs (`list_jobs`), tasks (`list_tasks`),
queues (`list_queues`) and locks (`list_locks`).
And commands to retry (`retry`) & cancel (`cancel`) a specific job.

You can get help for a specific command *cmd* by typing `help cmd`.
You can get help for a specific command _cmd_ by typing `help cmd`.

## Error reporting

Expand All @@ -45,9 +55,9 @@ Some error capture tools will automatically collect tracebacks from these logs.

A non-exhaustive list of tools which do this:

- Sentry via its [logging integration](https://docs.sentry.io/platforms/python/guides/logging/) (enabled by default)
- Google Cloud, although you may need to set up [json log formatting](https://cloud.google.com/error-reporting/docs/formatting-error-messages)
- Sentry via its [logging integration](https://docs.sentry.io/platforms/python/guides/logging/) (enabled by default)
- Google Cloud, although you may need to set up [json log formatting](https://cloud.google.com/error-reporting/docs/formatting-error-messages)

## The administration web portal

*Not yet, maybe someday.*
_Not yet, maybe someday._

0 comments on commit d5ae303

Please sign in to comment.