wavefront-client 0.5.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,15 @@
1
+ ---
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: !binary |-
4
+ ZmI1ZGFhN2I5Yjg2OTNhZTJkNmIyM2FlNDhiMjdkZTQxMWQ4MDEzMw==
5
+ data.tar.gz: !binary |-
6
+ YWI3YTAxYTZkZmI2YTgyZjE4ZDJhMDY4OWNjMTkzM2MxMTlhYzZjMg==
7
+ SHA512:
8
+ metadata.gz: !binary |-
9
+ MmFlZWRmOGZjZjc1NzRkMTY2MGEyOTFjNWQ2MjllNTk0ODVkYzhiNTIyNjdk
10
+ YmM3OTY5ZTdiZjQ4MzcwNmM4MTAzZWI4NTBhZjI0NGNmZGJlMzQ3NDMzNzdm
11
+ ODk1NTJiZjZkMTJkNGY1M2Q0MmExNWM4NTAzNjg3ZDlhNjM4NTc=
12
+ data.tar.gz: !binary |-
13
+ OWFmZjAzMmUwNDExNWMxMGQxZDcwOGQ0OWJlYzAyZjJhNDNlZDEzYmJjYjg1
14
+ NGNlNWRmMTQyYTI2YTQwZTFkNTdhN2Y2ZjdmOGY0ZmFjMGMzZTA3NWIxNDc5
15
+ MmJmNzMwZmUxY2VhZmExY2YwNjY5NjZmNWY1ZTc5MWMzNGI3MmM=
data/.gitignore ADDED
@@ -0,0 +1,5 @@
1
+ *.gem
2
+ Gemfile.lock
3
+ pkg
4
+ rdoc
5
+ spec/reports
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ 2.2.2
data/.travis.yml ADDED
@@ -0,0 +1,17 @@
1
+ language: ruby
2
+ cache: bundler
3
+ rvm:
4
+ - 1.9.3
5
+ - 2.0.0
6
+ - 2.1.0
7
+ - 2.2.2
8
+ deploy:
9
+ provider: rubygems
10
+ api_key:
11
+ secure: Z4cqo3EfGV/ygrodnVKi5eFj+0gwgAOqXeKPzxn9O7QFqJtDkX+AI4jlDrtzinVmmYgNi12sUH80WzPVLSFwkfu8WXKDbuK4d8/5sg/YGwB/reKYwkNcWtty+KGESlkXhgFU/izxZhtpFUoYSFrr0JEnCroSzlj7dbXIfirLrM1DQHQN4tpgrJ5sRhjZC0/8sBLV98dikxnatYDoCfkTaA3ZqeVwlELyhdIk/SkwzMy383LLEFD8g2SGNa5xQucTuZ63pTQyq9AfI09AwT4Mp83kc0wuON4Q4pmlLSaZYUzFmBf+auWKMDoIYc2tWF5eogrZn1nmaZakFYjS/vF8GLth4pTL4uSUQ2Z41EsjzuDbVkqodDJFxYBqEn0Tf961FB6YQrOC5HDyBoT8k/ar7Y6J2LtEQoI4twG6BJLv73htLUptlFeHzabE5h3Y65UNjkR0fEk8GVm10P3mymH/uvMZ8KaGniV98Cb0bRwESNhDTNTIzW5uGlK61ItHlcKwMDij9iq2GW0xMovDwFoDzOC3yOqtshkQcjQ6VpLN5L1Gpvc0phBIrBfXk2BTdEsUROLVTv5SlDPdWL0a4JXyD9yayZ3AJnoK6m5AxMWLQVlz5IYf3qTxtjH/wtt4fTsATer6TcGdk8cbB4qjO3SjYygCQiUT9plQImxvMAJMgmQ=
12
+ gem: wavefront-client
13
+ on:
14
+ tags: true
15
+ all_branches: true
16
+ repo: wavefrontHQ/ruby-client
17
+ ruby: 1.9.3
data/Gemfile ADDED
@@ -0,0 +1,2 @@
1
+ source 'https://rubygems.org'
2
+ gemspec
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/NOTICE ADDED
@@ -0,0 +1,12 @@
1
+ Copyright 2015 Wavefront Inc.
2
+ Licensed under the Apache License, Version 2.0 (the "License");
3
+ you may not use this file except in compliance with the License.
4
+ You may obtain a copy of the License at
5
+
6
+ http://www.apache.org/licenses/LICENSE-2.0
7
+
8
+ Unless required by applicable law or agreed to in writing, software
9
+ distributed under the License is distributed on an "AS IS" BASIS,
10
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11
+ See the License for the specific language governing permissions and
12
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,156 @@
1
+ # Wavefront::Client
2
+
3
+ This is a simple ruby gem for speaking to the [Wavefront][1] monitoring and graphing system.
4
+
5
+ ## Usage
6
+ Within your own ruby code:
7
+
8
+ ### Writer
9
+
10
+ The `Wavefront::Writer` class can be used to post metrics to Wavefront.
11
+
12
+ Example usage:
13
+
14
+ ```ruby
15
+ require 'wavefront/writer'
16
+ tags = {'k1' => 'v1', 'k2' => 'value 2'}
17
+ writer = Wavefront::Writer.new({:agent_host => 'agent.local.com', :host_name => 'server1', :metric_name => 'namespace.my.metric', :point_tags => tags})
18
+ # value of the metric at current timestamp is: 5
19
+ writer.write(5)
20
+ # Let's write a different metric overwriting the default options from the constructor
21
+ writer.write(6, 'namespace.my.other.metric', 'server2', {})
22
+ ```
23
+
24
+ * The initializer takes a hash of options, wherein one can set
25
+ * `:agent_host` - A `String` representing the hostname of the Wavefront Agent. Default: `localhost`
26
+ * `:agent_port` - A number representing the port of the Wavefront Agent. Default: `2878`
27
+ * `:host_name` - A `String` representing the host that reported metrics will appear to be from in Wavefront. Default: The fqdn of the machine where your Ruby code is running. Can be over-written by the write method
28
+ * `:metric_name` - A `String` representing the default metric name for any metrics reported from this class. Default: None. Can be over-written by the write method
29
+ * `point_tags` - A `Map` of key, value pairs of strings which will be sent to Wavefront. Can be over-written by the write method
30
+ * The write method parameters are:
31
+ * `metric_value` - A number, the value of the metric reporting at the current timestamp
32
+ * `metric_name` - A `String`, this must be present, either within the write method call or set on the Writer class
33
+ * `host_name` - A `String`, which will appear as the host for the sent metric in Wavefront.
34
+ * `point_tags` - A `Map` of key, value pairs of strings which will be sent to Wavefront. Not required. Note that if you specify these as part of the write method call they replace any set at the class level. The two maps are _not_ merged.
35
+ * `timestamp` - The Epoch Seconds of the reported point. Default: `Time.now`
36
+
37
+ ### Host Tags
38
+
39
+ The `Wavefront::Metadata` class facilitates the retrieval and posting of host tag related data to and from Wavefront.
40
+
41
+ Example usage:
42
+
43
+ ```ruby
44
+ require 'wavefront/metadata'
45
+ meta = Wavefront::Metadata.new('<TOKEN>')
46
+
47
+ meta.get_tags # Get tags for all hosts
48
+ meta.get_tags("webserver.hostname.com") # Get tags for a specific host
49
+ meta.add_tags(["host.server1.server.com","host.server2.server.com"],["tag1","tag2"]) # Add an arbitrary number of tags to an arbitrary number of hosts
50
+ meta.remove_tags(["server1.server.com","server2.server.com"],["tag1","tag2"]) # Remove an arbitrary number of tags from an arbitrary number of hosts
51
+ ```
52
+
53
+ * The initializer takes up to 3 parameters:
54
+ * `token` - A valid Wavefront API Token. This is required.
55
+ * `host` - A `String` representing the Wavefront endpoint to connect to. Default: `metrics.wavefront.com`.
56
+ * `debug` `true|false` - When set to `true` output `RestClient` debugging to `stdout`. Default: `false`.
57
+
58
+ ### Query Client
59
+
60
+ The `Wavefront::Client` class can be used to send queries to Wavefront and get a response
61
+
62
+ Example usage:
63
+
64
+ ```ruby
65
+ require 'wavefront/client'
66
+
67
+ TOKEN ='123TOKEN'
68
+ wave = Wavefront::Client.new(TOKEN)
69
+ response = wave.query('<TS_EXPRESSION>') # <TS_EXPRESSION> : Placeholder for a valid Wavefront ts() query
70
+ response = wave.query('<TS_EXPRESSION>', 'm', {:start_time => Time.now - 86400, :end_time => Time.now}) # <TS_EXPRESSION> : Placeholder for a valid Wavefront ts() query
71
+ ```
72
+
73
+ * Like the Metadata class, the initializer takes up to 3 parameters:
74
+ * `token` - A valid Wavefront API Token. This is required.
75
+ * `host` - A `String` representing the Wavefront endpoint to connect to. Default: `metrics.wavefront.com`.
76
+ * `debug` `true|false` - When set to `true` output `RestClient` debugging to `stdout`. Default: `false`.
77
+
78
+ * The query method takes up to 3 parameters:
79
+ * The first parameter is required and is any valid Wavefront TS expression
80
+ * The second parameter is a valid granularity, these are: 'd', 'm', 'h' and 's'. Default: `m`
81
+ * The third parameter is a Hash of options. These are:
82
+ * `:start_time` - An object of class `Time` that specifies the query start time. Default: `Time.now - 600`.
83
+ * `:end_time` - And object of class `Time` that specifies the query end time. Default: `Time.now`.
84
+ * `:response_format` `[ :raw, :ruby, :graphite, :highcharts ]` - See the section "Response Classes" below. Default: `:raw`.
85
+
86
+
87
+ ### Response Classes
88
+ The `query` method returns a sub-class of `Wavefront::Response`. By default this is `Wavefront::Response::Raw`, which is the raw String returned from the API. By including the `:response_format` key in the options hash when calling the query method you can receive responses as a number of other classes.
89
+
90
+ Example usage:
91
+
92
+ * `:response_format => :raw`
93
+
94
+ Default. Raw String returned from the API.
95
+
96
+ * `:response_format => :ruby`
97
+
98
+ A ruby object with accessor methods to the various parts of the query:
99
+
100
+ ```
101
+ response = wave.query('<TS_EXPRESSION>', 'm') # <TS_EXPRESSION> : Placeholder for a valid Wavefront ts() query
102
+ response.class # Wavefront::Response::Raw
103
+ response = wave.query('<TS_EXPRESSION>', 'm', {:response_format => :ruby}) # <TS_EXPRESSION> : Placeholder for a valid Wavefront ts() query
104
+ response.class # Wavefront::Response::Ruby
105
+ response.instance_variables # [:@response, :@query, :@name, :@timeseries, :@stats]
106
+ response.query
107
+ ```
108
+
109
+ * `:response_format => :graphite`
110
+
111
+ A ruby object that returns graphite-format data via the `graphite` method:
112
+
113
+ ```
114
+ response = wave.query('<TS_EXPRESSION>', 'm', {:response_format => :graphite}) # <TS_EXPRESSION> : Placeholder for a valid Wavefront ts() query
115
+ response.graphite[0]['datapoints'].first # [99.8, 1403702640]
116
+ ```
117
+
118
+ * `:response_format => :highcharts`
119
+
120
+ A ruby object that returns highcharts-format data via the `response` method:
121
+
122
+ ```
123
+ response = wave.query('<TS_EXPRESSION>', 'm', {:response_format => :highcharts}) # <TS_EXPRESSION> : Placeholder for a valid Wavefront ts() query
124
+ response.highcharts[0]['data'].first # [1436849460000, 517160277.3333333]
125
+ ```
126
+
127
+ ### Command-line client
128
+ A simple command line client is included too. You can see the full list of options by typing `wavefront-client --help` from a prompt.
129
+
130
+ ```bash
131
+ $ wavefront-client '<TS_EXPRESSION>' --minutes --token <YOUR_TOKEN > # <TS_EXPRESSION> : Placeholder for a valid Wavefront ts() query , <YOUR_TOKEN> : Placeholder for your Wavefront token
132
+ response.class # Wavefront::Response::Ruby
133
+ ```
134
+
135
+
136
+ ## Building and installing
137
+
138
+ ```bash
139
+ gem build ./wavefront-client.gemspec && gem install ./wavefront*.gem --no-rdoc --no-ri
140
+ ```
141
+
142
+ or
143
+
144
+ ```
145
+ rake install
146
+ ```
147
+
148
+ ## Contributing
149
+ 1. Fork it
150
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
151
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
152
+ 4. Push to the branch (`git push origin my-new-feature`)
153
+ 5. Create new Pull Request
154
+
155
+
156
+ [1]: http://wavefront.com
data/Rakefile ADDED
@@ -0,0 +1,28 @@
1
+ =begin
2
+ Copyright 2015 Wavefront Inc.
3
+ Licensed under the Apache License, Version 2.0 (the "License");
4
+ you may not use this file except in compliance with the License.
5
+ You may obtain a copy of the License at
6
+
7
+ http://www.apache.org/licenses/LICENSE-2.0
8
+
9
+ Unless required by applicable law or agreed to in writing, software
10
+ distributed under the License is distributed on an "AS IS" BASIS,
11
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ See the License for the specific language governing permissions and
13
+ limitations under the License.
14
+
15
+ =end
16
+
17
+ require "bundler/gem_tasks"
18
+ require "rspec/core/rake_task"
19
+
20
+ RSpec::Core::RakeTask.new(:spec)
21
+
22
+ task :default => :spec
23
+
24
+ task :install do
25
+ sh 'gem build ./wavefront-client.gemspec'
26
+ sh 'gem install wavefront-client-*.gem --no-rdoc --no-ri'
27
+ sh 'rm wavefront-client-*.gem'
28
+ end