Milimetric has submitted this change and it was merged.
Change subject: Add monitoring of dashboards
......................................................................
Add monitoring of dashboards
Change-Id: I4147f67572927773004f8de83e582572a7b94679
---
M scripts/check_web_page.sh
1 file changed, 167 insertions(+), 1 deletion(-)
Approvals:
Milimetric: Verified; Looks good to me, approved
diff --git a/scripts/check_web_page.sh b/scripts/check_web_page.sh
index fe14dea..660fdd8 100755
--- a/scripts/check_web_page.sh
+++ b/scripts/check_web_page.sh
@@ -6,8 +6,37 @@
set -e
+# Automatic cleanup of temporary file by trapping EXIT. (See
+# DEBUG=local below)
+TMP_FILES_ABS=()
+cleanup() {
+ if [ "$DEBUG" != "local" ]
+ then
+ for TMP_FILE_ABS in "${TMP_FILES_ABS[@]}"
+ do
+ rm -f "$TMP_FILE_ABS"
+ if [ -e "$TMP_FILE_ABS" ]
+ then
+ echo "Could not remove temporary file: $TMP_FILE_ABS" >&2
+ fi
+ done
+ fi
+}
+trap "cleanup" EXIT
+
# Absolute path to this script
SCRIPT_DIR_ABS="$(dirname "$0")"
+
+# Urls to download files from
+URL_BASE="http://gp.wmflabs.org/";
+URL_BASE_DASHBOARD="$URL_BASE/dashboards"
+
+# Set DEBUG to "local" to download files into /tmp and use those copies
+# instead of fetching the files again and again for each run. Files do
+# not get removed upon script exit. This is only useful when
+# debugging/developing the script
+DEBUG=
+#DEBUG=local
#---------------------------------------------------
# Dumps an error message to stderr and exits the script
@@ -26,6 +55,140 @@
}
#---------------------------------------------------
+# Creates a temporary file
+#
+# The temporary file gets added to the TMP_FILES_ABS array, and hence
+# removed upon exit of the script, if not in DEBUG=local mode. (See
+# trap at top of this script).
+#
+# Input:
+# $1 - stencil to be used for the temporary file. This stencil gets
+# prepended by "geowiki_monitor." and has a randow string
+# appended.
+#
+# Output:
+# TMP_FILE_ABS - The absolucte name of the created temporary file. Do
+# not clean up the file. It is removed automatically (when not
+# in DEBUG=local).
+#
+mktemp_file() {
+ local NAME="$1"
+ TMP_FILE_ABS=$(mktemp --tmpdir geowiki_monitor.$NAME.XXXXXX)
+ if [ -z "$TMP_FILE_ABS" ]
+ then
+ error "Could not create new temporary file"
+ fi
+ if [ ! -e "$TMP_FILE_ABS" ]
+ then
+ error "Could not create temporary file '$TMP_FILE_ABS'"
+ fi
+ TMP_FILES_ABS=( "${TMP_FILES_ABS[@]}" "${TMP_FILE_ABS}" )
+}
+
+#---------------------------------------------------
+# Downloads a URL to $DOWNLOADED_FILE_ABS without considering caches.
+#
+# Rather use the download_file function instead, as do_download_file
+# does not pick up previously downloaded files.
+#
+# This function does not respect DEBUG=local.
+#
+# Input:
+# $1 - The url to download
+#
+# Output:
+# DOWNLOADED_FILE_ABS - The absolute name of the file into which the
+# URL has been downloaded.
+#
+do_download_file() {
+ local URL="$1"
+ wget -O "$DOWNLOADED_FILE_ABS" -o /dev/null "$URL"
+}
+
+#---------------------------------------------------
+# Downloads a URL to $DOWNLOADED_FILE_ABS.
+#
+# When not in DEBUG=local mode, the file is downloaded from the given
+# URL into a temporary file (which automatically gets removed upon
+# script exit). The name of this temporary file is passed back.
+#
+# When in DEBUG=local mode, a canonical file name for the URL is
+# generated under /tmp/. If the file does not exist, the URL gets
+# downloaded into this URL. The canonical file name for the URL is
+# returned.
+#
+# Input:
+# $1 - The url to download
+#
+# Output:
+# DOWNLOADED_FILE_ABS - The absolute name of the file into which the
+# URL's content can be found. Do not modify this file, as it may
+# be reused for different runs, when in DEBUG=local mode. Do not
+# clean up the file. It is removed automatically (when not in
+# DEBUG=local).
+#
+download_file() {
+ local URL="$1"
+
+ local SAFE_URL="$(echo "$URL" | sed -e 's/[^a-zA-Z0-9_.-]/_/g')"
+
+ if [ "$DEBUG" = "local" ]
+ then
+ DOWNLOADED_FILE_ABS=/tmp/geowiki_monitor."$SAFE_URL"
+ if [ ! -e "$DOWNLOADED_FILE_ABS" ]
+ then
+ do_download_file "$URL"
+ fi
+ else
+ local TMP_FILE_ABS
+ mktemp_file "$SAFE_URL"
+ DOWNLOADED_FILE_ABS="$TMP_FILE_ABS"
+ do_download_file "$URL"
+ fi
+}
+
+#---------------------------------------------------
+# Downloads a dashboard file and does some basic checks on the file
+#
+# It is assured that
+# * the file exists and is not empty
+#
+# Input:
+# $1 - The dashboards's stub to download. The URL to download is generated
+# from this stub. E.g.: 'reportcard'.
+#
+# Output:
+# -
+#
+check_dashboard() {
+ local DASHBOARD_STUB="$1"
+
+ local DOWNLOADED_FILE_ABS=
+ download_file "${URL_BASE_DASHBOARD}/${DASHBOARD_STUB}"
+
+ # The downloaded file only contains the code to load limn, so
+ # there is not too much we can check for. But at least the server
+ # should respond with a non-empty page
+ if [ ! -s "${DOWNLOADED_FILE_ABS}" ]
+ then
+ error "No content for URL dashboard $DASHBOARD_STUB"
+ fi
+}
+
+#---------------------------------------------------
+# Checks that geowiki's dashboards are ok.
+#
+# Input:
+# -
+#
+# Output:
+# -
+#
+check_dashboards() {
+ check_dashboard reportcard
+}
+
+#---------------------------------------------------
# Checks that geowiki's files are ok.
#
# Input:
@@ -35,7 +198,10 @@
# -
#
check() {
- error "not yet implemented"
+ check_dashboards
+ error "checking graphs not yet implemented"
+ error "checking datasources not yet implemented"
+ error "checking datafiles not yet implemented"
}
--
To view, visit https://gerrit.wikimedia.org/r/83810
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: merged
Gerrit-Change-Id: I4147f67572927773004f8de83e582572a7b94679
Gerrit-PatchSet: 1
Gerrit-Project: analytics/geowiki
Gerrit-Branch: master
Gerrit-Owner: QChris <[email protected]>
Gerrit-Reviewer: Milimetric <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
