No commit activity in last 3 years
A long-lived project that still receives updates
This gem is a Logstash output plugin to be installed on top of the Logstashcore pipeline using $LS_HOME/bin/logstash-plugin install gemname.This gem is not a stand-alone program.
 Project Readme

<<<<<<< HEAD

Logstash Plugin

This is a plugin for Logstash.

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.


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.

Sample Logstash file

output {
	google_pubsub {

# Your GCP project id (name)
		project_id => "premium-poc"

# The topic name below is currently hard-coded in the plugin. You
# must first create this topic by hand before attempting to output
# messages to Google Pubsub.
#			topic => "pubsub-output-plugin-topic"
# Dynamic topic also supported based on the field in message or logstash tags
             topic => "%{topic}"

# If defined Only content of field passed as message. exclude_fields & include_fields ignored
		include_field =>  "message"  

# Exclude list takes precedence over include list
		exclude_fields => [ "@version" , "filename" , "tags" ]

# Only mentioned field passed in json format with key
		include_fields => [ "message" ]

# Set number of retries to avoid loss due to transient issues.
# Setting value to 0 does not retry. Default value set as 1
		retry => 2

# If you are running logstash within GCE, it will use
# Application Default Credentials and use GCE's metadata
# service to fetch tokens.  However, if you are running logstash
# outside of GCE, you will need to specify the service account's
# JSON key file below.

#		json_key_file => "/home/nirav/Downloads/Premium-POC-5837fe4cfb8f.json"
#		}


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:
gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
  • Install plugin
bin/logstash-plugin install --no-verify
  • Run Logstash with your plugin
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
gem build logstash-filter-awesome.gemspec
  • Install the plugin from the Logstash home
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.


Logstash output for sending events to the Google Pub/Sub service