From 769ebf255f5978069e5d12f94fc8207c7fb3b3f3 Mon Sep 17 00:00:00 2001 From: Karen Metts <35154725+karenzone@users.noreply.github.com> Date: Wed, 24 Jul 2019 15:41:56 -0400 Subject: [PATCH] [Doc] Fix formatting and bump to v3.0.5 (#21) * Fix formatting and bump to v3.0.5 * Update PR link in changelog --- CHANGELOG.md | 3 +++ docs/index.asciidoc | 11 +++++++++++ logstash-output-riemann.gemspec | 2 +- 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8684c6d..dfd09bf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## 3.0.5 + - Fix formatting in doc for conversion to --asciidoctor [#21](https://github.com/logstash-plugins/logstash-output-riemann/pull/21) + ## 3.0.4 - Docs: Set the default_codec doc attribute. diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 346ccd7..fc60cbc 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -32,7 +32,9 @@ outputs You can learn about Riemann here: * http://riemann.io/ + You can see the author talk about it here: + * http://vimeo.com/38377415 @@ -86,7 +88,9 @@ All nested logstash fields will be mapped to riemann fields containing all paren separated by dots and the deepest value. As an example, the logstash event: + [source,ruby] +----- { "@timestamp":"2013-12-10T14:36:26.151+0000", "@version": 1, @@ -96,14 +100,19 @@ As an example, the logstash event: "key": "value" } } +----- + Is mapped to this riemann event: + [source,ruby] +----- { :time 1386686186, :host host.domain.com, :message log message, :nested_field.key value } +----- It can be used in conjunction with or independent of the riemann_event option. When used with the riemann_event any duplicate keys receive their value from @@ -150,12 +159,14 @@ Any other field set here will be passed to Riemann as an event attribute. Example: [source,ruby] +----- riemann { riemann_event => { "metric" => "%{metric}" "service" => "%{service}" } } +----- `metric` and `ttl` values will be coerced to a floating point value. Values which cannot be coerced will zero (0.0). diff --git a/logstash-output-riemann.gemspec b/logstash-output-riemann.gemspec index 8b1451f..aafd64f 100644 --- a/logstash-output-riemann.gemspec +++ b/logstash-output-riemann.gemspec @@ -1,6 +1,6 @@ Gem::Specification.new do |s| s.name = 'logstash-output-riemann' - s.version = '3.0.4' + s.version = '3.0.5' s.licenses = ['Apache License (2.0)'] s.summary = "Sends metrics to Riemann" s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"