Document the unmapped mapper.

springernature · May 21, 2015 · 546987f · 546987f
1 parent 8db3049
commit 546987f
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/doc/mappers/README.md b/doc/mappers/README.md
@@ -11,8 +11,8 @@ to be consumed by some other process.
 The choice of mapper
 can be specified at the command line,
 using the `-m` [option].
-Three mappers are availble out-of-the-box,
-[statsd], [statsd-npg], [har] and [waterfall].
+Five mappers are availble out-of-the-box,
+[statsd], [statsd-npg], [har], [waterfall] and [unmapped].
 
 Defining custom mappers is simple.
 The [source code for the statsd mapper][src]
@@ -90,5 +90,6 @@ as `'\n'`.
 [statsd-npg]: statsd-npg.md
 [har]: har.md
 [waterfall]: waterfall.md
+[unmapped]: unmapped.md
 [src]: ../../src/mappers/statsd.js
 
diff --git a/doc/mappers/unmapped.md b/doc/mappers/unmapped.md
@@ -0,0 +1,20 @@
+# mappers/unmapped
+
+The unmapped mapper
+serialises the data
+in its raw format.
+That raw format
+looks like this:
+
+```js
+{
+    "data": {},       // Parsed boomerang request data
+    "referer": "",    // HTTP referer header
+    "userAgent": "",  // User agent string
+    "browser": {
+        "name": "",   // Browser name
+        "version": "" // Browser major rev
+    }
+}
+```
+