Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jaimemagiera/experience-sampler-data-collector-s2i

This repository contains the files necessary to build a container for the data collector component of the Experience Sampler system using Red Hat's Source-to-Image tool.
https://github.com/jaimemagiera/experience-sampler-data-collector-s2i

Last synced: about 2 months ago
JSON representation

This repository contains the files necessary to build a container for the data collector component of the Experience Sampler system using Red Hat's Source-to-Image tool.

Awesome Lists containing this project

README 

        
# Experience Sampler Data Collector s2i



This repository contains the files necessary to build a container for the data collector component of the [Experience Sampler](http://www.experiencesampler.com) system using Red Hat's [Source-to-Image](https://github.com/openshift/source-to-image) tool. The image can built and hosted on Red Hat OpenShift or the upstream OKD. 



## Project Details ##

The Experience Sampler Data collector parses submissions, in the form of HTTP requests, from the Experience Sampler applications (iOS, Android), and writes the resulting data to disk. The Data Collector itself is a perl cgi script. It resides in the [/prod/prod-app/cgi-bin/](prod/prod-app/cgi-bin) folder of this respository. The script utilizes an Apache environmnent variable, which is initially defined as a container environment variable, to construct a path for the data files to reside. The files can be saved to external storage by attaching a storage mount to the container, and setting the appropriate path via the DATA_DIR environment variable.   



## Building the Container ##

There are two ways to build the container in OKD/Openshift:



* **Web Console:** Create a new project in the web console. Under the **Workloads** tab of the project, create a new item of type **Git Repository**  



* **Command Line:** Using the oc command, you can create a new project, then create a new application from the respository.

> oc new-project ``



> oc new-app https://github.com/JaimeMagiera/experience-sampler-data-collector-s2i.git

 

For more information on bulding and running applications in OKD/OpenShift, see the [OKD documentation](https://docs.okd.io/latest/applications/application_life_cycle_management/creating-applications-using-cli.html)



## Configuring the Data Directory



This s2i build includes a shell script which looks for an environment variable DATA_DIR. If that variable exists, an Apache configuration file is created which passes that value on to the httpd process. The included data_collector cgi script in turn looks for that value when constructing the file path to save data files to. This provides flexibility in saving the data, and allows the script to be used in a variety of environments. To define the environment variable in OpenShift, add it to the Build Configuration via the console or command line.  



## Utilities ##

This repository also contains several utilities that you can use to test your data collector.  



[test-data-collector.sh](test-data-collector.sh) This shell script simulates a survey submission to your data collector script. Use the -u flag to provide the complete URL to the data collector script. The Study ID value is "TEST123". The "Participant ID" and "Pause Time" are randomly generated. 



[test-data-collector.html](test-data-collector.html) is webpage with embedded javascript that simulates a survey submission to your data collector script. Provide the complete URL to the data collector script in the URL textfield. The Study ID value is "TEST123". The "Participant ID" and "Pause Time" are randomly generated.