hostmonitor

command module
v0.2.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2022 License: MIT Imports: 1 Imported by: 0

README

HostMonitor

A simple utility to monitor host availability by given config.

Usage:
Run as a CLI tool to display test metrics in terminal:
hostmonitor watch [flags]
Run as a web server:

Web UI will be available at http://localhost:8080. The default port can be changed with a -p flag.

hostmonitor serve [flags]
Flags:

-c or --configUrl: [string] Url of config containing url list (default "https://raw.githubusercontent.com/Kashkovsky/hostmonitor/main/itarmy_targets.txt"). Either remote url or local file path are accepted.

-h or --help: help for a command (e.g. hostmonitor serve -h)

-t or --requestTimeout: [int] Request timeout in seconds (default 5)

-i or --testInterval: [int] Interval between test updates in seconds (default 10)

-u or --updateInterval: [int] Config update interval in seconds (default 600)

-p or --port: [int] Server port (default 8080, for web server only)

Examples:
# Run CLI, read urls from local file:
./hostmonitor watch -c ./my-config.txt

# Run server with remote config:
./hostmonitor serve -c https://mydomain.com/urls.txt

Documentation

Overview

Copyright © 2022 Denys Kashkovskyi <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL