changes to telemetry

Author: sonalgoyal

common/client/src/main/java/zingg/common/client/Client.java

@@ -147,9 +147,9 @@ public void printAnalyticsBanner(boolean collectMetrics) {
 		}
 		else {
 			LOG.info("");
-			LOG.info("********************************************************");
-			LOG.info("*    Zingg is not collecting any analytics data        *");
-			LOG.info("********************************************************");
+			LOG.info("*************************************************************************************************************");
+			LOG.info("*    Zingg is not collecting any analytics data and will only log a blank event with the name of the phase  *");
+			LOG.info("*************************************************************************************************************");
 			LOG.info("");
 		}
 	}

common/core/src/main/java/zingg/common/core/util/Analytics.java

@@ -93,12 +93,13 @@ public static void postEvent(String phase, boolean collectMetrics) {
 				paramNode.put(entry.getKey(), entry.getValue());
 			}
 			eventNode.set("params", paramNode); 
-
-			ArrayNode eventList;
-			eventList = mapper.createArrayNode();
-			eventList.add(eventNode);
-			rootNode.set("events", eventList);
 		}
+
+		ArrayNode eventList;
+		eventList = mapper.createArrayNode();
+		eventList.add(eventNode);
+		rootNode.set("events", eventList);
+		rootNode.put("user_id", getDomain());
 
 		String metricEvent = rootNode.toString();
 		LOG.warn("event is " + metricEvent);

docs/security.md

@@ -11,11 +11,28 @@ However, Zingg does collect usage metrics and writes them to Google Analytics. T
 
 The following details are captured:
 
-* **Data source type:** type of data format e.g. CSV, snowflake
+* **Data source type:** data format e.g. CSV, snowflake, parquet
 * **Fields count:** number of fields used for training
-* **Total Data count:** for match phase, number of total records
+* **Record Count:** total number of total records pasing through Zingg
 * **Execution Time:** execution time of the program
-* **Matched and Nonmatched records count:** for the train phase, the number of matched and nonmatched records
+* **Matches and Nonmatches:** the number of matched and nonmatched records
+* **Domain:** helps Zingg developers to understand our user enterprises
+* **JDK information:** version, flavour
+* **OS information:** operating system type
+* **Databricks Environment:** 
 
-If you do not wish to send this data, please set collectMetrics flag to false in the configuration JSON while running Zingg.
+An example analytics event while running Zingg is
+```
+{"client_id":"sonal-mac.local","events":[{"name":"findTrainingData","params":{"numMatchFields":"10.0","numTotalFields":"11.0","modelId":"100","java.version":"1.8.0_342-internal","dataFormat":"csv","os.arch":"x86_64","java.home":"/Library/Java/JavaVirtualMachines/openlogic-openjdk-8.jdk/Contents/Home/jre","executionTime":"93.0","zingg_version":"0.4.0","domain":"sonal-mac.local","os.name":"Mac OS X","DB_INSTANCE_TYPE":null,"DATABRICKS_RUNTIME_VERSION":null,"outputFormat":"csv"}}]}
+```
+
+To view the information captured while running Zingg, edit log4j2.properties and turn loggin level of zingg_analytics to warn
+```
+logger.zingg_analytics.level = warn
+```
+
+If you do not wish to send the data, please set collectMetrics flag to false in the configuration JSON while running Zingg. A blank event will be logged in this case
+```
+{"client_id":"sonal-mac.local","events":[{"name":"findTrainingData"}],"user_id":"sonal-mac.local"}
+```