README.md in fluent-plugin-datadog_event-0.1.4 vs README.md in fluent-plugin-datadog_event-0.1.5

- old
+ new

@@ -1,47 +1,45 @@ # Fluent::Plugin::DatadogEvent Generates Datadog events from matching fluent records. -## Installation +## Installation (from original source) -Add this line to your application's Gemfile: - -```ruby -gem 'fluent-plugin-datadog_event' ``` +$ gem install fluent-plugin-datadog_event +``` -And then execute: - - $ bundle - -Or install it yourself as: - - $ gem install fluent-plugin-datadog_event - -(latter path depending upon acceptance) - ## Configuration ### Syntax ``` <match ddevents.info> type datadog_event + # DD api key - mandatory api_key MyApIKey110123kjla7 - # all other config parameters are optional - # datadog specific tags associated with event + + # All other config parameters are optional + + # Datadog specific tags associated with event tags fluentevent + # alert type: info, warning, error, or success alert_type info - # aggregation key - anything with this unique value will be considered an additional instance of the same event + + # aggregation key - anything with this unique value # will be considered an additional instance of the # same event aggregation_key "my_aggregation_key" - # Message title + + # Message title msg_title "My app event" + # Source name - for filtering by event source source_type_name "my_app_named" + + # Optional (or add it to record["host"]) + host myhost </match> ``` ### Dynamic config @@ -57,7 +55,15 @@ msg_title "App event: ${tag_parts[1]}" source_type_name "fluent-${tag_parts[1])" </match> ``` -With the above config, an event tagged as 'ddevents.myapp.info' would be handled at the level of info, with "myapp" as part of the messahe, source_type, and aggregation key - Use of rewrite-tag-names can make this very flexible. +With the above config, an event tagged as 'ddevents.myapp.info' would be handled at the level of info, with "myapp" as part of the message, source_type, and aggregation key - Use of rewrite-tag-names can make this very flexible. + +## Contributing + +1. Fork it ( https://github.com/inokappa/fluent-plugin-datadog_event ) +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request