Real-user monitoring & tracking for web applications
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md
jkool-rum-plugin.js
jkool-rum-plugin.jsp
jkool-rum-plugin.php

README.md

jKool Real-User Monitoring & Tracking for Web Apps

jKool is happy to offer a simple and easy to use plug-in that you can use to monitor end-user experience & engagement for your web apps. This plugin gathers performance, usability, errors, clicks and stream them to your jKool account. When you register and login to your jKool repository (https://www.jkoolcloud.com) you will see end-user analytics by simply clicking on End-User Monitoring Dashboard. You will also have the ability to create your own views of the end user data by creating your own viewlets. Please follow instructions below to setup jKool RUM, which should only take a few minutes. If you encounter any difficulty please don't hesitate to contact us at support@jkoolcloud.com.

###Import the plugins. Into the web application you wish to monitor, import jkool-rum-plugin.js and either jkool-rum-plugin.jsp (if using javascript) or jkool-rum-plugin.php (if using php).

###Import jquery libraries These libraries can be obtained at http://jquery.com/download/

###Add the following code in to the head section of the web pages you wish to monitor Please note that you will receive your jKool token when you register for jKool.

<script>
window["token"] = "Your Token";
window["appl"] = "Your Application Name";
window["dataCenter"] = "Your Data Center Name"
window["mark"] = "all|none|list of functions you wish to measure"
</script>

###Include the plugins in your project

  • Include the jsp or php plugin on every page you wish to track inside the body tag.
<%@ include file="jkool-rum-plugin.jsp" %>
<?php include "/inc/jkool-rum-plugin.php"; ?>
  • Also include the javascript plugin to every page you wish to track. It needs to be included after the jsp plugin.
<script src="js/lib/jkool-rum-plugin.js" type="text/javascript"></script>

Automatic Injection for Apache Web Server

If you don't wish to instrument every page of your webapp, you can have Apache automatically inject the code for you. Simply do the following:

  • Add the following to httpd.conf:
LoadModule substitute_module modules/mod_substitute.so
LoadModule filter_module modules/mod_filter.so
  • Create a file called jkool-plugin.conf as follows:
<Location />
AddOutputFilterByType SUBSTITUTE text/html
Substitute "s|<head>|<head>
<script type="text/javascript" src="/js/jquery.min.1.7.2.js"></script><script>window["token"] = "<your-token>";window["appl"] = "<your-application-name>";window["dataCenter"] = "<your-data-center>"</script>|in"
Substitute "s|</form>|<%@ include file="jkool-rum-plugin.jsp" %></form><script src="/js/jkool-rum-plugin.js" type="text/javascript"></script>|in"
</Location>

The above is for Apache 2.4. If running Apache 2.2, you will need to also add this line of code:

SetOutputFilter INFLATE;SUBSTITUTE;DEFLATE 
  • Add the location of this file to httpd.conf by adding the following:
Include [path]/jkool-plugin.conf
  • Restart Apache

Automatic Injection for IIS

If you don't wish to instrument every page of your webapp, you can have IIS automatically inject the code for you. Simply do the following:

  • Install URL Rewrite from here http://www.iis.net/download/urlrewrite
  • Open IIS Manager, click on your site and then open the URL Rewrite feature
  • In the Outbound Rule section click View Preconditions and the Add to add a new condition called IsHTML. The condition need check {RESPONSE_CONTENT_TYPE} matches the pattern “^text/html”. This is so that we only insert our JavaScript code into HTML and not into any other content type.
  • Add an Outbound rule called 'jKoolPlugin1'. This Outbound rule should check for our Precondition “IsHTML”, and then Match on a pattern <head> using an “Exact Match”. In the Action section we have a rewrite action which then rewrites <head> as:
<head><script type="text/javascript" src="/js/jquery.min.1.7.2.js"></script><script>window["token"] = "<your-token>";window["appl"] = "<your-application-name>";window["dataCenter"] = "<your-data-center>"</script>
  • Add another Outbound called jKoolPlugin2. The rule should check for our Precondition “IsHTML”, and then Match on a pattern </form> using an “Exact Match”. In the Action section we have a rewrite action which then rewrites </form> as:
<%@ include file="jkool-rum-plugin.jsp" %></form><script src="/js/jkool-rum-plugin.js" type="text/javascript"></script>

Automatic Injection for Ngnix

If you don't wish to instrument every page of your webapp, you can have Ngnix automatically inject the code for you. Simply do the following:

location / {
    sub_filter '<head>' '<head><script type="text/javascript" src="/js/jquery.min.1.7.2.js"></script><script>window["token"] = "<your-token>";window["appl"] = "<your-application-name>";window["dataCenter"] = "<your-data-center>"</script>';
    sub_filter '</form>' '<%@ include file="jkool-rum-plugin.jsp" %></form><script src="/js/jkool-rum-plugin.js" type="text/javascript"></script>';
    sub_filter_once on;
}

###To get performance metrics on javascript functions

Including the plugins will measure your overall site performance (i.e. page load time, redirect time, connect time, domain lookup time, request and response time, etc.). If you wish more fine-grained measuring of javascript functions, please do the following:

  • Set the window parameter "mark" equal to "all" in order to automatically obtain javascript function performance automatically. This will measure every javascript function within you site.

  • If measuring every javascript function proves to be too much data for you, you can instead set the window paramter "mark" equal to a list of javascript functions you wish to measure. This will cause the plugin only to report on those javascript functions specified.

  • If you wish to report custom data (i.e. - you wish to specify message text or properties) on functions that are invoked after a page load (i.e. - Ajax), you can set the performance measures manually by doing the following:

Add the following code before and after the javascript you wish to measure.

performance.mark("start_<descriptive name>");  
<javascript code being marked>
performance.mark("end_<descriptive name>");  
performance.measure('measure_<descriptive name>', 'start_<descriptive name>', 'end_<descriptive name>');
afterLoadMeasure(<name>, <custom properties>, <custom message>, <descriptive name>, <INFO or ERROR>)
Where:
<name> - the name of the custom event of type string
<custom properties> - your custom fields you would like to report on. Each field should be in the following format and be of type string: {"name": "<name value>","type": <type value>,"value":"<value value>"},...
<custom message> - a custom message for your event of type string
<descriptive name> - the name of the mark/measure (from above)
<ERROR> if you are reporting an error event, <INFO> otherwise.

Here is an example:

  function testAjaxFunction() {
       performance.mark("start_processJavascriptFunctionABC");
       $.get('http://localhost:8080/demo/async', function(data) {
   		    ... your code ...
            performance.mark("end_processJavascriptFunctionABC");  
    		performance.measure('measure_processJavascriptFunctionABC', 'start_processJavascriptFunctionABC', 'end_processJavascriptFunctionABC'); 
    		var properties = '{"name": "ABCProperty1","type": "string","value":"hello"},{"name": "ABCPropery2","type": "integer","value":"10"}';    
    		afterLoadMeasure('FunctionABCEvent', properties, 'Function ABC Message', 'processJavascriptFunctionABC', 'INFO'); 
    	});
   }

###Obfuscate

We strongly recommend that you obfuscate jkool-rum-plugin.js prior to releasing it into a production environment. A good obfuscation tool can be found here:

http://yui.github.io/yuicompressor/

###View End-User Analytics Your web application is now setup for real user monitoring.

Logon to your jKool Dashboard (https://jkool.jkoolcloud.com), click on "Dashboard". Once logged in, you will see a button labeled "EUM" on the upper-right hand side. Click on this button to see various charts displaying your end user data. You may also create your own viewlets. Click on the Tutorial and learn to create your own viewlets.