wavefront-cli 2.3.1 → 2.4.0

data/lib/wavefront-cli/output/hcl.rb

@@ -0,0 +1,20 @@
+require_relative 'base'
+
+module WavefrontOutput
+  #
+  # Display objects in an HCL-compatible way, for use with the
+  # Wavefront Terraform provider. We farm everything out, as
+  # different resource types need various amounts of massaging. Args
+  # are passed through to the child class.
+  #
+  class Hcl < Base
+    def run
+      require_relative File.join('hcl', options[:class])
+      oclass = Object.const_get(format('WavefrontHclOutput::%s',
+                              options[:class].to_s.capitalize))
+      oclass.new(resp, options).run
+    rescue LoadError
+      abort "no HCL output for #{options[:class]}."
+    end
+  end
+end

data/lib/wavefront-cli/output/hcl/alert.rb

@@ -0,0 +1,14 @@
+require_relative 'base'
+
+module WavefrontHclOutput
+  #
+  # Define alerts which can be understood by the Wavefront Terraform
+  # provider.
+  #
+  class Alert < Base
+    def hcl_fields
+      %w[name target condition additional_information display_expression
+         minutes resolve_after_minutes severity tags]
+    end
+  end
+end

data/lib/wavefront-cli/output/hcl/base.rb

@@ -0,0 +1,92 @@
+require 'securerandom'
+require 'json'
+
+module WavefrontHclOutput
+  class Base
+    attr_reader :resp, :options
+
+    def initialize(resp, options)
+      @resp = resp
+      @options = options
+    end
+
+    def run
+      puts open_output
+      required_fields.each { |k, v| puts handler(k, v) }
+      puts close_output
+    end
+
+    # Fields which the provider requires.
+    # @return [Array] of strings
+    #
+    def hcl_fields
+      []
+    end
+
+    def open_output
+      format('resource "wavefront_%s" "%s" {', resource_name,
+             SecureRandom.uuid)
+    end
+
+    def close_output
+      '}'
+    end
+
+    # Override this if the provider calls a resource something other
+    # than the name of the inheriting class
+    #
+    def resource_name
+      options[:class]
+    end
+
+    # The provider can only handle certain keys. Each class should
+    # provide a list of things it knows the provider requires. If it
+    # does not, we display everything
+    #
+    def required_fields
+      return resp if hcl_fields.empty?
+      resp.select { |k, _v| hcl_fields.include?(k) }
+    end
+
+    # Format each key-value pair
+    # @param k [String] key
+    # @param v [Any] value
+    # @return [String]
+    #
+    def handler(k, v)
+      key_handler = "khandle_#{k}".to_sym
+      value_handler = "vhandle_#{k}".to_sym
+      quote_handler = "qhandle_#{k}".to_sym
+      k = send(key_handler) if respond_to?(key_handler)
+      v = send(value_handler, v) if respond_to?(value_handler)
+
+      quote_handler = :quote_value unless respond_to?(quote_handler)
+
+      format('  %s = %s', k.to_snake, send(quote_handler, v))
+    end
+
+    # Tags need to be in an array. They aren't always called "tags"
+    # by the API.
+    # @param v [Array,Hash,String] tags
+    # @return [Array] of soft-quoted tags
+    #
+    def vhandle_tags(v)
+      v = v.values if v.is_a?(Hash)
+      Array(v).flatten
+    end
+
+    # Some values need to be quoted, some need to be escaped etc
+    # etc.
+    # @param v [Object] value
+    # @return [String]
+    #
+    def quote_value(v)
+      case v.class.to_s.to_sym
+      when :String
+        format('"%s"', v.gsub(/\"/, '\"'))
+      else
+        v
+      end
+    end
+  end
+end

data/lib/wavefront-cli/output/hcl/dashboard.rb

@@ -0,0 +1,114 @@
+require_relative 'base'
+
+module WavefrontHclOutput
+  #
+  # This is a rather kludgy class which generates HCL output
+  # suitable for the Wavefront Terraform provider. It has to work
+  # round a number of inconsistencies and omissions in said
+  # provider, and will have to change as the provider improves.
+  #
+  # It works, manually, down the hierarchy described
+  # in https://github.com/spaceapegames/terraform-provider-wavefront/blob/master/wavefront/resource_dashboard.go
+  #
+  class Dashboard < Base
+
+    # Top-level fields
+    #
+    def hcl_fields
+      %w[name description url sections parameter_details tags]
+    end
+
+    def khandle_sections
+      'section'
+    end
+
+    # @param vals [Array] an array of objects
+    # @param fn [Symbol] a method which knows how to deal with one
+    #   of the objects in vals
+    # @return [String] HCL list of vals
+    #
+    def listmaker(vals, fn)
+      vals.each_with_object([]) { |v, a| a.<< send(fn, v) }.to_hcl_list
+    end
+
+    def vhandle_sections(v)
+      v.each_with_object([]) do |section, a|
+        a.<< ("name = \"#{section[:name]}\"\n      row = " +
+              handle_rows(section[:rows])).braced(4)
+      end.to_hcl_list
+    end
+
+    def handle_rows(rows)
+      rows.each_with_object([]) do |row, a|
+        a.<< ("chart = " + handle_charts(row[:charts]).to_s).braced(8)
+      end.to_hcl_list
+    end
+
+    def handle_charts(charts)
+      listmaker(charts, :handle_chart)
+    end
+
+    def handle_chart(chart)
+      fields = %w[units name description]
+
+      lines = chart.each_with_object([]) do |(k, v), a|
+        a.<< format('%s = %s', k, quote_value(v)) if fields.include?(k)
+      end
+
+      lines.<< "source = #{handle_sources(chart[:sources])}"
+      lines.to_hcl_obj(10)
+    end
+
+    def handle_sources(sources)
+      listmaker(sources, :handle_source)
+    end
+
+    def handle_source(source)
+      fields = %w[name query disabled scatterPlotSource querybuilderEnabled
+                  sourceDescription]
+
+      source.each_with_object([]) do |(k, v), a|
+        if fields.include?(k)
+          k = 'queryBuilderEnabled' if k == 'querybuilderEnabled'
+          a.<< format('%s = %s', k.to_snake, quote_value(v))
+        end
+      end.to_hcl_obj(14)
+    end
+
+    def qhandle_sections(v)
+      v
+    end
+
+    def quote_value(v)
+      v.gsub!(/\$/, '$$') if v.is_a?(String)
+      super
+    end
+  end
+end
+
+class String
+  def braced(indent = 0)
+    pad = ' ' * indent
+    "\n#{pad}{#{self}\n#{pad}}"
+  end
+end
+
+class Array
+  #
+  # Turn an array into a string which represents an HCL list
+  # @return [String]
+  #
+  def to_hcl_list
+    '[' + self.join(',') + ']'
+  end
+
+  # Turn an array into a string which represents an HCL object
+  # @return [String]
+  #
+  def to_hcl_obj(indent = 0)
+    outpad = ' ' * indent
+    inpad = ' ' * (indent + 2)
+
+    "\n#{outpad}{\n#{inpad}" + self.join("\n#{inpad}") + "\n#{outpad}}"
+  end
+end

data/lib/wavefront-cli/output/hcl/notificant.rb

@@ -0,0 +1,30 @@
+require_relative 'base'
+
+module WavefrontHclOutput
+  #
+  # Munge notificant output into something compatible with the
+  # Wavefront Terraform provider
+  #
+  class Notificant < Base
+    def hcl_fields
+      %w[title description triggers template method recipient emailSubject
+         contentType customHttpHeaders]
+    end
+
+    def vhandle_template(v)
+      v.gsub(/\s*\n/, '')
+    end
+
+    def resource_name
+      'alert_target'
+    end
+
+    def khandle_title
+      'name'
+    end
+
+    def khandle_customHttpHeaders
+      'custom_headers'
+    end
+  end
+end

data/lib/wavefront-cli/output/json.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module WavefrontOutput
+  #
+  # Display as JSON
+  #
+  class Json < Base
+    def run
+      puts resp.to_json
+    end
+  end
+end

data/lib/wavefront-cli/output/ruby.rb

@@ -0,0 +1,12 @@
+require_relative 'base'
+
+module WavefrontOutput
+  #
+  # Display as a raw Ruby object
+  #
+  class Ruby < Base
+    def run
+      p resp
+    end
+  end
+end

data/lib/wavefront-cli/output/wavefront.tf

@@ -0,0 +1,257 @@
+MERP MERP
+resource "wavefront_dashboard" "9f8d3f29-d965-4f7e-8473-43571e431b99" {
+  name = "JPC Website Host"
+  description = "overview of SmartOS zones"
+  url = "jpc-webhost"
+  section = [
+    { name = "Memory"
+      row = [
+        { chart = [
+          {
+            units = "B"
+            name = "Swap Free"
+            description = "Remember, on Solaris, \"swap\" means backing store, so this is all memory."
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "New Query"
+            query = "ts(\"tenant.swapresv.value\", env=${env}) - ts(\"tenant.swapresv.usage\", env=${env})"
+          }]
+          },
+          {
+            units = ""
+            name = "Free Physical Memory"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "physical memory"
+            query = "ts(\"tenant.physicalmem.value\", env=${env}) - ts(\"tenant.physicalmem.usage\", env=${env})"
+          },
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = true
+            source_description = ""
+            name = "out of memory"
+            query = "0"
+          }]
+          },
+          {
+            units = ""
+            name = "times over memory"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "times over memory"
+            query = "deriv(ts(\"tenant.memory_cap.nover\", env=${env}))"
+          }]
+          }]
+        },
+        { chart = [
+          {
+            units = "B"
+            name = "Sinatra application memory"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "New Query"
+            query = "sum(ts(\"process.memory.pr_rssize.*\", svc=\"svc:/application/sinatra/*\" and env=${env}), svc)"
+          }]
+          },
+          {
+            units = ""
+            name = "top memory consumers"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "by process name"
+            query = "sum(ts(\"process.memory.pr_rssize.*\", env=${env}), metrics)"
+          }]
+          }]
+        }]
+    },
+    { name = "nginx"
+      row = [
+        { chart = [
+          {
+            units = "req/s"
+            name = "\"200\" HTTP requests"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "Query"
+            query = "rate(ts(\"nginx.code.200\"))"
+          }]
+          },
+          {
+            units = "ms"
+            name = "request latency"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "total response time"
+            query = "ts(\"nginx.time.response.*\")"
+          },
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "upstream response time"
+            query = "ts(\"nginx.time.upstream_response.*\")"
+          }]
+          },
+          {
+            units = "req/s"
+            name = "HTTP Errors"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "40x"
+            query = "ceil(rate(ts(\"nginx.code.4*\")))"
+          },
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "50x"
+            query = "ceil(rate(ts(\"nginx.code.5*\")))"
+          }]
+          }]
+        }]
+    },
+    { name = "Processes and Services"
+      row = [
+        { chart = [
+          {
+            units = "processes"
+            name = "processes"
+            description = "number active processes in zone"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = true
+            source_description = ""
+            name = "running processes"
+            query = "ts(\"tenant.nprocs.usage\", env=${env})"
+          }]
+          },
+          {
+            units = "services"
+            name = "Service States"
+            description = "count of services in each possible state. Disabled service are not shown,"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "New Query"
+            query = "ts(\"smf.svcs.*\", env=${env})"
+          }]
+          }]
+        }]
+    },
+    { name = "Network"
+      row = [
+        { chart = [
+          {
+            units = "bytes"
+            name = "Network In"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "New Query"
+            query = "deriv(ts(\"network.*.net0.rbytes64\", env=${env}))"
+          }]
+          },
+          {
+            units = "bytes"
+            name = "Network Out"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "network out"
+            query = "deriv(ts(\"network.*.net0.obytes64\", env=${env}))"
+          }]
+          }]
+        },
+        { chart = [
+          {
+            units = "s"
+            name = "Puppet Run Time"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "time"
+            query = "ts(\"puppet.time.*\", env=${env})"
+          }]
+          },
+          {
+            units = "Units"
+            name = "Puppet Changes"
+            description = ""
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "New Query"
+            query = "ts(\"puppet.changes.total\")"
+          }]
+          }]
+        }]
+    },
+    { name = "Page Impressions"
+      row = [
+        { chart = [
+          {
+            units = ""
+            name = "Most read posts"
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "Query"
+            query = "sum(ts(\"nginx.code.200\", vhost=sysdef.xyz and path=\"/post/*\"), pointTags)"
+          }]
+          }]
+        },
+        { chart = [
+          {
+            units = ""
+            name = "most viewed pieces"
+            description = ""
+            source = [
+          {
+            scatter_plot_source = "Y"
+            query_builder_enabled = false
+            source_description = ""
+            name = "Query"
+            query = "sum(ts(\"nginx.code.200\", vhost=\"rdfisher.co.uk\" and path=\"/piece/*\"), pointTags)"
+          }]
+          }]
+        }]
+    }]
+  tags = []
+}