logstash-filter-emoji 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c457407f53496f9c1896fab9aeba881f7cb38a67
-  data.tar.gz: 64007a22e81616ac020f1010f9a0d3d223d26b71
+  metadata.gz: 8bf678b6f5ecf91845711bf00ecb22fc666adc88
+  data.tar.gz: 9581d2694e591f9aa5ce2e1a6cdb8b39cece5d24
 SHA512:
-  metadata.gz: da0358dfb1690e7194fcbd748699be46035301ecb486f81e0f007c59f6b0bed11af32970093156ed9df5604010145a435b9e1170fa0153d83edec2450e3e8603
-  data.tar.gz: eb42aa2f86895d9056c3adc06f15e24b8e513f1e29088e6447c62504f4cb5ba9965f5effa8319bf12ea9e56dfba68aafb33be39dfcef0610c39652c1f9a33dba
+  metadata.gz: 5bbe89db72f2dfb11b458d4b6665c901f45b553d2601b1a22621aecf909b317896864fad538a639b64a87a24516ac4d5ed2160dcafa9fb687410ce7884042820
+  data.tar.gz: 18c71dffbe27f3d48b5ecc518a9b9a8f6b66ffea2a43aa014fd3ca41f9e6db24401dbb2d9e2967973df38e4fd30d35bd53c7170d5ac2e207ec4a5e4ac643a44b

data/Gemfile

@@ -1,3 +1,11 @@
 source 'https://rubygems.org'
+
 gemspec
 
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,176 @@
+:plugin: emoji
+:type: filter
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Emoji filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+This plugin maps the severity names or numeric codes as defined in
+https://tools.ietf.org/html/rfc3164#section-4.1.1[RFC 3164] and
+https://tools.ietf.org/html/rfc5424#section-6.2.1[RFC 5424] to the emoji
+as defined in the configuration.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Emoji Filter Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-fallback>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-field>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-override>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-sev_alert>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sev_critical>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sev_debug>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sev_emergency>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sev_error>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sev_info>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sev_notice>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-sev_warning>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-target>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-fallback"]
+===== `fallback` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+In case no match is found in the event, this will add a default emoji, which
+will always populate `target`, if the match failed.
+
+For example, if we have configured `fallback => "`❓`"`, using this
+dictionary:
+[source,ruby]
+    foo: 👤
+
+Then, if logstash received an event with the field `foo` set to 👤, the
+target field would be set to 👤. However, if logstash received an event with
+`foo` set to `nope`, then the target field would still be populated, but
+with the value of ❓.
+This configuration can be dynamic and include parts of the event using the
+`%{field}` syntax.
+
+[id="plugins-{type}s-{plugin}-field"]
+===== `field` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The name of the logstash event field containing the value to be compared for
+a match by the emoji filter (e.g. `severity`).
+
+If this field is an array, only the first value will be used.
+
+[id="plugins-{type}s-{plugin}-override"]
+===== `override` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+If the target field already exists, this configuration item specifies
+whether the filter should skip being rewritten as an emoji (default) or
+overwrite the target field value with the emoji value.
+
+[id="plugins-{type}s-{plugin}-sev_alert"]
+===== `sev_alert` 
+
+  * Value type is <<string,string>>
+  * Default value is `"🚨"`
+
+`sev_alert` selects the emoji/unicode character for Alert severity
+
+[id="plugins-{type}s-{plugin}-sev_critical"]
+===== `sev_critical` 
+
+  * Value type is <<string,string>>
+  * Default value is `"🔥"`
+
+`sev_critical` selects the emoji/unicode character for Critical severity
+
+[id="plugins-{type}s-{plugin}-sev_debug"]
+===== `sev_debug` 
+
+  * Value type is <<string,string>>
+  * Default value is `"🐛"`
+
+`sev_debug` selects the emoji/unicode character for Debug severity
+
+[id="plugins-{type}s-{plugin}-sev_emergency"]
+===== `sev_emergency` 
+
+  * Value type is <<string,string>>
+  * Default value is `"💥"`
+
+`sev_emergency` selects the emoji/unicode character for Emergency severity
+
+[id="plugins-{type}s-{plugin}-sev_error"]
+===== `sev_error` 
+
+  * Value type is <<string,string>>
+  * Default value is `"❌"`
+
+`sev_error` selects the emoji/unicode character for Error severity
+
+[id="plugins-{type}s-{plugin}-sev_info"]
+===== `sev_info` 
+
+  * Value type is <<string,string>>
+  * Default value is `"ℹ️"`
+
+`sev_info` selects the emoji/unicode character for Informational severity
+
+[id="plugins-{type}s-{plugin}-sev_notice"]
+===== `sev_notice` 
+
+  * Value type is <<string,string>>
+  * Default value is `"👀"`
+
+`sev_notice` selects the emoji/unicode character for Notice severity
+
+[id="plugins-{type}s-{plugin}-sev_warning"]
+===== `sev_warning` 
+
+  * Value type is <<string,string>>
+  * Default value is `"⚠️"`
+
+`sev_warning` selects the emoji/unicode character for Warning severity
+
+[id="plugins-{type}s-{plugin}-target"]
+===== `target` 
+
+  * Value type is <<string,string>>
+  * Default value is `"emoji"`
+
+The target field you wish to populate with the emoji. The default
+is a field named `emoji`. Set this to the same value as the source (`field`)
+if you want to do a substitution, in this case filter will allways succeed.
+This will overwrite the old value of the source field!
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-filter-emoji.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-emoji'
-  s.version       = '1.0.0'
+  s.version         = '1.0.1'
   s.licenses      = ['Apache License (2.0)']
   s.summary         = "The emoji filter allows you to match field values with emoji and either replace them, or insert the emoji into a target field"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
    # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-emoji
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-08 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -50,6 +50,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- docs/index.asciidoc
 - lib/logstash/filters/emoji.rb
 - logstash-filter-emoji.gemspec
 - spec/filters/emoji_spec.rb