StatusWeb

StatusWeb

StatusWeb is a robust yet exceptionally lightweight plugin designed for Velocity proxies, providing a simple and highly efficient HTTP endpoint to broadcast your server's operational status. Tailored for modern infrastructure, it serves as an ideal solution for automated monitoring, health checks, and integrating with container orchestration platforms.

Key Features

• Dedicated Status Endpoint: A specific web address (/) that exclusively reports the live status of your Velocity proxy.
• Plain Text Simplicity: The endpoint provides a direct, unambiguous plain text response: Online. This minimalist approach ensures maximum compatibility with monitoring tools and minimizes data overhead.
• Essential for Health Checks: Perfectly suited for use cases like Kubernetes liveness/readiness probes, Docker health checks, and external uptime monitoring services. Quickly determine if your proxy is active and responsive.
• Featherlight Footprint: Engineered for efficiency, StatusWeb consumes minimal system resources, ensuring it doesn't impact your proxy's performance.
• Configurable Port: Easily customize the HTTP server's listening port to avoid conflicts and integrate seamlessly with your network setup.

Why Choose StatusWeb?

In today's dynamic server environments, knowing the real-time status of your proxy is crucial. StatusWeb offers a no-fuss, reliable mechanism to continuously verify your Velocity instance's availability. Its simplicity is its strength, delivering precisely what's needed for automated system checks without any unnecessary complexity.

Configuration

StatusWeb keeps configuration straightforward through a config.properties file located in your plugin's data folder (typically /plugins/StatusWeb/).

# StatusWeb configuration

# The network interface to bind the HTTP server to.
# Use 0.0.0.0 to listen on all available network interfaces.
bind=0.0.0.0

# The port number on which the HTTP server will listen for incoming requests.
port=51234

How to Use

Once StatusWeb is installed and configured:

1. Start your Velocity proxy. StatusWeb will log its binding address and port.
2. Access the endpoint: Open your web browser or use a command-line tool like curl to access http://your-server-ip:configured-port/.