Split parser/serializer docs (#4690)

plugins/serializers/EXAMPLE_README.md

@@ -0,0 +1,46 @@
+# Example
+
+This description explains at a high level what the serializer does and
+provides links to where additional information about the format can be found.
+
+### Configuration
+
+This section contains the sample configuration for the serializer.  Since the
+configuration for a serializer is not have a standalone plugin, use the `file`
+or `http` outputs as the base config.
+
+```toml
+[[inputs.file]]
+  files = ["stdout"]
+
+  ## Describe variables using the standard SampleConfig style.
+  ##   https://github.com/influxdata/telegraf/wiki/SampleConfig
+  example_option = "example_value"
+
+  ## Data format to output.
+  ## Each data format has its own unique set of configuration options, read
+  ## more about them here:
+  ##   https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
+  data_format = "example"
+```
+
+#### example_option
+
+If an option requires a more expansive explanation than can be included inline
+in the sample configuration, it may be described here.
+
+### Metrics
+
+The optional Metrics section contains details about how the serializer converts
+Telegraf metrics into output.
+
+### Example
+
+The optional Example section can show an example conversion to the output
+format using InfluxDB Line Protocol as the reference format.
+
+For line delimited text formats a diff may be appropriate:
+```diff
+- cpu,host=localhost,source=example.org value=42
++ cpu|host=localhost|source=example.org|value=42
+```

plugins/serializers/graphite/README.md

@@ -0,0 +1,51 @@
+# Graphite
+
+The Graphite data format is translated from Telegraf Metrics using either the
+template pattern or tag support method.  You can select between the two
+methods using the [`graphite_tag_support`](#graphite-tag-support) option.  When set, the tag support
+method is used, otherwise the [Template Pattern][templates]) is used.
+
+### Configuration
+
+```toml
+[[outputs.file]]
+  ## Files to write to, "stdout" is a specially handled file.
+  files = ["stdout", "/tmp/metrics.out"]
+
+  ## Data format to output.
+  ## Each data format has its own unique set of configuration options, read
+  ## more about them here:
+  ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
+  data_format = "graphite"
+
+  ## Prefix added to each graphite bucket
+  prefix = "telegraf"
+  ## Graphite template pattern
+  template = "host.tags.measurement.field"
+
+  ## Support Graphite tags, recommended to enable when using Graphite 1.1 or later.
+  # graphite_tag_support = false
+```
+
+#### graphite_tag_support
+
+When the `graphite_tag_support` option is enabled, the template pattern is not
+used.  Instead, tags are encoded using
+[Graphite tag support](http://graphite.readthedocs.io/en/latest/tags.html)
+added in Graphite 1.1.  The `metric_path` is a combination of the optional
+`prefix` option, measurement name, and field name.
+
+The tag `name` is reserved by Graphite, any conflicting tags and will be encoded as `_name`.
+
+**Example Conversion**:
+```
+cpu,cpu=cpu-total,dc=us-east-1,host=tars usage_idle=98.09,usage_user=0.89 1455320660004257758
+=>
+cpu.usage_user;cpu=cpu-total;dc=us-east-1;host=tars 0.89 1455320690
+cpu.usage_idle;cpu=cpu-total;dc=us-east-1;host=tars 98.09 1455320690
+```
+
+#### templates
+
+Consult the [Template Patterns](/docs/TEMPLATE_PATTERN.md) documentation for
+details.

plugins/serializers/influx/README.md

@@ -0,0 +1,34 @@
+# Influx
+
+The `influx` data format outputs metrics into [InfluxDB Line Protocol][line
+protocol].  This is the recommended format unless another format is required
+for interoperability.
+
+### Configuration
+```toml
+[[outputs.file]]
+  ## Files to write to, "stdout" is a specially handled file.
+  files = ["stdout", "/tmp/metrics.out"]
+
+  ## Data format to output.
+  ## Each data format has its own unique set of configuration options, read
+  ## more about them here:
+  ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
+  data_format = "influx"
+
+  ## Maximum line length in bytes.  Useful only for debugging.
+  influx_max_line_bytes = 0
+
+  ## When true, fields will be output in ascending lexical order.  Enabling
+  ## this option will result in decreased performance and is only recommended
+  ## when you need predictable ordering while debugging.
+  influx_sort_fields = false
+
+  ## When true, Telegraf will output unsigned integers as unsigned values,
+  ## i.e.: `42u`.  You will need a version of InfluxDB supporting unsigned
+  ## integer values.  Enabling this option will result in field type errors if
+  ## existing data has been written.
+  influx_uint_support = false
+```
+
+[line protocol]: https://docs.influxdata.com/influxdb/latest/write_protocols/line_protocol_tutorial/

plugins/serializers/json/README.md

@@ -0,0 +1,77 @@
+# JSON
+
+The `json` output data format converts metrics into JSON documents.
+
+### Configuration
+
+```toml
+[[outputs.file]]
+  ## Files to write to, "stdout" is a specially handled file.
+  files = ["stdout", "/tmp/metrics.out"]
+
+  ## Data format to output.
+  ## Each data format has its own unique set of configuration options, read
+  ## more about them here:
+  ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
+  data_format = "json"
+
+  ## The resolution to use for the metric timestamp.  Must be a duration string
+  ## such as "1ns", "1us", "1ms", "10ms", "1s".  Durations are truncated to
+  ## the power of 10 less than the specified units.
+  json_timestamp_units = "1s"
+```
+
+### Examples:
+
+Standard form:
+```json
+{
+    "fields": {
+        "field_1": 30,
+        "field_2": 4,
+        "field_N": 59,
+        "n_images": 660
+    },
+    "name": "docker",
+    "tags": {
+        "host": "raynor"
+    },
+    "timestamp": 1458229140
+}
+```
+
+When an output plugin needs to emit multiple metrics at one time, it may use
+the batch format.  The use of batch format is determined by the plugin,
+reference the documentation for the specific plugin.
+```json
+{
+    "metrics": [
+        {
+            "fields": {
+                "field_1": 30,
+                "field_2": 4,
+                "field_N": 59,
+                "n_images": 660
+            },
+            "name": "docker",
+            "tags": {
+                "host": "raynor"
+            },
+            "timestamp": 1458229140
+        },
+        {
+            "fields": {
+                "field_1": 30,
+                "field_2": 4,
+                "field_N": 59,
+                "n_images": 660
+            },
+            "name": "docker",
+            "tags": {
+                "host": "raynor"
+            },
+            "timestamp": 1458229140
+        }
+    ]
+}
+```

plugins/serializers/splunkmetric/README.md

@@ -79,7 +79,7 @@ The following aspects of the token can be overriden with tags:
 * source
 
 You can either use `[global_tags]` or using a more advanced configuration as documented [here](https://github.com/influxdata/telegraf/blob/master/docs/CONFIGURATION.md).
- 
+
 Such as this example which overrides the index just on the cpu metric:
 ```toml
 [[inputs.cpu]]
@@ -122,7 +122,7 @@ TIMESTAMP_FIELDS = time
 TIME_FORMAT = %s.%3N
 ```
 
-An example configuration of a file based output is: 
+An example configuration of a file based output is:
 
 ```toml
  # Send telegraf metrics to file(s)