From 5e7144393ab03db152823f6f582a7957e14073b8 Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Wed, 24 Jul 2019 12:30:42 -0400 Subject: [PATCH 1/2] asciidoctor-librato --- CHANGELOG.md | 3 +++ docs/index.asciidoc | 19 +++++++++++++++++++ logstash-output-librato.gemspec | 2 +- 3 files changed, 23 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 35825c2..9c0e828 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## 3.0.7 + - Fix formatting in doc for conversion to --asciidoctor [#tbd](https://github.com/logstash-plugins/logstash-output-librato/pull/tbd) + ## 3.0.6 - Docs: Set the default_codec doc attribute. diff --git a/docs/index.asciidoc b/docs/index.asciidoc index d2dde27..dde7fa6 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -73,17 +73,23 @@ All values will be passed through `event.sprintf` Example: [source,ruby] +----- { "title" => "Logstash event on %{host}" "name" => "logstash_stream" } +----- + or + [source,ruby] +----- { "title" => "Logstash event" "description" => "%{message}" "name" => "logstash_stream" } +----- [id="plugins-{type}s-{plugin}-api_token"] ===== `api_token` @@ -115,20 +121,26 @@ Send data to Librato as a counter Example: [source,ruby] +----- { "value" => "1" "source" => "%{host}" "name" => "messages_received" } +----- Additionally, you can override the `measure_time` for the event. Must be a unix timestamp: + [source,ruby] +----- { "value" => "1" "source" => "%{host}" "name" => "messages_received" "measure_time" => "%{my_unixtime_field}" } +----- + Default is to use the event's timestamp [id="plugins-{type}s-{plugin}-gauge"] @@ -142,19 +154,26 @@ Send data to Librato as a gauge Example: [source,ruby] +----- { "value" => "%{bytes_received}" "source" => "%{host}" "name" => "apache_bytes" } +----- + Additionally, you can override the `measure_time` for the event. Must be a unix timestamp: + [source,ruby] +----- { "value" => "%{bytes_received}" "source" => "%{host}" "name" => "apache_bytes" "measure_time" => "%{my_unixtime_field} } +----- + Default is to use the event's timestamp diff --git a/logstash-output-librato.gemspec b/logstash-output-librato.gemspec index 03448a1..c673b98 100644 --- a/logstash-output-librato.gemspec +++ b/logstash-output-librato.gemspec @@ -1,6 +1,6 @@ Gem::Specification.new do |s| s.name = 'logstash-output-librato' - s.version = '3.0.6' + s.version = '3.0.7' s.licenses = ['Apache License (2.0)'] s.summary = "Sends metrics, annotations, and alerts to Librato based on Logstash events" 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" From c66a8b6c48f20acbebb0722d2aa86574015ef68d Mon Sep 17 00:00:00 2001 From: Karen Metts <35154725+karenzone@users.noreply.github.com> Date: Wed, 24 Jul 2019 12:34:28 -0400 Subject: [PATCH 2/2] Update PR link in changelog --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9c0e828..c76169c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,5 @@ ## 3.0.7 - - Fix formatting in doc for conversion to --asciidoctor [#tbd](https://github.com/logstash-plugins/logstash-output-librato/pull/tbd) + - Fix formatting in doc for conversion to --asciidoctor [#9](https://github.com/logstash-plugins/logstash-output-librato/pull/9) ## 3.0.6 - Docs: Set the default_codec doc attribute.