2020-01-19 12:31:22 +08:00
# Asynqmon
2020-01-23 22:33:34 +08:00
Asynqmon is a command line tool to monitor the tasks managed by `asynq` package.
2020-01-19 12:31:22 +08:00
2020-01-20 00:40:51 +08:00
## Table of Contents
- [Installation ](#installation )
- [Quick Start ](#quick-start )
- [Stats ](#stats )
- [History ](#history )
- [List ](#list )
- [Enqueue ](#enqueue )
- [Delete ](#delete )
- [Kill ](#kill )
- [Config File ](#config-file )
## Installation
2020-01-19 12:31:22 +08:00
In order to use the tool, compile it using the following command:
go get github.com/hibiken/asynq/tools/asynqmon
This will create the asynqmon executable under your `$GOPATH/bin` directory.
## Quick Start
2020-01-23 22:33:34 +08:00
The tool has a few commands to inspect the state of tasks and queues.
2020-01-19 12:31:22 +08:00
Run `asynqmon help` to see all the available commands.
Asynqmon needs to connect to a redis-server to inspect the state of queues and tasks. Use flags to specify the options to connect to the redis-server used by your application.
By default, Asynqmon will try to connect to a redis server running at `localhost:6379` .
### Stats
2020-01-23 22:33:34 +08:00
Stats command gives the overview of the current state of tasks and queues. You can run it in conjunction with `watch` command to repeatedly run `stats` .
2020-01-19 12:31:22 +08:00
Example:
watch -n 3 asynqmon stats
This will run `asynqmon stats` command every 3 seconds.
2020-01-20 00:40:51 +08:00
### History
2020-01-23 22:33:34 +08:00
History command shows the number of processed and failed tasks from the last x days.
By default, it shows the stats from the last 10 days. Use `--days` to specify the number of days.
Example:
asynqmon history --days=30
2020-01-20 00:40:51 +08:00
### List
2020-01-23 22:33:34 +08:00
List command shows all tasks in the specified state in a table format
Example:
asynqmon ls retry
asynqmon ls scheduled
asynqmon ls dead
2020-01-27 11:58:48 +08:00
asynqmon ls enqueued:default
2020-01-23 22:33:34 +08:00
asynqmon ls inprogress
2020-01-20 00:40:51 +08:00
### Enqueue
2020-01-23 22:33:34 +08:00
There are two commands to enqueue tasks.
Command `enq` takes a task ID and moves the task to **Enqueued** state. You can obtain the task ID by running `ls` command.
Example:
asynqmon enq d:1575732274:bnogo8gt6toe23vhef0g
Command `enqall` moves all tasks to **Enqueued** state from the specified state.
Example:
asynqmon enqall retry
Running the above command will move all **Retry** tasks to **Enqueued** state.
2020-01-20 00:40:51 +08:00
### Delete
2020-01-23 22:33:34 +08:00
There are two commands for task deletion.
Command `del` takes a task ID and deletes the task. You can obtain the task ID by running `ls` command.
Example:
asynqmon del r:1575732274:bnogo8gt6toe23vhef0g
Command `delall` deletes all tasks which are in the specified state.
Example:
asynqmon delall retry
Running the above command will delete all **Retry** tasks.
2020-01-20 00:40:51 +08:00
### Kill
2020-01-23 22:33:34 +08:00
There are two commands to kill (i.e. move to dead state) tasks.
Command `kill` takes a task ID and kills the task. You can obtain the task ID by running `ls` command.
Example:
asynqmon kill r:1575732274:bnogo8gt6toe23vhef0g
Command `killall` kills all tasks which are in the specified state.
Example:
asynqmon killall retry
Running the above command will move all **Retry** tasks to **Dead** state.
2020-01-20 00:40:51 +08:00
## Config File
2020-01-23 22:33:34 +08:00
You can use a config file to set default values for the flags.
2020-01-20 00:40:51 +08:00
This is useful, for example when you have to connect to a remote redis server.
By default, `asynqmon` will try to read config file located in
2020-01-23 22:33:34 +08:00
`$HOME/.asynqmon.(yaml|json)` . You can specify the file location via `--config` flag.
2020-01-20 00:40:51 +08:00
Config file example:
2020-01-23 22:33:34 +08:00
```yaml
2020-01-20 00:40:51 +08:00
uri: 127.0.0.1:6379
db: 2
password: mypassword
```
This will set the default values for `--uri` , `--db` , and `--password` flags.
