logstash-output-wavefront 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CONTRIBUTORS.md +6 -0
- data/Gemfile +2 -0
- data/LICENSE +201 -0
- data/README.md +29 -0
- data/lib/logstash/outputs/wavefront.rb +165 -0
- data/logstash-output-wavefront.gemspec +32 -0
- data/spec/outputs/wavefront_spec.rb +114 -0
- metadata +115 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b1201aeb0e991022979337ec5c1be2e487ed8d65
|
4
|
+
data.tar.gz: 74746a3bd8ef4ff5dfb93e367ffcfc0e9f328421
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 70852a3cab317df46fa25dc8b4200cb109be35bf60b20987899287601d354f23c6e83f02fdbd2f9df33177e8288eae0c182a6d90bcad7be83b63461398219269
|
7
|
+
data.tar.gz: cab76d6d673dd0488fe02cc591cc9f1c5eeb257e49c08ad0e9e2b69272f91d99d63b61d2a7b9d35a90db56198fcd85fc37da1096b1b01fd3b49de898fc7655ea
|
data/CONTRIBUTORS.md
ADDED
@@ -0,0 +1,6 @@
|
|
1
|
+
The following is a list of people who have contributed ideas, code, bug
|
2
|
+
reports, or in general have helped the wavefront logstash plugin along its way.
|
3
|
+
|
4
|
+
Contributors:
|
5
|
+
|
6
|
+
* Rob Fisher (snltd), for the [WavefrontHQ Ruby Client](https://github.com/wavefrontHQ/ruby-client)
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,29 @@
|
|
1
|
+
# Wavefront Logstash Output Plugin
|
2
|
+
Fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want.
|
3
|
+
|
4
|
+
## Contributing
|
5
|
+
All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
|
6
|
+
|
7
|
+
## Developing
|
8
|
+
To better understand contributing to logstash plugins, visit [their article on custom output plugins](https://www.elastic.co/guide/en/logstash/current/_how_to_write_a_logstash_output_plugin.html).
|
9
|
+
|
10
|
+
To test a local build of this plugin,
|
11
|
+
|
12
|
+
1. Install logstash. Either from source or from a package manager is fine.
|
13
|
+
1. Install ruby bundler -- `gem install bundler` should do it.
|
14
|
+
1. In this directory, `gem build logstash-output-wavefront.gemspec`
|
15
|
+
1. `logstash-plugin install *wavefront*.gem`
|
16
|
+
|
17
|
+
### Install dependencies
|
18
|
+
```
|
19
|
+
bundle install
|
20
|
+
```
|
21
|
+
|
22
|
+
### Test
|
23
|
+
```
|
24
|
+
bundle exec rspec
|
25
|
+
```
|
26
|
+
|
27
|
+
## Need Help?
|
28
|
+
|
29
|
+
support@wavefront.com
|
@@ -0,0 +1,165 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
require "logstash/namespace"
|
3
|
+
require "logstash/outputs/base"
|
4
|
+
require "socket"
|
5
|
+
require "wavefront/writer"
|
6
|
+
|
7
|
+
# ==== The Wavefront Output Plugin for Logstash
|
8
|
+
# Every event processed by this plugin has all of its fields scanned. If those
|
9
|
+
# fields contain hashes, and those hashes have keys that match "metrics" below,
|
10
|
+
# they are sent to Wavefront.
|
11
|
+
#
|
12
|
+
# For example, suppose you give the following config:
|
13
|
+
# ----
|
14
|
+
# output {
|
15
|
+
# wavefront {
|
16
|
+
# prefix => "mymetrics"
|
17
|
+
# metrics => ["count", "mean"]
|
18
|
+
# }
|
19
|
+
# }
|
20
|
+
# ----
|
21
|
+
#
|
22
|
+
# Then, the following event...
|
23
|
+
# ----
|
24
|
+
# {
|
25
|
+
# "data1" => {
|
26
|
+
# "count" => 200,
|
27
|
+
# "mean" => 42.2
|
28
|
+
# },
|
29
|
+
# "data2" => {
|
30
|
+
# "count" => 123,
|
31
|
+
# "max" => 9001
|
32
|
+
# },
|
33
|
+
# "data3" => "I'm not a hash, so I'm not even parsed."
|
34
|
+
# }
|
35
|
+
# ----
|
36
|
+
#
|
37
|
+
# Will report the following metrics to Wavefront:
|
38
|
+
#
|
39
|
+
# * `mymetrics.data1.count 200`
|
40
|
+
# * `mymetrics.data1.mean 42.2`
|
41
|
+
# * `mymetrics.data2.count 123`
|
42
|
+
#
|
43
|
+
# This scheme allows you to easily integrate with the
|
44
|
+
# <<plugins-filters-metrics,metrics filter plugin>>, but integration with any
|
45
|
+
# other filter should be possible with mutates and groks.
|
46
|
+
#
|
47
|
+
# ==== The Wavefront Proxy
|
48
|
+
# This plugin is designed to send telemetry to the
|
49
|
+
# https://github.com/wavefrontHQ/java/tree/master/proxy[Wavefront Proxy]
|
50
|
+
# (https://github.com/wavefrontHQ/install[installation instructions]).
|
51
|
+
class LogStash::Outputs::Wavefront < LogStash::Outputs::Base
|
52
|
+
config_name "wavefront"
|
53
|
+
|
54
|
+
# The hostname or IP of a running Wavefront Proxy.
|
55
|
+
config :host, :validate => :string, :default => "localhost"
|
56
|
+
# The port that the Wavefront Proxy is listening on.
|
57
|
+
config :port, :validate => :number, :default => 2878
|
58
|
+
# The Wavefront UI will show all telemetry as coming from this "source". If
|
59
|
+
# empty, we will use the hostname of the node running logstash.
|
60
|
+
config :source, :validate => :string, :default => ""
|
61
|
+
# The metrics to parse out of incoming events, as described above.
|
62
|
+
config :metrics, :validate => :array, :default => ["count", "mean"]
|
63
|
+
# A special string to insert before every incoming metric before sending to
|
64
|
+
# WF. May be blank, in which case we will use no special prefix.
|
65
|
+
config :prefix, :validate => :string, :default => ""
|
66
|
+
# A special string that allows you to tag your outgoing metrics. For example,
|
67
|
+
# the following event:
|
68
|
+
# ----
|
69
|
+
# {
|
70
|
+
# "data1.tagz.zone=abc.class=123" => {
|
71
|
+
# "count" => 200
|
72
|
+
# }
|
73
|
+
# }
|
74
|
+
# ----
|
75
|
+
#
|
76
|
+
# Will send the following metric to WF:
|
77
|
+
#
|
78
|
+
# * `data1.count 200 zone=abc class=123`
|
79
|
+
config :tag_separator, :validate => :string, :default => "tagz"
|
80
|
+
|
81
|
+
# Access to these fields is provided for testing only!
|
82
|
+
attr_reader :source
|
83
|
+
|
84
|
+
public
|
85
|
+
def register
|
86
|
+
if @source == ""
|
87
|
+
@source = Socket.gethostname
|
88
|
+
end
|
89
|
+
@open = false
|
90
|
+
end
|
91
|
+
|
92
|
+
private
|
93
|
+
def try_set_writer()
|
94
|
+
begin
|
95
|
+
@writer = Wavefront::Writer.new({
|
96
|
+
:agent_host => @host,
|
97
|
+
:agent_port => @port,
|
98
|
+
:host_name => @source
|
99
|
+
})
|
100
|
+
rescue Errno::ECONNREFUSED
|
101
|
+
@logger.error("Could not connect to wavefront proxy!")
|
102
|
+
return false
|
103
|
+
end
|
104
|
+
return true
|
105
|
+
end
|
106
|
+
|
107
|
+
public
|
108
|
+
def receive(event)
|
109
|
+
if not @open
|
110
|
+
if not try_set_writer
|
111
|
+
@logger.error("Dropping point, connection to WF agent is down.")
|
112
|
+
return
|
113
|
+
else
|
114
|
+
@open = true
|
115
|
+
end
|
116
|
+
end
|
117
|
+
|
118
|
+
event.to_hash.each do |faux_metric_name, field_value|
|
119
|
+
next if field_value.class != Hash
|
120
|
+
|
121
|
+
# Parse out tags if any are encoded in the metric name.
|
122
|
+
parts = faux_metric_name.split(".")
|
123
|
+
tags = {}
|
124
|
+
if parts.length == 1 || @tag_separator == ""
|
125
|
+
metric_name = faux_metric_name
|
126
|
+
else
|
127
|
+
idx = parts.index(@tag_separator)
|
128
|
+
if idx == nil
|
129
|
+
metric_name = faux_metric_name
|
130
|
+
else
|
131
|
+
metric_name = parts.slice(0, idx).join(".")
|
132
|
+
parts.slice(idx + 1, parts.length - 1).each do |keyvalue|
|
133
|
+
tag_parts = keyvalue.split("=")
|
134
|
+
if tag_parts.length <= 1
|
135
|
+
next
|
136
|
+
else
|
137
|
+
tags[tag_parts[0]] = tag_parts.slice(1, tag_parts.length).join("=")
|
138
|
+
end
|
139
|
+
end
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
field_value.each do |metric_specifier, metric_value|
|
144
|
+
full_metric = "#{metric_name}.#{metric_specifier}"
|
145
|
+
if @metrics.include? metric_specifier
|
146
|
+
full_metric_name =\
|
147
|
+
@prefix == "" ? full_metric : "#{@prefix}.#{full_metric}"
|
148
|
+
@logger.debug? && logger.debug(
|
149
|
+
"Sending #{full_metric_name}=#{metric_value}: #{tags}")
|
150
|
+
begin
|
151
|
+
@writer.write(metric_value, full_metric_name, {:point_tags => tags})
|
152
|
+
rescue Errno::EPIPE
|
153
|
+
@logger.error("Connection to WF agent dropped!")
|
154
|
+
@open = false
|
155
|
+
return
|
156
|
+
end
|
157
|
+
else
|
158
|
+
@logger.debug? && logger.debug(
|
159
|
+
"Skipping unmentioned metric #{metric_specifier}")
|
160
|
+
end
|
161
|
+
end
|
162
|
+
end
|
163
|
+
end # def receive
|
164
|
+
|
165
|
+
end # class Wavefront
|
@@ -0,0 +1,32 @@
|
|
1
|
+
Gem::Specification.new do |s|
|
2
|
+
# Metadata.
|
3
|
+
s.name = "logstash-output-wavefront"
|
4
|
+
s.version = "1.0.0"
|
5
|
+
s.licenses = ["Apache License (2.0)"]
|
6
|
+
s.summary = "Logstash plugin for sending data to Wavefront."
|
7
|
+
s.description = "This gem is a Logstash plugin required to be installed "\
|
8
|
+
"on top of the Logstash core pipeline using "\
|
9
|
+
"$LS_HOME/bin/logstash-plugin install gemname. "\
|
10
|
+
"This gem is not a stand-alone program."
|
11
|
+
s.authors = ["Wavefront"]
|
12
|
+
s.email = "help@wavefront.com"
|
13
|
+
s.homepage = "https://www.wavefront.com/"
|
14
|
+
|
15
|
+
# Package contents.
|
16
|
+
s.require_paths = ["lib"]
|
17
|
+
s.files = Dir["lib/**/*",
|
18
|
+
"spec/**/*",
|
19
|
+
"vendor/**/*",
|
20
|
+
"*.gemspec",
|
21
|
+
"*.md",
|
22
|
+
"Gemfile",
|
23
|
+
"LICENSE"]
|
24
|
+
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
25
|
+
s.metadata = { "logstash_plugin" => "true", "logstash_group" => "output" }
|
26
|
+
|
27
|
+
# Gem dependencies
|
28
|
+
s.add_runtime_dependency "logstash-core", ">= 2.0.0", "< 3.0.0"
|
29
|
+
s.add_runtime_dependency "logstash-codec-plain", "2.0.4"
|
30
|
+
s.add_runtime_dependency "wavefront-client", "3.3.0"
|
31
|
+
s.add_development_dependency "logstash-devutils", "0.0.22"
|
32
|
+
end
|
@@ -0,0 +1,114 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
require "logstash/devutils/rspec/spec_helper"
|
3
|
+
require "logstash/outputs/wavefront"
|
4
|
+
require "logstash/codecs/plain"
|
5
|
+
require "logstash/event"
|
6
|
+
require "socket"
|
7
|
+
|
8
|
+
def event(hash = {})
|
9
|
+
event = LogStash::Event.new
|
10
|
+
hash.each do |k, v|
|
11
|
+
event[k] = v
|
12
|
+
end
|
13
|
+
event
|
14
|
+
end
|
15
|
+
|
16
|
+
def maketags(**kwargs)
|
17
|
+
return { :point_tags => Hash[kwargs.map { |k, v| [k.id2name, v]}] }
|
18
|
+
end
|
19
|
+
|
20
|
+
describe LogStash::Outputs::Wavefront do
|
21
|
+
subject(:mywriter) { double("mywriter") }
|
22
|
+
|
23
|
+
subject do
|
24
|
+
wavefront = LogStash::Outputs::Wavefront.new({
|
25
|
+
"host" => host,
|
26
|
+
"port" => port,
|
27
|
+
"source" => source,
|
28
|
+
"metrics" => metrics,
|
29
|
+
"prefix" => prefix,
|
30
|
+
"tag_separator" => tag_separator
|
31
|
+
})
|
32
|
+
expect(Wavefront::Writer).to receive(:new) { mywriter }
|
33
|
+
wavefront.register
|
34
|
+
wavefront
|
35
|
+
end
|
36
|
+
|
37
|
+
let(:host) { "localhost" }
|
38
|
+
let(:port) { 2878 }
|
39
|
+
let(:source) { "mynode" }
|
40
|
+
let(:metrics) { ["count"] }
|
41
|
+
let(:prefix) { "myprefix" }
|
42
|
+
let(:tag_separator) { "tagz" }
|
43
|
+
|
44
|
+
describe "#register" do
|
45
|
+
context "without a given source" do
|
46
|
+
let(:source) { "" }
|
47
|
+
it "infers source name from socket" do
|
48
|
+
subject.receive(event())
|
49
|
+
expect(subject.source).to eq(Socket.gethostname)
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
describe "#receive" do
|
55
|
+
it "forwards event with matching metrics" do
|
56
|
+
expect(mywriter).to receive(:write).with(2, "myprefix.a.count", maketags({}))
|
57
|
+
subject.receive(event({"a" => {"count" => 2}}))
|
58
|
+
end
|
59
|
+
|
60
|
+
it "forwards multiple metrics when needed" do
|
61
|
+
expect(mywriter).to receive(:write).with(2, "myprefix.a.count", maketags({}))
|
62
|
+
expect(mywriter).to receive(:write).with(3, "myprefix.b.count", maketags({}))
|
63
|
+
subject.receive(event({"a" => {"count" => 2}, "b" => {"count" => 3}}))
|
64
|
+
end
|
65
|
+
|
66
|
+
context "without a metrics prefix" do
|
67
|
+
let(:prefix) { "" }
|
68
|
+
it "does not include a metrics prefix in the output" do
|
69
|
+
expect(mywriter).to receive(:write).with(2, "a.count", maketags({}))
|
70
|
+
subject.receive(event({"a" => {"count" => 2}}))
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
it "drops event without matching metrics" do
|
75
|
+
subject.receive(event({"a" => {"foo" => 2}}))
|
76
|
+
end
|
77
|
+
|
78
|
+
it "skips non-hash fields in the event" do
|
79
|
+
subject.receive(event({"a" => "b"}))
|
80
|
+
end
|
81
|
+
|
82
|
+
it "parses tags when they are present in the metric name" do
|
83
|
+
expect(mywriter).to receive(:write).with(2, "myprefix.a.count",
|
84
|
+
maketags(foo: "bar", boo: "baz=qux"))
|
85
|
+
subject.receive(event(
|
86
|
+
{"a.tagz.foo=bar.boo=baz=qux.tagwrongformat" => {"count" => 2}}))
|
87
|
+
end
|
88
|
+
|
89
|
+
it "starts zombie mode when WF cxn drops" do
|
90
|
+
expect(mywriter).to receive(:write).with(any_args).and_raise(Errno::EPIPE)
|
91
|
+
subject.receive(event({"a" => {"count" => 2}}))
|
92
|
+
# Pipe is broken, we should try to connect again.
|
93
|
+
expect(Wavefront::Writer).to receive(:new) { mywriter }.once
|
94
|
+
expect(mywriter).to receive(:write).with(any_args)
|
95
|
+
subject.receive(event({"a" => {"count" => 2}}))
|
96
|
+
end
|
97
|
+
|
98
|
+
it "does not try to reconnect when cxn is still healthy" do
|
99
|
+
expect(mywriter).to receive(:write).with(any_args).twice
|
100
|
+
subject.receive(event({"a" => {"count" => 2}}))
|
101
|
+
subject.receive(event({"a" => {"count" => 2}}))
|
102
|
+
end
|
103
|
+
|
104
|
+
context "without a tags separator" do
|
105
|
+
let(:tag_separator) { "" }
|
106
|
+
it "does not parse out tags from the metric name" do
|
107
|
+
expect(mywriter).to receive(:write).with(
|
108
|
+
2, "myprefix.a.tagz.foo=bar.boo=baz.count", maketags({}))
|
109
|
+
subject.receive(event({"a.tagz.foo=bar.boo=baz" => {"count" => 2}}))
|
110
|
+
end
|
111
|
+
end
|
112
|
+
end
|
113
|
+
|
114
|
+
end
|
metadata
ADDED
@@ -0,0 +1,115 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: logstash-output-wavefront
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Wavefront
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-09-12 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
15
|
+
requirements:
|
16
|
+
- - ">="
|
17
|
+
- !ruby/object:Gem::Version
|
18
|
+
version: 2.0.0
|
19
|
+
- - "<"
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: 3.0.0
|
22
|
+
name: logstash-core
|
23
|
+
prerelease: false
|
24
|
+
type: :runtime
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: 2.0.0
|
30
|
+
- - "<"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 3.0.0
|
33
|
+
- !ruby/object:Gem::Dependency
|
34
|
+
requirement: !ruby/object:Gem::Requirement
|
35
|
+
requirements:
|
36
|
+
- - '='
|
37
|
+
- !ruby/object:Gem::Version
|
38
|
+
version: 2.0.4
|
39
|
+
name: logstash-codec-plain
|
40
|
+
prerelease: false
|
41
|
+
type: :runtime
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - '='
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: 2.0.4
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
requirements:
|
50
|
+
- - '='
|
51
|
+
- !ruby/object:Gem::Version
|
52
|
+
version: 3.3.0
|
53
|
+
name: wavefront-client
|
54
|
+
prerelease: false
|
55
|
+
type: :runtime
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - '='
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: 3.3.0
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
requirement: !ruby/object:Gem::Requirement
|
63
|
+
requirements:
|
64
|
+
- - '='
|
65
|
+
- !ruby/object:Gem::Version
|
66
|
+
version: 0.0.22
|
67
|
+
name: logstash-devutils
|
68
|
+
prerelease: false
|
69
|
+
type: :development
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - '='
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: 0.0.22
|
75
|
+
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.
|
76
|
+
email: help@wavefront.com
|
77
|
+
executables: []
|
78
|
+
extensions: []
|
79
|
+
extra_rdoc_files: []
|
80
|
+
files:
|
81
|
+
- CONTRIBUTORS.md
|
82
|
+
- Gemfile
|
83
|
+
- LICENSE
|
84
|
+
- README.md
|
85
|
+
- lib/logstash/outputs/wavefront.rb
|
86
|
+
- logstash-output-wavefront.gemspec
|
87
|
+
- spec/outputs/wavefront_spec.rb
|
88
|
+
homepage: https://www.wavefront.com/
|
89
|
+
licenses:
|
90
|
+
- Apache License (2.0)
|
91
|
+
metadata:
|
92
|
+
logstash_plugin: 'true'
|
93
|
+
logstash_group: output
|
94
|
+
post_install_message:
|
95
|
+
rdoc_options: []
|
96
|
+
require_paths:
|
97
|
+
- lib
|
98
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - ">="
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '0'
|
103
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
104
|
+
requirements:
|
105
|
+
- - ">="
|
106
|
+
- !ruby/object:Gem::Version
|
107
|
+
version: '0'
|
108
|
+
requirements: []
|
109
|
+
rubyforge_project:
|
110
|
+
rubygems_version: 2.4.8
|
111
|
+
signing_key:
|
112
|
+
specification_version: 4
|
113
|
+
summary: Logstash plugin for sending data to Wavefront.
|
114
|
+
test_files:
|
115
|
+
- spec/outputs/wavefront_spec.rb
|