logstash-filter-prune 2.0.4 → 2.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/lib/logstash/filters/prune.rb +14 -14
  3. data/logstash-filter-prune.gemspec +1 -1
  4. metadata +9 -9
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 4a59227b4c4812eb86a83da6ec1ce49be8760bbf
4
- data.tar.gz: 4eb13cbdfae172074f1ac95a26d9348d02c62c8f
3
+ metadata.gz: 235b8f5dbe51477acb30bac94cf52b7f2bb7c63a
4
+ data.tar.gz: 71fb35971cbeedbf9929d240dbe831569b61578b
5
5
  SHA512:
6
- metadata.gz: 55a9e9b8e97e44af49c5989de10e693603aa0b1ee8f3a09caee0a80c05a9cde80429cb3bc8508278f62252a075849bd8dcf3f2fdcc8eb4d6ab85c7e94d4d9dad
7
- data.tar.gz: e0d0d675ab2c2de534161b24482deb7fefa87347c9b08fa7db7a1b5511f3d5e1a0bf3483549de4aa8f121248e85f4c7cb46df0e1f25a419c018d9ceced9b825b
6
+ metadata.gz: 0dbd0c0723ce8ecdddc46190215cb2c4cf9b10e5599944ba7416dc0f5d006746f77a51c68d7e02ebd717b9483009c07bda95e2a3b5a4ff6ad9afb5d62586560c
7
+ data.tar.gz: 240571b3dec2d17d99c9f3e1e7fdac0d016bb97c33edbb8b453af52fda2c72ba8154e6a88d711f4f8097c17169cf450b8b9ee41950301857863a614002980b69
data/lib/logstash/filters/prune.rb CHANGED
@@ -3,13 +3,19 @@ require "logstash/filters/base"
3
3
  require "logstash/namespace"
4
4
 
5
5
 
6
- # The prune filter is for pruning event data from `@fields` based on whitelist/blacklist
7
- # of field names or their values (names and values can also be regular expressions).
6
+ # The prune filter is for removing fields from events based on
7
+ # whitelists or blacklist of field names or their values (names and
8
+ # values can also be regular expressions).
9
+ #
10
+ # This can e.g. be useful if you have a <<plugins-filters-json,json>>
11
+ # or <<plugins-filters-kv,kv>> filter that creates a number of fields
12
+ # with names that you don't necessarily know the names of beforehand,
13
+ # and you only want to keep a subset of them.
8
14
 
9
15
  class LogStash::Filters::Prune < LogStash::Filters::Base
10
16
  config_name "prune"
11
17
 
12
- # Trigger whether configation fields and values should be interpolated for
18
+ # Trigger whether configuration fields and values should be interpolated for
13
19
  # dynamic values.
14
20
  # Probably adds some performance overhead. Defaults to false.
15
21
  config :interpolate, :validate => :boolean, :default => false
@@ -18,29 +24,25 @@ class LogStash::Filters::Prune < LogStash::Filters::Base
18
24
  # [source,ruby]
19
25
  # filter {
20
26
  # %PLUGIN% {
21
- # tags => [ "apache-accesslog" ]
22
27
  # whitelist_names => [ "method", "(referrer|status)", "${some}_field" ]
23
28
  # }
24
29
  # }
25
30
  config :whitelist_names, :validate => :array, :default => []
26
31
 
27
- # Exclude fields which names match specified regexps, by default exclude unresolved `%{field}` strings.
32
+ # Exclude fields whose names match specified regexps, by default exclude unresolved `%{field}` strings.
28
33
  # [source,ruby]
29
34
  # filter {
30
35
  # %PLUGIN% {
31
- # tags => [ "apache-accesslog" ]
32
36
  # blacklist_names => [ "method", "(referrer|status)", "${some}_field" ]
33
37
  # }
34
38
  # }
35
39
  config :blacklist_names, :validate => :array, :default => [ "%\{[^}]+\}" ]
36
40
 
37
- # Include specified fields only if their values match regexps.
38
- # In case field values are arrays, the fields are pruned on per array item
39
- # thus only matching array items will be included.
41
+ # Include specified fields only if their values match one of the supplied regular expressions.
42
+ # In case field values are arrays, each array item is matched against the regular expressions and only matching array items will be included.
40
43
  # [source,ruby]
41
44
  # filter {
42
45
  # %PLUGIN% {
43
- # tags => [ "apache-accesslog" ]
44
46
  # whitelist_values => [ "uripath", "/index.php",
45
47
  # "method", "(GET|POST)",
46
48
  # "status", "^[^2]" ]
@@ -48,13 +50,11 @@ class LogStash::Filters::Prune < LogStash::Filters::Base
48
50
  # }
49
51
  config :whitelist_values, :validate => :hash, :default => {}
50
52
 
51
- # Exclude specified fields if their values match regexps.
52
- # In case field values are arrays, the fields are pruned on per array item
53
- # in case all array items are matched whole field will be deleted.
53
+ # Exclude specified fields if their values match one of the supplied regular expressions.
54
+ # In case field values are arrays, each array item is matched against the regular expressions and matching array items will be excluded.
54
55
  # [source,ruby]
55
56
  # filter {
56
57
  # %PLUGIN% {
57
- # tags => [ "apache-accesslog" ]
58
58
  # blacklist_values => [ "uripath", "/index.php",
59
59
  # "method", "(HEAD|OPTIONS)",
60
60
  # "status", "^[^2]" ]
data/logstash-filter-prune.gemspec CHANGED
@@ -1,7 +1,7 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-filter-prune'
4
- s.version = '2.0.4'
4
+ s.version = '2.0.5'
5
5
  s.licenses = ['Apache License (2.0)']
6
6
  s.summary = "The prune filter is for pruning event data from fields based on whitelist/blacklist of field names or their values (names and values can also be regular expressions)"
7
7
  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"
metadata CHANGED
@@ -1,19 +1,19 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-filter-prune
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.4
4
+ version: 2.0.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-03-24 00:00:00.000000000 Z
11
+ date: 2016-03-30 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
15
15
  requirements:
16
- - - "~>"
16
+ - - ~>
17
17
  - !ruby/object:Gem::Version
18
18
  version: '1.0'
19
19
  name: logstash-core-plugin-api
@@ -21,13 +21,13 @@ dependencies:
21
21
  type: :runtime
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "~>"
24
+ - - ~>
25
25
  - !ruby/object:Gem::Version
26
26
  version: '1.0'
27
27
  - !ruby/object:Gem::Dependency
28
28
  requirement: !ruby/object:Gem::Requirement
29
29
  requirements:
30
- - - ">="
30
+ - - '>='
31
31
  - !ruby/object:Gem::Version
32
32
  version: '0'
33
33
  name: logstash-devutils
@@ -35,7 +35,7 @@ dependencies:
35
35
  type: :development
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - ">="
38
+ - - '>='
39
39
  - !ruby/object:Gem::Version
40
40
  version: '0'
41
41
  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
@@ -65,17 +65,17 @@ require_paths:
65
65
  - lib
66
66
  required_ruby_version: !ruby/object:Gem::Requirement
67
67
  requirements:
68
- - - ">="
68
+ - - '>='
69
69
  - !ruby/object:Gem::Version
70
70
  version: '0'
71
71
  required_rubygems_version: !ruby/object:Gem::Requirement
72
72
  requirements:
73
- - - ">="
73
+ - - '>='
74
74
  - !ruby/object:Gem::Version
75
75
  version: '0'
76
76
  requirements: []
77
77
  rubyforge_project:
78
- rubygems_version: 2.4.8
78
+ rubygems_version: 2.4.5
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: The prune filter is for pruning event data from fields based on whitelist/blacklist of field names or their values (names and values can also be regular expressions)