fluent-plugin-elastic-log 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.rubocop.yml +18 -0
- data/.ruby-version +1 -0
- data/Gemfile +5 -0
- data/LICENSE +202 -0
- data/README.md +43 -0
- data/Rakefile +19 -0
- data/fluent-plugin-elastic-log.gemspec +42 -0
- data/lib/fluent/plugin/elastic_log/granted_privileges_metric.rb +92 -0
- data/lib/fluent/plugin/out_elastic_audit_log_metric.rb +151 -0
- metadata +191 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 6ef4e2a586f566d7b309ef59d3c754bbccaffe6ba545eb31a4715683403f67af
|
4
|
+
data.tar.gz: fd5f957963bb03ca6bc4c2f456c8cf3c9053f35a53cadb2594280bc5899858c1
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 482176de12204c607485f80d2234106e20c6d618f8bd6c04155105ff335a20e8d04c71778e9e3bc1382e3efbacda46b2aa1c95fbc2521cebe061503970cdecab
|
7
|
+
data.tar.gz: f1a408614e789248cc1486ca9af9a11c3c8a66502c2bfbd3fe655e9dcd60f66bfbf3853082f99f78b368b39dfe15d67ae223b3a4574b1fdd8018e4651e1e3944
|
data/.rubocop.yml
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
require:
|
2
|
+
- rubocop-rake
|
3
|
+
|
4
|
+
AllCops:
|
5
|
+
TargetRubyVersion: 2.4
|
6
|
+
NewCops: enable
|
7
|
+
|
8
|
+
Metrics/BlockLength:
|
9
|
+
Exclude:
|
10
|
+
- fluent-plugin-elastic-log.gemspec
|
11
|
+
- test/**/*.rb
|
12
|
+
|
13
|
+
Metrics/MethodLength:
|
14
|
+
Max: 20
|
15
|
+
|
16
|
+
Naming/MethodParameterName:
|
17
|
+
Exclude:
|
18
|
+
- lib/fluent/plugin/out_elastic_audit_log_metric.rb
|
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.4.10
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,43 @@
|
|
1
|
+
# fluent-plugin-elastic-log
|
2
|
+
|
3
|
+
[Fluentd](https://fluentd.org/) filter plugin to do something.
|
4
|
+
|
5
|
+
TODO: write description for you plugin.
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
### RubyGems
|
10
|
+
|
11
|
+
```
|
12
|
+
$ gem install fluent-plugin-elastic-log
|
13
|
+
```
|
14
|
+
|
15
|
+
### Bundler
|
16
|
+
|
17
|
+
Add following line to your Gemfile:
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
gem "fluent-plugin-elastic-log"
|
21
|
+
```
|
22
|
+
|
23
|
+
And then execute:
|
24
|
+
|
25
|
+
```
|
26
|
+
$ bundle
|
27
|
+
```
|
28
|
+
|
29
|
+
## Configuration
|
30
|
+
|
31
|
+
You can generate configuration template:
|
32
|
+
|
33
|
+
```
|
34
|
+
$ fluent-plugin-config-format filter elastic-log
|
35
|
+
```
|
36
|
+
|
37
|
+
You can copy and paste generated documents here.
|
38
|
+
|
39
|
+
## Copyright
|
40
|
+
|
41
|
+
* Copyright(c) 2023- Thomas Tych
|
42
|
+
* License
|
43
|
+
* Apache License, Version 2.0
|
data/Rakefile
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'bundler'
|
4
|
+
Bundler::GemHelper.install_tasks
|
5
|
+
|
6
|
+
require 'rake/testtask'
|
7
|
+
require 'rubocop/rake_task'
|
8
|
+
require 'bump/tasks'
|
9
|
+
|
10
|
+
Rake::TestTask.new(:test) do |t|
|
11
|
+
t.libs.push('lib', 'test')
|
12
|
+
t.test_files = FileList['test/**/test_*.rb', 'test/**/*_test.rb']
|
13
|
+
t.verbose = true
|
14
|
+
t.warning = true
|
15
|
+
end
|
16
|
+
|
17
|
+
RuboCop::RakeTask.new
|
18
|
+
|
19
|
+
task default: %i[test rubocop]
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
lib = File.expand_path('lib', __dir__)
|
4
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'fluent-plugin-elastic-log'
|
8
|
+
spec.version = '0.2.0'
|
9
|
+
spec.authors = ['Thomas Tych']
|
10
|
+
spec.email = ['thomas.tych@gmail.com']
|
11
|
+
|
12
|
+
spec.summary = "fluentd plugins to process elastic logs.'"
|
13
|
+
spec.homepage = 'https://gitlab.com/ttych/fluent-plugin-elastic-log'
|
14
|
+
spec.license = 'Apache-2.0'
|
15
|
+
|
16
|
+
spec.required_ruby_version = '>= 2.4.0'
|
17
|
+
|
18
|
+
spec.files = Dir.chdir(__dir__) do
|
19
|
+
`git ls-files -z`.split("\x0").reject do |f|
|
20
|
+
(f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
|
21
|
+
end
|
22
|
+
end
|
23
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
24
|
+
spec.require_paths = ['lib']
|
25
|
+
|
26
|
+
# commented dependency use blocked old versions
|
27
|
+
# for compatibility with ruby 2.4.10
|
28
|
+
# for old version of td-agent
|
29
|
+
|
30
|
+
spec.add_development_dependency 'bump', '~> 0.10.0'
|
31
|
+
spec.add_development_dependency 'bundler', '~> 2.2'
|
32
|
+
spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
|
33
|
+
spec.add_development_dependency 'rake', '~> 13.0.6'
|
34
|
+
spec.add_development_dependency 'reek', '~> 6.0.6' # < 6.1.x to work with ruby 2.4.10
|
35
|
+
spec.add_development_dependency 'rubocop', '~> 1.12.1' # < 1.13.x to work with ruby 2.4.10
|
36
|
+
spec.add_development_dependency 'rubocop-rake', '~> 0.5.1' # < 0.6.x to work with ruby 2.4.10
|
37
|
+
spec.add_development_dependency 'test-unit', '~> 3.5.7'
|
38
|
+
|
39
|
+
spec.add_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
|
40
|
+
|
41
|
+
spec.metadata['rubygems_mfa_required'] = 'true'
|
42
|
+
end
|
@@ -0,0 +1,92 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'set'
|
4
|
+
require 'time'
|
5
|
+
|
6
|
+
require 'fluent/event'
|
7
|
+
|
8
|
+
module Fluent
|
9
|
+
module Plugin
|
10
|
+
module ElasticLog
|
11
|
+
# record to metric converter
|
12
|
+
# for GRANTED PRIVILEGE
|
13
|
+
class GrantedPrivilegesMetric
|
14
|
+
# REQUEST PRIVILEGE:
|
15
|
+
# cluster:
|
16
|
+
# admin/* => admin
|
17
|
+
# monitor/* => monitor
|
18
|
+
# indices:
|
19
|
+
# admin/* => admin
|
20
|
+
# data/read/* => read
|
21
|
+
# data/write/* => write
|
22
|
+
# monitor/* => monitor
|
23
|
+
PRIVILEGE_MAP = {
|
24
|
+
"cluster:admin/" => 'admin_query',
|
25
|
+
"cluster:monitor/" => 'monitor_query',
|
26
|
+
"indices:admin/" => 'admin_query',
|
27
|
+
"indices:data/read/" => 'read_query',
|
28
|
+
"indices:data/write/" => 'write_query',
|
29
|
+
"indices:monitor/" => 'monitor_query'
|
30
|
+
}.freeze
|
31
|
+
|
32
|
+
ILM_PATTERN = /^(.*)-\d{6}$/.freeze
|
33
|
+
|
34
|
+
attr_reader :time, :record, :conf
|
35
|
+
|
36
|
+
def initialize(time:, record:, conf:)
|
37
|
+
@time = time
|
38
|
+
@record = record
|
39
|
+
@conf = conf
|
40
|
+
end
|
41
|
+
|
42
|
+
def timestamp
|
43
|
+
begin
|
44
|
+
timestamp = Time.parse(record[:timestamp])
|
45
|
+
rescue StandardError
|
46
|
+
timestamp = time.to_time
|
47
|
+
end
|
48
|
+
|
49
|
+
return timestamp.utc.strftime('%s%3N') if conf.timestamp_format == :epochmillis
|
50
|
+
|
51
|
+
timestamp.utc.iso8601(3)
|
52
|
+
end
|
53
|
+
|
54
|
+
def metric_name
|
55
|
+
PRIVILEGE_MAP.each do |pattern, name|
|
56
|
+
return "#{name}_count" if record[:privilege].to_s.start_with?(pattern)
|
57
|
+
end
|
58
|
+
"unknown_count"
|
59
|
+
end
|
60
|
+
|
61
|
+
def base
|
62
|
+
{
|
63
|
+
'timestamp' => timestamp,
|
64
|
+
'metric_name' => metric_name,
|
65
|
+
'metric_value' => 1,
|
66
|
+
'tags_user' => record[:user],
|
67
|
+
'tags_cluster' => record[:cluster]
|
68
|
+
}
|
69
|
+
end
|
70
|
+
|
71
|
+
def indices
|
72
|
+
indices = record[:r_indices] || record[:indices] || [nil]
|
73
|
+
if conf.aggregate_ilm
|
74
|
+
indices = indices.inject(Set.new) do |acc, index|
|
75
|
+
aggregated_format = index[ILM_PATTERN, 1]
|
76
|
+
acc << (aggregated_format || index)
|
77
|
+
end.to_a
|
78
|
+
end
|
79
|
+
indices
|
80
|
+
end
|
81
|
+
|
82
|
+
def generate_event_stream
|
83
|
+
metric_es = MultiEventStream.new
|
84
|
+
indices.each do |indice|
|
85
|
+
metric_es.add(time, base.merge(tags_technical_name: indice))
|
86
|
+
end
|
87
|
+
metric_es
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
91
|
+
end
|
92
|
+
end
|
@@ -0,0 +1,151 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
#
|
4
|
+
# Copyright 2023- Thomas Tych
|
5
|
+
#
|
6
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
+
# you may not use this file except in compliance with the License.
|
8
|
+
# You may obtain a copy of the License at
|
9
|
+
#
|
10
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
+
#
|
12
|
+
# Unless required by applicable law or agreed to in writing, software
|
13
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
15
|
+
# See the License for the specific language governing permissions and
|
16
|
+
# limitations under the License.
|
17
|
+
|
18
|
+
require 'fluent/plugin/output'
|
19
|
+
require 'fluent/plugin/elastic_log/granted_privileges_metric'
|
20
|
+
|
21
|
+
module Fluent
|
22
|
+
module Plugin
|
23
|
+
# output plugin
|
24
|
+
# convert audit log to metric events
|
25
|
+
class ElasticAuditLogMetricOutput < Fluent::Plugin::Output
|
26
|
+
NAME = 'elastic_audit_log_metric'
|
27
|
+
|
28
|
+
Fluent::Plugin.register_output(NAME, self)
|
29
|
+
|
30
|
+
helpers :event_emitter
|
31
|
+
|
32
|
+
ALLOWED_CATEGORIES = %w[GRANTED_PRIVILEGES].freeze
|
33
|
+
# FAILED_LOGIN AUTHENTICATED MISSING_PRIVILEGES SSL_EXCEPTION
|
34
|
+
# OPENDISTRO_SECURITY_INDEX_ATTEMPT BAD_HEADERS
|
35
|
+
|
36
|
+
DEFAULT_CATEGORY_KEY = 'audit_category'
|
37
|
+
DEFAULT_LAYER_KEY = 'audit_request_layer'
|
38
|
+
DEFAULT_REQUEST_TYPE = 'audit_transport_request_type'
|
39
|
+
DEFAULT_CLUSTER_KEY = 'audit_cluster_name'
|
40
|
+
DEFAULT_USER_KEY = 'audit_request_effective_user'
|
41
|
+
DEFAULT_INDICES_KEY = 'audit_trace_indices'
|
42
|
+
DEFAULT_R_INDICES_KEY = 'audit_trace_resolved_indices'
|
43
|
+
DEFAULT_TIMESTAMP_KEY = '@timestamp'
|
44
|
+
DEFAULT_PRIVILEGE_KEY = 'audit_request_privilege'
|
45
|
+
|
46
|
+
# REQUEST PRIVILEGE:
|
47
|
+
# cluster:
|
48
|
+
# admin/* => admin
|
49
|
+
# monitor/* => monitor
|
50
|
+
# indices:
|
51
|
+
# admin/* => admin
|
52
|
+
# data/read/* => read
|
53
|
+
# data/write/* => write
|
54
|
+
# monitor/* => monitor
|
55
|
+
|
56
|
+
desc 'Tag to emit metric events on'
|
57
|
+
config_param :tag, :string, default: nil
|
58
|
+
desc 'Categories selected to be converted to metrics'
|
59
|
+
config_param :categories, :array, default: ALLOWED_CATEGORIES, value_type: :string
|
60
|
+
|
61
|
+
desc 'Category key'
|
62
|
+
config_param :category_key, :string, default: DEFAULT_CATEGORY_KEY
|
63
|
+
desc 'Layer key'
|
64
|
+
config_param :layer_key, :string, default: DEFAULT_LAYER_KEY
|
65
|
+
desc 'Request type key'
|
66
|
+
config_param :request_type_key, :string, default: DEFAULT_REQUEST_TYPE
|
67
|
+
desc 'Cluster key'
|
68
|
+
config_param :cluster_key, :string, default: DEFAULT_CLUSTER_KEY
|
69
|
+
desc 'Request user key'
|
70
|
+
config_param :user_key, :string, default: DEFAULT_USER_KEY
|
71
|
+
desc 'Indices key'
|
72
|
+
config_param :indices_key, :string, default: DEFAULT_INDICES_KEY
|
73
|
+
desc 'Resolved indices key'
|
74
|
+
config_param :r_indices_key, :string, default: DEFAULT_R_INDICES_KEY
|
75
|
+
desc 'Timestamp key'
|
76
|
+
config_param :timestamp_key, :string, default: DEFAULT_TIMESTAMP_KEY
|
77
|
+
desc 'Request privilege key'
|
78
|
+
config_param :privilege_key, :string, default: DEFAULT_PRIVILEGE_KEY
|
79
|
+
|
80
|
+
desc 'Timestamp format'
|
81
|
+
config_param :timestamp_format, :enum, list: %i[iso epochmillis], default: :iso
|
82
|
+
|
83
|
+
desc 'Aggregate ILM'
|
84
|
+
config_param :aggregate_ilm, :bool, default: true
|
85
|
+
|
86
|
+
def configure(conf)
|
87
|
+
super
|
88
|
+
raise Fluent::ConfigError, "#{NAME}: tag is mandatory" if !tag || tag.to_s.empty?
|
89
|
+
|
90
|
+
check_configuration_keys
|
91
|
+
|
92
|
+
unsupported_categories = categories - ALLOWED_CATEGORIES
|
93
|
+
unless unsupported_categories.empty?
|
94
|
+
log.warn("#{NAME}: unsupported categories #{unsupported_categories}")
|
95
|
+
@categories = categories - unsupported_categories
|
96
|
+
end
|
97
|
+
|
98
|
+
true
|
99
|
+
end
|
100
|
+
|
101
|
+
def check_configuration_keys
|
102
|
+
keys = %w[category layer request_type cluster user indices r_indices timestamp privilege]
|
103
|
+
invalid_keys = keys.each_with_object([]) do |key, invalid|
|
104
|
+
key_label = "#{key}_key"
|
105
|
+
key_value = send(key_label)
|
106
|
+
invalid << key_label if !key_value || key_value.to_s.empty?
|
107
|
+
end
|
108
|
+
|
109
|
+
raise Fluent::ConfigError, "#{NAME}: #{invalid_keys} are empty" if invalid_keys.any?
|
110
|
+
end
|
111
|
+
|
112
|
+
def process(_tag, es)
|
113
|
+
es.each do |time, record|
|
114
|
+
next unless record
|
115
|
+
next unless (category = record[category_key])
|
116
|
+
next unless ALLOWED_CATEGORIES.include? category
|
117
|
+
|
118
|
+
event_time = Fluent::EventTime.from_time(time)
|
119
|
+
metric_es = send("generate_#{category.downcase}_metrics_for", event_time, record)
|
120
|
+
router.emit_stream(tag, metric_es) if metric_es
|
121
|
+
end
|
122
|
+
end
|
123
|
+
|
124
|
+
# es = Fluent::MultiEventStream.new
|
125
|
+
# router.emit_stream(tag, es)
|
126
|
+
|
127
|
+
private
|
128
|
+
|
129
|
+
# rubocop:disable Metrics/AbcSize
|
130
|
+
def generate_granted_privileges_metrics_for(time, record)
|
131
|
+
return unless record[privilege_key]
|
132
|
+
|
133
|
+
Fluent::Plugin::ElasticLog::GrantedPrivilegesMetric.new(
|
134
|
+
time: time,
|
135
|
+
record: {
|
136
|
+
timestamp: record[timestamp_key],
|
137
|
+
privilege: record[privilege_key],
|
138
|
+
user: record[user_key],
|
139
|
+
cluster: record[cluster_key],
|
140
|
+
indices: record[indices_key],
|
141
|
+
r_indices: record[r_indices_key],
|
142
|
+
layer: record[layer_key],
|
143
|
+
request_type: record[request_type_key]
|
144
|
+
},
|
145
|
+
conf: self
|
146
|
+
).generate_event_stream
|
147
|
+
end
|
148
|
+
# rubocop:enable Metrics/AbcSize
|
149
|
+
end
|
150
|
+
end
|
151
|
+
end
|
metadata
ADDED
@@ -0,0 +1,191 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-elastic-log
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.2.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Thomas Tych
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2023-06-08 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bump
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.10.0
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.10.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '2.2'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '2.2'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: byebug
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '11.1'
|
48
|
+
- - ">="
|
49
|
+
- !ruby/object:Gem::Version
|
50
|
+
version: 11.1.3
|
51
|
+
type: :development
|
52
|
+
prerelease: false
|
53
|
+
version_requirements: !ruby/object:Gem::Requirement
|
54
|
+
requirements:
|
55
|
+
- - "~>"
|
56
|
+
- !ruby/object:Gem::Version
|
57
|
+
version: '11.1'
|
58
|
+
- - ">="
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: 11.1.3
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
name: rake
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - "~>"
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: 13.0.6
|
68
|
+
type: :development
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: 13.0.6
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: reek
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: 6.0.6
|
82
|
+
type: :development
|
83
|
+
prerelease: false
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: 6.0.6
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
name: rubocop
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - "~>"
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: 1.12.1
|
96
|
+
type: :development
|
97
|
+
prerelease: false
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - "~>"
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: 1.12.1
|
103
|
+
- !ruby/object:Gem::Dependency
|
104
|
+
name: rubocop-rake
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - "~>"
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: 0.5.1
|
110
|
+
type: :development
|
111
|
+
prerelease: false
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
113
|
+
requirements:
|
114
|
+
- - "~>"
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: 0.5.1
|
117
|
+
- !ruby/object:Gem::Dependency
|
118
|
+
name: test-unit
|
119
|
+
requirement: !ruby/object:Gem::Requirement
|
120
|
+
requirements:
|
121
|
+
- - "~>"
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: 3.5.7
|
124
|
+
type: :development
|
125
|
+
prerelease: false
|
126
|
+
version_requirements: !ruby/object:Gem::Requirement
|
127
|
+
requirements:
|
128
|
+
- - "~>"
|
129
|
+
- !ruby/object:Gem::Version
|
130
|
+
version: 3.5.7
|
131
|
+
- !ruby/object:Gem::Dependency
|
132
|
+
name: fluentd
|
133
|
+
requirement: !ruby/object:Gem::Requirement
|
134
|
+
requirements:
|
135
|
+
- - ">="
|
136
|
+
- !ruby/object:Gem::Version
|
137
|
+
version: 0.14.10
|
138
|
+
- - "<"
|
139
|
+
- !ruby/object:Gem::Version
|
140
|
+
version: '2'
|
141
|
+
type: :runtime
|
142
|
+
prerelease: false
|
143
|
+
version_requirements: !ruby/object:Gem::Requirement
|
144
|
+
requirements:
|
145
|
+
- - ">="
|
146
|
+
- !ruby/object:Gem::Version
|
147
|
+
version: 0.14.10
|
148
|
+
- - "<"
|
149
|
+
- !ruby/object:Gem::Version
|
150
|
+
version: '2'
|
151
|
+
description:
|
152
|
+
email:
|
153
|
+
- thomas.tych@gmail.com
|
154
|
+
executables: []
|
155
|
+
extensions: []
|
156
|
+
extra_rdoc_files: []
|
157
|
+
files:
|
158
|
+
- ".rubocop.yml"
|
159
|
+
- ".ruby-version"
|
160
|
+
- Gemfile
|
161
|
+
- LICENSE
|
162
|
+
- README.md
|
163
|
+
- Rakefile
|
164
|
+
- fluent-plugin-elastic-log.gemspec
|
165
|
+
- lib/fluent/plugin/elastic_log/granted_privileges_metric.rb
|
166
|
+
- lib/fluent/plugin/out_elastic_audit_log_metric.rb
|
167
|
+
homepage: https://gitlab.com/ttych/fluent-plugin-elastic-log
|
168
|
+
licenses:
|
169
|
+
- Apache-2.0
|
170
|
+
metadata:
|
171
|
+
rubygems_mfa_required: 'true'
|
172
|
+
post_install_message:
|
173
|
+
rdoc_options: []
|
174
|
+
require_paths:
|
175
|
+
- lib
|
176
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
177
|
+
requirements:
|
178
|
+
- - ">="
|
179
|
+
- !ruby/object:Gem::Version
|
180
|
+
version: 2.4.0
|
181
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
182
|
+
requirements:
|
183
|
+
- - ">="
|
184
|
+
- !ruby/object:Gem::Version
|
185
|
+
version: '0'
|
186
|
+
requirements: []
|
187
|
+
rubygems_version: 3.1.6
|
188
|
+
signing_key:
|
189
|
+
specification_version: 4
|
190
|
+
summary: fluentd plugins to process elastic logs.'
|
191
|
+
test_files: []
|