monitor-custom

This directory contains a dockerizable webservice that runs R code and returns various types of custom products.

Reboot Instructions for an Operational Site

make production_bounce

(Yes, that's it.)

Now for the gory details.

Files

The basic files required for a product-only webservice (no UI) are the following:

├── Makefile
├── NEWS.md
├── README.md
├── README_THIS_IS_GIT_BRANCH_master
├── docker
│   ├── docker-compose-desktop.yml
│   ├── docker-compose-test.yml
│   └── docker-compose-v4.yml
└── monitor-custom
    ├── Dockerfile-test
    ├── Dockerfile-v4
    └── R
        ├── dailyhourlybarplot/
        ├── monitor-custom-app.R
        └── sharedUtils/

Running the app from RStudio

Outside of RStudio you must first:

make desktop_download_data

Inside RStudio you can run the app with:

cd monitor-custom/
"Set As Working Directoroy"
open up R/monitor-custom-app.R
set breakpoints if desired
click the 'Source' button

The app will be available at:

localhost:8080/monitor-custom/dev/

Running the app with Docker

You can create and run a docker image with the with:

make desktop_reboot

The app will be available at:

localhost:8080/monitor-custom/test/

You can clean the data download directory by typing:

make clean

The Makefile has targets for three different types of deployment: desktop, test, production. The test and production targets are intended to be deployed on an AWS instance.

A quick refresher on docker commands is available at the docker cheatsheet.

Host Computer Settings

Data Files

Latest data .RData files are mounted from the following directory which must exist:

/data/monitoring/RData

In production, a crontab on the host machine will keep this directory up-to-date.

Log Files

Log files will be written to a directory named after the deployment type:

/var/log/monitor-custom/test/app or /var/log/monitor-custom/production/app

except for desktop which are written to:

monitor-custom/logs

ProxyPass Settings

On AWS instances, ProxyPass settings are defined in:

/etc/apache2/sites-enabled/default-ssl.conf

Testing the app

You can ask to see the api by hitting the service with no sub-service specified:

localhost:8080/monitor-custom/test

You can ask for a plot:

localhost:8080/monitor-custom/test/plot?monitorid=530331011_01&plottype=timeseries

You can specify responsetype=json to have the service return a json response for use by javascript code in a user interface:

localhost:8080/monitor-custom/test/plot?monitorid=530331011_01&plottype=timeseries&responsetype=json

MazamaScience/monitoring-custom-service