Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Fix formatting and bump to v3.0.7 #9

Merged
merged 2 commits into from
Jul 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 3.0.7
- 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.

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


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