Maestro

• Easy web browser automation
• Monitor website functionality and uptime with a real web browser
• Receive a screenshot when functionality does not work as expected
• Receive a screenshot when web page elements are not displaying in the browser

What is Maestro

Maestro = Ragios + Uptime_monitor plugin + Firefox/Chrome + Selenium Grid + Kubernetes

With Maestro, all the above is setup and configured running in Docker containers for very easy Website functionality/uptime monitoring with a real web browser (Chrome or Firefox).

Local Usage:

You can run Maestro locally with Docker Compose for development and testing, for production it is recommended to run Maestro on a Kubernetes Cluster, see details here Usage on a Kubernetes Cluster. See below for running Maestro locally with Docker Compose.

Clone the Maestro Repo:

git clone [email protected]:obi-a/maestro.git

Switch to the directory of the cloned repo

cd maestro

Start Ragios with Docker-compose

docker-compose up -d

Open the Web UI to confirm Ragios is running fine. In your browser open http://localhost:5041.

Maestro runs Ragios with the Uptime_monitor plugin and its dependencies already installed and configured.

Using the Uptime Monitor

The easiest way to start adding monitors is using the Ragios ruby client with pry console. You can use PRY from Ragios Web Service container. To access the web service container

docker-compose exec web pry

This approach is only for testing Ragios, ideally the ragios client should run in a different host or node from the rest of the stack.

Using ragios-client to add a monitor inside pry.

require "ragios-client"
ragios = Ragios::Client.new

monitor = {
  monitor: "Google.com home page",
  url: "https://google.com",
  every: "5m",
  via: "log_notifier",
  plugin: "uptime_monitor",
  exists?: 'title.with_text("Google")',
  browser: "firefox"
}
ragios.create(monitor)
# => {:monitor=>"Google.com home page",
# :url=>"https://google.com",
# :every=>"5m",
# :via=>["log_notifier"],
# :plugin=>"uptime_monitor",
# :exists?=>"title.with_text(\"Google\")",
# :browser=>"firefox",
# :created_at_=>"2018-02-10 15:17:13 UTC",
# :status_=>"active",
# :type=>"monitor",
# :_id=>"1181d969-b4f1-4ba6-9388-6f057f18cdb7"}

The monitor created above uses the uptime_monitor plugin to launch the firefox web browser every hour to visit Google.com and verify that the homepage html title tag contains the text string "Google". The validation is defined in the key/pair exists?: 'title.with_text("Google")'.

For a complete guide on using ragios-client see here: Using Ragios

For a complete guide on using the uptime_monitor plugin see here: Using Uptime_monitor plugin

Configure Ragios & Uptime Monitor

• See details on general Ragios configuration here Ragios Configuration
• Ragios ships with Amazon SES email notifier built-in see details on Ragios Notifications here: Ragios Notifications
• To configure uptime monitor to send screenshots when it detects a problem, add the correct environment variables to docker compose, the env vars are described here: Uptime Monitor enable Screenshots

Usage on a Kubernetes Cluster

Create a namespace for Ragios in your cluster

kubectl apply -f kubernetes-manifests/ragios-namespace.yaml

For receiving email notifications from Ragios using Amazon SES add AWS SES credentials as a kubernetes secret using the command below, insert the AWS crendentials of your AWS account with SES permissions, for more details see Ragios Notifications

kubectl create secret generic ses-aws-secret \
  --from-literal=ses_aws_access_key_id='<INSERT SES_AWS_ACCESS_KEY_ID>' \
  --from-literal=ses_aws_secret_access_key='<INSERT S3_AWS_SECRET_ACCESS_KEY>' \
  --namespace='ragios'

Add a kubernetes configmap with for SES config details. Replace the command below with the config details. See Ragios Notifications for details

kubectl create configmap ses-aws-config \
  --from-literal=aws_ses_send_from='<INSERT AWS_SES_SEND_FROM>' \
  --from-literal=aws_ses_endpoint='<INSERT AWS_SES_ENDPOINT>' \
  --namespace='ragios'

Optionally, to use uptime_monitor screenshots feature, add a Kubernetes secret for S3 credentials and a configmap for uptime_monitor screenshots configuration. See more details on uptime_monitor screenshots here Uptime Monitor enable Screenshots. Insert the appropriate credentials or config data in the command below:

kubectl create secret generic s3-aws-secret \
  --from-literal=s3_aws_access_key_id='<INSERT S3_AWS_ACCESS_KEY_ID>' \
  --from-literal=s3_aws_secret_access_key='<INSERT S3_AWS_SECRET_ACCESS_KEY>' \
  --namespace='ragios'

kubectl create configmap s3-aws-config \
  --from-literal=ragios_hercules_s3_dir='<RAGIOS_HERCULES_S3_DIR>' \
  --from-literal=ragios_hercules_enable_screenshots='true' \
  --namespace='ragios'

Follow the remaining steps from here https://github.com/obi-a/ragios/wiki/Run-Ragios-on-a-Kubernetes-Cluster#add-ragios-and-couchdb-credentials to complete the process and run Maestro on your Kubernetes Cluster (Note that the Maestro repo runs a customized Ragios version, so it is a very identical process as running Ragios on a Kubernetes Cluster).

License:

MIT License.

Copyright (c) 2019 Obi Akubue, obi-akubue.org