fluent-plugin-telemetry-iosxe 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +3 -0
- data/Gemfile.lock +58 -0
- data/LICENSE +202 -0
- data/README.md +140 -0
- data/Rakefile +13 -0
- data/fluent-plugin-telemetry-iosxe.gemspec +30 -0
- data/lib/fluent/plugin/in_telemetry_iosxe.rb +181 -0
- data/test/helper.rb +9 -0
- data/test/plugin/test_in_telemetry_iosxe.rb +36 -0
- metadata +159 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: d2191fa2623bc0df51d16941183c3945bf4ed73c
|
4
|
+
data.tar.gz: cc8725b6a2244b78f3c71dfef9e9d134760be0d1
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 99a5f72f68f5a2d614f54ae72b07149c70f50dfcd8634e906902f653c7f36f09d76617941cefa7f10d9b3e7cb5642c41a3d6343967a49eb4cf78c9688f454308
|
7
|
+
data.tar.gz: 7a09e58e2810f6dbe4d96db9cccd06639a103d560b8608b85f296d2a80b42475318cf4ebc03ec1e1b8f4da2fa0c6d4832787a55311f5ffa84024d2aee921b742
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
fluent-plugin-telemetry-iosxe (0.0.1)
|
5
|
+
fluentd (>= 0.14.10, < 2)
|
6
|
+
net-ssh (~> 4.2.0)
|
7
|
+
nokogiri (~> 1.8.1)
|
8
|
+
nori (~> 2.6.0)
|
9
|
+
|
10
|
+
GEM
|
11
|
+
remote: https://rubygems.org/
|
12
|
+
specs:
|
13
|
+
cool.io (1.5.3)
|
14
|
+
fluentd (1.0.1)
|
15
|
+
cool.io (>= 1.4.5, < 2.0.0)
|
16
|
+
http_parser.rb (>= 0.5.1, < 0.7.0)
|
17
|
+
msgpack (>= 0.7.0, < 2.0.0)
|
18
|
+
ruby_dig (~> 0.0.2)
|
19
|
+
serverengine (>= 2.0.4, < 3.0.0)
|
20
|
+
sigdump (~> 0.2.2)
|
21
|
+
strptime (~> 0.1)
|
22
|
+
tzinfo (~> 1.0)
|
23
|
+
tzinfo-data (~> 1.0)
|
24
|
+
yajl-ruby (~> 1.0)
|
25
|
+
http_parser.rb (0.6.0)
|
26
|
+
mini_portile2 (2.3.0)
|
27
|
+
msgpack (1.2.0)
|
28
|
+
net-ssh (4.2.0)
|
29
|
+
nokogiri (1.8.1)
|
30
|
+
mini_portile2 (~> 2.3.0)
|
31
|
+
nori (2.6.0)
|
32
|
+
power_assert (1.1.1)
|
33
|
+
rake (12.3.0)
|
34
|
+
ruby_dig (0.0.2)
|
35
|
+
serverengine (2.0.5)
|
36
|
+
sigdump (~> 0.2.2)
|
37
|
+
sigdump (0.2.4)
|
38
|
+
strptime (0.1.9)
|
39
|
+
test-unit (3.2.6)
|
40
|
+
power_assert
|
41
|
+
thread_safe (0.3.6)
|
42
|
+
tzinfo (1.2.4)
|
43
|
+
thread_safe (~> 0.1)
|
44
|
+
tzinfo-data (1.2017.3)
|
45
|
+
tzinfo (>= 1.0.0)
|
46
|
+
yajl-ruby (1.3.1)
|
47
|
+
|
48
|
+
PLATFORMS
|
49
|
+
ruby
|
50
|
+
|
51
|
+
DEPENDENCIES
|
52
|
+
bundler (~> 1.14)
|
53
|
+
fluent-plugin-telemetry-iosxe!
|
54
|
+
rake (~> 12.0)
|
55
|
+
test-unit (~> 3.0)
|
56
|
+
|
57
|
+
BUNDLED WITH
|
58
|
+
1.16.0
|
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,140 @@
|
|
1
|
+
# fluent-plugin-telemetry-iosxe
|
2
|
+
|
3
|
+
[Fluentd](https://fluentd.org/) input plugin to collect IOS-XE telemetry.
|
4
|
+
|
5
|
+
## Requirements
|
6
|
+
|
7
|
+
`fluent-plugin-telemetry-iosxe` supports fluentd-0.14.0 or later.
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
### RubyGems
|
12
|
+
|
13
|
+
```
|
14
|
+
$ gem install fluent-plugin-telemetry-iosxe
|
15
|
+
```
|
16
|
+
|
17
|
+
### Bundler
|
18
|
+
|
19
|
+
Add following line to your Gemfile:
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
gem "fluent-plugin-telemetry-iosxe"
|
23
|
+
```
|
24
|
+
|
25
|
+
And then execute:
|
26
|
+
|
27
|
+
```
|
28
|
+
$ bundle
|
29
|
+
```
|
30
|
+
|
31
|
+
## Configuration
|
32
|
+
|
33
|
+
|
34
|
+
### Configuration Example 1
|
35
|
+
|
36
|
+
Collect telemetry input and then output to stdout.
|
37
|
+
|
38
|
+
```
|
39
|
+
<source>
|
40
|
+
@type telemetry_iosxe
|
41
|
+
server 192.0.2.1
|
42
|
+
port 830
|
43
|
+
user admin
|
44
|
+
password admin
|
45
|
+
xpath_filter /ios-emul-oper-db:ios-emul-oper-db/cpu-usage/five-seconds
|
46
|
+
tag cpu-usage-five-seconds
|
47
|
+
period 500
|
48
|
+
@label @telemetry
|
49
|
+
</source>
|
50
|
+
<label @telemetry>
|
51
|
+
<match **>
|
52
|
+
@type stdout
|
53
|
+
</match>
|
54
|
+
</label>
|
55
|
+
```
|
56
|
+
|
57
|
+
### Configuration Example 2
|
58
|
+
|
59
|
+
Collect telemetry input and then output to InfluxDB with flattening input.
|
60
|
+
|
61
|
+
```
|
62
|
+
<source>
|
63
|
+
@type telemetry_iosxe
|
64
|
+
server 192.0.2.1
|
65
|
+
port 830
|
66
|
+
xpath_filter /ios-emul-oper-db:ios-emul-oper-db/cpu-usage/five-seconds
|
67
|
+
user admin
|
68
|
+
password admin
|
69
|
+
tag cpu-usage-five-seconds
|
70
|
+
period 500
|
71
|
+
@label @telemetry
|
72
|
+
</source>
|
73
|
+
<label @telemetry>
|
74
|
+
<filter **>
|
75
|
+
@type flatten_hash
|
76
|
+
separator .
|
77
|
+
</filter>
|
78
|
+
<match **>
|
79
|
+
@type influxdb
|
80
|
+
host localhost
|
81
|
+
port 8086
|
82
|
+
dbname telemetry
|
83
|
+
user admin
|
84
|
+
password admin
|
85
|
+
time_precision s
|
86
|
+
auto_tags true
|
87
|
+
</match>
|
88
|
+
</label>
|
89
|
+
```
|
90
|
+
|
91
|
+
**server**
|
92
|
+
|
93
|
+
IP address to subscribe to Telemetry publisher.
|
94
|
+
|
95
|
+
**port**
|
96
|
+
|
97
|
+
TCP port number to subscribe to Telemetry publisher.
|
98
|
+
(default: 830)
|
99
|
+
|
100
|
+
**xpath_filter**
|
101
|
+
|
102
|
+
XPath filter to specify the information element to subscribe to.
|
103
|
+
|
104
|
+
**user**
|
105
|
+
|
106
|
+
Username to subscribe to Telemetry publisher.
|
107
|
+
(default: admin)
|
108
|
+
|
109
|
+
**password**
|
110
|
+
|
111
|
+
Password to subscribe to Telemetry publisher.
|
112
|
+
(default: admin)
|
113
|
+
|
114
|
+
**parser**
|
115
|
+
|
116
|
+
XML parser(REXML or Nokogiri) to parse XML encoded messages.
|
117
|
+
(default: Nokogiri)
|
118
|
+
|
119
|
+
**tag**
|
120
|
+
|
121
|
+
Fluentd tag.
|
122
|
+
|
123
|
+
**period**
|
124
|
+
|
125
|
+
Period in centiseconds (1/100 of a second).
|
126
|
+
|
127
|
+
**strip_namespaces**
|
128
|
+
|
129
|
+
Strip XML namespaces.
|
130
|
+
(default: true)
|
131
|
+
|
132
|
+
**typecast_integer**
|
133
|
+
|
134
|
+
Typecast string-typed integer value to integer.
|
135
|
+
(default: true)
|
136
|
+
|
137
|
+
**typecast_float**
|
138
|
+
|
139
|
+
Typecast string-typed float value to float.
|
140
|
+
(default: true)
|
data/Rakefile
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
require "bundler"
|
2
|
+
Bundler::GemHelper.install_tasks
|
3
|
+
|
4
|
+
require "rake/testtask"
|
5
|
+
|
6
|
+
Rake::TestTask.new(:test) do |t|
|
7
|
+
t.libs.push("lib", "test")
|
8
|
+
t.test_files = FileList["test/**/test_*.rb"]
|
9
|
+
t.verbose = true
|
10
|
+
t.warning = true
|
11
|
+
end
|
12
|
+
|
13
|
+
task default: [:test]
|
@@ -0,0 +1,30 @@
|
|
1
|
+
lib = File.expand_path("../lib", __FILE__)
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
3
|
+
|
4
|
+
Gem::Specification.new do |spec|
|
5
|
+
spec.name = "fluent-plugin-telemetry-iosxe"
|
6
|
+
spec.version = "0.0.1"
|
7
|
+
spec.authors = ["Tetsuhiro Sato"]
|
8
|
+
spec.email = ["tetsusat@cisco.com"]
|
9
|
+
|
10
|
+
spec.summary = %q{Fluentd input plugin to collect IOS-XR telemetry.}
|
11
|
+
spec.description = spec.summary
|
12
|
+
spec.homepage = "https://github.com/tetsusat/fluent-plugin-telemetry-iosxe"
|
13
|
+
spec.license = "Apache-2.0"
|
14
|
+
|
15
|
+
test_files, files = `git ls-files -z`.split("\x0").partition do |f|
|
16
|
+
f.match(%r{^(test|spec|features)/})
|
17
|
+
end
|
18
|
+
spec.files = files
|
19
|
+
spec.executables = files.grep(%r{^bin/}) { |f| File.basename(f) }
|
20
|
+
spec.test_files = test_files
|
21
|
+
spec.require_paths = ["lib"]
|
22
|
+
|
23
|
+
spec.add_development_dependency "bundler", "~> 1.14"
|
24
|
+
spec.add_development_dependency "rake", "~> 12.0"
|
25
|
+
spec.add_development_dependency "test-unit", "~> 3.0"
|
26
|
+
spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
|
27
|
+
spec.add_runtime_dependency "net-ssh", ["~> 4.2.0"]
|
28
|
+
spec.add_runtime_dependency "nokogiri", ["~> 1.8.1"]
|
29
|
+
spec.add_runtime_dependency "nori", ["~> 2.6.0"]
|
30
|
+
end
|
@@ -0,0 +1,181 @@
|
|
1
|
+
require "fluent/input"
|
2
|
+
require "time"
|
3
|
+
require "net/ssh"
|
4
|
+
require "nori"
|
5
|
+
|
6
|
+
class String
|
7
|
+
def is_i?
|
8
|
+
self.to_i.to_s == self
|
9
|
+
end
|
10
|
+
|
11
|
+
def is_f?
|
12
|
+
self.to_f.to_s == self
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
module Fluent
|
17
|
+
class TelemetryIosxeInput < Input
|
18
|
+
Fluent::Plugin.register_input("telemetry_iosxe", self)
|
19
|
+
config_param :server, :string
|
20
|
+
config_param :port, :integer, default: 830
|
21
|
+
config_param :user, :string, default: "admin"
|
22
|
+
config_param :password, :string, default: "admin", secret: true
|
23
|
+
config_param :parser, :enum,list: [:rexml, :nokogiri], default: :nokogiri
|
24
|
+
config_param :xpath_filter, :string
|
25
|
+
config_param :tag, :string
|
26
|
+
config_param :period, :integer
|
27
|
+
config_param :strip_namespaces, :bool, default: true
|
28
|
+
config_param :typecast_integer, :bool, default: true
|
29
|
+
config_param :typecast_float, :bool, default: true
|
30
|
+
|
31
|
+
def configure(conf)
|
32
|
+
super
|
33
|
+
end
|
34
|
+
|
35
|
+
def start
|
36
|
+
super
|
37
|
+
@sigint = false
|
38
|
+
trap :INT do
|
39
|
+
log.info "got SIGINT ..."
|
40
|
+
@sigint = true
|
41
|
+
end
|
42
|
+
@hello_done = false
|
43
|
+
@buffer = ""
|
44
|
+
@parser = Nori.new(:parser => @parser, :advanced_typecasting => false)
|
45
|
+
hello = <<-EOS
|
46
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
47
|
+
<hello xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
|
48
|
+
<capabilities>
|
49
|
+
<capability>urn:ietf:params:netconf:base:1.0</capability>
|
50
|
+
</capabilities>
|
51
|
+
</hello>]]>]]>
|
52
|
+
EOS
|
53
|
+
|
54
|
+
subscription = <<-EOS
|
55
|
+
<?xml version="1.0" encoding="utf-8"?>
|
56
|
+
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
|
57
|
+
<establish-subscription xmlns="urn:ietf:params:xml:ns:yang:ietf-event-notifications" xmlns:yp="urn:ietf:params:xml:ns:yang:ietf-yang-push">
|
58
|
+
<stream>yp:yang-push</stream>
|
59
|
+
<yp:xpath-filter>#{@xpath_filter}</yp:xpath-filter>
|
60
|
+
<yp:period>#{@period}</yp:period>
|
61
|
+
</establish-subscription>
|
62
|
+
</rpc>
|
63
|
+
EOS
|
64
|
+
|
65
|
+
@ssh = Net::SSH.start(@server, @user, :port => @port, :password => @password, :timeout => 10)
|
66
|
+
@channel = @ssh.open_channel do |channel|
|
67
|
+
channel.subsystem("netconf") do |ch, success|
|
68
|
+
raise "subsystem could not be started" unless success
|
69
|
+
ch.on_data do |c, data|
|
70
|
+
log.debug "on data ..."
|
71
|
+
log.debug data
|
72
|
+
receive_data(data)
|
73
|
+
end
|
74
|
+
ch.on_close do |c|
|
75
|
+
log.debug "on close ..."
|
76
|
+
end
|
77
|
+
ch.on_eof do |c|
|
78
|
+
log.debug "on eof ..."
|
79
|
+
end
|
80
|
+
log.info "send hello"
|
81
|
+
ch.send_data(hello)
|
82
|
+
log.info "send subscription"
|
83
|
+
ch.send_data(subscription)
|
84
|
+
end
|
85
|
+
end
|
86
|
+
@ssh.loop(1) { not @sigint } # if we get sigint, we need to end loop
|
87
|
+
end
|
88
|
+
|
89
|
+
def shutdown
|
90
|
+
log.info "shutdown ..."
|
91
|
+
delete_subscription = <<-EOS
|
92
|
+
<?xml version="1.0" encoding="utf-8"?>
|
93
|
+
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
|
94
|
+
<delete-subscription xmlns="urn:ietf:params:xml:ns:yang:ietf-event-notifications" xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0">
|
95
|
+
<subscription-id>#{@subscription_id}</subscription-id>
|
96
|
+
</delete-subscription>
|
97
|
+
</rpc>]]>]]>
|
98
|
+
EOS
|
99
|
+
close_session = <<-EOS
|
100
|
+
<?xml version="1.0" encoding="utf-8"?>
|
101
|
+
<rpc message-id="101" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
|
102
|
+
<close-session/>
|
103
|
+
</rpc>]]>]]>
|
104
|
+
EOS
|
105
|
+
@channel.send_data(delete_subscription)
|
106
|
+
@channel.send_data(close_session)
|
107
|
+
@ssh.close
|
108
|
+
super
|
109
|
+
end
|
110
|
+
|
111
|
+
protected
|
112
|
+
def receive_data(data)
|
113
|
+
log.info "receive data ..."
|
114
|
+
if data.include?("]]>]]>")
|
115
|
+
msg = data.split("]]>]]>")
|
116
|
+
if msg.empty? # this could happen when data is exactly "]]>]]>"
|
117
|
+
if @hello_done
|
118
|
+
parse_msg()
|
119
|
+
else
|
120
|
+
parse_hello()
|
121
|
+
@hello_done = true
|
122
|
+
end
|
123
|
+
else
|
124
|
+
for m in msg
|
125
|
+
@buffer << m
|
126
|
+
if @hello_done
|
127
|
+
parse_msg()
|
128
|
+
else
|
129
|
+
parse_hello()
|
130
|
+
@hello_done = true
|
131
|
+
end
|
132
|
+
end
|
133
|
+
end
|
134
|
+
else
|
135
|
+
@buffer << data
|
136
|
+
end
|
137
|
+
end
|
138
|
+
|
139
|
+
def parse_hello
|
140
|
+
hello = @parser.parse(@buffer)
|
141
|
+
log.debug hello
|
142
|
+
@session_id = hello["hello"]["session_id"]
|
143
|
+
log.info "Session ID is #{@session_id}"
|
144
|
+
@buffer = ""
|
145
|
+
end
|
146
|
+
|
147
|
+
def parse_msg
|
148
|
+
h = @parser.parse(@buffer)
|
149
|
+
log.debug h
|
150
|
+
if h["notification"]
|
151
|
+
iso8601_time = h["notification"]["eventTime"]
|
152
|
+
unix_time = Time.iso8601(iso8601_time).to_i
|
153
|
+
content = h["notification"]["push_update"]["datastore_contents_xml"]
|
154
|
+
traverse(content) do |node, key, parent|
|
155
|
+
if @typecast_integer && node.is_i?
|
156
|
+
parent[key] = node.to_i unless parent.nil?
|
157
|
+
elsif @typecast_float && node.is_f?
|
158
|
+
parent[key] = node.to_f unless parent.nil?
|
159
|
+
end
|
160
|
+
end
|
161
|
+
router.emit(@tag, unix_time, content)
|
162
|
+
elsif h["rpc_reply"] && h["rpc_reply"]["subscription_id"]
|
163
|
+
@subscription_id = h["rpc_reply"]["subscription_id"]
|
164
|
+
log.info "Subscription ID is #{@subscription_id}"
|
165
|
+
end
|
166
|
+
@buffer = ""
|
167
|
+
end
|
168
|
+
|
169
|
+
def traverse(obj, key=nil, parent=nil, &blk)
|
170
|
+
case obj
|
171
|
+
when Hash
|
172
|
+
obj.reject! { |k,v| k == "@xmlns" } if @strip_namespaces
|
173
|
+
obj.each { |k,v| traverse(v, k, obj, &blk) }
|
174
|
+
when Array
|
175
|
+
obj.each_with_index { |v,k| traverse(v, k, obj, &blk) }
|
176
|
+
else
|
177
|
+
blk.call(obj, key, parent)
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|
181
|
+
end
|
data/test/helper.rb
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
|
2
|
+
require "test-unit"
|
3
|
+
require "fluent/test"
|
4
|
+
require "fluent/test/driver/input"
|
5
|
+
require "fluent/test/helpers"
|
6
|
+
require "fluent/plugin/in_telemetry_iosxe"
|
7
|
+
|
8
|
+
Test::Unit::TestCase.include(Fluent::Test::Helpers)
|
9
|
+
Test::Unit::TestCase.extend(Fluent::Test::Helpers)
|
@@ -0,0 +1,36 @@
|
|
1
|
+
require "helper"
|
2
|
+
|
3
|
+
class TelemetryIosxeInputTest < Test::Unit::TestCase
|
4
|
+
def setup
|
5
|
+
Fluent::Test.setup # this is required to setup router and others
|
6
|
+
end
|
7
|
+
|
8
|
+
# default configuration for tests
|
9
|
+
CONFIG = %[
|
10
|
+
server 127.0.0.1
|
11
|
+
port 830
|
12
|
+
xpath_filter /ios-emul-oper-db:ios-emul-oper-db/cpu-usage/five-seconds
|
13
|
+
period 500
|
14
|
+
tag cpu-usage-five-seconds
|
15
|
+
]
|
16
|
+
|
17
|
+
def create_driver(conf = CONFIG)
|
18
|
+
Fluent::Test::Driver::Input.new(Fluent::TelemetryIosxeInput).configure(conf)
|
19
|
+
end
|
20
|
+
|
21
|
+
sub_test_case "configuration" do
|
22
|
+
test "configuration" do
|
23
|
+
d = create_driver
|
24
|
+
assert_equal "127.0.0.1", d.instance.server
|
25
|
+
assert_equal 830, d.instance.port
|
26
|
+
assert_equal "admin", d.instance.user
|
27
|
+
assert_equal "admin", d.instance.password
|
28
|
+
assert_equal :nokogiri, d.instance.parser
|
29
|
+
assert_equal "/ios-emul-oper-db:ios-emul-oper-db/cpu-usage/five-seconds", d.instance.xpath_filter
|
30
|
+
assert_equal 500, d.instance.period
|
31
|
+
assert_equal true, d.instance.strip_namespaces
|
32
|
+
assert_equal true, d.instance.typecast_integer
|
33
|
+
assert_equal "cpu-usage-five-seconds", d.instance.tag
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
metadata
ADDED
@@ -0,0 +1,159 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: fluent-plugin-telemetry-iosxe
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Tetsuhiro Sato
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-12-20 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.14'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.14'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '12.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '12.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: test-unit
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: fluentd
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 0.14.10
|
62
|
+
- - "<"
|
63
|
+
- !ruby/object:Gem::Version
|
64
|
+
version: '2'
|
65
|
+
type: :runtime
|
66
|
+
prerelease: false
|
67
|
+
version_requirements: !ruby/object:Gem::Requirement
|
68
|
+
requirements:
|
69
|
+
- - ">="
|
70
|
+
- !ruby/object:Gem::Version
|
71
|
+
version: 0.14.10
|
72
|
+
- - "<"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '2'
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: net-ssh
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: 4.2.0
|
82
|
+
type: :runtime
|
83
|
+
prerelease: false
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: 4.2.0
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
name: nokogiri
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - "~>"
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: 1.8.1
|
96
|
+
type: :runtime
|
97
|
+
prerelease: false
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - "~>"
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: 1.8.1
|
103
|
+
- !ruby/object:Gem::Dependency
|
104
|
+
name: nori
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - "~>"
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: 2.6.0
|
110
|
+
type: :runtime
|
111
|
+
prerelease: false
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
113
|
+
requirements:
|
114
|
+
- - "~>"
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: 2.6.0
|
117
|
+
description: Fluentd input plugin to collect IOS-XR telemetry.
|
118
|
+
email:
|
119
|
+
- tetsusat@cisco.com
|
120
|
+
executables: []
|
121
|
+
extensions: []
|
122
|
+
extra_rdoc_files: []
|
123
|
+
files:
|
124
|
+
- Gemfile
|
125
|
+
- Gemfile.lock
|
126
|
+
- LICENSE
|
127
|
+
- README.md
|
128
|
+
- Rakefile
|
129
|
+
- fluent-plugin-telemetry-iosxe.gemspec
|
130
|
+
- lib/fluent/plugin/in_telemetry_iosxe.rb
|
131
|
+
- test/helper.rb
|
132
|
+
- test/plugin/test_in_telemetry_iosxe.rb
|
133
|
+
homepage: https://github.com/tetsusat/fluent-plugin-telemetry-iosxe
|
134
|
+
licenses:
|
135
|
+
- Apache-2.0
|
136
|
+
metadata: {}
|
137
|
+
post_install_message:
|
138
|
+
rdoc_options: []
|
139
|
+
require_paths:
|
140
|
+
- lib
|
141
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - ">="
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: '0'
|
146
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
147
|
+
requirements:
|
148
|
+
- - ">="
|
149
|
+
- !ruby/object:Gem::Version
|
150
|
+
version: '0'
|
151
|
+
requirements: []
|
152
|
+
rubyforge_project:
|
153
|
+
rubygems_version: 2.5.2.1
|
154
|
+
signing_key:
|
155
|
+
specification_version: 4
|
156
|
+
summary: Fluentd input plugin to collect IOS-XR telemetry.
|
157
|
+
test_files:
|
158
|
+
- test/helper.rb
|
159
|
+
- test/plugin/test_in_telemetry_iosxe.rb
|