@aicore/core-analytics-client-lib 1.0.3 → 1.0.4

package/README.md

@@ -40,14 +40,18 @@ initSession(): Initialize the analytics session. It takes the following paramete
 * `granularitySec` (_Optional_): The smallest time period under which the events can be distinguished. Multiple
 events happening during this time period is aggregated to a count. The default granularity is 3 Seconds, which means
 that any events that happen within 3 seconds cannot be distinguished in ordering.
-* `postBaseURLInit` Optional: Provide your own analytics server address if you self-hosted the server
+* `analyticsURL` (_Optional_): Provide your own analytics server address if you self-hosted the server
+* `debug` (_Optional_):  set to true if you want to see detailed debug logs.
 
 ```javascript
 // Example for custom initSession where the analytics aggregated data 
 // is posted to custom server https://localhost:3000 every 600 secs
 // with a granularity(resolution) of 5 seconds.
 
-initSession("accountID", "appName", 600, 5, "https://localhost:3000");
+initSession("accountID", "appName", "https://localhost:3000", 600, 5);
+
+// To initSession in debug mode set debug arg in init to true:
+initSession("accountID", "appName", "https://localhost:3000", 600, 5, true);
 ```
 
 ## Raising analytics events

package/dist/analytics.min.js

@@ -1,3 +1,4 @@
-let accountID,appName,userID,sessionID,postIntervalSeconds,granularitySec,postURL;const DEFAULT_GRANULARITY_IN_SECONDS=3,DEFAULT_RETRY_TIME_IN_SECONDS=30,DEFAULT_POST_INTERVAL_SECONDS=600,USERID_LOCAL_STORAGE_KEY="aicore.analytics.userID",POST_LARGE_DATA_THRESHOLD_BYTES=1e4;let currentAnalyticsEvent=null;const IS_NODE_ENV="undefined"==typeof window;let DEFAULT_BASE_URL="https://analytics.core.ai",granularityTimer,postTimer,currentQuantisedTime=0;if(IS_NODE_ENV)throw new Error("Node environment is not currently supported");function _createAnalyticsEvent(){return{schemaVersion:1,accountID:accountID,appName:appName,uuid:userID,sessionID:sessionID,granularitySec:granularitySec,unixTimestampUTC:+new Date,numEventsTotal:0,events:{}}}function _validateCurrentState(){if(!currentAnalyticsEvent)throw new Error("Please call initSession before using any analytics event")}function getCurrentAnalyticsEvent(){return _validateCurrentState(),JSON.parse(JSON.stringify(currentAnalyticsEvent))}function _getOrCreateUserID(){let t=localStorage.getItem(USERID_LOCAL_STORAGE_KEY);return t||(t=crypto.randomUUID(),localStorage.setItem(USERID_LOCAL_STORAGE_KEY,t)),t}function _getOrCreateSessionID(){let t=sessionStorage.getItem(USERID_LOCAL_STORAGE_KEY);return t||(t=Math.random().toString(36).substr(2,10),sessionStorage.setItem(USERID_LOCAL_STORAGE_KEY,t)),t}function _setupIDs(){userID=_getOrCreateUserID(),sessionID=_getOrCreateSessionID()}function _retryPost(t){t.backoffCount=(t.backoffCount||0)+1,console.log(`Failed to call core analytics server. Will retry in ${DEFAULT_RETRY_TIME_IN_SECONDS*t.backoffCount}s: `),setTimeout(()=>{_postCurrentAnalyticsEvent(t)},1e3*DEFAULT_RETRY_TIME_IN_SECONDS*t.backoffCount)}function _postCurrentAnalyticsEvent(e){var t;e||(e=currentAnalyticsEvent,currentAnalyticsEvent=_createAnalyticsEvent()),0!==e.numEventsTotal&&((t=JSON.stringify(e)).length>POST_LARGE_DATA_THRESHOLD_BYTES&&console.warn(`Analytics event generated is very large at greater than ${t.length}B. This 
-        typically means that you may be sending too many value events? .`),window.fetch(postURL,{method:"POST",headers:{"Content-Type":"application/json"},body:t}).then(t=>{200!==t.status&&(400!==t.status?_retryPost(e):console.error("Bad Request, this is most likely a problem with the library, update to latest version."))}).catch(t=>{console.error(t),_retryPost(e)}))}function _setupTimers(){granularityTimer&&(clearInterval(granularityTimer),granularityTimer=null),granularityTimer=setInterval(()=>{currentQuantisedTime+=granularitySec},1e3*granularitySec),postTimer&&(clearInterval(postTimer),postTimer=null),postTimer=setInterval(_postCurrentAnalyticsEvent,1e3*postIntervalSeconds)}function initSession(t,e,n,r,a){if(!t||!e)throw new Error("accountID and appName must exist for init");accountID=t,appName=e,postIntervalSeconds=n||DEFAULT_POST_INTERVAL_SECONDS,granularitySec=r||DEFAULT_GRANULARITY_IN_SECONDS,postURL=(a||DEFAULT_BASE_URL)+"/ingest",_setupIDs(),currentAnalyticsEvent=_createAnalyticsEvent(),_setupTimers()}function _ensureAnalyticsEventExists(t,e,n){let r=currentAnalyticsEvent.events;r[t]=r[t]||{},r[t][e]=r[t][e]||{},r[t][e][n]=r[t][e][n]||{time:[],valueCount:[]}}function _validateEvent(t,e,n,r,a){if(_validateCurrentState(),!t||!e||!n)throw new Error("missing eventType or category or subCategory");if("number"!=typeof r||r<0)throw new Error("invalid count");if("number"!=typeof a)throw new Error("invalid value")}function _updateExistingAnalyticsEvent(e,n,r,a,s,i){let o=currentAnalyticsEvent.events;var t="number"==typeof o[n][r][a].valueCount[e];if(t&&0===i)o[n][r][a].valueCount[e]+=s;else if(t&&0!==i){let t={};t[i]=s,t[0]=o[n][r][a].valueCount[e],o[n][r][a].valueCount[e]=t}else if(!t){let t=o[n][r][a].valueCount[e];t[i]=(t[i]||0)+s}currentAnalyticsEvent.numEventsTotal+=1}function analyticsEvent(e,n,r,a=1,s=0){_validateEvent(e,n,r,a,s),_ensureAnalyticsEventExists(e,n,r);let i=currentAnalyticsEvent.events;var t=i[e][n][r].time;if((0<t.length?t[t.length-1]:null)===currentQuantisedTime)_updateExistingAnalyticsEvent(i[e][n][r].valueCount.length-1,e,n,r,a,s);else{if(i[e][n][r].time.push(currentQuantisedTime),0===s)i[e][n][r].valueCount.push(a);else{let t={};t[s]=a,i[e][n][r].valueCount.push(t)}currentAnalyticsEvent.numEventsTotal+=1}}export{initSession,getCurrentAnalyticsEvent,analyticsEvent};
+let accountID,appName,userID,sessionID,postIntervalSeconds,granularitySec,analyticsURL,postURL,serverConfig;const DEFAULT_GRANULARITY_IN_SECONDS=3,DEFAULT_RETRY_TIME_IN_SECONDS=30,DEFAULT_POST_INTERVAL_SECONDS=600,USERID_LOCAL_STORAGE_KEY="aicore.analytics.userID",POST_LARGE_DATA_THRESHOLD_BYTES=1e4;let currentAnalyticsEvent=null;const IS_NODE_ENV="undefined"==typeof window;let DEFAULT_BASE_URL="https://analytics.core.ai",granularityTimer,postTimer,currentQuantisedTime=0,disabled=!1,debugMode=!1;function debugLog(...e){debugMode&&console.log(...e)}function debugError(...e){debugMode&&console.error(...e)}if(IS_NODE_ENV)throw new Error("Node environment is not currently supported");function _createAnalyticsEvent(){return{schemaVersion:1,accountID:accountID,appName:appName,uuid:userID,sessionID:sessionID,unixTimestampUTC:+new Date,numEventsTotal:0,events:{}}}function _validateCurrentState(){if(!currentAnalyticsEvent)throw new Error("Please call initSession before using any analytics event")}function getCurrentAnalyticsEvent(){return _validateCurrentState(),JSON.parse(JSON.stringify(currentAnalyticsEvent))}function _getOrCreateUserID(){let e=localStorage.getItem(USERID_LOCAL_STORAGE_KEY);return e||(e=crypto.randomUUID(),localStorage.setItem(USERID_LOCAL_STORAGE_KEY,e)),e}function _getOrCreateSessionID(){let e=sessionStorage.getItem(USERID_LOCAL_STORAGE_KEY);return e||(e=Math.random().toString(36).substr(2,10),sessionStorage.setItem(USERID_LOCAL_STORAGE_KEY,e)),e}function _setupIDs(){userID=_getOrCreateUserID(),sessionID=_getOrCreateSessionID()}function _retryPost(e){e.backoffCount=(e.backoffCount||0)+1,debugLog(`Failed to call core analytics server. Will retry in ${DEFAULT_RETRY_TIME_IN_SECONDS*e.backoffCount}s: `),setTimeout(()=>{_postCurrentAnalyticsEvent(e)},1e3*DEFAULT_RETRY_TIME_IN_SECONDS*e.backoffCount)}function _postCurrentAnalyticsEvent(t){var e;disabled||(t||(t=currentAnalyticsEvent,currentQuantisedTime=0,_resetGranularityTimer(),currentAnalyticsEvent=_createAnalyticsEvent()),0!==t.numEventsTotal&&((e=JSON.stringify(t)).length>POST_LARGE_DATA_THRESHOLD_BYTES&&console.warn(`Analytics event generated is very large at greater than ${e.length}B. This 
+        typically means that you may be sending too many value events? .`),debugLog("Sending Analytics data of length: ",e.length,"B"),window.fetch(postURL,{method:"POST",headers:{"Content-Type":"application/json"},body:e}).then(e=>{200!==e.status&&(400!==e.status?_retryPost(t):console.error("Analytics client: Bad Request, this is most likely a problem with the library, update to latest version."))}).catch(e=>{debugError(e),_retryPost(t)})))}function _resetGranularityTimer(e){granularityTimer&&(clearInterval(granularityTimer),granularityTimer=null),e||(granularityTimer=setInterval(()=>{currentQuantisedTime+=granularitySec},1e3*granularitySec))}function _setupTimers(e){_resetGranularityTimer(e),postTimer&&(clearInterval(postTimer),postTimer=null),e||(postTimer=setInterval(_postCurrentAnalyticsEvent,1e3*postIntervalSeconds))}async function _getServerConfig(){return new Promise((n,r)=>{var e=analyticsURL+(`/getAppConfig?accountID=${accountID}&appName=`+appName);window.fetch(e).then(async e=>{switch(e.status){case 200:var t=await e.json();return void n(t);case 400:r("Bad Request, check library version compatible?",e);break;default:r("analytics client: Could not update from remote config. Continuing with defaults.",e)}}).catch(e=>{r("analytics client: Could not update from remote config. Continuing with defaults.",e)})})}function getAppConfig(){return{accountID:accountID,appName:appName,disabled:disabled,uuid:userID,sessionID:sessionID,postIntervalSeconds:postIntervalSeconds,granularitySec:granularitySec,analyticsURL:analyticsURL,serverConfig:serverConfig}}async function _initFromRemoteConfig(e,t){(serverConfig=await _getServerConfig())!=={}&&(postIntervalSeconds=e||serverConfig.postIntervalSecondsInit||DEFAULT_POST_INTERVAL_SECONDS,granularitySec=t||serverConfig.granularitySecInit||DEFAULT_GRANULARITY_IN_SECONDS,analyticsURL=serverConfig.analyticsURLInit||analyticsURL||DEFAULT_BASE_URL,_setupTimers(disabled=!0===serverConfig.disabled),debugLog(`Init analytics Config from remote. disabled: ${disabled}
+        postIntervalSeconds:${postIntervalSeconds}, granularitySec: ${granularitySec} ,URL: `+analyticsURL),disabled&&console.warn(`Core Analytics is disabled from the server for app: ${accountID}:`+appName))}function _stripTrailingSlash(e){return e.replace(/\/$/,"")}function initSession(e,t,n,r,a,i){if(!e||!t)throw new Error("accountID and appName must exist for init");analyticsURL=n?_stripTrailingSlash(n):DEFAULT_BASE_URL,accountID=e,appName=t,debugMode=i||!1,postIntervalSeconds=r||DEFAULT_POST_INTERVAL_SECONDS,granularitySec=a||DEFAULT_GRANULARITY_IN_SECONDS,postURL=analyticsURL+"/ingest",_setupIDs(),currentAnalyticsEvent=_createAnalyticsEvent(),_setupTimers(),_initFromRemoteConfig(r,a)}function _ensureAnalyticsEventExists(e,t,n){let r=currentAnalyticsEvent.events;r[e]=r[e]||{},r[e][t]=r[e][t]||{},r[e][t][n]=r[e][t][n]||{time:[],valueCount:[]}}function _validateEvent(e,t,n,r,a){if(_validateCurrentState(),!e||!t||!n)throw new Error("missing eventType or category or subCategory");if("number"!=typeof r||r<0)throw new Error("invalid count");if("number"!=typeof a)throw new Error("invalid value")}function _updateExistingAnalyticsEvent(t,n,r,a,i,s){let o=currentAnalyticsEvent.events;var e="number"==typeof o[n][r][a].valueCount[t];if(e&&0===s)o[n][r][a].valueCount[t]+=i;else if(e&&0!==s){let e={};e[s]=i,e[0]=o[n][r][a].valueCount[t],o[n][r][a].valueCount[t]=e}else if(!e){let e=o[n][r][a].valueCount[t];e[s]=(e[s]||0)+i}currentAnalyticsEvent.numEventsTotal+=1}function analyticsEvent(n,r,a,i=1,s=0){if(!disabled){_validateEvent(n,r,a,i,s),_ensureAnalyticsEventExists(n,r,a);let t=currentAnalyticsEvent.events;var e=t[n][r][a].time;if((0<e.length?e[e.length-1]:null)!==currentQuantisedTime){if(t[n][r][a].time.push(currentQuantisedTime),0===s)t[n][r][a].valueCount.push(i);else{let e={};e[s]=i,t[n][r][a].valueCount.push(e)}currentAnalyticsEvent.numEventsTotal+=1}else _updateExistingAnalyticsEvent(t[n][r][a].valueCount.length-1,n,r,a,i,s)}}export{initSession,getCurrentAnalyticsEvent,analyticsEvent,getAppConfig};
 //# sourceMappingURL=analytics.min.js.map

package/dist/analytics.min.js.map

@@ -1 +1 @@
-{"version":3,"sourceRoot":"src/analytics.js","sources":["src/analytics.js"],"names":["let","accountID","appName","userID","sessionID","postIntervalSeconds","granularitySec","postURL","DEFAULT_GRANULARITY_IN_SECONDS","DEFAULT_RETRY_TIME_IN_SECONDS","DEFAULT_POST_INTERVAL_SECONDS","USERID_LOCAL_STORAGE_KEY","POST_LARGE_DATA_THRESHOLD_BYTES","currentAnalyticsEvent","IS_NODE_ENV","window","DEFAULT_BASE_URL","granularityTimer","postTimer","currentQuantisedTime","Error","_createAnalyticsEvent","schemaVersion","uuid","unixTimestampUTC","Date","numEventsTotal","events","_validateCurrentState","getCurrentAnalyticsEvent","JSON","parse","stringify","_getOrCreateUserID","localUserID","localStorage","getItem","crypto","randomUUID","setItem","_getOrCreateSessionID","localSessionID","sessionStorage","Math","random","toString","substr","_setupIDs","_retryPost","eventToSend","backoffCount","console","log","setTimeout","_postCurrentAnalyticsEvent","textToSend","length","warn","fetch","method","headers","Content-Type","body","then","res","status","error","catch","_setupTimers","clearInterval","setInterval","initSession","accountIDInit","appNameInit","postIntervalSecondsInit","granularitySecInit","postBaseURLInit","_ensureAnalyticsEventExists","eventType","category","subCategory","time","valueCount","_validateEvent","count","value","_updateExistingAnalyticsEvent","index","newValue","storedValueIsCount","newValueCount","storedValueObject","analyticsEvent","eventCategory","eventCount","eventValue","timeArray","push"],"mappings":"AAKAA,IAAIC,UAAWC,QAASC,OAAQC,UAAWC,oBAAqBC,eAAgBC,QAChF,MAAMC,+BAAiC,EACjCC,8BAAgC,GAChCC,8BAAgC,IAChCC,yBAA2B,0BAC3BC,gCAAkC,IACxCZ,IAAIa,sBAAwB,KAC5B,MAAMC,YAAiC,oBAAXC,OAC5Bf,IAAIgB,iBAAmB,4BAEnBC,iBACAC,UACAC,qBAAuB,EAE3B,GAAGL,YACC,MAAM,IAAIM,MAAM,+CAGpB,SAASC,wBACL,MAAO,CACHC,cAAe,EACfrB,UAAWA,UACXC,QAASA,QACTqB,KAAMpB,OACNC,UAAWA,UACXE,eAAgBA,eAChBkB,kBAAmB,IAAIC,KACvBC,eAAgB,EAChBC,OAAQ,IAIhB,SAASC,wBACL,IAAIf,sBACA,MAAM,IAAIO,MAAM,4DAIxB,SAASS,2BAGL,OAFAD,wBAEOE,KAAKC,MAAMD,KAAKE,UAAUnB,wBAGrC,SAASoB,qBACLjC,IAAIkC,EAAcC,aAAaC,QAAQzB,0BAKvC,OAJIuB,IACAA,EAAcG,OAAOC,aACrBH,aAAaI,QAAQ5B,yBAA0BuB,IAE5CA,EAGX,SAASM,wBACLxC,IAAIyC,EAAiBC,eAAeN,QAAQzB,0BAK5C,OAJI8B,IACAA,EAAiBE,KAAKC,SAASC,SAAS,IAAIC,OAAO,EAAG,IACtDJ,eAAeH,QAAQ5B,yBAA0B8B,IAE9CA,EAGX,SAASM,YACL5C,OAAS8B,qBACT7B,UAAYoC,wBAGhB,SAASQ,WAAWC,GAChBA,EAAYC,cAAgBD,EAAYC,cAAgB,GAAK,EAC7DC,QAAQC,2DACJ3C,8BAAgCwC,EAAYC,mBAChDG,WAAW,KACPC,2BAA2BL,IACI,IAAhCxC,8BAAuCwC,EAAYC,cAG1D,SAASI,2BAA2BL,GAKhC,IAGIM,EAPAN,IACAA,EAAcpC,sBACdA,sBAAwBQ,yBAEM,IAA/B4B,EAAYvB,kBAGX6B,EAAazB,KAAKE,UAAUiB,IAClBO,OAAS5C,iCACnBuC,QAAQM,gEAAgEF,EAAWC;2EAGvFzC,OAAO2C,MAAMnD,QAAS,CAClBoD,OAAQ,OACRC,QAAS,CAACC,eAAgB,oBAC1BC,KAAMP,IACPQ,KAAKC,IACc,MAAfA,EAAIC,SAGW,MAAfD,EAAIC,OACHjB,WAAWC,GAEXE,QAAQe,MAAM,6FAEnBC,MAAMH,IACLb,QAAQe,MAAMF,GACdhB,WAAWC,MAInB,SAASmB,eACFnD,mBACCoD,cAAcpD,kBACdA,iBAAmB,MAEvBA,iBAAmBqD,YAAY,KAC3BnD,sBAA8Cb,gBAChC,IAAfA,gBAEAY,YACCmD,cAAcnD,WACdA,UAAY,MAEhBA,UAAYoD,YAAYhB,2BAAgD,IAApBjD,qBAcxD,SAASkE,YAAYC,EAAeC,EAAaC,EAAyBC,EAAoBC,GAC1F,IAAIJ,IAAkBC,EAClB,MAAM,IAAIrD,MAAM,6CAEpBnB,UAAYuE,EACZtE,QAAUuE,EACVpE,oBAAsBqE,GAA2BhE,8BACjDJ,eAAiBqE,GAAsBnE,+BACvCD,SAAWqE,GAAmB5D,kBAAoB,UAClD+B,YACAlC,sBAAwBQ,wBACxB+C,eAGJ,SAASS,4BAA4BC,EAAWC,EAAUC,GACtDhF,IAAI2B,EAASd,sBAAsBc,OACnCA,EAAOmD,GAAanD,EAAOmD,IAAc,GACzCnD,EAAOmD,GAAWC,GAAYpD,EAAOmD,GAAWC,IAAa,GAC7DpD,EAAOmD,GAAWC,GAAUC,GAAerD,EAAOmD,GAAWC,GAAUC,IAAgB,CACnFC,KAAM,GACNC,WAAY,IAIpB,SAASC,eAAeL,EAAWC,EAAUC,EAAaI,EAAOC,GAE7D,GADAzD,yBACIkD,IAAcC,IAAaC,EAC3B,MAAM,IAAI5D,MAAM,gDAEpB,GAAoB,iBAAX,GAAuBgE,EAAO,EACnC,MAAM,IAAIhE,MAAM,iBAEpB,GAAoB,iBAAX,EACL,MAAM,IAAIA,MAAM,iBAIxB,SAASkE,8BAA8BC,EAAOT,EAAWC,EAAUC,EAAaI,EAAOI,GACnFxF,IAAI2B,EAASd,sBAAsBc,OACnC,IAAM8D,EAA+F,iBAAnE9D,EAAOmD,GAAWC,GAAUC,GAAyB,WAAEO,GACzF,GAAGE,GAAmC,IAAbD,EACrB7D,EAAOmD,GAAWC,GAAUC,GAAyB,WAAEO,IAAUH,OAC9D,GAAGK,GAAmC,IAAbD,EAAe,CAC3CxF,IAAI0F,EAAgB,GACpBA,EAAcF,GAAYJ,EAC1BM,EAAc,GAAK/D,EAAOmD,GAAWC,GAAUC,GAAyB,WAAEO,GAC1E5D,EAAOmD,GAAWC,GAAUC,GAAyB,WAAEO,GAASG,OAC7D,IAAID,EAAmB,CAC1BzF,IAAI2F,EAAoBhE,EAAOmD,GAAWC,GAAUC,GAAyB,WAAEO,GAC/EI,EAAkBH,IAAaG,EAAkBH,IAAa,GAAKJ,EAEvEvE,sBAAsBa,gBAAkB,EAY5C,SAASkE,eAAed,EAAWe,EAAeb,EAAac,EAAW,EAAGC,EAAW,GACpFZ,eAAeL,EAAWe,EAAeb,EAAac,EAAYC,GAClElB,4BAA4BC,EAAWe,EAAeb,GACtDhF,IAAI2B,EAASd,sBAAsBc,OACnC3B,IAAIgG,EAAYrE,EAAOmD,GAAWe,GAAeb,GAAmB,KAEpE,IADgC,EAAjBgB,EAAUxC,OAAUwC,EAAUA,EAAUxC,OAAO,GAAK,QACnDrC,qBAahBmE,8BADwB3D,EAAOmD,GAAWe,GAAeb,GAAyB,WAAExB,OAAQ,EAC3CsB,EAAWe,EAAeb,EAAac,EAAYC,OAbpG,CAEI,GADApE,EAAOmD,GAAWe,GAAeb,GAAmB,KAAEiB,KAAK9E,sBAC3C,IAAb4E,EACCpE,EAAOmD,GAAWe,GAAeb,GAAyB,WAAEiB,KAAKH,OAC9D,CACH9F,IAAIkF,EAAa,GACjBA,EAAWa,GAAcD,EACzBnE,EAAOmD,GAAWe,GAAeb,GAAyB,WAAEiB,KAAKf,GAErErE,sBAAsBa,gBAAkB,UAQ5C6C,YACA1C,yBACA+D"}
+{"version":3,"sourceRoot":"src/analytics.js","sources":["src/analytics.js"],"names":["let","accountID","appName","userID","sessionID","postIntervalSeconds","granularitySec","analyticsURL","postURL","serverConfig","DEFAULT_GRANULARITY_IN_SECONDS","DEFAULT_RETRY_TIME_IN_SECONDS","DEFAULT_POST_INTERVAL_SECONDS","USERID_LOCAL_STORAGE_KEY","POST_LARGE_DATA_THRESHOLD_BYTES","currentAnalyticsEvent","IS_NODE_ENV","window","DEFAULT_BASE_URL","granularityTimer","postTimer","currentQuantisedTime","disabled","debugMode","debugLog","args","console","log","debugError","error","Error","_createAnalyticsEvent","schemaVersion","uuid","unixTimestampUTC","Date","numEventsTotal","events","_validateCurrentState","getCurrentAnalyticsEvent","JSON","parse","stringify","_getOrCreateUserID","localUserID","localStorage","getItem","crypto","randomUUID","setItem","_getOrCreateSessionID","localSessionID","sessionStorage","Math","random","toString","substr","_setupIDs","_retryPost","eventToSend","backoffCount","setTimeout","_postCurrentAnalyticsEvent","textToSend","_resetGranularityTimer","length","warn","fetch","method","headers","Content-Type","body","then","res","status","catch","disable","clearInterval","setInterval","_setupTimers","async","_getServerConfig","Promise","resolve","reject","configURL","serverResponse","json","err","getAppConfig","_initFromRemoteConfig","postIntervalSecondsInit","granularitySecInit","_stripTrailingSlash","url","replace","initSession","accountIDInit","appNameInit","analyticsURLInit","debug","_ensureAnalyticsEventExists","eventType","category","subCategory","time","valueCount","_validateEvent","count","value","_updateExistingAnalyticsEvent","index","newValue","storedValueIsCount","newValueCount","storedValueObject","analyticsEvent","eventCategory","eventCount","eventValue","timeArray","push"],"mappings":"AAKAA,IAAIC,UAAWC,QAASC,OAAQC,UAAWC,oBAAqBC,eAAgBC,aAAcC,QAASC,aACvG,MAAMC,+BAAiC,EACjCC,8BAAgC,GAChCC,8BAAgC,IAChCC,yBAA2B,0BAC3BC,gCAAkC,IACxCd,IAAIe,sBAAwB,KAC5B,MAAMC,YAAiC,oBAAXC,OAC5BjB,IAAIkB,iBAAmB,4BAEnBC,iBACAC,UACAC,qBAAuB,EACvBC,UAAW,EACXC,WAAY,EAEhB,SAASC,YAAYC,GACbF,WAGJG,QAAQC,OAAOF,GAGnB,SAASG,cAAcH,GACfF,WAGJG,QAAQG,SAASJ,GAIrB,GAAGT,YACC,MAAM,IAAIc,MAAM,+CAGpB,SAASC,wBACL,MAAO,CACHC,cAAe,EACf/B,UAAWA,UACXC,QAASA,QACT+B,KAAM9B,OACNC,UAAWA,UACX8B,kBAAmB,IAAIC,KACvBC,eAAgB,EAChBC,OAAQ,IAIhB,SAASC,wBACL,IAAIvB,sBACA,MAAM,IAAIe,MAAM,4DAIxB,SAASS,2BAGL,OAFAD,wBAEOE,KAAKC,MAAMD,KAAKE,UAAU3B,wBAGrC,SAAS4B,qBACL3C,IAAI4C,EAAcC,aAAaC,QAAQjC,0BAKvC,OAJI+B,IACAA,EAAcG,OAAOC,aACrBH,aAAaI,QAAQpC,yBAA0B+B,IAE5CA,EAGX,SAASM,wBACLlD,IAAImD,EAAiBC,eAAeN,QAAQjC,0BAK5C,OAJIsC,IACAA,EAAiBE,KAAKC,SAASC,SAAS,IAAIC,OAAO,EAAG,IACtDJ,eAAeH,QAAQpC,yBAA0BsC,IAE9CA,EAGX,SAASM,YACLtD,OAASwC,qBACTvC,UAAY8C,wBAGhB,SAASQ,WAAWC,GAChBA,EAAYC,cAAgBD,EAAYC,cAAgB,GAAK,EAC7DpC,gEACIb,8BAAgCgD,EAAYC,mBAChDC,WAAW,KACPC,2BAA2BH,IACI,IAAhChD,8BAAuCgD,EAAYC,cAG1D,SAASE,2BAA2BH,GAChC,IAYII,EAZDzC,WAGCqC,IACAA,EAAc5C,sBACdM,qBAAuB,EACvB2C,yBACAjD,sBAAwBgB,yBAEM,IAA/B4B,EAAYvB,kBAGX2B,EAAavB,KAAKE,UAAUiB,IAClBM,OAASnD,iCACnBY,QAAQwC,gEAAgEH,EAAWE;2EAGvFzC,SAAS,qCAAsCuC,EAAWE,OAAQ,KAClEhD,OAAOkD,MAAM3D,QAAS,CAClB4D,OAAQ,OACRC,QAAS,CAACC,eAAgB,oBAC1BC,KAAMR,IACPS,KAAKC,IACc,MAAfA,EAAIC,SAGW,MAAfD,EAAIC,OACHhB,WAAWC,GAEXjC,QAAQG,MAAM,+GAGnB8C,MAAMF,IACL7C,WAAW6C,GACXf,WAAWC,OAInB,SAASK,uBAAuBY,GACzBzD,mBACC0D,cAAc1D,kBACdA,iBAAmB,MAEpByD,IAGHzD,iBAAmB2D,YAAY,KAC3BzD,sBAA8Cf,gBAChC,IAAfA,iBAGP,SAASyE,aAAaH,GAClBZ,uBAAuBY,GACpBxD,YACCyD,cAAczD,WACdA,UAAY,MAEbwD,IAGHxD,UAAY0D,YAAYhB,2BAAgD,IAApBzD,sBAGxD2E,eAAeC,mBACX,OAAO,IAAIC,QAAQ,CAACC,EAASC,KACzBpF,IAAIqF,EAAY9E,yCAA0CN,qBAAqBC,SAC/Ee,OAAOkD,MAAMkB,GAAWb,KAAWC,MAAAA,IAC/B,OAAQA,EAAIC,QACZ,KAAK,IACD1E,IAAIsF,QAAuBb,EAAIc,OAE/B,YADAJ,EAAQG,GAEZ,KAAK,IACDF,EAAO,iDAAkDX,GACzD,MACJ,QACIW,EAAO,mFAAoFX,MAEhGE,MAAMa,IACLJ,EAAO,mFAAoFI,OASvG,SAASC,eACL,MAAO,CACHxF,UAAAA,UAAWC,QAAAA,QAASoB,SAAAA,SACpBW,KAAM9B,OAAQC,UAAAA,UACdC,oBAAAA,oBAAqBC,eAAAA,eAAgBC,aAAAA,aAAcE,aAAAA,cAI3DuE,eAAeU,sBAAsBC,EAAyBC,IAC1DnF,mBAAqBwE,sBACD,KAEhB5E,oBAAsBsF,GAClBlF,aAAsC,yBAAKG,8BAC/CN,eAAiBsF,GAAsBnF,aAAiC,oBAAKC,+BAE7EH,aAAeE,aAA+B,kBAAKF,cAAgBW,iBAEnE6D,aADAzD,UAAwC,IAA7Bb,aAAuB,UAElCe,yDAAyDF;8BACnCjB,wCAAwCC,wBAAwBC,cACnFe,UACCI,QAAQwC,4DAA4DjE,aAAaC,UAK7F,SAAS2F,oBAAoBC,GACzB,OAAOA,EAAIC,QAAQ,MAAO,IAe9B,SAASC,YAAYC,EAAeC,EAAaC,EAAkBR,EAAyBC,EAAoBQ,GAC5G,IAAIH,IAAkBC,EAClB,MAAM,IAAIpE,MAAM,6CAEpBvB,aAAe4F,EAAkBN,oBAAoBM,GAAoBjF,iBACzEjB,UAAYgG,EACZ/F,QAAUgG,EACV3E,UAAY6E,IAAS,EACrB/F,oBAAsBsF,GAA2B/E,8BACjDN,eAAiBsF,GAAsBlF,+BACvCF,QAAUD,aAAe,UACzBkD,YACA1C,sBAAwBgB,wBACxBgD,eACAW,sBAAsBC,EAAyBC,GAGnD,SAASS,4BAA4BC,EAAWC,EAAUC,GACtDxG,IAAIqC,EAAStB,sBAAsBsB,OACnCA,EAAOiE,GAAajE,EAAOiE,IAAc,GACzCjE,EAAOiE,GAAWC,GAAYlE,EAAOiE,GAAWC,IAAa,GAC7DlE,EAAOiE,GAAWC,GAAUC,GAAenE,EAAOiE,GAAWC,GAAUC,IAAgB,CACnFC,KAAM,GACNC,WAAY,IAIpB,SAASC,eAAeL,EAAWC,EAAUC,EAAaI,EAAOC,GAE7D,GADAvE,yBACIgE,IAAcC,IAAaC,EAC3B,MAAM,IAAI1E,MAAM,gDAEpB,GAAoB,iBAAX,GAAuB8E,EAAO,EACnC,MAAM,IAAI9E,MAAM,iBAEpB,GAAoB,iBAAX,EACL,MAAM,IAAIA,MAAM,iBAIxB,SAASgF,8BAA8BC,EAAOT,EAAWC,EAAUC,EAAaI,EAAOI,GACnFhH,IAAIqC,EAAStB,sBAAsBsB,OACnC,IAAM4E,EAA+F,iBAAnE5E,EAAOiE,GAAWC,GAAUC,GAAyB,WAAEO,GACzF,GAAGE,GAAmC,IAAbD,EACrB3E,EAAOiE,GAAWC,GAAUC,GAAyB,WAAEO,IAAUH,OAC9D,GAAGK,GAAmC,IAAbD,EAAe,CAC3ChH,IAAIkH,EAAgB,GACpBA,EAAcF,GAAYJ,EAC1BM,EAAc,GAAK7E,EAAOiE,GAAWC,GAAUC,GAAyB,WAAEO,GAC1E1E,EAAOiE,GAAWC,GAAUC,GAAyB,WAAEO,GAASG,OAC7D,IAAID,EAAmB,CAC1BjH,IAAImH,EAAoB9E,EAAOiE,GAAWC,GAAUC,GAAyB,WAAEO,GAC/EI,EAAkBH,IAAaG,EAAkBH,IAAa,GAAKJ,EAEvE7F,sBAAsBqB,gBAAkB,EAY5C,SAASgF,eAAed,EAAWe,EAAeb,EAAac,EAAW,EAAGC,EAAW,GACpF,IAAGjG,SAAH,CAGAqF,eAAeL,EAAWe,EAAeb,EAAac,EAAYC,GAClElB,4BAA4BC,EAAWe,EAAeb,GACtDxG,IAAIqC,EAAStB,sBAAsBsB,OACnCrC,IAAIwH,EAAYnF,EAAOiE,GAAWe,GAAeb,GAAmB,KAEpE,IADgC,EAAjBgB,EAAUvD,OAAUuD,EAAUA,EAAUvD,OAAO,GAAK,QACnD5C,qBAAhB,CAEI,GADAgB,EAAOiE,GAAWe,GAAeb,GAAmB,KAAEiB,KAAKpG,sBAC3C,IAAbkG,EACClF,EAAOiE,GAAWe,GAAeb,GAAyB,WAAEiB,KAAKH,OAC9D,CACHtH,IAAI0G,EAAa,GACjBA,EAAWa,GAAcD,EACzBjF,EAAOiE,GAAWe,GAAeb,GAAyB,WAAEiB,KAAKf,GAErE3F,sBAAsBqB,gBAAkB,OAI5C0E,8BADwBzE,EAAOiE,GAAWe,GAAeb,GAAyB,WAAEvC,OAAQ,EAC3CqC,EAAWe,EAAeb,EAAac,EAAYC,WAIpGvB,YACAzD,yBACA6E,eACA3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aicore/core-analytics-client-lib",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Analytics client library for https://github.com/aicore/Core-Analytics-Server",
   "main": "dist/analytics.min.js",
   "type": "module",
@@ -26,9 +26,10 @@
     "cover:unit": "echo please open test/index.html in browser to run tests",
     "cover:integ": "echo please open test/index.html in browser to run tests",
     "build": "",
-    "patchVersion": "npm --no-git-tag-version version patch",
     "minify": "echo creating minified package dist/analytics.min.js && mkdir -p dist && uglifyjs src/analytics.js --compress --mangle -o dist/analytics.min.js -c -m --source-map \"root='src/analytics.js',url='analytics.min.js.map'\"",
-    "release": "npm run patchVersion && npm run minify"
+    "bumpPatchVersion": "npm --no-git-tag-version version patch",
+    "bumpPatchVersionWithGitTag": "npm version patch",
+    "release": "npm run minify && npm run bumpPatchVersionWithGitTag"
   },
   "files": [
     "src",
@@ -45,13 +46,13 @@
   },
   "homepage": "https://github.com/aicore/core-analytics-client-lib#readme",
   "devDependencies": {
-    "@commitlint/cli": "16.1.0",
-    "@commitlint/config-conventional": "16.0.0",
-    "c8": "7.11.0",
+    "@commitlint/cli": "16.3.0",
+    "@commitlint/config-conventional": "16.2.4",
+    "c8": "7.11.2",
     "chai": "4.3.6",
-    "eslint": "8.8.0",
+    "eslint": "8.15.0",
     "husky": "7.0.4",
-    "mocha": "9.2.0",
-    "uglify-js": "3.15.1"
+    "mocha": "9.2.2",
+    "uglify-js": "3.15.5"
   }
 }

package/src/analytics.js

@@ -3,7 +3,7 @@
 // jshint ignore: start
 /*global localStorage, sessionStorage, crypto*/
 
-let accountID, appName, userID, sessionID, postIntervalSeconds, granularitySec, postURL;
+let accountID, appName, userID, sessionID, postIntervalSeconds, granularitySec, analyticsURL, postURL, serverConfig;
 const DEFAULT_GRANULARITY_IN_SECONDS = 3;
 const DEFAULT_RETRY_TIME_IN_SECONDS = 30;
 const DEFAULT_POST_INTERVAL_SECONDS = 600; // 10 minutes
@@ -16,6 +16,23 @@ let DEFAULT_BASE_URL = "https://analytics.core.ai";
 let granularityTimer;
 let postTimer;
 let currentQuantisedTime = 0;
+let disabled = false;
+let debugMode = false;
+
+function debugLog(...args) {
+    if(!debugMode){
+        return;
+    }
+    console.log(...args);
+}
+
+function debugError(...args) {
+    if(!debugMode){
+        return;
+    }
+    console.error(...args);
+}
+
 
 if(IS_NODE_ENV){
     throw new Error("Node environment is not currently supported");
@@ -28,7 +45,6 @@ function _createAnalyticsEvent() {
         appName: appName,
         uuid: userID,
         sessionID: sessionID,
-        granularitySec: granularitySec,
         unixTimestampUTC: +new Date(),
         numEventsTotal: 0,
         events: {}
@@ -72,7 +88,7 @@ function _setupIDs() {
 
 function _retryPost(eventToSend) {
     eventToSend.backoffCount = (eventToSend.backoffCount || 0) + 1;
-    console.log(`Failed to call core analytics server. Will retry in ${
+    debugLog(`Failed to call core analytics server. Will retry in ${
         DEFAULT_RETRY_TIME_IN_SECONDS * eventToSend.backoffCount}s: `);
     setTimeout(()=>{
         _postCurrentAnalyticsEvent(eventToSend);
@@ -80,8 +96,13 @@ function _retryPost(eventToSend) {
 }
 
 function _postCurrentAnalyticsEvent(eventToSend) {
+    if(disabled){
+        return;
+    }
     if(!eventToSend){
         eventToSend = currentAnalyticsEvent;
+        currentQuantisedTime = 0;
+        _resetGranularityTimer();
         currentAnalyticsEvent = _createAnalyticsEvent();
     }
     if(eventToSend.numEventsTotal === 0 ){
@@ -92,6 +113,7 @@ function _postCurrentAnalyticsEvent(eventToSend) {
         console.warn(`Analytics event generated is very large at greater than ${textToSend.length}B. This 
         typically means that you may be sending too many value events? .`);
     }
+    debugLog("Sending Analytics data of length: ", textToSend.length, "B");
     window.fetch(postURL, {
         method: "POST",
         headers: {'Content-Type': 'application/json'},
@@ -103,53 +125,123 @@ function _postCurrentAnalyticsEvent(eventToSend) {
         if(res.status !== 400){ // we don't retry bad requests
             _retryPost(eventToSend);
         } else {
-            console.error("Bad Request, this is most likely a problem with the library, update to latest version.");
+            console.error("Analytics client: " +
+                "Bad Request, this is most likely a problem with the library, update to latest version.");
         }
     }).catch(res => {
-        console.error(res);
+        debugError(res);
         _retryPost(eventToSend);
     });
 }
 
-function _setupTimers() {
+function _resetGranularityTimer(disable) {
     if(granularityTimer){
         clearInterval(granularityTimer);
         granularityTimer = null;
     }
+    if(disable){
+        return;
+    }
     granularityTimer = setInterval(()=>{
         currentQuantisedTime = currentQuantisedTime + granularitySec;
     }, granularitySec*1000);
+}
 
+function _setupTimers(disable) {
+    _resetGranularityTimer(disable);
     if(postTimer){
         clearInterval(postTimer);
         postTimer = null;
     }
+    if(disable){
+        return;
+    }
     postTimer = setInterval(_postCurrentAnalyticsEvent, postIntervalSeconds*1000);
 }
 
+async function _getServerConfig() {
+    return new Promise((resolve, reject)=>{
+        let configURL = analyticsURL + `/getAppConfig?accountID=${accountID}&appName=${appName}`;
+        window.fetch(configURL).then(async res=>{
+            switch (res.status) {
+            case 200:
+                let serverResponse = await res.json();
+                resolve(serverResponse);
+                return;
+            case 400:
+                reject("Bad Request, check library version compatible?", res);
+                break;
+            default:
+                reject("analytics client: Could not update from remote config. Continuing with defaults.", res);
+            }
+        }).catch(err => {
+            reject("analytics client: Could not update from remote config. Continuing with defaults.", err);
+        });
+    });
+}
+
+/**
+ * Returns the analytics config for the app
+ * @returns {Object}
+ */
+function getAppConfig() {
+    return {
+        accountID, appName, disabled,
+        uuid: userID, sessionID,
+        postIntervalSeconds, granularitySec, analyticsURL, serverConfig
+    };
+}
+
+async function _initFromRemoteConfig(postIntervalSecondsInit, granularitySecInit) {
+    serverConfig = await _getServerConfig();
+    if(serverConfig !== {}){
+        // User init overrides takes precedence over server overrides
+        postIntervalSeconds = postIntervalSecondsInit ||
+            serverConfig["postIntervalSecondsInit"] || DEFAULT_POST_INTERVAL_SECONDS;
+        granularitySec = granularitySecInit || serverConfig["granularitySecInit"] || DEFAULT_GRANULARITY_IN_SECONDS;
+        // For URLs, the server suggested URL takes precedence over user init values
+        analyticsURL = serverConfig["analyticsURLInit"] || analyticsURL || DEFAULT_BASE_URL;
+        disabled = serverConfig["disabled"] === true;
+        _setupTimers(disabled);
+        debugLog(`Init analytics Config from remote. disabled: ${disabled}
+        postIntervalSeconds:${postIntervalSeconds}, granularitySec: ${granularitySec} ,URL: ${analyticsURL}`);
+        if(disabled){
+            console.warn(`Core Analytics is disabled from the server for app: ${accountID}:${appName}`);
+        }
+    }
+}
+
+function _stripTrailingSlash(url) {
+    return url.replace(/\/$/, "");
+}
+
 /**
  * Initialize the analytics session
  * @param accountIDInit Your analytics account id as configured in the server or core.ai analytics
  * @param appNameInit The app name to log the events against.
+ * @param analyticsURLInit Optional: Provide your own analytics server address if you self-hosted the server
  * @param postIntervalSecondsInit Optional: This defines the interval between sending analytics events to the server.
  * Default is 10 minutes
  * @param granularitySecInit Optional: The smallest time period under which the events can be distinguished. Multiple
  * events happening during this time period is aggregated to a count. The default granularity is 3 Seconds, which means
  * that any events that happen within 3 seconds cannot be distinguished in ordering.
- * @param postBaseURLInit Optional: Provide your own analytics server address if you self-hosted the server
+ * @param debug set to true if you want to see detailed debug logs.
  */
-function initSession(accountIDInit, appNameInit, postIntervalSecondsInit, granularitySecInit, postBaseURLInit) {
+function initSession(accountIDInit, appNameInit, analyticsURLInit, postIntervalSecondsInit, granularitySecInit, debug) {
     if(!accountIDInit || !appNameInit){
         throw new Error("accountID and appName must exist for init");
     }
+    analyticsURL = analyticsURLInit? _stripTrailingSlash(analyticsURLInit) : DEFAULT_BASE_URL;
     accountID = accountIDInit;
     appName = appNameInit;
+    debugMode = debug || false;
     postIntervalSeconds = postIntervalSecondsInit || DEFAULT_POST_INTERVAL_SECONDS;
     granularitySec = granularitySecInit || DEFAULT_GRANULARITY_IN_SECONDS;
-    postURL = (postBaseURLInit || DEFAULT_BASE_URL) + "/ingest";
+    postURL = analyticsURL + "/ingest";
     _setupIDs();
     currentAnalyticsEvent = _createAnalyticsEvent();
     _setupTimers();
+    _initFromRemoteConfig(postIntervalSecondsInit, granularitySecInit);
 }
 
 function _ensureAnalyticsEventExists(eventType, category, subCategory) {
@@ -202,6 +294,9 @@ function _updateExistingAnalyticsEvent(index, eventType, category, subCategory,
  * @param eventValue (Optional) : A number value associated with the event. defaults to 0
  */
 function analyticsEvent(eventType, eventCategory, subCategory, eventCount=1, eventValue=0) {
+    if(disabled){
+        return;
+    }
     _validateEvent(eventType, eventCategory, subCategory, eventCount, eventValue);
     _ensureAnalyticsEventExists(eventType, eventCategory, subCategory);
     let events = currentAnalyticsEvent.events;
@@ -226,5 +321,6 @@ function analyticsEvent(eventType, eventCategory, subCategory, eventCount=1, eve
 export {
     initSession,
     getCurrentAnalyticsEvent,
-    analyticsEvent
+    analyticsEvent,
+    getAppConfig
 };

package/src/client-schema.md

@@ -8,16 +8,20 @@ schema:
  "appName" : "app1",
  "uuid": "u1",
  "sessionID": "s1",
- "granularitySec" : 3,
  "unixTimestampUTC" : 1643043376,
- "numEventsTotal": 25,
+ "numEventsTotal": 8,
  "events":{
    "eventType":{
     "category":{
       "subCategory": {
-       "t": [0,3],
-       "v": [1,[1,3]],
-       "c": [23,2]
+       "time": [0,2],
+       "valueCount": [
+          1,
+          [{
+          "1": 5,
+          "3": 2
+          }]
+       ]
       }
     }
    }
@@ -30,49 +34,58 @@ schema:
 1. `appName`: The application name for which the event is being raised.
 2. `uuid`: The unique id for the user. or the string `default` if there is no UUID/anonymous analytics is used from client.
 3. `sessionID`: The unique session-id autogenerated by the client lib for each session. Will be reset for every session.
-4. `granularitySec`: The minimum granularity for event recording in seconds. Repeating events within the same granularity window will be aggregated and only the count will be increased.
 5. `unixTimestampUTC`: The start Unix time from which the client time is being recorded.
 5. `numEventsTotal`: The sum total of all events raised from the client. This aggregates all count values `c`
-6. `events` : A map of events that took place from `unixTimestamp`. The keys are nested in order `eventType`  > `category` > `subCategory`
-    * Within a subcategory, `t` array specifies the `time window` in seconds from the `unixTimestamp` for which the current event is raised.
-    * `v` array specifies the `values` if any that are logged as part of the event. If no value is specified, the default value `1` is used. If multiple values are logged within the same window, it is logged as an array.
-    * `c` array specifies the `count` of events that happened within the time window. For Eg. in the above schema, the event that started in window 0 repeated 23 counts within the window with the default value(1).
+6. `events` : A map of events that took place from `unixTimestampUTC`. The keys are nested in order `eventType`  > `category` > `subCategory`
+    * Within a subcategory, `time` array specifies the `time drift` in seconds from the `unixTimestampUTC` for which the current event is raised.
+    * `valueCount` array specifies the `values` and/or related counts. If the array
+      item is a number, then it signifies count. If it is an object, then
+      it indicates values and the corresponding counts.
 
 ## sample analytics event
 Schema
 ```json
 {
- "schemaVersion" : 1,
- "appName" : "brackets",
- "uuid": "u1",
- "sessionID": "s1",
- "granularitySec" : 3,
- "unixTimestampUTC" : 1643043376,
- "numEventsTotal" : 5,
- "events":{
-   "platform":{
-    "os":{
-      "win": {
-       "t": [0],
-       "v": [1],
-       "c": [1]
-      }
-    }, "performance":{
-      "fileOpenTimeMs": {
-       "t": [0,3,6],
-       "v": [102, [50,34], 200],
-       "c": [1,2,1]
+   "schemaVersion": 1,
+   "appName": "brackets",
+   "uuid": "u1",
+   "sessionID": "s1",
+   "unixTimestampUTC": 1643043376,
+   "numEventsTotal": 5,
+   "events": {
+      "platform": {
+         "os": {
+            "win": {
+               "time": [0],
+               "valueCount": [1]
+            }
+         },
+         "performance": {
+            "fileOpenTimeMs": {
+               "time": [0, 2, 5],
+               "valueCount": [
+                  [{
+                     "121": 1
+                  }],
+                  [{
+                     "100": 1,
+                     "300": 1
+                  }],
+                  [{
+                     "100": 5
+                  }]
+               ]
+            }
+         }
       }
-    }
    }
- }
 }
 
 ```
 The above event raises two event types :
 1. (platform, os, win)
 2. (platform, performance, fileOpenTimeMs)
-    * at time `1643043376 + 0`, a value of `102` is registered.
-    * at time `1643043376 + 3000`, two values `[50,34]` are registered.
-    * at time `1643043376 + 6000`, a value of 200 is registered.
+    * at time `1643043376 + 0`, a value of `121` is registered and count is 1.
+    * at time `1643043376 + 3000`, two values `[100,300]` are registered with a count each of 1.
+    * at time `1643043376 + 6000`, a value of `500` is registered with a count of 5.