Birddog

Birddog is a free tool for monitoring workers, services and jobs of a RoadRunner instance.

Installation

docker run \
    -p 8080:8080 \
    -p 3000:3000 \
    --env DEFAULT_RPC_SERVER_ADDRESS=tcp://127.0.0.1:6001 \
    ghcr.io/roadrunner-server/birddog:latest

You can also define multiple RPC servers via env variables:

docker run \
    -p 8080:8080 \
    -p 3000:3000 \
    --env DEFAULT_RPC_SERVER=foo \
    --env RPC_SERVER_FOO=tcp://127.0.0.1:6001 \ 
    --env RPC_SERVER_BAR=tcp://127.0.0.1:6001 \
    ghcr.io/roadrunner-server/birddog:latest

or using docker compose:

version: "3.7"

services:
    rr-php:
        build:
            dockerfile: ./docker/php/Dockerfile
        command: rr serve
        restart: on-failure

    monitor:
        image: ghcr.io/roadrunner-server/birddog:latest
        ports:
            - "8080:8080"
            - "3000:3000"
        environment:
            DEFAULT_RPC_SERVER_ADDRESS: tcp://rr-php:6001
            API_URL: http://127.0.0.1:8080

Configuration

There ENV variables that can be used to configure the Birddog:

# Birddog Websocket API URL
WS_URL=http://127.0.0.1:8080/connection/websocket

# Default RR RPC server address
# It works only if you won't relace DEFAULT_RPC_SERVER ENV variable
DEFAULT_RPC_SERVER_ADDRESS=tcp://127.0.0.1:6001

# Default RPC server name 
DEFAULT_RPC_SERVER=foo

# Servers definition
# You can define multiple servers using the following format. Every server should start with RPC_SERVER_ prefix.
RPC_SERVER_FOO=tcp://127.0.0.1:6001
RPC_SERVER_BAR=tcp://127.0.0.1:6001