fluent-plugin-splunk-hec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 891d6573230e5e79e740d8a1d583f5f8b205313169e9c7ae809fcac2e7bf2367
+  data.tar.gz: 5d6e4fbf0e6f80eb9eaf7ea1ba9b1b0e1c0ffb231e8682be1ecdb0f353a7a8cb
+SHA512:
+  metadata.gz: 8d728f7565cb240a50759acf353bfc5ef1de88223d79c81f5a9ba4f1c848414df8448d1642652ba42e0bc82983b0ffbc9918e6e6a8576aa3051f9eea18f44ac2
+  data.tar.gz: a5a0e99b20197fca605bc03f094657cb06367b61e69fd5562f0ad35c5cfe733b2ee66de62019d8576467d357f2e7de8eb8594497d9e30e651cafd15eff6ff526

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zliang@splunk.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fluent-plugin-splunk_hec_output.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-splunk-hec (1.0.0)
+      fluentd (~> 1.0)
+      multi_json (~> 1.13)
+      net-http-persistent (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    connection_pool (2.2.1)
+    cool.io (1.5.3)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    dig_rb (1.0.1)
+    fluentd (1.1.0)
+      cool.io (>= 1.4.5, < 2.0.0)
+      dig_rb (~> 1.0.0)
+      http_parser.rb (>= 0.5.1, < 0.7.0)
+      msgpack (>= 0.7.0, < 2.0.0)
+      serverengine (>= 2.0.4, < 3.0.0)
+      sigdump (~> 0.2.2)
+      strptime (>= 0.2.2, < 1.0.0)
+      tzinfo (~> 1.0)
+      tzinfo-data (~> 1.0)
+      yajl-ruby (~> 1.0)
+    hashdiff (0.3.7)
+    http_parser.rb (0.6.0)
+    minitest (5.11.3)
+    msgpack (1.2.2)
+    multi_json (1.13.1)
+    net-http-persistent (3.0.0)
+      connection_pool (~> 2.2)
+    power_assert (1.1.1)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    safe_yaml (1.0.4)
+    serverengine (2.0.6)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.2.3)
+    test-unit (3.2.7)
+      power_assert
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2018.3)
+      tzinfo (>= 1.0.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yajl-ruby (1.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fluent-plugin-splunk-hec!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  test-unit (~> 3.0)
+  webmock (~> 3.2)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,234 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 Splunk Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   
+=======================================================================
+Fluentd Plugin for Splunk HEC:
+
+The Fluentd Plugin for Splunk HTTP Event Collector project contains
+subcomponents with separate copyright notices and license terms.
+Your use of the source code for the these subcomponents is subject
+to the terms and conditions of the following licenses.
+
+========================================================================
+Apache License 2.0
+========================================================================
+The following components are provided under the Apache License 2.0. See project link for details.
+
+    (Apache License 2.0) fluentd (https://github.com/fluent/fluentd/blob/master/LICENSE)
+
+========================================================================
+MIT licenses
+========================================================================
+The following components are provided under the MIT License. See project link for details.
+
+    (MIT License) multi_json (https://github.com/intridea/multi_json/blob/master/LICENSE.md)
+    (MIT License) net-http-persistent (https://github.com/drbrain/net-http-persistent/blob/master/README.rdoc#license)
+    (MIT License) bundler (https://github.com/bundler/bundler/blob/master/LICENSE.md)
+    (MIT License) rake (https://github.com/ruby/rake/blob/master/MIT-LICENSE)
+    (MIT License) webmock (https://github.com/bblimke/webmock/blob/master/LICENSE)
+    (MIT License) minitest (https://github.com/seattlerb/minitest/blob/master/README.rdoc#license)
+
+========================================================================
+For test-unit:
+========================================================================
+
+See https://github.com/test-unit/test-unit/blob/master/COPYING

data/README.md

@@ -0,0 +1,381 @@
+[ ![Codeship Status for splunk/fluent-plugin-splunk-hec](https://app.codeship.com/projects/7905e540-105f-0136-dde3-2adac7655f3e/status?branch=master)](https://app.codeship.com/projects/282733)
+# fluent-plugin-splunk-hec
+
+[Fluentd](https://fluentd.org/) output plugin to send events and metrics to [Splunk](https://www.splunk.com) over the HEC (HTTP Event Collector) API.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-splunk-hec
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-splunk-hec"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+* See also: [Output Plugin Overview](https://docs.fluentd.org/v1.0/articles/output-plugin-overview)
+
+### Examples
+
+#### Example 1: Minimum Configs
+
+```
+<match **>
+  @type splunk_hec
+  hec_host 12.34.56.78
+  hec_port 8088
+  hec_token 00000000-0000-0000-0000-000000000000
+</match>
+```
+
+This example is very basic, it just tells the plugin to send events to Splunk HEC on `https://12.34.56.78:8088` (https is the default protocol), using the HEC token `00000000-0000-0000-0000-000000000000`. It will use whatever index, source, sourcetype are configured in HEC. And the `host` of each event is the hostname of the machine which running fluentd.
+
+#### Example 2: Overwrite HEC defaults
+
+```
+<match **>
+  @type splunk_hec
+  hec_host 12.34.56.78
+  hec_port 8088
+  hec_token 00000000-0000-0000-0000-000000000000
+
+  index awesome
+  source ${tag}
+  sourcetype _json
+</match>
+```
+
+This configuration will
+* send all events to the `awesome` index, and
+* set their source to the event tags. `${tag}` is a special value which will be replaced by the event tags, and
+* set their sourcetype to `_json`.
+
+Sometimes you want to use the values from the input event for these parameters, this is where the `*_key` parameters help.
+
+```
+<match **>
+  ...omitting other parameters...
+
+  source_key file_path
+</match>
+```
+
+In the second example (in order to keep it concise, we just omitted the repeating parameters, and we will keep doing so in the following examples), it uses the `source_key` config to set the source of event to the value of the event's `file_path` field. Given an input event like
+```javascript
+{"file_path": "/var/log/splunk.log", "message": "This is an exmaple.", "level": "info"}
+```
+Then the source for this event will be "/var/log/splunk.log". And the "file\_path" field will be removed from the input event, so what you will eventually get ingested in Splunk is
+```javascript
+{"message": "This is an exmaple.", "level": "info"}
+```
+If you want to keep "file\_path" in the event, you can use `keep_keys`.
+
+Besides `source_key` there are also other `*_key` parameters, check the parameters details below.
+
+#### Example 3: Sending metrics
+
+[Metrics](https://docs.splunk.com/Documentation/Splunk/latest/Metrics/Overview) is avaialble since Splunk 7.0.0, you can use this output plugin to send events as metrics to a Splunk metric index by setting `data_type` to "metric".
+
+```
+<match **>
+  @type splunk_hec
+  data_type metric
+  hec_host 12.34.56.78
+  hec_port 8088
+  hec_token 00000000-0000-0000-0000-000000000000
+</match>
+```
+
+With this configuration, the plugin will treat each input event as a collection of metrics, i.e. each key-varlue pair in the event is a metric name-value pair. For example, given an input event like
+
+```javascript
+{"cpu/usage": 0.5, "cpu/rate": 10, "memory/usage": 100, "memory/rss": 90}
+```
+
+then 4 metrics will be sent to splunk.
+
+If the input events are not like this, instead they have the metric name and metric value as properties of the event. Then you can use `metric_name_key` and `metric_value_key`. Given an input event like
+
+```javascript
+{"metric": "cpu/usage", "value": 0.5, "app": "web_ui"}
+```
+
+You should change the configuration to
+
+```
+<match **>
+  @type splunk_hec
+  data_type metric
+  hec_host 12.34.56.78
+  hec_port 8088
+  hec_token 00000000-0000-0000-0000-000000000000
+
+  metric_name_key metric
+  metric_value_key value
+</match>
+```
+
+All other properties of the input (in this example, "app"), will be sent as dimensions of the metric. You can use the `<fields>` section to customize the dimensions.
+
+### Parameters
+
+#### @type
+
+This value must be `splunk_hec`.
+
+#### protocol (enum) (optional)
+
+Protocol to use to call HEC API.
+
+Available values: http, https
+
+Default value: `https`.
+
+### hec_host (string) (required)
+
+The hostname/IP to HEC, or HEC load balancer.
+
+### hec_port (integer) (optional)
+
+The port number to HEC, or HEC load balancer.
+
+Default value: `8088`.
+
+### hec_token (string) (required)
+
+The HEC token.
+
+### index (string) (optional)
+
+The Splunk index to index events. When not set, will be decided by HEC. This is exclusive with `index_key`.
+
+### index_key (string) (optional)
+
+Field name to contain Splunk index name. This is exclusive with `index`.
+
+### host (string) (optional)
+
+The host field for events. This is exclusive with `host_key`.
+
+Default value: the hostname of the host machine.
+
+### host_key (string) (optional)
+
+Field name to contain host. This is exclusive with `host`.
+
+### source (string) (optional)
+
+The source field for events, when not set, will be decided by HEC. This is exclusive with `source_key`.
+
+### source_key (string) (optional)
+
+Field name to contain source. This is exclusive with `source`.
+
+### sourcetype (string) (optional)
+
+The sourcetype field for events, when not set, will be decided by HEC. This is exclusive with `sourcetype_key`.
+
+### sourcetype_key (string) (optional)
+
+Field name to contain sourcetype. This is exclusive with `sourcetype`.
+
+### metrics_from_event (bool) (optional)
+
+When `data_type` is set to "metric", by default it will treat every key-value pair in the input event as a metric name-value pair. Set `metrics_from_event` to `false` to disable this behavior and use `metric_name_key` and `metric_value_key` to define metrics.
+
+Default value: `true`.
+
+### metric_name_key (string) (optional)
+
+Field name to contain metric name. This is exclusive with `metrics_from_event`, when this is set, `metrics_from_event` will be set to `false`.
+
+### metric_value_key (string) (optional)
+
+Field name to contain metric value, this is required when `metric_name_key` is set.
+
+### keep_keys (bool) (optional)
+
+By default, all the fields used by the `*_key` parameters will be removed from the original input events. To change this behavior, set this parameter to `true`.
+
+Default value: `true`.
+
+### coerce_to_utf8 (bool) (optional)
+
+Whether to allow non-UTF-8 characters in user logs. If set to true, any non-UTF-8 character would be replaced by the string specified by `non_utf8_replacement_string`. If set to false, any non-UTF-8 character would trigger the plugin to error out.
+
+Default value: `true`.
+
+### non_utf8_replacement_string (string) (optional)
+
+If `coerce_to_utf8` is set to true, any non-UTF-8 character would be replaced by the string specified here.
+
+Default value: `' '`.
+
+### &lt;fields&gt; section (optional) (single)
+
+Depending on the value of `data_type` parameter, the parameters inside `<fields>` section have different meanings. Despite the meaning, the syntax for parameters is unique.
+
+#### When `data_type` is `event`
+
+In this case, parameters inside `<fields>` will be used as indexed fields. And these fields will be removed from the original input events. Please see the "Add a "fields" property at the top JSON level" [here](http://dev.splunk.com/view/event-collector/SP-CAAAFB6) for details. Given we have configuration like
+
+```
+<match **>
+  @type splunk_hec
+  ...omitting other parameters...
+
+  <fields>
+    file
+    level
+    app applicatioin
+  </fields>
+</match>
+```
+
+and an input event like
+
+```javascript
+{"application": "webServer", "file": "server.rb", "lineNo": 100, "level": "info", "message": "Request finished in 30ms."}
+```
+
+Then the HEC request JSON payload will be:
+
+```javascript
+{
+   // omitting other fields
+   // ...
+   "event": "{\"lineNo\": 100, \"message\": \"Request finished in 30ms.\"}",
+   "fields": {
+     "file": "server.rb",
+     "level": "info",
+     "app": "webServer"
+   }
+}
+```
+
+As you can see, parameters inside `<fields>` section can be a key-value pair or just a key (a name).
+If a parameter is a key-value, the key will be the name of the field inside the `"fields"` JSON object,
+whereas the value is the field name of the input event. So a key-value pair is a rename.
+
+If a parameter has just a key, it means its value is exactly the same as the key.
+
+#### When `data_type` is `metric`
+
+For metrics, parameters inside `<fields>` are used as dimensions. If `<fields>` is not presented, the original input event will be used as dimensions. If an empty `<fields></fields>` is presented, no dimension will be sent. For example, given configuration like
+
+```
+<match **>
+  @type splunk_hec
+  data_type metric
+  ...omitting other parameters...
+
+  metric_name_key name
+  metric_value_key value
+  <fields>
+    file
+    level
+    app applicatioin
+  </fields>
+</match>
+```
+
+and an input event like
+
+```javascript
+{"application": "webServer", "file": "server.rb", "value": 100, "status": "OK", "message": "Normal", "name": "CPU Usage"}
+```
+
+Then, a metric of "CPU Usage" with value=100, along with 3 dimensions file="server.rb", status="OK", and app="webServer" will be sent to Splunk.
+
+### &lt;format&gt; section (optional) (multiple)
+
+The `<format>` section let us define which formatter to use to format events.
+By default, it uses [the `json` formatter](https://docs.fluentd.org/v1.0/articles/formatter_jso://docs.fluentd.org/v1.0/articles/formatter_json).
+
+Besides the `@type` parameter, you should define all other parameters for the formatter inside this section.
+
+Multiple `<format>` sections can be defined to use different formatters for different tags. Each `<format>` section accepts an argument just like the `<match>` section does, to define tag matching. But default, every event will be formatted with `json`. For example:
+
+```
+<match **>
+  @type splunk_hec
+  ...
+
+  <format sometag.**>
+    @type single_value
+    message_key log
+  </format>
+
+  <format some.othertag>
+    @type csv
+    fields ["some", "fields"]
+  </format>
+```
+
+In this example, it will format events with tags which start with `sometag.` with the `single_value` formatter, and format events with tags `some.othertag` with the `csv` formatter, and format all other events with the `json` formatter (the default formatter).
+
+If you want to use a different default formatter, you can add a `<format **>` (or `<format>`) section.
+
+#### @type (string) (required)
+
+Defines which formatter to use.
+
+### SSL parameters
+
+There are quite some parameters you can use to configure SSL (for HTTPS protocol).
+All these parameters are optional.
+
+#### client_cert (string)
+
+The path to a file containing a PEM-format CA certificate for this client.
+
+#### client_key (string)
+
+The private key for this client.
+
+#### ca_file (string)
+
+The path to a file containing a PEM-format CA certificate.
+
+#### ca_path (string)
+
+The path to a directory containing CA certificates in PEM format.
+
+#### ciphers (array)
+
+List of SSl ciphers allowed.
+
+#### insecure_ssl (bool)
+
+Indicates if insecure SSL connection is allowed, i.e. do not verify the server's certificate.
+
+Default value: `false`.
+
+## About Buffer
+
+This plugin sends events to HEC using [batch mode](https://docs.splunk.com/Documentation/Splunk/7.1.0/Data/FormateventsforHTTPEventCollector#Event_data).
+It batches all events in a chunk in one request. So you need to configure the `<buffer>` section carefully to gain the best performance.
+Here are some hints:
+
+* Read through the [fluentd buffer document](https://docs.fluentd.org/v1.0/articles/buffer-section) to understand the buffer configurations.
+* Use `chunk_limit_size` and/or `chunk_limit_records` to define how big a chunk can be. And remeber that all events in a chunk will be sent in one request.
+* Splunk has a limit on how big the payload of a HEC request can be. And it's defined with `max_content_length` in [the `[http_input]` section of `limits.conf`](https://docs.splunk.com/Documentation/Splunk/latest/Admin/Limitsconf#.5Bhttp_input.5D). In Splunk of version 6.5.0+, the default value is 800MiB, while in versions before 6.5.0, it's just 1MB. Make sure your chunk size won't exceed this limit, or you should change the limit on your Splunk deployment.
+* Sending requests to HEC takes time, so if you flush your fluentd buffer too fast (for example, with a very small `flush_interval`), it's possible that the plugin cannot catch up with the buffer flushing. There are two ways you can handle this situdation, one is to increase the `flush_interval` or use multiple flush threads by setting `flush_thread_count` to a number bigger than 1.
+
+## License
+
+Please see [LICENSE](LICENSE).