Update examples following refactor

examples/all_batching.js

@@ -16,12 +16,8 @@
 
 /**
  * This example shows how to batch events with the
- * SplunkLogger with all available settings.
- *
- * By default autoFlush is enabled.
- *
- * By disabling autoFlush, events will be queued
- * until flush() is called.
+ * SplunkLogger with all available settings:
+ * batchInterval, maxBatchCount, & maxBatchSize.
  */
 
 // Change to require("splunk-logging").Logger;

examples/basic.js

@@ -26,8 +26,7 @@ var SplunkLogger = require("../index").Logger;
  */
 var config = {
     token: "your-token-here",
-    url: "https://localhost:8088",
-    maxBatchCount: 1 // Send events 1 at a time
+    url: "https://localhost:8088"
 };
 
 // Create a new logger
@@ -50,7 +49,7 @@ var payload = {
         source: "chicken coop",
         sourcetype: "httpevent",
         index: "main",
-        host: "farm.local",
+        host: "farm.local"
     },
     // Severity is also optional
     severity: "info"
@@ -59,8 +58,8 @@ var payload = {
 console.log("Sending payload", payload);
 
 /**
- * Since maxBatchCount is set to 1, calling send
- * will immediately send the payload.
+ * Since maxBatchCount is set to 1 by default,
+ * calling send will immediately send the payload.
  * 
  * The underlying HTTP POST request is made to
  *

examples/custom_format.js

@@ -47,7 +47,12 @@ Logger.error = function(err, context) {
  * be whatever was passed to Logger.send().
  * Severity will always be a string.
  *
- * In this example, we're 
+ * In this example, we're building up a string
+ * of key=value pairs if message is an object,
+ * otherwise the message value is as value for
+ * the message key.
+ * This string is prefixed with the event
+ * severity in square brackets.
  */
 Logger.eventFormatter = function(message, severity) {
     var event = "[" + severity + "]";
@@ -58,7 +63,7 @@ Logger.eventFormatter = function(message, severity) {
         }
     }
     else {
-        event += "message=" + message + " ";
+        event += "message=" + message;
     }
 
     return event;
@@ -76,7 +81,7 @@ var payload = {
         source: "chicken coop",
         sourcetype: "httpevent",
         index: "main",
-        host: "farm.local",
+        host: "farm.local"
     },
     // Severity is also optional
     severity: "info"
@@ -85,8 +90,8 @@ var payload = {
 console.log("Sending payload", payload);
 
 /**
- * Since maxBatchCount is set to 1, calling send
- * will immediately send the payload.
+ * Since maxBatchCount is set to 1 by default,
+ * calling send will immediately send the payload.
  * 
  * The underlying HTTP POST request is made to
  *
@@ -95,13 +100,11 @@ console.log("Sending payload", payload);
  * with the following body
  *
  *     {
- *         "metadata": {
- *             "source": "chicken coop",
- *             "sourcetype": "httpevent",
- *             "index": "main",
- *             "host": "farm.local"
- *         },
- *         "event": "[info]temperature=70F, chickenCount=500"
+ *         "source": "chicken coop",
+ *         "sourcetype": "httpevent",
+ *         "index": "main",
+ *         "host": "farm.local",
+ *         "event": "[info]temperature=70F chickenCount=500 "
  *     }
  *
  */

examples/manual_batching.js

@@ -17,9 +17,8 @@
 /**
  * This example shows how to batch events with the
  * SplunkLogger by manually calling flush.
- * By default autoFlush is enabled.
  *
- * By disabling autoFlush, events will be queued
+ * By setting maxbatchCount=0, events will be queued
  * until flush() is called.
  */
 
@@ -29,12 +28,12 @@ var SplunkLogger = require("../index").Logger;
 /**
  * Only the token property is required.
  * 
- * Here, autoFlush is set to false.
+ * Here, maxBatchCount is set to 0.
  */
 var config = {
     token: "your-token-here",
     url: "https://localhost:8088",
-    autoFlush: false // Manually flush events
+    maxBatchCount: 0 // Manually flush events
 };
 
 // Create a new logger
@@ -57,7 +56,7 @@ var payload = {
         source: "chicken coop",
         sourcetype: "httpevent",
         index: "main",
-        host: "farm.local",
+        host: "farm.local"
     },
     // Severity is also optional
     severity: "info"
@@ -81,7 +80,7 @@ console.log("Queuing second payload", payload2);
 Logger.send(payload2);
 
 /**
- * Since autoFlush is disabled, call flush manually.
+ * Call flush manually.
  * This will send both payloads in a single
  * HTTP request.
  *

examples/retry.js

@@ -56,7 +56,7 @@ var payload = {
         source: "chicken coop",
         sourcetype: "httpevent",
         index: "main",
-        host: "farm.local",
+        host: "farm.local"
     },
     // Severity is also optional
     severity: "info"

splunklogger.js

@@ -165,7 +165,6 @@ SplunkLogger.prototype._disableTimer = function() {
     }
 };
 
-// TODO: update doc
 /**
  * Configures an interval timer to flush any events in
  * <code>this.serializedContextQueue</code> at the specified interval.