Build Status

Uniqness Logstash Plugin

This is a Logstash plugin for Uniqness.

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.



Setting Input Type Required
api_key String False
bucket String True
consumer_key String True
dedicated Boolean False
flush_size Number False
idle_flush_time Number False
message String False
secret_key String True
url String False


  • Value type is string
  • There is no default value for this setting.

The API key of your Uniqness account.


  • Value type is string
  • There is no default value for this setting.

The bucket to push data in.


  • Value type is string
  • There is no default value for this setting.

The Consumer key of your Uniqness account.


  • Value type is boolean
  • Default value is false.

Whether you subscribed to a Uniqness dedicated plan or not.


  • Value type is number
  • Default value is 100.

Number of events to queue up before writing to Uniqness API.


  • Value type is number
  • Default value is 1.

Amount of time since the last flush before a flush is done even if the number of buffered events is smaller than flush_size.


  • Value type is string
  • Default value is "%{message}".

Data to push to Uniqness API.


  • Value type is string
  • There is no default value for this setting.

The Secret key of your Uniqness account.


  • Value type is string
  • Default value is

Root url of Uniqness API.


output {
    uniqness {
        consumer_key => "xxxxxx"
        api_key => "xxxxxx"
        secret_key => "xxxxxxxxx"
        bucket => "users-%{+YYYY.MM.dd}"
        message => "%{userId}"


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 discussion forum.


1. Plugin Developement and Testing


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

  • Create a new plugin or clone and existing from the GitHub logstash-plugins organization. We also provide example plugins.

  • Install dependencies

    bundle install


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

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: 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.

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


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 file.