Add analytics (#8)

* Add analytics

* Add analytics for exceptions

Author: irlaec

octoprint_netconnectd/__init__.py

@@ -14,9 +14,7 @@
 
 import octoprint.plugin
 from octoprint.server import admin_permission
-
-
-
+from octoprint_netconnectd.analytics import Analytics
 
 class NetconnectdSettingsPlugin(octoprint.plugin.SettingsPlugin,
                                 octoprint.plugin.TemplatePlugin,
@@ -27,8 +25,10 @@ class NetconnectdSettingsPlugin(octoprint.plugin.SettingsPlugin,
 
 	def __init__(self):
 		self.address = None
+		self._analytics = None
 
 	def initialize(self):
+		self._analytics = Analytics(self)
 		self.address = self._settings.get(["socket"])
 		self.forwardUrl = self._settings.get(["forwardUrl"])
 		self._log_state_timed(self.LOG_STATE_DELAY)
@@ -100,32 +100,41 @@ def on_api_get(self, request):
 		))
 
 	def on_api_command(self, command, data, adminRequired=True):
-		if command == "refresh_wifi":
-			return jsonify(self._get_wifi_list(force=True))
-
-		# any commands processed after this check require admin permissions
-		if adminRequired and not admin_permission.can():
-			return make_response("Insufficient rights", 403)
-			
-		if command == "configure_wifi":
-			if data["psk"]:
-				self._logger.info("Configuring wifi {ssid} and psk...".format(**data))
-			else:
-				self._logger.info("Configuring wifi {ssid}...".format(**data))
+		try:
+			if command == "refresh_wifi":
+				self._analytics.write_wifi_config_command(command, success=True)
+				return jsonify(self._get_wifi_list(force=True))
+
+			# any commands processed after this check require admin permissions
+			if adminRequired and not admin_permission.can():
+				self._analytics.write_wifi_config_command(command, success=False, err='Insufficient rights')
+				return make_response("Insufficient rights", 403)
+
+			if command == "configure_wifi":
+				if data["psk"]:
+					self._logger.info("Configuring wifi {ssid} and psk...".format(**data))
+				else:
+					self._logger.info("Configuring wifi {ssid}...".format(**data))
+
+				self._configure_and_select_wifi(data["ssid"], data["psk"], force=data["force"] if "force" in data else False)
+
+			elif command == "forget_wifi":
+				self._forget_wifi()
 
-			self._configure_and_select_wifi(data["ssid"], data["psk"], force=data["force"] if "force" in data else False)
+			elif command == "reset":
+				self._reset()
 
-		elif command == "forget_wifi":
-			self._forget_wifi()
+			elif command == "start_ap":
+				self._start_ap()
 
-		elif command == "reset":
-			self._reset()
+			elif command == "stop_ap":
+				self._stop_ap()
 
-		elif command == "start_ap":
-			self._start_ap()
+			self._analytics.write_wifi_config_command(command, success=True)
 
-		elif command == "stop_ap":
-			self._stop_ap()
+		except RuntimeError as e:
+			self._analytics.write_wifi_config_command(command, success=False, err=str(e))
+			raise RuntimeError
 
 	##~~ AssetPlugin API
 

octoprint_netconnectd/analytics.py

@@ -0,0 +1,28 @@
+
+class Analytics:
+    ANALYTICS_DATA = 'MrbAnalyticsData'
+    EVENT_WIFI_CONFIG = 'wifi_config'
+    EVENT_WIFI_REFRESH = 'wifi_refresh'
+
+    def __init__(self, plugin):
+        self._plugin = plugin
+        self._logger = self._plugin._logger
+
+    def write_wifi_config_command(self, command, success, err=None):
+        try:
+            data = dict(
+                command=command,
+                success=success,
+                err=err,
+            )
+            self._send_op_event(eventname=self.EVENT_WIFI_CONFIG, data=data)
+        except:
+            self._logger.exception("Exception while writing wifi config command to analytics.")
+
+    def _send_op_event(self, eventname, data):
+        payload = dict(
+            plugin='netconnectd',
+            eventname=eventname,
+            data=data
+        )
+        self._plugin._event_bus.fire(self.ANALYTICS_DATA, payload)