wavefront-client 0.5.2

data/bin/wavefront-client

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+#     Copyright 2015 Wavefront Inc.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+# http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'wavefront/client'
+require 'slop'
+
+@opts = Slop.parse(strict: true) do
+  banner 'Usage: wavefront-client QUERY (OPTIONS)'
+  on 'm', 'minutes', 'Query granularity of minutes'
+  on 'h', 'hours', 'Query granularity of hours'
+  on 'S', 'seconds', 'Query granularity of seconds'
+  on 's', 'start=', 'Time in UNIX epoch seconds to begin the query from'
+  on 't', 'token=', 'Wavefront authentication token'
+  on 'e', 'end=', 'Time in UNIX epoch seconds to query to'
+  on 'h', 'help', 'Display this message'
+end
+
+if @opts.help?
+  puts @opts
+  exit 0
+end
+
+query = ARGV[0]
+if @opts.minutes?
+  granularity = 'm'
+elsif @opts.hours?
+  granularity = 'h'
+elsif @opts.seconds?
+  granularity = 's'
+else
+  puts "You must specify a granularity of either --seconds, --minutes or --hours. See --help for more information."
+  exit 1
+end
+
+options = Hash.new
+if @opts[:start]
+  options[:start_time] = @opts[:start]
+end
+
+if @opts[:end]
+  options[:end_time] = @opts[:end]
+end
+
+wave = Wavefront::Client.new(@opts[:token])
+puts wave.query(query, granularity, options)

data/lib/wavefront/alerting.rb

@@ -0,0 +1,57 @@
+=begin 
+    Copyright 2015 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+require "wavefront/client/version"
+require "wavefront/exception"
+require 'rest_client'
+require 'uri'
+require 'logger'
+
+module Wavefront
+  class Alerting
+    DEFAULT_HOST = 'metrics.wavefront.com'
+    DEFAULT_PATH = '/api/alert/'
+
+    attr_reader :token
+
+    def initialize(token)
+      @token = token
+    end
+
+    def active(options={})
+
+      options[:host] ||= DEFAULT_HOST
+      options[:path] ||= DEFAULT_PATH
+
+      uri = URI::HTTPS.build(:host => options[:host], :path => options[:path])
+      uri = URI.join(uri.to_s,"active")
+      uri = URI.join(uri.to_s,"?t=#{@token}")
+      
+      response = RestClient.get(uri.to_s)
+
+      return response
+    end
+
+    private
+
+    def debug(enabled)
+      if enabled
+        RestClient.log = 'stdout'
+      end
+    end
+
+  end
+end

data/lib/wavefront/client.rb

@@ -0,0 +1,70 @@
+=begin 
+    Copyright 2015 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+require "wavefront/client/version"
+require "wavefront/client/constants"
+require "wavefront/exception"
+require "wavefront/response"
+require 'rest_client'
+require 'uri'
+require 'logger'
+
+module Wavefront
+  class Client
+    DEFAULT_PERIOD_SECONDS = 600
+    DEFAULT_PATH = '/chart/api'
+    DEFAULT_FORMAT = :raw
+    FORMATS = [ :raw, :ruby, :graphite, :highcharts ]
+    GRANULARITIES = %w( s m h d )
+
+    attr_reader :headers, :base_uri
+
+    def initialize(token, host=DEFAULT_HOST, debug=false)
+      @headers = {'X-AUTH-TOKEN' => token}
+      @base_uri = URI::HTTPS.build(:host => host, :path => DEFAULT_PATH)
+      debug(debug)
+    end
+
+    def query(query, granularity='m', options={})
+
+      options[:end_time] ||= Time.now
+      options[:start_time] ||= options[:end_time] - DEFAULT_PERIOD_SECONDS
+      options[:response_format] ||= DEFAULT_FORMAT
+
+      [ options[:start_time], options[:end_time] ].each { |o| raise Wavefront::Exception::InvalidTimeFormat unless o.is_a?(Time) }
+      raise Wavefront::Exception::InvalidGranularity unless GRANULARITIES.include?(granularity)
+      raise Wavefront::Exception::InvalidResponseFormat unless FORMATS.include?(options[:response_format])
+
+      args = {:params =>
+              {:q => query, :g => granularity, :n => 'Unknown',
+               :s => options[:start_time].to_i, :e => options[:end_time].to_i}}.merge(@headers)
+      response = RestClient.get @base_uri.to_s, args
+
+      klass = Object.const_get('Wavefront').const_get('Response').const_get(options[:response_format].to_s.capitalize)
+      return klass.new(response)
+
+    end
+
+    private
+
+    def debug(enabled)
+      if enabled
+        RestClient.log = 'stdout'
+      end
+    end
+
+  end
+end

data/lib/wavefront/client/constants.rb

@@ -0,0 +1,17 @@
+=begin 
+    Copyright 2015 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+DEFAULT_HOST = 'metrics.wavefront.com'

data/lib/wavefront/client/version.rb

@@ -0,0 +1,21 @@
+=begin
+    Copyright 2015 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+module Wavefront
+  class Client
+    VERSION = "0.5.2"
+  end
+end

data/lib/wavefront/events.rb

@@ -0,0 +1,68 @@
+require_relative 'client/version'
+require_relative 'exception'
+require 'rest_client'
+require 'uri'
+require 'logger'
+#
+# Add basic support to cover Wavefront's events API. I have followed
+# the standards and conventions established in the files already in
+# this repository.
+#
+# R Fisher 07/2015
+#
+module Wavefront
+  #
+  # These methods expect to be called with a hash whose keys are as
+  # defined in the Wavefront API Console. That is, 'n' as 'name for
+  # the event', 's' as 'start time for the event' and so-on.
+  #
+  class Events
+    DEFAULT_HOST = 'metrics.wavefront.com'
+    DEFAULT_PATH = '/api/events/'
+
+    attr_reader :token
+
+    def initialize(token)
+      @token = token
+    end
+
+    def create(payload = {}, options = {})
+      options[:host] ||= DEFAULT_HOST
+      options[:path] ||= DEFAULT_PATH
+
+      uri = URI::HTTPS.build(
+        host:  options[:host],
+        path:  options[:path],
+        query: "t=#{@token}"
+      )
+
+      RestClient.post(uri.to_s, payload)
+    end
+
+    def close(payload = {}, options = {})
+      options[:host] ||= DEFAULT_HOST
+      options[:path] ||= DEFAULT_PATH
+
+      # This request seems to need the data as a query string. I was
+      # getting a 500 when I posted a hash. A map will do the
+      # needful.
+
+      uri = URI::HTTPS.build(
+        host:  options[:host],
+        path:  options[:path] + 'close',
+        query: URI.escape(
+          payload.map { |k, v| [k, v].join('=') }.join('&') + '&t=' + @token
+        )
+      )
+      puts uri.to_s
+
+      RestClient.post(uri.to_s, payload)
+    end
+
+    private
+
+    def debug(enabled)
+      RestClient.log = 'stdout' if enabled
+    end
+  end
+end

data/lib/wavefront/exception.rb

@@ -0,0 +1,27 @@
+=begin 
+    Copyright 2015 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+require "wavefront/client/version"
+
+module Wavefront
+  class Exception
+    class InvalidTimeFormat < ::Exception; end
+    class InvalidGranularity < ::Exception; end
+    class InvaldResponseFormat < ::Exception; end
+    class EmptyMetricName < ::Exception; end
+    class NotImplemented < ::Exception; end
+  end
+end

data/lib/wavefront/metadata.rb

@@ -0,0 +1,90 @@
+=begin 
+    Copyright 2015 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+require "wavefront/client/version"
+require "wavefront/client/constants"
+require "wavefront/exception"
+require 'rest_client'
+require 'uri'
+require 'logger'
+
+module Wavefront
+  class Metadata
+    DEFAULT_PATH = '/api/manage/source/'
+
+    attr_reader :headers, :base_uri
+
+    def initialize(token, host=DEFAULT_HOST, debug=false)
+      @headers = {'X-AUTH-TOKEN' => token}
+      @base_uri = URI::HTTPS.build(:host => host, :path => DEFAULT_PATH)
+      debug(debug)
+    end
+
+    def get_tags(hostname='')
+      uri = @base_uri
+      
+      unless hostname.empty?
+        uri = URI.join(@base_uri.to_s, hostname)
+      end
+      
+      begin
+        response = RestClient.get(uri.to_s, @headers)
+      rescue RestClient::ResourceNotFound
+        # If a 404 is returned, we return an empty JSON as this is the expected behaviour for untagged hosts
+        response = {}        
+      end
+
+      return response
+ 
+    end
+
+    def add_tags(hostnames, tags)
+      
+      # Build and call tagging URI for each host and tag.
+      hostnames.each do |hostname|
+        host_uri = URI.join(@base_uri.to_s,"#{hostname}/")
+        extended_uri = URI.join(host_uri.to_s,"tags/")        
+        tags.each do |tag|
+          final_uri = URI.join(extended_uri.to_s,tag)
+          RestClient.put(final_uri.to_s, {}, @headers)
+        end
+      end
+
+    end
+
+    def remove_tags(hostnames, tags, options={})
+          
+      hostnames.each do |hostname|
+        host_uri = URI.join(@base_uri.to_s,"#{hostname}/")
+        extended_uri = URI.join(host_uri.to_s,"tags/")
+        tags.each do |tag|
+          final_uri = URI.join(extended_uri.to_s,tag)
+          RestClient.delete(final_uri.to_s, @headers)
+        end
+      end
+
+    end
+
+    private
+
+    def debug(enabled)
+      if enabled
+        RestClient.log = 'stdout'
+      end
+    end
+
+  end
+end

data/lib/wavefront/response.rb

@@ -0,0 +1,93 @@
+=begin 
+    Copyright 2015 Wavefront Inc.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+   limitations under the License.
+
+=end
+
+require 'wavefront/client/version'
+require 'wavefront/exception'
+require 'json'
+
+module Wavefront
+  class Response
+    class Raw
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def to_s
+        return @response
+      end
+
+    end
+
+    class Ruby
+      include JSON
+      attr_reader :response
+      
+      def initialize(response)
+        @response = response
+
+        JSON.parse(response).each_pair do |k,v|
+          self.instance_variable_set("@#{k}", v)	# Dynamically populate instance vars
+          self.class.__send__(:attr_reader, k)		# and set accessors
+        end
+      end
+
+    end
+
+    class Graphite < Wavefront::Response::Ruby
+      attr_reader :response, :graphite
+
+      def initialize(response)
+        super
+        
+        datapoints = Array.new
+        self.timeseries.each do |ts|
+          ts['data'].each do |d|
+            datapoints << [d[1], d[0]]
+          end
+        end
+
+        @graphite = [{ 'target' => self.query, 'datapoints' => datapoints }]
+      end
+
+    end
+
+    class Highcharts < Wavefront::Response::Ruby
+      include JSON
+      attr_reader :response, :highcharts
+
+      def initialize(response)
+        super
+
+        @response = JSON.parse(response)
+
+	@highcharts = []
+	self.timeseries.each do |series|
+	  # Highcharts expects the time in milliseconds since the epoch
+	  # And for some reason the first value tends to be BS
+
+	  @highcharts << { 'name' => series['label'],  'data' => series['data'][1..-1].map!{|x,y| [ x * 1000, y ]} }
+	end
+      end
+
+      def to_json
+	@highcharts.to_json
+      end
+    end
+
+  end
+end