README.md in logstash-input-azuretable-0.1.4 vs README.md in logstash-input-azuretable-0.1.6
- old
+ new
@@ -1,86 +1,67 @@
-# Logstash Plugin
+# Logstash input plugin for Azure diagnostics data from Storage Tables
-This is a plugin for [Logstash](https://github.com/elastic/logstash).
+## Summary
+This plugin reads Azure diagnostics data from specified Azure Storage Table and parses the data for output.
-It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+## Installation
+You can install this plugin using the Logstash "plugin" or "logstash-plugin" (for newer versions of Logstash) command:
+```sh
+logstash-plugin install logstash-input-azurewadtable
+```
+For more information, see Logstash reference [Working with plugins](https://www.elastic.co/guide/en/logstash/current/working-with-plugins.html).
-## Documentation
+## Configuration
+### Required Parameters
+__*account_name*__
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+The Azure Storage account name.
-- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+__*access_key*__
-## Need Help?
+The access key to the storage account.
-Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+__*table_name*__
-## Developing
+The storage table to pull data from.
-### 1. Plugin Developement and Testing
+### Optional Parameters
+__*entity_count_to_process*__
-#### Code
-- To get started, you'll need JRuby with the Bundler gem installed.
+The plugin queries and processes table entities in a loop, this parameter is to specify the maximum number of entities it should query and process per loop. The default value is 100.
-- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+__*collection_start_time_utc*__
-- Install dependencies
-```sh
-bundle install
-```
+Specifies the point of time after which the entities created should be included in the query results. The default value is when the plugin gets initialized:
-#### Test
-
-- Update your dependencies
-
-```sh
-bundle install
+```ruby
+Time.now.utc.iso8601
```
+__*etw_pretty_print*__
-- Run tests
+True to pretty print ETW files, otherwise False. The default value is False.
-```sh
-bundle exec rspec
-```
+__*idle_delay_seconds*__
-### 2. Running your unpublished Plugin in Logstash
+Specifies the seconds to wait between each processing loop. The default value is 15.
-#### 2.1 Run in a local Logstash clone
+__*endpoint*__
-- Edit Logstash `Gemfile` and add the local plugin path, for example:
-```ruby
-gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
-```
-- Install plugin
-```sh
-bin/logstash-plugin install --no-verify
-```
-- Run Logstash with your plugin
-```sh
-bin/logstash -e 'filter {awesome {}}'
-```
-At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+Specifies the endpoint of Azure environment. The default value is "core.windows.net".
-#### 2.2 Run in an installed Logstash
-
-You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
-
-- Build your plugin gem
-```sh
-gem build logstash-filter-awesome.gemspec
+### Examples
```
-- Install the plugin from the Logstash home
-```sh
-bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+input
+{
+ azurewadtable
+ {
+ account_name => "mystorageaccount"
+ access_key => "VGhpcyBpcyBhIGZha2Uga2V5Lg=="
+ table_name => "WADWindowsEventLogsTable"
+ }
+}
```
-- Start Logstash and proceed to test the plugin
-## Contributing
+## More information
+The source code of this plugin is hosted in GitHub repo [Microsoft Azure Diagnostics with ELK](https://github.com/Azure/azure-diagnostics-tools). We welcome you to provide feedback and/or contribute to the project.
-All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
-
-Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.
-
-It is more important to the community that you are able to contribute.
-
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.
+Please also see [Analyze Diagnostics Data with ELK template](https://github.com/Azure/azure-quickstart-templates/tree/master/diagnostics-with-elk) for quick deployment of ELK to Azure.