No commit activity in last 3 years
No release in over 3 years
Output plugin for Logstash for sending Azure IoTHub
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Project Readme

logstash-output-iothub

This is a plugin for Logstash.

This plugin provide sending messages to Microsoft Azure IoTHub.

Usage

Install

In your logstash home directory,

bin/logstash-plugin install logstash-output-iothub

More details for plugins, please see here.

Configuration

Please see below example.

output {
  iothub {
    connection_string => "{set your iot hub connection string}"
  }
}
  • connection_string : your device connection string.

About connection string, please see here

For Developers

Developing

1. Plugin Developement and Testing

Code

  • To get started, you'll need JRuby with the Bundler gem installed.

  • Install dependencies

bundle install
rake install_jars

Test

  • Update your dependencies
bundle install
rake install_jars
  • Run tests
bundle exec rspec

Publish

Publish plugin as gem to RubyGems.org.

$ bundle exec rake publish_gem

2. Running your unpublished Plugin in Logstash

2.1 Run in a local Logstash clone

  • Edit Logstash Gemfile and add the local plugin path, for example:
gem "logstash-output-iothub", :path => "/your/local/logstash-output-iothub"
  • Install plugin
bin/logstash-plugin install --no-verify
  • Run Logstash with your plugin
bin/logstash -e 'output {iothub {connection_string => "<conn_str>"}}'

At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.

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
gem build logstash-output-iothub.gemspec
  • Install the plugin from the Logstash home
bin/logstash-plugin install /your/local/plugin/logstash-output-iothub.gem
  • Start Logstash and proceed to test the plugin

Contributing

Please post to Github - tac0x2a/logstash-output-iothub

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.

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.

About Logstash

Documentation

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.

Need Help?

Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.