db pooling: add ability to pool db writes

Enabled by default. This handles only the softPolling() events.
Misc cleanup and handle possibility of a null uptime

Author: schulzad

smartapps/influxdb-logger/influxdb-logger.groovy

@@ -67,18 +67,19 @@ preferences {
         input "prefDatabaseName", "text", title: "Database Name", defaultValue: "", required: true
         input "prefDatabaseUser", "text", title: "Username", required: false
         input "prefDatabasePass", "text", title: "Password", required: false
+        input "preDatabasePooling", "bool", title: "Enable Pooling", defaultValue: true, required: true
     }
-    
+
     section("Polling:") {
         input "prefSoftPollingInterval", "number", title:"Soft-Polling interval (minutes)", defaultValue: 10, required: true
     }
-    
+
     section("System Monitoring:") {
         input "prefLogModeEvents", "bool", title:"Log Mode Events?", defaultValue: true, required: true
         input "prefLogHubProperties", "bool", title:"Log Hub Properties?", defaultValue: true, required: true
         input "prefLogLocationProperties", "bool", title:"Log Location Properties?", defaultValue: true, required: true
     }
-    
+
     section("Devices To Monitor:") {
         input "accelerometers", "capability.accelerationSensor", title: "Accelerometers", multiple: true, required: false
         input "alarms", "capability.alarm", title: "Alarms", multiple: true, required: false
@@ -107,8 +108,8 @@ preferences {
         input "sleepSensors", "capability.sleepSensor", title: "Sleep Sensors", multiple: true, required: false
         input "smokeDetectors", "capability.smokeDetector", title: "Smoke Detectors", multiple: true, required: false
         input "soundSensors", "capability.soundSensor", title: "Sound Sensors", multiple: true, required: false
-		input "spls", "capability.soundPressureLevel", title: "Sound Pressure Level Sensors", multiple: true, required: false
-		input "switches", "capability.switch", title: "Switches", multiple: true, required: false
+        input "spls", "capability.soundPressureLevel", title: "Sound Pressure Level Sensors", multiple: true, required: false
+        input "switches", "capability.switch", title: "Switches", multiple: true, required: false
         input "switchLevels", "capability.switchLevel", title: "Switch Levels", multiple: true, required: false
         input "tamperAlerts", "capability.tamperAlert", title: "Tamper Alerts", multiple: true, required: false
         input "temperatures", "capability.temperatureMeasurement", title: "Temperature Sensors", multiple: true, required: false
@@ -137,7 +138,7 @@ preferences {
 def installed() {
     state.installedAt = now()
     state.loggingLevelIDE = 5
-    log.debug "${app.label}: Installed with settings: ${settings}" 
+    log.debug "${app.label}: Installed with settings: ${settings}"
 }
 
 /**
@@ -151,11 +152,11 @@ def uninstalled() {
 
 /**
  *  updated()
- * 
+ *
  *  Runs when app settings are changed.
- * 
+ *
  *  Updates device.state with input values and other hard-coded values.
- *  Builds state.deviceAttributes which describes the attributes that will be monitored for each device collection 
+ *  Builds state.deviceAttributes which describes the attributes that will be monitored for each device collection
  *  (used by manageSubscriptions() and softPoll()).
  *  Refreshes scheduling and subscriptions.
  **/
@@ -164,24 +165,25 @@ def updated() {
 
     // Update internal state:
     state.loggingLevelIDE = (settings.configLoggingLevelIDE) ? settings.configLoggingLevelIDE.toInteger() : 3
-    
+
     // Database config:
     state.databaseHost = settings.prefDatabaseHost
     state.databasePort = settings.prefDatabasePort
     state.databaseName = settings.prefDatabaseName
     state.databaseUser = settings.prefDatabaseUser
-    state.databasePass = settings.prefDatabasePass 
-    
+    state.databasePass = settings.prefDatabasePass
+    state.databasePool = settings.prefDatabasePooling
+
     state.path = "/write?db=${state.databaseName}"
-    state.headers = [:] 
+    state.headers = [:]
     state.headers.put("HOST", "${state.databaseHost}:${state.databasePort}")
     state.headers.put("Content-Type", "application/x-www-form-urlencoded")
     if (state.databaseUser && state.databasePass) {
         state.headers.put("Authorization", encodeCredentialsBasic(state.databaseUser, state.databasePass))
     }
 
     // Build array of device collections and the attributes we want to report on for that collection:
-    //  Note, the collection names are stored as strings. Adding references to the actual collection 
+    //  Note, the collection names are stored as strings. Adding references to the actual collection
     //  objects causes major issues (possibly memory issues?).
     state.deviceAttributes = []
     state.deviceAttributes << [ devices: 'accelerometers', attributes: ['acceleration']]
@@ -211,8 +213,8 @@ def updated() {
     state.deviceAttributes << [ devices: 'sleepSensors', attributes: ['sleeping']]
     state.deviceAttributes << [ devices: 'smokeDetectors', attributes: ['smoke']]
     state.deviceAttributes << [ devices: 'soundSensors', attributes: ['sound']]
-	state.deviceAttributes << [ devices: 'spls', attributes: ['soundPressureLevel']]
-	state.deviceAttributes << [ devices: 'switches', attributes: ['switch']]
+    state.deviceAttributes << [ devices: 'spls', attributes: ['soundPressureLevel']]
+    state.deviceAttributes << [ devices: 'switches', attributes: ['switch']]
     state.deviceAttributes << [ devices: 'switchLevels', attributes: ['level']]
     state.deviceAttributes << [ devices: 'tamperAlerts', attributes: ['tamper']]
     state.deviceAttributes << [ devices: 'temperatures', attributes: ['temperature']]
@@ -228,7 +230,10 @@ def updated() {
     // Configure Scheduling:
     state.softPollingInterval = settings.prefSoftPollingInterval.toInteger()
     manageSchedules()
-    
+
+    // Configure if we're pooling InfluxPooling
+    state.poolData = ""
+
     // Configure Subscriptions:
     manageSubscriptions()
 }
@@ -239,18 +244,18 @@ def updated() {
 
 /**
  *  handleAppTouch(evt)
- * 
+ *
  *  Used for testing.
  **/
 def handleAppTouch(evt) {
     logger("handleAppTouch()","trace")
-    
+
     softPoll()
 }
 
 /**
  *  handleModeEvent(evt)
- * 
+ *
  *  Log Mode changes.
  **/
 def handleModeEvent(evt) {
@@ -268,16 +273,16 @@ def handleModeEvent(evt) {
  *
  *  Builds data to send to InfluxDB.
  *   - Escapes and quotes string values.
- *   - Calculates logical binary values where string values can be 
+ *   - Calculates logical binary values where string values can be
  *     represented as binary values (e.g. contact: closed = 1, open = 0)
- * 
- *  Useful references: 
+ *
+ *  Useful references:
  *   - http://docs.smartthings.com/en/latest/capabilities-reference.html
  *   - https://docs.influxdata.com/influxdb/v0.10/guides/writing_data/
  **/
 def handleEvent(evt) {
     logger("handleEvent(): $evt.displayName($evt.name:$evt.unit) $evt.value","info")
-    
+
     // Build data string to send to InfluxDB:
     //  Format: <measurement>[,<tag_name>=<tag_value>] field=<field_value>
     //    If value is an integer, it must have a trailing "i"
@@ -297,9 +302,9 @@ def handleEvent(evt) {
     def unit = escapeStringForInfluxDB(evt.unit)
     def value = escapeStringForInfluxDB(evt.value)
     def valueBinary = ''
-    
+
     def data = "${measurement},deviceId=${deviceId},deviceName=${deviceName},groupId=${groupId},groupName=${groupName},hubId=${hubId},hubName=${hubName},locationId=${locationId},locationName=${locationName}"
-    
+
     // Unit tag and fields depend on the event type:
     //  Most string-valued attributes can be translated to a binary value too.
     if ('acceleration' == evt.name) { // acceleration: Calculate a binary value (active = 1, inactive = 0)
@@ -474,17 +479,22 @@ def handleEvent(evt) {
     }
     // Catch any other event with a string value that hasn't been handled:
     else if (evt.value ==~ /.*[^0-9\.,-].*/) { // match if any characters are not digits, period, comma, or hyphen.
-		logger("handleEvent(): Found a string value that's not explicitly handled: Device Name: ${deviceName}, Event Name: ${evt.name}, Value: ${evt.value}","warn")
+        logger("handleEvent(): Found a string value that's not explicitly handled: Device Name: ${deviceName}, Event Name: ${evt.name}, Value:${evt.value}","warn")
         value = '"' + value + '"'
         data += ",unit=${unit} value=${value}"
     }
     // Catch any other general numerical event (carbonDioxide, power, energy, humidity, level, temperature, ultravioletIndex, voltage, etc).
     else {
         data += ",unit=${unit} value=${value}"
     }
-    
-    // Post data to InfluxDB:
-    postToInfluxDB(data)
+
+    // Post data to InfluxDB pool requests if enabled.
+    if (settings.preDatabasePooling) {
+        poolInfluxDB(data)
+    }
+    else {
+        postToInfluxDB(data)
+    }
 
 }
 
@@ -497,17 +507,17 @@ def handleEvent(evt) {
  *  softPoll()
  *
  *  Executed by schedule.
- * 
+ *
  *  Forces data to be posted to InfluxDB (even if an event has not been triggered).
  *  Doesn't poll devices, just builds a fake event to pass to handleEvent().
  *
  *  Also calls LogSystemProperties().
  **/
 def softPoll() {
     logger("softPoll()","trace")
-    
+
     logSystemProperties()
-    
+
     // Iterate over each attribute for each device, in each device collection in deviceAttributes:
     def devs // temp variable to hold device collection.
     state.deviceAttributes.each { da ->
@@ -519,7 +529,7 @@ def softPoll() {
                         logger("softPoll(): Softpolling device ${d} for attribute: ${attr}","info")
                         // Send fake event to handleEvent():
                         handleEvent([
-                            name: attr, 
+                            name: attr,
                             value: d.latestState(attr)?.value,
                             unit: d.latestState(attr)?.unit,
                             device: d,
@@ -571,7 +581,7 @@ def logSystemProperties() {
                 def hubIP = '"' + escapeStringForInfluxDB(h.localIP) + '"'
                 def hubStatus = '"' + escapeStringForInfluxDB(h.status) + '"'
                 def batteryInUse = ("false" == h.hub.getDataValue("batteryInUse")) ? "0i" : "1i"
-                def hubUptime = h.hub.getDataValue("uptime") + 'i'
+                def hubUptime = ("null" == h.hub.getDataValue("uptime")) ? (h.hub.getDataValue("uptime") + "i") : "0i"
                 def zigbeePowerLevel = h.hub.getDataValue("zigbeePowerLevel") + 'i'
                 def zwavePowerLevel =  '"' + escapeStringForInfluxDB(h.hub.getDataValue("zwavePowerLevel")) + '"'
                 def firmwareVersion =  '"' + escapeStringForInfluxDB(h.firmwareVersionString) + '"'
@@ -588,6 +598,31 @@ def logSystemProperties() {
 
 }
 
+
+/**
+ * poolInfluxDB()
+ **/
+def poolInfluxDB(data) {
+  state.poolData = state.poolData + '\n' + "${data}"
+  // If 80% of state data max commit immediately
+  if (state.poolData.size() >= 80000) {
+    commitPoolToInfluxDB()
+  }
+  else {
+    runIn(5, commitPoolToInfluxDB)
+  }
+}
+
+/**
+ * commit Pool
+ **/
+def commitPoolToInfluxDB() {
+  logger("commitPoolToInfluxDB(): ${state.poolData.size()} bytes", "info")
+  logger("commitPoolToInfluxDB(): ${state.poolData}", "info")
+  postToInfluxDB(state.poolData)
+  state.poolData = ""
+}
+
 /**
  *  postToInfluxDB()
  *
@@ -597,7 +632,7 @@ def logSystemProperties() {
  **/
 def postToInfluxDB(data) {
     logger("postToInfluxDB(): Posting data to InfluxDB: Host: ${state.databaseHost}, Port: ${state.databasePort}, Database: ${state.databaseName}, Data: [${data}]","debug")
-    
+
     try {
         def hubAction = new physicalgraph.device.HubAction(
         	[
@@ -609,15 +644,15 @@ def postToInfluxDB(data) {
             null,
             [ callback: handleInfluxResponse ]
         )
-		
+
         sendHubCommand(hubAction)
     }
     catch (Exception e) {
 		logger("postToInfluxDB(): Exception ${e} on ${hubAction}","error")
     }
 
     // For reference, code that could be used for WAN hosts:
-    // def url = "http://${state.databaseHost}:${state.databasePort}/write?db=${state.databaseName}" 
+    // def url = "http://${state.databaseHost}:${state.databasePort}/write?db=${state.databaseName}"
     //    try {
     //      httpPost(url, data) { response ->
     //          if (response.status != 999 ) {
@@ -626,7 +661,7 @@ def postToInfluxDB(data) {
     //              log.debug "Response contentType: ${response.contentType}"
     //            }
     //      }
-    //  } catch (e) {	
+    //  } catch (e) {
     //      logger("postToInfluxDB(): Something went wrong when posting: ${e}","error")
     //  }
 }
@@ -649,8 +684,8 @@ def handleInfluxResponse(physicalgraph.device.HubResponse hubResponse) {
 
 /**
  *  manageSchedules()
- * 
- *  Configures/restarts scheduled tasks: 
+ *
+ *  Configures/restarts scheduled tasks:
  *   softPoll() - Run every {state.softPollingInterval} minutes.
  **/
 private manageSchedules() {
@@ -659,7 +694,7 @@ private manageSchedules() {
     // Generate a random offset (1-60):
     Random rand = new Random(now())
     def randomOffset = 0
-    
+
     // softPoll:
     try {
         unschedule(softPoll)
@@ -673,26 +708,26 @@ private manageSchedules() {
         logger("manageSchedules(): Scheduling softpoll to run every ${state.softPollingInterval} minutes (offset of ${randomOffset} seconds).","trace")
         schedule("${randomOffset} 0/${state.softPollingInterval} * * * ?", "softPoll")
     }
-    
+
 }
 
 /**
  *  manageSubscriptions()
- * 
+ *
  *  Configures subscriptions.
  **/
 private manageSubscriptions() {
 	logger("manageSubscriptions()","trace")
 
     // Unsubscribe:
     unsubscribe()
-    
+
     // Subscribe to App Touch events:
     subscribe(app,handleAppTouch)
-    
+
     // Subscribe to mode events:
     if (prefLogModeEvents) subscribe(location, "mode", handleModeEvent)
-    
+
     // Subscribe to device attributes (iterate over each attribute for each device collection in state.deviceAttributes):
     def devs // dynamic variable holding device collection.
     state.deviceAttributes.each { da ->
@@ -754,9 +789,9 @@ private encodeCredentialsBasic(username, password) {
  *  escapeStringForInfluxDB()
  *
  *  Escape values to InfluxDB.
- *  
- *  If a tag key, tag value, or field key contains a space, comma, or an equals sign = it must 
- *  be escaped using the backslash character \. Backslash characters do not need to be escaped. 
+ *
+ *  If a tag key, tag value, or field key contains a space, comma, or an equals sign = it must
+ *  be escaped using the backslash character \. Backslash characters do not need to be escaped.
  *  Commas and spaces will also need to be escaped for measurements, though equals signs = do not.
  *
  *  Further info: https://docs.influxdata.com/influxdb/v0.10/write_protocols/write_syntax/
@@ -779,10 +814,10 @@ private escapeStringForInfluxDB(str) {
  *  getGroupName()
  *
  *  Get the name of a 'Group' (i.e. Room) from its ID.
- *  
+ *
  *  This is done manually as there does not appear to be a way to enumerate
  *  groups from a SmartApp currently.
- * 
+ *
  *  GroupIds can be obtained from the SmartThings IDE under 'My Locations'.
  *
  *  See: https://community.smartthings.com/t/accessing-group-within-a-smartapp/6830
@@ -793,5 +828,6 @@ private getGroupName(id) {
     else if (id == 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX') {return 'Kitchen'}
     else if (id == 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX') {return 'Lounge'}
     else if (id == 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX') {return 'Office'}
-    else {return 'Unknown'}    
+    else {return 'Unknown'}
 }
+