Implement metrics

Author: elpete

ModuleConfig.cfc

@@ -4,14 +4,18 @@ component {
 	this.author = "Eric Peterson";
 	this.webUrl = "https://github.com/coldbox-modules/unleashsdk";
 	this.dependencies = [ "hyper" ];
+    this.version = "0.1.0";
 
 	function configure() {
 		settings = {
+            "appName": getApplicationName(),
+            "instanceId": resolveHostname(),
             "environment": variables.controller.getSetting( "environment" ),
             "contextProvider": "DefaultContextProvider@unleashsdk",
             "apiURL": getSystemSetting( "UNLEASH_API_URL" ),
             "apiToken": getSystemSetting( "UNLEASH_API_TOKEN" ),
-            "refreshInterval": 10
+            "refreshInterval": 10,
+            "metricsInterval": 60
         };
 
         binder.map( "UnleashHyperClient@unleashsdk" )
@@ -34,7 +38,27 @@ component {
 	}
 
 	function onLoad() {
-        
+        wirebox.getInstance( "UnleashSDK@unleashsdk" ).register();
+	}
+
+    private string function getApplicationName() {
+		try {
+			return getApplicationSettings().name;
+		} catch ( any e ) {
+			return "";
+		}
+	}
+
+    private string function resolveHostname() {
+		var hostname = createObject( "java", "java.lang.System" ).getProperty( "hostname" );
+		if ( isNull( hostname ) ) {
+			try {
+				hostname = createObject( "java", "java.net.InetAddress" ).getLocalHost().getHostName();
+			} catch ( UnknownHostException e ) {
+				hostname = "undefined";
+			}
+		}
+		return hostname;
 	}
 
 }

config/Scheduler.cfc

@@ -1,6 +1,7 @@
 component {
 
     property name="refreshInterval" inject="coldbox:setting:refreshInterval@unleashsdk";
+    property name="metricsInterval" inject="coldbox:setting:metricsInterval@unleashsdk";
     property name="log" inject="logbox:logger:{this}";
 
     function configure() {
@@ -9,7 +10,7 @@ component {
             .every( variables.refreshInterval, "seconds" )
             .before( function() {
                 if ( log.canDebug() ) {
-                    log.debug( "Starting to fetch new features from unleash" );
+                    log.debug( "Starting to fetch new features from Unleash" );
                 } 
             } )
             .onSuccess( function( task, results ) {
@@ -22,6 +23,26 @@ component {
                     log.error( "Exception when running task [unleashsdk-refresh-features]:", exception );
                 }
             } );
+
+        task( "unleashsdk-send-metrics" )
+            .call( getInstance( "UnleashSDK@unleashsdk" ), "sendMetrics" )
+            .every( variables.metricsInterval, "seconds" )
+            .delay( variables.metricsInterval, "seconds" )
+            .before( function() {
+                if ( log.canDebug() ) {
+                    log.debug( "Starting to send metrics to Unleash" );
+                } 
+            } )
+            .onSuccess( function( task, results ) {
+                if ( log.canInfo() ) {
+                    log.info( "Successfully sent metrics to Unleash features", results );
+                }
+            } )
+            .onFailure( function( task, exception ) {
+                if ( log.canError() ) {
+                    log.error( "Exception when running task [unleashsdk-send-metrics]:", exception );
+                }
+            } );
     }
 
 }

models/UnleashSDK.cfc

@@ -1,6 +1,7 @@
 component singleton accessors="true" {
 
 	property name="settings" inject="coldbox:moduleSettings:unleashsdk";
+	property name="config"   inject="coldbox:moduleConfig:unleashsdk";
 	property name="client"   inject="UnleashHyperClient@unleashsdk";
 	property name="log"      inject="logbox:logger:{this}";
 	property name="cache"    inject="cachebox:default";
@@ -14,10 +15,39 @@ component singleton accessors="true" {
 		"applicationHostname" : "ApplicationHostnameStrategy@unleashsdk"
 	};
 
+	function onDIComplete() {
+		variables.metricsBucket = newMetricsBucket();
+	}
+
+	function register() {
+		var registrationInfo = {
+			"appName"    : variables.settings.appName,
+			"instanceId" : variables.settings.instanceId,
+			"sdkVersion" : "coldbox-modules/unleashsdk:#variables.config.version#",
+			"strategies" : variables.strategies.keyArray(),
+			"started"    : getIsoTimeString( now() ),
+			"interval"   : variables.settings.metricsInterval * 1000
+		};
+		if ( log.canInfo() ) {
+			log.info( "Registering instance with Unleash", registrationInfo );
+		}
+		variables.client.post( "/client/register", registrationInfo );
+	}
+
 	public boolean function isEnabled(
 		required string name,
 		struct additionalContext = {},
 		boolean defaultValue     = false
+	) {
+		var enabled = checkEnabled( argumentCollection = arguments );
+		countForMetrics( arguments.name, enabled );
+		return enabled;
+	}
+
+	public boolean function checkEnabled(
+		required string name,
+		struct additionalContext = {},
+		boolean defaultValue     = false
 	) {
 		var feature = getFeature( arguments.name );
 		if ( isNull( feature ) ) {
@@ -131,6 +161,34 @@ component singleton accessors="true" {
 		return features;
 	}
 
+	public struct function sendMetrics() {
+		var bucketToSend        = variables.metricsBucket;
+		variables.metricsBucket = newMetricsBucket();
+		bucketToSend.stop       = getIsoTimeString( now() );
+		var metrics             = {
+			"appName"    : variables.settings.appName,
+			"instanceId" : variables.settings.instanceId,
+			"bucket"     : bucketToSend
+		};
+		variables.client.post( "/client/metrics", metrics );
+		return metrics;
+	}
+
+	private void function countForMetrics( required string name, required boolean enabled ) {
+		if ( !variables.metricsBucket.toggles.keyExists( arguments.name ) ) {
+			variables.metricsBucket.toggles[ arguments.name ] = { "yes" : 0, "no" : 0 };
+		}
+		variables.metricsBucket.toggles[ arguments.name ][ yesNoFormat( arguments.enabled ) ]++;
+	}
+
+	public struct function newMetricsBucket() {
+		return {
+			"start"   : getIsoTimeString( now() ),
+			"stop"    : "",
+			"toggles" : {}
+		};
+	}
+
 	private array function fetchFeatures() {
 		return variables.client.get( "/client/features" ).json().features;
 	}
@@ -174,4 +232,15 @@ component singleton accessors="true" {
 		return javacast( "null", "" );
 	}
 
+	private string function getIsoTimeString( required date datetime, boolean convertToUTC = true ) {
+		if ( arguments.convertToUTC ) {
+			arguments.datetime = dateConvert( "local2utc", arguments.datetime );
+		}
+
+		return dateFormat( arguments.datetime, "yyyy-mm-dd" ) &
+		"T" &
+		timeFormat( arguments.datetime, "HH:mm:ss" ) &
+		"Z";
+	}
+
 }