multiforecast-client 0.62.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1316eee0e12243629951f3a621150271e5df2a3f
+  data.tar.gz: f4cb9e1be15332f4f7cf51036f2d509ef93926c6
+SHA512:
+  metadata.gz: 61b291a15bbf7ce71c80783ef984ac3b56cc2a10862a8ccce2ae05034848dabf72bc6926f3bbd9fed495adcf0c8d5f4494636e29f250c0c723256564118ebb6f
+  data.tar.gz: 0cc4d55285915ff7334b047076c52efa49a3b5dc52d9fcddef604804260da1a5f33ccc9efdcbf37f6da602ad0c1849e100b362fc0d9ccbbcf78181bdffd89e0e

data/.gitignore

@@ -0,0 +1,14 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+.ruby-version
+vendor
+doc/*
+tags
+tmp/*
+.yardoc
+multiforecast.yml

data/.pryrc

@@ -0,0 +1,5 @@
+Pry.commands.alias_command 'c', 'continue'
+Pry.commands.alias_command 's', 'step'
+Pry.commands.alias_command 'n', 'next'
+Pry.commands.alias_command 'f', 'finish'
+

data/.rdebugrc

@@ -0,0 +1,4 @@
+set autolist
+set autoeval
+set autoreload
+

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+#  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# 0.62.0.1 (2013/07/06)
+
+First version
+

data/Gemfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+gemspec
+gem 'multiforecast-client', path: '.'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Naotoshi SEO
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# multiforecast-client
+
+testing ruby: 1.9.2, 1.9.3, 2.0.0; GrowthForecast: >= 0.62 (Jun 27, 2013 released)
+
+## About multiforecast-client
+
+`multiforecast-client` is a Multiple GrowthForecast Client, aimed to be used for [Yohoushi](https://github.com/yohoushi/yohoushi) visualization tool.
+
+Features
+
+- Possible to send http requests to multiple growthforecasts seemlessly
+- Enables to create graphs whose levels are more than 3.
+- CRUD graphs
+- Get graph image uri
+
+## USAGE
+
+### Library
+
+Create a client.
+
+```ruby
+require 'multiforecast-client'
+client = MultiForecast::Client.new('mapping' => {
+  'foo/' => 'http://localhost:5125',
+  ''     => 'http://localhost:5000'
+})
+```
+
+The first `post_graph` posts a number to the first GrowthForecast.
+The second `post_graph` posts a number to the second GrowthForecast because the specified path did not match with the first mapping rule 'foo/'.
+Notice that the pattern matching is processed from top as ruby's hash is an ordered hash.
+
+```ruby
+client.post_graph('foo/b/c/d', { 'number' => 0 })
+client.post_graph('bar/b/c/d', { 'number' => 0 })
+```
+
+See [examples](./examples) for more.
+
+### CLI
+
+`multiforecast-client` also provides a CLI named `multiforecast`.
+
+Generate a config file template to store a mapping rule:
+
+```
+$ multiforecast genearte config
+Generated multiforecast.yml
+$ cat multiforecast.yml
+---
+mapping:
+  '': http://localhost:5125
+short_metrics: true
+```
+
+Post a number and create a graph:
+
+```
+$ multiforecast post '{"number":0}' 'foo/a/b/c' -c multiforecast.yml
+```
+
+Delete a graph or graphs under a path:
+
+```
+$ multiforecast delete 'foo/' -c multiforecast.yml
+```
+
+See help for more:
+
+```
+$ multiforecast help
+```
+
+## INSIDE: How to treat graphs of more than 3 levels
+
+Although GrowthForecast can treat only graphs of 3 leveled path, MultiForecast can handle graphs of more than 3 levels.
+This feature is achieved by converting a given path to GrowthForecast's `service_name/section_name/graph_name` path as follows:
+
+    service_name = 'multiforecast'
+    section_name = CGI.escape(File.dirname(path)).gsub('+', '%20').gsub('.', '%2E')
+    graph_name   = File.basename(path)
+
+As a viewer for these converted path, [Yohoushi](https://github.com/yohoushi/yohoushi) is ready for you.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2013 Naotoshi SEO. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib -r multiforecast-client.rb'
+end
+task :c => :console

data/VERSION

@@ -0,0 +1 @@
+0.62.0.2

data/bin/multiforecast

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require 'multiforecast/cli'
+MultiForecast::CLI.start(ARGV)

data/examples/example.rb

@@ -0,0 +1,161 @@
+# -*- encoding: utf-8 -*-
+require 'multiforecast-client'
+require 'pp'
+
+### Create a Multi GrowthForecast Client
+client = MultiForecast::Client.new('mapping' => {
+  'app1/' => 'http://localhost:5125',
+  'app2/' => 'http://localhost:5000'
+})
+# client.debug_dev = STDOUT # print out HTTP requests and responses
+
+pp 'Create a graph (Post a number)'
+client.post_graph('app1/2xx_count', { 'number' => 0 })
+client.post_graph('app1/3xx_count', { 'number' => 0 })
+pp client.post_graph('app2/2xx_count', { 'number' => 0 }) #=>
+# {"error"=>0,
+#  "data"=>
+#   {"number"=>0,
+#    "llimit"=>-1000000000,
+#    "mode"=>"gauge",
+#    "stype"=>"AREA",
+#    "adjustval"=>"1",
+#    "meta"=>"",
+#    "service_name"=>"multiforecast",
+#    "gmode"=>"gauge",
+#    "color"=>"#33cc99",
+#    "created_at"=>"2013/05/20 17:57:57",
+#    "section_name"=>"multiforecast",
+#    "ulimit"=>1000000000,
+#    "id"=>2,
+#    "graph_name"=>"app2%2F2xx_count",
+#    "description"=>"",
+#    "sulimit"=>100000,
+#    "unit"=>"",
+#    "sort"=>0,
+#    "updated_at"=>"2013/05/20 17:57:57",
+#    "adjust"=>"*",
+#    "type"=>"AREA",
+#    "sllimit"=>-100000,
+#    "md5"=>"c81e728d9d4c2f636f067f89cc14862c"}}
+
+pp 'List graphs. All graphs from multiple growthforecasts are shown'
+pp client.list_graph #=>
+# [{"graph_name"=>"app1%2F3xx_count",
+#   "service_name"=>"multiforecast",
+#   "section_name"=>"multiforecast",
+#   "id"=>2,
+#   "base_uri"=>"http://localhost:5125",
+#   "path"=>"app1/3xx_count"},
+#  {"graph_name"=>"app1%2F2xx_count",
+#   "service_name"=>"multiforecast",
+#   "section_name"=>"multiforecast",
+#   "id"=>1,
+#   "base_uri"=>"http://localhost:5125",
+#   "path"=>"app1/2xx_count"},
+#  {"service_name"=>"multiforecast",
+#   "graph_name"=>"app2%2F2xx_count",
+#   "section_name"=>"multiforecast",
+#   "id"=>2,
+#   "base_uri"=>"http://localhost:5000",
+#   "path"=>"app2/2xx_count"}]
+
+pp 'List graphs by filtering by dirpath app1/'
+pp client.list_graph('app1/') #=>
+# [{"graph_name"=>"app1%2F3xx_count",
+#   "service_name"=>"multiforecast",
+#   "section_name"=>"multiforecast",
+#   "id"=>2,
+#   "base_uri"=>"http://localhost:5125",
+#   "path"=>"app1/3xx_count"},
+#  {"graph_name"=>"app1%2F2xx_count",
+#   "service_name"=>"multiforecast",
+#   "section_name"=>"multiforecast",
+#   "id"=>1,
+#   "base_uri"=>"http://localhost:5125",
+#   "path"=>"app1/2xx_count"}]
+
+pp 'Get a graph property'
+pp client.get_graph('app2/2xx_count') #=>
+# {"number"=>0,
+#  "llimit"=>-1000000000,
+#  "mode"=>"gauge",
+#  "stype"=>"AREA",
+#  "adjustval"=>"1",
+#  "meta"=>"",
+#  "service_name"=>"multiforecast",
+#  "gmode"=>"gauge",
+#  "color"=>"#33cc99",
+#  "created_at"=>"2013/05/20 17:57:57",
+#  "section_name"=>"multiforecast",
+#  "ulimit"=>1000000000,
+#  "id"=>2,
+#  "graph_name"=>"app2%2F2xx_count",
+#  "description"=>"",
+#  "sulimit"=>100000,
+#  "unit"=>"",
+#  "sort"=>0,
+#  "updated_at"=>"2013/05/20 17:57:57",
+#  "adjust"=>"*",
+#  "type"=>"AREA",
+#  "sllimit"=>-100000,
+#  "md5"=>"c81e728d9d4c2f636f067f89cc14862c",
+#  "base_uri"=>"http://localhost:5000",
+#  "path"=>"app2/2xx_count"}
+
+pp 'Get a graph image uri'
+pp client.get_graph_uri('app2/2xx_count', term: '3h') #=>
+# "http://localhost:5125/graph/multiforecast/multiforecast/app1%2F2xx_count?t=3h"
+
+pp 'Delete a complex graph'
+pp client.delete_graph('app2/2xx_count') #=>
+# {"location"=>"http://localhost:5000/list/multiforecast/multiforecast", "error"=>0}
+
+pp 'Create a complex graph'
+# Source graphs of a complex graph must exist on *a* GrowthForecast
+from_graphs= [
+  {"path"=>'app1/2xx_count', "gmode" => 'gauge', "stack" => true, "type" => 'AREA'},
+  {"path"=>'app1/3xx_count', "gmode" => 'gauge', "stack" => true, "type" => 'AREA'},
+]
+to_complex = {
+  'path' => 'app1/complex',
+  "description"  => "response time count",
+  "sort"         => 10,
+}
+pp client.create_complex(from_graphs, to_complex) #=>
+# {"location"=>"http://localhost:5125/list/multiforecast/multiforecast", "error"=>0}
+
+pp 'Get a complex graph'
+pp client.get_complex(to_complex['path']) #=>
+# {"number"=>0,
+#  "complex"=>true,
+#  "created_at"=>"2013/05/20 18:00:09",
+#  "service_name"=>"multiforecast",
+#  "section_name"=>"multiforecast",
+#  "id"=>1,
+#  "graph_name"=>"app1%2Fcomplex",
+#  "data"=>
+#   [{"gmode"=>"gauge", "stack"=>false, "type"=>"AREA", "graph_id"=>1},
+#    {"gmode"=>"gauge", "stack"=>true, "type"=>"AREA", "graph_id"=>2}],
+#  "sumup"=>false,
+#  "description"=>"response time count",
+#  "sort"=>10,
+#  "updated_at"=>"2013/05/20 18:00:09",
+#  "base_uri"=>"http://localhost:5125",
+#  "path"=>"app1/complex"}
+
+pp 'Get a complex graph image uri'
+pp client.get_complex_uri(to_complex['path'], term: '3h') #=>
+# "http://localhost:5125/complex/graph/multiforecast/multiforecast/app1%2Fcomplex?t=3h"
+
+pp 'List complex graphs'
+pp client.list_complex #=>
+# [{"service_name"=>"multiforecast", "graph_name"=>"app1%2Fcomplex", "section_name"=>"multiforecast", "id"=>1, "base_uri"=>"http://localhost:5125", "path"=>"app1/complex"}]
+
+pp 'List complex graphs by filetering by dirpath app1/'
+pp client.list_complex('app1/')
+
+pp 'Delete a complex graph'
+pp client.delete_complex(to_complex['path']) #=>
+# {"location"=>"http://localhost:5125/list/multiforecast/multiforecast", "error"=>0}
+

data/lib/multiforecast/cli.rb

@@ -0,0 +1,69 @@
+# -*- encoding: utf-8 -*-
+require 'thor'
+require 'yaml'
+require 'multiforecast-client'
+
+class MultiForecast::CLI < Thor
+  class_option :config,    :aliases => ["-c"], :type => :string
+  class_option :silent,    :aliases => ["-S"], :type => :boolean
+
+  def initialize(args = [], opts = [], config = {})
+    super(args, opts, config)
+
+    if options['config'] && File.exists?(options['config'])
+      @options = YAML.load_file(options['config']).merge(@options)
+    end
+    @client = MultiForecast::Client.new(@options)
+  end
+
+  desc 'generate config', 'Generate a sample config file'
+  def generate(target)
+    config = {
+      'mapping' => { '' => 'http://localhost:5125' },
+    }
+    File.open("multiforecast.yml", "w") do |file|
+      YAML.dump(config, file)
+      $stdout.puts "Generated #{file.path}"
+    end
+  end
+
+  desc 'post <json> <path>', 'Post a parameter to a path'
+  long_desc <<-LONGDESC
+    Post a parameter to a path
+
+    ex)
+    $ multiforecast post '{"number":0}' 'test/test' -c multiforecast.yml
+  LONGDESC
+  def post(json, path)
+    begin
+      res = @client.post_graph(path, JSON.parse(json))
+      $stdout.puts res unless @options['silent']
+    rescue => e
+      $stderr.puts "\tclass:#{e.class}\t#{e.message}"
+    end
+  end
+
+  desc 'delete <base_path>', 'Delete a graph or graphs under a path'
+  def delete(base_path)
+    graphs = @client.list_graph(base_path)
+    graphs.each do |graph|
+      begin
+        @client.delete_graph(graph['path'])
+        $stdout.puts "Deleted #{graph['path']}" unless @options['silent']
+      rescue => e
+        $stderr.puts "\tclass:#{e.class}\t#{e.message}"
+      end
+    end
+    complexes = @client.list_complex(base_path)
+    complexes.each do |graph|
+      begin
+        @client.delete_complex(graph['path'])
+        $stdout.puts "Deleted #{graph['path']}" unless @options['silent']
+      rescue => e
+        puts "\tclass:#{e.class}\t#{e.message}"
+      end
+    end
+    $stderr.puts "Not found" if graphs.empty? and complexes.empty? unless @options['silent']
+  end
+end
+