Asynqmon

Asynqmon is a web based tool for monitoring and administrating Asynq queues and tasks.

Compatibility

Current version of Asynqmon is compatible with Asynq v0.15 or above.

Installation

Release binaries

You can download the release binary for your system from the releases page.

Building from source

To build Asynqmon from source code, first ensure that have a working Go environment with version 1.16 or greater installed. You also need Node.js and Yarn installed in order to build the frontend assets.

Download the source code and then run:

make build

The asynqmon binary should be created in the current directory.

Usage

Asynqmon server needs to connect to redis server to serve data. By default, it connects to redis server running on port 6379 locally, and the server listens on port 8080.

To use the defaults, simply run and open http://localhost:8080.

./asynqmon

Pass flags to specify port, redis server address, etc.

./asynqmon --port=3000 --redis_addr=localhost:6380

To see all available flags, run

./asynqmon --help

Running from Docker

To run Asynqmon in Docker container, you only need to install Docker to your system. No need to install Node.js and Yarn, they will be installed automatically in container.

After that, just run this command:

make docker

Next, go to localhost:8080 and see Asynqmon dashboard:

Change a default Asynqmon settings

By default, Asynqmon runs on http://localhost:8080 and waiting to connect to the Redis server on port 6379. You can easily change this settings by running Docker container with custom options, like this:

docker run --rm \
    --name asynqmon \
    -p 3000:3000 \
    asynqmon --port=3000 --redis_addr=localhost:6380

Works with a Redis server from Docker

If you run Redis server from Docker container too (i.e. is not locally installed to your machine), you need to set Docker network to make them work together. For example, if Redis container have a name like dev-redis, and our Docker network called dev-network, you should run Asynqmon container by this command:

docker run --rm \
    --name asynqmon \
    --network dev-network \
    -p 8080:8080 \
    asynqmon --redis_addr=dev-redis:6379

License

Asynqmon is released under the MIT license. See LICENSE.

2.8 KiB Raw Blame History