Difference between revisions of "Analytics"

From CoGepedia
Jump to: navigation, search
m
m (Get Analytics Running:)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
= CoGe - Analytics  =
 
  
 
CoGe Analytics is a metrics and analytics engine for the CoGe platform written on Clojure's web framework Noir.  
 
CoGe Analytics is a metrics and analytics engine for the CoGe platform written on Clojure's web framework Noir.  
 
<br>
 
  
 
== How To: Deploy on a Server via Apache Webserver  ==
 
== How To: Deploy on a Server via Apache Webserver  ==
Line 22: Line 19:
 
Once you have all the prerequisites installed, you need to get the Greentea (Analytics) repo from Github. Run:  
 
Once you have all the prerequisites installed, you need to get the Greentea (Analytics) repo from Github. Run:  
  
   `$ git clone https://github.com/LyonsLab/Greentea.git`
+
   $ git clone https://github.com/LyonsLab/Greentea.git
  
TODO: Create a method of loading settings into Analytics from a configuration file so there's no need to unsafely fudge with the code.
+
=== Get Analytics Running:  ===
  
Open "Greentea/src/greentea/db.clj" in your favorite text editor.  
+
Install&nbsp;[http://genomevolution.org/wiki/index.php/Teabag Teabag] to get Greentea running.  
  
Modify from line 9:
+
'''---Alternatively---'''
 
+
  defdb cogedb                                                                 
+
  (mysql {:db "&lt;DB&gt;"                                                           
+
        &nbsp;:user "&lt;DB USER&gt;"                                                         
+
        &nbsp;:host "&lt;DB HOST (probably localhost)&gt;"                                                   
+
        &nbsp;:port "&lt;DB&nbsp;PORT (remove this line if default)&gt;"                                                         
+
        &nbsp;:password "&lt;DB&nbsp;PASSWORD&gt;"})
+
 
+
Write to the file. Make sure not to push any sensitive information back to Github!
+
 
+
=== Get Analytics Running:  ===
+
  
 
Inside the cloned directory run:  
 
Inside the cloned directory run:  
  
   `$ lein run &amp;`
+
   $ lein run &amp;&gt;&nbsp;/dev/null &amp;
  
it should pull in all the required dependencies'''*''' and start a Jetty servlet running on port 3456.  
+
Leiningen should pull in all the required dependencies'''*''' and start a Jetty servlet running on port 3456.  
  
Check localhost:3456 to verify that the analytics platform is running.  
+
Check localhost:3456 to verify that the analytics platform is running.
  
 
=== Configure Apache to Proxy the Servlet Port to the /analytics Endpoint  ===
 
=== Configure Apache to Proxy the Servlet Port to the /analytics Endpoint  ===
  
Now to setup apache to point localhost/analytics/ to port 3456. Open '/etc/apache2/apache.conf' in your favorite editor and add these lines:  
+
Now to setup apache to point localhost/analytics/ to port 3456. Open '/etc/apache2/apache.conf' (or another conf location) in your favorite editor and add these lines:  
  
 
  RewriteEngine On  
 
  RewriteEngine On  
Line 60: Line 46:
 
  ServerAdmin coge.genome@gmail.com ServerName localhost  
 
  ServerAdmin coge.genome@gmail.com ServerName localhost  
 
  #ServerAlias geco.com.analytics
 
  #ServerAlias geco.com.analytics
  ErrorLog /home/rchasman/logs/error.log CustomLog &lt;PATH&gt;/logs/access.log combined LogLevel warn
+
  ErrorLog /home/rchasman/logs/error.log CustomLog &lt;PATH&gt;/logs/access.log combined LogLevel warn                  
+
                                                     
&lt;Directory &lt;PATH&gt;/Greentea/resources/public/&gt;                   
+
AllowOverride All                                                       
+
Order Allow,Deny                                                       
+
Allow from all                                                         
+
&lt;/Directory&gt;                                                               
+
                                                       
+
DocumentRoot &lt;PATH&gt;/Greentea/resources/public                   
+
                                                       
+
 
  ProxyPass /analytics/ http://localhost:3456/analytics/                       
 
  ProxyPass /analytics/ http://localhost:3456/analytics/                       
ProxyPassReverse /analytics/ http://localhost:3456/analytics/               
+
                                                     
                                                       
+
 
  ProxyPass /analytics http://localhost:3456/analytics/                         
 
  ProxyPass /analytics http://localhost:3456/analytics/                         
ProxyPassReverse /analytics http://localhost:3456/analytics/               
+
                                                                   
                                                       
+
ProxyPass /greentea/ http://localhost:3456/greentea/                       
+
ProxyPassReverse /greentea/ http://localhost:3456/greentea/                 
+
                                                       
+
ProxyPass /greentea http://localhost:3456/greentea/                         
+
ProxyPassReverse /greentea http://localhost:3456/greentea/                 
+
 
  &lt;/VirtualHost&gt;  
 
  &lt;/VirtualHost&gt;  
  
Line 87: Line 58:
 
Finally:  
 
Finally:  
  
   `sudo services apache2 restart`
+
   $ sudo services apache2 restart
 
+
If it says OK, it means the server should be started and you should be able to point a browser at localhost/analytics.
+
 
+
If everything was configured properly point your browser to &lt;DNS&gt;/analytics and Analytics should be up and running! <br> <br>
+
 
+
----
+
 
+
=== *In the case of a common dependency issue with iplant-clojure-commons:  ===
+
 
+
We need to point to the missing dependency manually: Run:
+
 
+
  `$ git clone https://github.com/iPlantCollaborativeOpenSource/iplant-clojure-commons.git`
+
 
+
In the iplant-clojure-commons directory, run:
+
 
+
  `$ lein uberjar`
+
 
+
In lein 2.0 this will create a file at "&lt;PATH&gt;/iplant-clojure-commons/clojure-commons-1.3.3-SNAPSHOT-standalone.jar"
+
 
+
Replacing with appropriate &lt;PATH&gt;, run:
+
 
+
  `$ mvn install:install-file -DgroupId=org.iplantc -DartifactId=clojure-commons -Dversion=1.3.3-SNAPSHOT -Dpackaging=jar -Dfile=&lt;PATH&gt;/iplant-clojure-commons/clojure-commons-1.3.3-SNAPSHOT-standalone.jar`
+
 
+
Now try
+
 
+
  `$ lein clean`
+
 
+
and then
+
  
  `$ lein run`
+
If it says OK, it means the server should be started and you should be able to point a browser at it.
  
The dependency issue should be resolved.
+
If everything was configured properly point your browser to &lt;DNS&gt;/analytics and Analytics should be up and running! <br> <br>

Latest revision as of 17:29, 3 June 2016

CoGe Analytics is a metrics and analytics engine for the CoGe platform written on Clojure's web framework Noir.

How To: Deploy on a Server via Apache Webserver

Prerequisites:

(You can install these CLI tools using your linux distributions preferred package manager)

Configuring Analytics to the Database

Once you have all the prerequisites installed, you need to get the Greentea (Analytics) repo from Github. Run:

 $ git clone https://github.com/LyonsLab/Greentea.git

Get Analytics Running:

Install Teabag to get Greentea running.

---Alternatively---

Inside the cloned directory run:

 $ lein run &> /dev/null &

Leiningen should pull in all the required dependencies* and start a Jetty servlet running on port 3456.

Check localhost:3456 to verify that the analytics platform is running.

Configure Apache to Proxy the Servlet Port to the /analytics Endpoint

Now to setup apache to point localhost/analytics/ to port 3456. Open '/etc/apache2/apache.conf' (or another conf location) in your favorite editor and add these lines:

RewriteEngine On 
NameVirtualHost *:90 
Listen 90

<VirtualHost *:90> 
ServerAdmin coge.genome@gmail.com ServerName localhost 
#ServerAlias geco.com.analytics
ErrorLog /home/rchasman/logs/error.log CustomLog <PATH>/logs/access.log combined LogLevel warn                   
                                                     
ProxyPass /analytics/ http://localhost:3456/analytics/                       
                                                     
ProxyPass /analytics http://localhost:3456/analytics/                        
                                                                   
</VirtualHost> 

These lines proxy calls to /analytics and /analytics/ to port 3456/analytics so that we don't have to type any ugly numbers to reach our site.

Finally:

 $ sudo services apache2 restart

If it says OK, it means the server should be started and you should be able to point a browser at it.

If everything was configured properly point your browser to <DNS>/analytics and Analytics should be up and running!