diff --git a/README.md b/README.md index 40be71f..652670a 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ To install `asynq` library, run the following command: go get -u github.com/hibiken/asynq ``` -## Quick Start +## Quickstart First, make sure you are running a Redis server locally. diff --git a/docs/assets/asynqmon_ps.gif b/docs/assets/asynqmon_ps.gif new file mode 100644 index 0000000..7043329 Binary files /dev/null and b/docs/assets/asynqmon_ps.gif differ diff --git a/tools/asynqmon/README.md b/tools/asynqmon/README.md index 3d6c6b1..56dfcc4 100644 --- a/tools/asynqmon/README.md +++ b/tools/asynqmon/README.md @@ -8,6 +8,7 @@ Asynqmon is a command line tool to monitor the tasks managed by `asynq` package. - [Quick Start](#quick-start) - [Stats](#stats) - [History](#history) + - [Process Status](#process-status) - [List](#list) - [Enqueue](#enqueue) - [Delete](#delete) @@ -22,7 +23,7 @@ In order to use the tool, compile it using the following command: This will create the asynqmon executable under your `$GOPATH/bin` directory. -## Quick Start +## Quickstart The tool has a few commands to inspect the state of tasks and queues. @@ -56,6 +57,16 @@ Example: ![Gif](/docs/assets/asynqmon_history.gif) +### Process Status + +PS (ProcessStatus) command shows the list of running worker processes. + +Example: + + asynqmon ps + +![Gif](/docs/assets/asynqmon_ps.gif) + ### List List command shows all tasks in the specified state in a table format