dish: A Lightweight and Efficient Monitoring Service

dish is a streamlined monitoring service designed for efficient socket connection checks. This versatile tool can be configured remotely and operates as a one-shot service, making it ideal for rapid monitoring of various HTTP/S and TCP sockets.

Key Features

• Compact: As a tiny monitoring service, dish is lightweight and efficient.
• Remote Configuration: Easily manage an independent "dish network" through the -source ${REMOTE_JSON_API_URL} option.
• Performance: Executes tests in parallel with a default timeout of just 10 seconds per socket, ensuring low overall execution time.

Usage Examples

The dish tool can be installed using the following command:

go install go.vxn.dev/dish/cmd/dish@latest

To explore the options, invoke:

dish -h

Running dish with a Local JSON File

# Specify a local JSON file to load sockets
 dish -source /opt/dish/sockets.json

Running dish with a Remote JSON API

# Use a remote REST API to supply socket information
 dish -source http://restapi.example.com/dish/sockets/:instance

Alerting Mechanisms

When monitoring, timely notifications of any issues are crucial. dish provides multiple alerting methods:

• Upload test results to a remote JSON API using the -updateURL option.
• Send alerts via Telegram with integrated support.
• Report failed socket attempts to Prometheus Pushgateway.
• Push results to a specified webhook URL.

(This screenshot illustrates Telegram alerting in action.)

Docker Support

dish can be easily deployed in Docker:

# Build the Docker image
make build

# Run using Docker Compose
make run

# Or use Docker run command
 docker run --rm \
 dish:1.7.1-go1.23 \
 -verbose \
 -source https://api.example.com \
 -pushgw \
 -target https://pushgateway.example.com

Cronjob Integration

To automate the running of dish, a bash script can be created and scheduled:

# Example bash script (tiny-dish-run.sh)
#!/bin/bash
TELEGRAM_TOKEN="123:AAAbcD_ef"
# additional setup omitted for brevity

docker run --rm \
 ${DISH_TAG} \
 # setting flags and options

A cronjob can then be added to run this script periodically:

# Crontab configuration
MAILTO=monitoring@example.com
*/2 * * * * /home/user/tiny-dish-run.sh

Documentation and Further Reading

For more in-depth information, refer to the dish history article.

In summary, dish serves as an efficient and flexible solution for monitoring socket connections, making it an invaluable tool for developers and system administrators.