logstash-output-sentry 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8de667fbcb016da4649ee29c7d6193ef99af069
-  data.tar.gz: deb9057c87497347303620fbf2bc700726cec89c
+  metadata.gz: 8b4b6f3febff467476f1bda31a0553447d425348
+  data.tar.gz: 8ae6985516d7982465dbd4f9892115ea3e44cca6
 SHA512:
-  metadata.gz: 7145110b5052de92e18c1808be0f187edfe5084f0a7517742341f6bb08225cc770045376ad51894583a14a6500eb66730a7606e5d4f4b48c051e55f75d4486bb
-  data.tar.gz: 3e81262b7f1bbd9b5e891bbda08fb7045b4528459392d33022926d76ccd4b450476ebdabe7915e5539aae0e249c5aaf77a7af3e873319681107811569972a3af
+  metadata.gz: 762fbb64d456fa1236e979f599ec45c59391e39aacca9741a0bda7406655e8b3057fbbb0bb9a8d92cae283b8ca0cfb12f7ea06a8fe06085587c37c3682733c2c
+  data.tar.gz: f2f5c3550935a4ba57386c75adf49ed1911dce630ba93a71ef08574a486ff8c056b6c0776b7d1dfddacb577a3a5b36be7795935820e84c6fd9d86d4231ce6a27

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.0
+ - Improving sentry.rb script based on antho31/logstash-output-sentry and bigpandaio/logstash-output-sentry projects.
+ - Creating documentation (starting from bigpandaio/logstash-output-sentry with some fixes for the differences that we have introduced to the code).
 ## 0.1.0
  - Starting project from clarkdave/logstash-sentry.rb
  - Packing script in a gem so it can be easily installed.

data/README.md

@@ -1,89 +1,104 @@
-# Logstash Plugin
+# Logstash-Output-Sentry Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-example-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Outputs/job/logstash-plugin-output-example-unit/)
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
 
-This is a plugin for [Logstash](https://github.com/elastic/logstash).
+This plugin gives you the possibility to send your output parsed with Logstash to a Sentry host.
 
-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.
+This plugin 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.
 
-## 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](http://www.elastic.co/guide/en/logstash/current/).
-
-- 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
-
-## Need Help?
+But keep in mind that this is not an official plugin, and this plugin is not supported by the Logstash community.
 
-Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
 
-## Developing
+## Documentation
 
-### 1. Plugin Developement and Testing
+### Installation
 
-#### Code
-- To get started, you'll need JRuby with the Bundler gem installed.
+You must have [Logstash](https://github.com/elasticsearch/logstash) installed for using this plugin. You can find instructions on how to install it on the [Logstash website](https://www.elastic.co/downloads/logstash). Maybe the easiest way to install is using their [repositories](https://www.elastic.co/guide/en/logstash/current/package-repositories.html).
 
-- 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).
+As this plugin has been shared on [RubyGems](https://rubygems.org) with the name [logstash-output-sentry](https://rubygems.org/gems/logstash-output-sentry) you can install it using the following command from your Logstash installation path:
 
-- Install dependencies
 ```sh
-bundle install
+bin/plugin install logstash-output-sentry
 ```
 
-#### Test
-
-- Update your dependencies
+When installing from official repository as suggested below, the installation path is ```/opt/logstash```.
 
-```sh
-bundle install
-```
+### Usage
 
-- Run tests
+[Sentry](https://getsentry.com/) is a modern error logging and aggregation platform.
+It’s important to note that Sentry should not be thought of as a log stream, but as an aggregator.
+It fits somewhere in-between a simple metrics solution (such as Graphite) and a full-on log stream aggregator (like Logstash).
 
-```sh
-bundle exec rspec
+* In Sentry, generate and get your client key (Settings -> Client key). The client key has this form:
+```
+[http|https]://[key]:[secret]@[host]/[project_id]
 ```
 
-### 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:
+* In your Logstash configuration file, inform your client key:
 ```ruby
-gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
-```
-- Install plugin
-```sh
-bin/plugin install --no-verify
+output {
+  sentry {
+    'key' => "yourkey"
+    'secret' => "yoursecretkey"
+    'project_id' => "yourprojectid"
+  }
+}
 ```
-- 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
+* Note that all your fields (incluing the Logstash field "message") will be in the "extra" field in Sentry. But be careful : by default , the host is set to "app.getsentry.com". If you have installed Sentry on your own machine, please change the host (change "localhost:9000" with the correct value according your configuration):
+```ruby
+output {
+  sentry {
+    'host' => "localhost:9000"
+    'use_ssl' => false
+    'project_id' => "yourprojectid"
+    'key' => "yourkey"
+    'secret' => "yoursecretkey"
+  }
+}
+```
 
-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:
+* You can change the "message" field (default : "Message from logstash"), or optionally specify a field to use from your event. In case the message field doesn't exist, it'll be used as the actual message.
+```ruby
+sentry {
+  'project_id' => "1"
+  'key' => "87e60914d35a4394a69acc3b6d15d061"
+  'secret' => "596d005d20274474991a2fb8c33040b8"
+  'msg' => "msg_field"
+}
+```
 
-- Build your plugin gem
-```sh
-gem build logstash-filter-awesome.gemspec
+* You can indicate the level (default : "error"), and decide if all your Logstash fields will be tagged in Sentry. If you use the protocole HTTPS, please enable "use_ssl" (default : true), but if you use http you MUST disable ssl.
+```ruby
+sentry {
+  'host' => "192.168.56.102:9000"
+  'use_ssl' => false
+  'project_id' => "1"
+  'key' => "87e60914d35a4394a69acc3b6d15d061"
+  'secret' => "596d005d20274474991a2fb8c33040b8"
+  'msg' => "Message you want"
+  'level_tag' => "fatal"
+  'fields_to_tags' => true
+}
 ```
-- Install the plugin from the Logstash home
-```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+
+* You can optionally strip the timestamp from the sentry title by do setting `strip_timestamp` to `true`, which will change `YYYY-MM-DD HH:MM:SS,MILLISEC INFO ..` to `INFO ...`
+```ruby
+sentry {
+  'host' => "192.168.56.102:9000"
+  'use_ssl' => false
+  'project_id' => "1"
+  'key' => "87e60914d35a4394a69acc3b6d15d061"
+  'secret' => "596d005d20274474991a2fb8c33040b8"
+  'msg' => "Message you want"
+  'level_tag' => "fatal"
+  'fields_to_tags' => true
+  'strim_timestamp' => true
+}
 ```
-- Start Logstash and proceed to test the plugin
 
 ## Contributing
 
 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.
+Note that this plugin has been written from [this Dave Clark's Gist](https://gist.github.com/clarkdave/edaab9be9eaa9bf1ee5f).

data/lib/logstash/outputs/sentry.rb

@@ -1,46 +1,75 @@
 # encoding: utf-8
-# The MIT License (MIT)
-
-# Copyright (c) 2014 Dave Clark
-
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
 require 'logstash/outputs/base'
 require 'logstash/namespace'
+require 'json'
+
+# Sentry is a modern error logging and aggregation platform.
+# * https://getsentry.com/
+#
+# It’s important to note that Sentry should not be thought of as a log stream, but as an aggregator.
+# It fits somewhere in-between a simple metrics solution (such as Graphite) and a full-on log stream aggregator (like Logstash).
+#
+# Generate and inform your client key (Settings -> Client key)
+# The client key has this form  * https://[key]:[secret]@[host]/[project_id] *
+#
+# More informations :
+# * https://sentry.readthedocs.org/en/latest/
+
 
 class LogStash::Outputs::Sentry < LogStash::Outputs::Base
 
   config_name 'sentry'
 
-  config :host, :validate => :string, :required => true, :default => 'app.getsentry.com'
+  # Whether to use SSL (https) or not (http)
   config :use_ssl, :validate => :boolean, :required => false, :default => true
+
+  # Sentry host
+  config :host, :validate => :string, :required => true, :default => 'app.getsentry.com'
+
+  # Project id, key and secret
+  config :project_id, :validate => :string, :required => true
   config :key, :validate => :string, :required => true
   config :secret, :validate => :string, :required => true
-  config :project_id, :validate => :string, :required => true
+
+  # This sets the message value in Sentry (the title of your event)
+  config :msg, :validate => :string, :default => 'Message from logstash', :required => false
+
+  # This sets the level value in Sentry (the level tag)
+  config :level_tag, :validate => :string, :default => 'error', :required => false
+
+  # If set to true automatically map all logstash defined fields to Sentry extra fields.
+  # As an example, the logstash event:
+  # [source,ruby]
+  #    {
+  #      "@timestamp": "2013-12-10T14:36:26.151+0000",
+  #      "@version": 1,
+  #      "message": "log message",
+  #      "host": "host.domain.com",
+  #      "nested_field": {
+  #                        "key": "value"
+  #                      }
+  #    }
+  # Is mapped to this Sentry  event:
+  # [source,ruby]
+  # extra {
+  #      "@timestamp": "2013-12-10T14:36:26.151+0000",
+  #      "@version": 1,
+  #      "message": "log message",
+  #      "host": "host.domain.com",
+  #      "nested_field": {
+  #                        "key": "value"
+  #                      }
+  #    }
+  config :fields_to_tags, :validate => :boolean, :default => false, :required => false
 
   public
   def register
     require 'net/https'
     require 'uri'
-    
+
     @url = "%{proto}://#{host}/api/#{project_id}/store/" % { :proto => use_ssl ? 'https' : 'http' }
     @uri = URI.parse(@url)
+
     @client = Net::HTTP.new(@uri.host, @uri.port)
     @client.use_ssl = use_ssl
     @client.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -52,20 +81,21 @@ class LogStash::Outputs::Sentry < LogStash::Outputs::Base
   def receive(event)
     return unless output?(event)
 
-    require 'json'
     require 'securerandom'
 
     packet = {
       :event_id => SecureRandom.uuid.gsub('-', ''),
       :timestamp => event['@timestamp'],
-      :message => event['message']
+      :message => event['message'] || "#{msg}",
+      :level => "#{level_tag}",
+      :platform => 'logstash',
+      :server_name => event['host'],
+      :extra => event.to_hash,
     }
 
-    packet[:level] = event['[fields][level]']
-
-    packet[:platform] = 'logstash'
-    packet[:server_name] = event['host']
-    #packet[:extra] = event['fields'].to_hash
+    if fields_to_tags
+      packet[:tags] = event.to_hash
+    end
 
     @logger.debug('Sentry packet', :sentry_packet => packet)
 

data/logstash-output-sentry.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name = 'logstash-output-sentry'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.licenses = ['Apache License (2.0)']
   s.summary = 'This output plugin sends messages to any sentry server.'
-  s.description = 'This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program.'
+  s.description = 'This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install logstash-output-sentry. This gem is not a stand-alone program.'
   s.authors = ['Javier Matos Odut']
   s.email = 'iam@javiermatos.com'
   s.homepage = 'https://github.com/javiermatos/logstash-output-sentry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-sentry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Javier Matos Odut
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core
@@ -79,8 +79,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: This gem is a logstash plugin required to be installed on top of the
-  Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not
-  a stand-alone program.
+  Logstash core pipeline using $LS_HOME/bin/plugin install logstash-output-sentry.
+  This gem is not a stand-alone program.
 email: iam@javiermatos.com
 executables: []
 extensions: []