Skip to content

Commit

Permalink
[Doc] Fix formatting and bump to v3.0.5 (#21)
Browse files Browse the repository at this point in the history
* Fix formatting and bump to v3.0.5

* Update PR link in changelog
  • Loading branch information
karenzone authored Jul 24, 2019
1 parent 0752ffa commit 769ebf2
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
11 changes: 11 additions & 0 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down Expand Up @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion logstash-output-riemann.gemspec
Original file line number Diff line number Diff line change
@@ -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"
Expand Down

0 comments on commit 769ebf2

Please sign in to comment.