Initial commit
This commit is contained in:
BDR
commit
27b7891bd7
5 changed files with 168 additions and 0 deletions
21
LICENSE
Normal file
21
LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2021 Baptiste DE RENZO
|
||||
|
||||
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 (including the next
|
||||
paragraph) 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.
|
||||
27
README.md
Normal file
27
README.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# Tinystatus
|
||||
|
||||
tinystatus generate an html status page via shell script.
|
||||
|
||||
## Features
|
||||
|
||||
* Parallel checks
|
||||
* HTTP, ping, port checks
|
||||
* HTTP expected status code (401, ...)
|
||||
* Minimal dependencies (curl, nc and coreutils)
|
||||
* Easy configuration and customisation
|
||||
* Incident history (manual)
|
||||
|
||||
## Demo
|
||||
|
||||
An example site is available [here](https://lab.bdro.fr/tinystatus/).
|
||||
|
||||
## Setup
|
||||
|
||||
To install tinystatus:
|
||||
|
||||
* Clone the repository and go to the created directory
|
||||
* Edit the checks file `checks.list`
|
||||
* To add incidents or maintenance, edit `incidents.list`
|
||||
* Generate status page `./tinystatus > index.html`
|
||||
* Serve the page with your favorite web server
|
||||
|
||||
4
checks.list
Normal file
4
checks.list
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
http | 200 | Google website | https://google.com
|
||||
http | 404 | Google 404 | https://google.com/dummy
|
||||
ping | 0 | Google ping | 8.8.8.8
|
||||
port | 0 | Google dns | 8.8.8.8:53
|
||||
2
incidents.list
Normal file
2
incidents.list
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
2021/02/01 08:00 - Site unavailable. Resolved after 5 minutes of downtime.
|
||||
2021/01/01 09:00 - User may have problem with API. Incident resolved after 1 hour.
|
||||
114
tinystatus
Executable file
114
tinystatus
Executable file
|
|
@ -0,0 +1,114 @@
|
|||
#!/usr/bin/env sh
|
||||
|
||||
title=tinystatus
|
||||
timeout=10
|
||||
tmp=${tmpdir:-/tmp/tinystatus}
|
||||
useragent="User-Agent: Mozilla/5.0 (X11; Linux x86_64; Debian) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36"
|
||||
|
||||
command_exists(){
|
||||
if ! command -v "${1}" >/dev/null 2>&1; then
|
||||
echo >&2 "Error: ${1} missing. Please install it"
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
get_element(){
|
||||
echo "${2}" | awk -v col="${1}" -F'|' '{gsub(/^[ \t]+|[ \t]+$/, "", $col); print $col}'
|
||||
}
|
||||
|
||||
check(){
|
||||
ctype="${1}"
|
||||
host="${2}"
|
||||
name="${3}"
|
||||
expectedcode="${4}"
|
||||
|
||||
if [ ${ctype} = 'http' ]; then
|
||||
statuscode="$(curl -sSkLo /dev/null -H "${useragent}" -m "${timeout}" -w "%{http_code}" "${host}" 2> "${tmp}/ko/${name}.error")"
|
||||
elif [ ${ctype} = 'port' ]; then
|
||||
error="$(nc -w "${timeout}" -zv $(echo "${host}" | sed 's,:, ,') 2>&1)"
|
||||
statuscode=$?
|
||||
[ ${statuscode} -ne 0 ] && echo "${error}" > "${tmp}/ko/${name}.error"
|
||||
elif [ ${ctype} = 'ping' ]; then
|
||||
ping -W "${timeout}" -c 1 "${host}" >/dev/null 2>&1
|
||||
statuscode=$?
|
||||
[ ${statuscode} -ne 0 ] && echo 'Host unreachable' > "${tmp}/ko/${name}.error"
|
||||
fi
|
||||
|
||||
# verity status and write files
|
||||
if [ ${statuscode} -eq ${expectedcode} ]; then
|
||||
echo "Status code: ${statuscode}" > "${tmp}/ok/${name}.status"
|
||||
else
|
||||
echo "Status code: ${statuscode}" > "${tmp}/ko/${name}.status"
|
||||
fi
|
||||
if [ -s "${tmp}/ko/${name}.error" ]; then
|
||||
sed "${tmp}/ko/${name}.error" \
|
||||
-e 's,curl: ([0-9]*) ,,' \
|
||||
-e 's,.*) failed: ,,' > "${tmp}/ko/${name}.status"
|
||||
fi
|
||||
}
|
||||
|
||||
command_exists 'curl'
|
||||
command_exists 'nc'
|
||||
rm -r "${tmp}"
|
||||
mkdir -p "${tmp}/ok" "${tmp}/ko" || exit 1
|
||||
|
||||
while IFS='\n' read -r line; do
|
||||
ctype="$(get_element 1 "${line}")"
|
||||
code="$(get_element 2 "${line}")"
|
||||
name="$(get_element 3 "${line}")"
|
||||
host="$(get_element 4 "${line}")"
|
||||
check "${ctype}" "${host}" "${name}" "${code}" &
|
||||
done < "${1:-checks.list}"
|
||||
wait
|
||||
|
||||
cat << EOF
|
||||
<!DOCTYPE html><html lang="en"><head><title>${title}</title><style>
|
||||
body { font-family: segoe ui,Roboto,Oxygen-Sans,Ubuntu,Cantarell,helvetica neue,Verdana,sans-serif; }
|
||||
h1 { margin-top: 30px; }
|
||||
ul { padding: 0px; }
|
||||
li { list-style: none; margin-bottom: 2px; padding: 5px; border-bottom: 1px solid #ddd; }
|
||||
.container { max-width: 600px; width: 100%; margin: 15px auto; }
|
||||
.panel { text-align: center; padding: 10px; border: 0px; border-radius: 5px; }
|
||||
.failed-bg { color: white; background-color: #E25D6A; }
|
||||
.success-bg { color: white; background-color: #52B86A; }
|
||||
.failed { color: #E25D6A; }
|
||||
.success { color: #52B86A; }
|
||||
.small { font-size: 80%; }
|
||||
.status { float: right; }
|
||||
</style></head>
|
||||
<body>
|
||||
<div class='container'>
|
||||
<h1>Global status</h1>
|
||||
EOF
|
||||
outagenb=$(find ${tmp}/ko -mindepth 1 | grep -c 'status$')
|
||||
if [ ${outagenb} -ne 0 ]; then
|
||||
echo "<ul><li class='panel failed-bg'>${outagenb} Outage(s)</li></ul>"
|
||||
else
|
||||
echo "<ul><li class='panel success-bg'>All Systems Operational</li></ul>"
|
||||
fi
|
||||
cat << EOF
|
||||
<h1>Services</h1>
|
||||
<ul>
|
||||
EOF
|
||||
for file in ${tmp}/ko/*.status; do
|
||||
[ -e "${file}" ] || continue
|
||||
name=$(basename "${file}" | sed 's,.status$,,')
|
||||
status=$(cat "${file}")
|
||||
echo "<li>${name} <span class='small failed'>(${status})</span><span class='status failed'>Disrupted</span></li>"
|
||||
done
|
||||
for file in ${tmp}/ok/*.status; do
|
||||
[ -e "${file}" ] || continue
|
||||
name=$(basename "${file}" | sed 's,.status$,,')
|
||||
echo "<li>${name} <span class='status success'>Operationnal</span></li>"
|
||||
done
|
||||
cat << EOF
|
||||
</ul>
|
||||
<p class=small> Last check: $(date +"%Y/%m/%d %H:%M:%S")</p>
|
||||
<h1>Incidents</h1>
|
||||
EOF
|
||||
sed 's|^\(.*\)$|<p>\1</p>|' "${2:-incidents.list}" 2>/dev/null || echo "<p>No incident reported yet ;)</p>"
|
||||
cat <<EOF
|
||||
</div>
|
||||
</body></html>
|
||||
EOF
|
||||
|
||||
Loading…
Reference in a new issue