cloudstats 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 901b4e7eb8fcbe02e904e270563230c003d32896
+  data.tar.gz: 3f1d30106500d8439151b1331fce2df0c89b425b
+SHA512:
+  metadata.gz: 79449f16ba287d92ba8f6924c386e86a9e415eab28f082e11a4b932d045115807bf42673f133398f9780dc8f43c1b2fb50671389876465fca719c440ed9a193f
+  data.tar.gz: 2b38b87f2b14de75a76d7ea27c385a01c0077c3184c98d56a1ff755677e14714891d709195d848b09e9322a7323248187e43d2daac93b10d5a84bf45c3ff437e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cloudstats.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 niwo
+
+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,38 @@
+# Cloudstats
+
+Cloudstats pulls project and account statistics from the CloudStack API and feeds them into a Influxdb database.
+Whit the help of Grafana this let's you craft beautiful usage dashboards.
+
+## Installation
+
+Install the gem as:
+
+    $ gem install cloudstats
+
+## Usage
+
+Make sure you have a working [cloudstack_client](https://github.com/niwo/cloudstack_client) configuration file in your home directory.
+Usually this is found under `~/.cloudstack.yml`
+
+Install gem dependencies:
+
+    $ bundle install
+
+See the help for more options:
+
+    $ bin/cloudstats help
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/niwo/cloudstats.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/cloudstats

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+# resolve bin path, ignoring symlinks
+# resolve path, ignoring symlinks
+require "pathname"
+$:.unshift File.expand_path(
+  "../../lib", Pathname.new(__FILE__).realpath
+)
+require "cloudstats/cli"
+
+Cloudstats::Cli.start

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cloudstats"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cloudstats.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloudstats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloudstats"
+  spec.version       = Cloudstats::VERSION
+  spec.authors       = ["niwo"]
+  spec.email         = ["nik.wolfgramm@gmail.com"]
+
+  spec.summary       = %q{Collect CloudStack stats and feed them to influxdb.}
+  spec.description   = %q{Collect project and account statistics from the CloudStack API and feeds them into a influxdb.}
+  spec.homepage      = "https://github.com/niwo/cloudstats"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = %w(cloudstats)
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "thor", "~> 0.19"
+  spec.add_runtime_dependency "cloudstack_client", "~> 1.5.3"
+end

data/lib/cloudstats.rb

@@ -0,0 +1 @@
+require "cloudstats/version"

data/lib/cloudstats/cli.rb

@@ -0,0 +1,117 @@
+require "thor"
+require "cloudstats/version"
+require "cloudstats/collect"
+require "cloudstats/feed"
+
+module Cloudstats
+  class Cli < Thor
+    include Thor::Actions
+
+    package_name "cloudstats"
+
+    class_option :cloudstack_url,
+      default: "http://localhost:8080/client/api",
+      aliases: '-A',
+      desc: 'CloudStack API URL'
+
+    class_option :cloudstack_api_key,
+      aliases: '-k',
+      desc: 'CloudStack API Key'
+
+    class_option :cloudstack_secret_key,
+      aliases: '-s',
+      desc: 'CloudStack API Secret'
+
+    class_option :cloudstack_config,
+      default: CloudstackClient::Configuration.locate_config_file,
+      aliases: '-C',
+      desc: 'Location of your cloudstack-cli configuration file'
+
+    class_option :env,
+      aliases: '-E',
+      desc: 'cloudstack-cli environment to use'
+
+    class_option :influx_url,
+      default: "http://localhost:8086/",
+      aliases: '-U',
+      desc: 'Influxdb URL'
+
+    class_option :influx_user,
+      default: "cloudstack-stats",
+      aliases: '-u',
+      desc: 'Influxdb user'
+
+    class_option :influx_password,
+      aliases: '-p',
+      desc: 'Influxdb password'
+
+    class_option :database,
+      default: "cloudstack-stats",
+      aliases: '-D',
+      desc: 'Influxdb database'
+
+    class_option :debug,
+      aliases: '-D',
+      desc: 'Enable debug output',
+      type: :boolean,
+      default: false
+
+    # catch control-c and exit
+    trap("SIGINT") do
+      puts
+      puts "exiting.."
+      exit!
+    end
+
+    # exit with return code 1 in case of a error
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "version", "Print version number"
+    def version
+      say "cloudstats v#{Cloudstats::VERSION}"
+    end
+    map %w(-v --version) => :version
+
+    desc "projects", "Pull projects stats from CloudStack."
+    option :domain,
+      desc: "Name of Domain (for recursive search)",
+      default: "ROOT"
+    def projects
+      say "Collect stats...", :yellow
+      stats = Collect.new(options).project_stats
+      say "Write stats to influxdb...", :yellow
+      Feed.new(options).write(stats) {|stat, res| print_status(stat, res)}
+    rescue => e
+      say "ERROR: ", :red
+      puts e.message
+    end
+
+    desc "accounts", "Pull account stats from CloudStack."
+    option :domain,
+      desc: "Name of Domain (for recursive search)",
+      default: "ROOT"
+    def accounts
+      say "Collect stats...", :yellow
+      stats = Collect.new(options).account_stats
+      say "Write stats to influxdb...", :yellow
+      Feed.new(options).write(stats) {|stat, res| print_status(stat, res)}
+    # rescue => e
+    #   say "ERROR: ", :red
+    #   puts e.message
+    end
+
+    no_commands do
+      def print_status(stat, res)
+        print_in_columns [
+          stat['name'],
+          res.code == '204' ?
+            "OK (HTTP #{res.code})" :
+            "FAIL (HTTP #{res.code})"
+        ]
+      end
+    end
+
+  end # class
+end # module

data/lib/cloudstats/collect.rb

@@ -0,0 +1,65 @@
+require "cloudstack_client"
+require "cloudstack_client/configuration"
+require "yaml"
+
+module Cloudstats
+  class Collect
+
+    def initialize(settings)
+      @settings = settings.dup
+      @config = if @settings[:cloudstack_url] &&
+        @settings[:cloudstack_api_key] &&
+        @settings[:cloudstack_secret_key]
+        {
+          url: @settings[:cloudstack_url],
+          api_key: @settings[:cloudstack_api_key],
+          secret_key: @settings[:cloudstack_secret_key]
+        }
+      else
+        @settings[:config_file] = @settings[:cloudstack_config]
+        CloudstackClient::Configuration.load(@settings)
+      end
+      @cs ||= CloudstackClient::Client.new(
+        @config[:url],
+        @config[:api_key],
+        @config[:secret_key]
+      )
+      @cs.debug = true if @settings[:debug]
+      @cs
+    end
+
+    def account_stats
+      {
+        type: "account",
+        stats: @cs.list_accounts(client_options)
+      }
+    end
+
+    def project_stats
+      {
+        type: "project",
+        stats: @cs.list_projects(client_options)
+      }
+    end
+
+    private
+
+    def client_options
+      { listall: true, isrecursive: true }.merge(
+       resolve_domain(@settings)
+      )
+    end
+
+    def resolve_domain(opts)
+      if opts[:domain]
+        if domain = @cs.list_domains(name: opts[:domain]).first
+          opts[:domainid] = domain['id']
+        else
+          raise "Domain #{opts[:domain]} not found."
+        end
+      end
+      opts
+    end
+
+  end
+end

data/lib/cloudstats/feed.rb

@@ -0,0 +1,88 @@
+module Cloudstats
+  CS_TAGS = %w(domain)
+
+  CS_STATS = %w(
+    vmrunning vmstopped
+    memorytotal cputotal iptotal
+    primarystoragetotal
+    secondarystoragetotal
+    snapshottotal networktotal
+    volumetotal sentbytes
+  )
+
+  class Feed
+    require "net/http"
+    require "uri"
+
+    def initialize(opts = {})
+      @database = opts[:database]
+      @url = opts[:influx_url] ||
+        "http://localhost:8086/"
+      @user = opts[:influx_user]
+      @password = opts[:influx_password]
+      @debug = opts[:debug]
+      @total = {type: "total", stats: [{}]}
+    end
+
+    def write(stats, total = true)
+      uri = URI.parse(
+        URI.join(
+          @url,
+          "write?db=#{@database}&precision=m"
+        ).to_s
+      )
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if uri.scheme == "https"
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.content_type = "application/octet-stream"
+      request.basic_auth(@user, @password) if @user && @password
+
+
+      type = stats[:type]
+      stats[:stats].each do |stat|
+        add_to_total(stat) if total
+        request.body = line = stat_to_line(stat, type)
+        puts line if @debug
+        response = http.request(request)
+        yield(stat, response) if block_given?
+      end
+      if total
+        @total[:stats][0]['name'] = type
+        write(@total, total = false) {|stat, response| yield(stat, response)}
+      end
+    end
+
+    private
+
+    # builds influxdb line protocol strings
+    def stat_to_line(obj, type)
+      fields = Cloudstats::CS_STATS.map {|name| "#{name}=#{obj[name].to_i}i" }
+      unless type == "total"
+        tags = Cloudstats::CS_TAGS.map {|name| "#{name}=#{obj[name]}" }
+      end
+      line = "#{type}.#{normalize_name(obj["name"])},type=#{type}"
+      line += "," + tags.join(",") if tags
+      line +=  " " + fields.join(",")
+    end
+
+    def add_to_total(obj)
+      Cloudstats::CS_STATS.each do |stat|
+        if @total[:stats][0].key? stat
+          @total[:stats][0][stat] += obj[stat].to_i
+        else
+          @total[:stats][0][stat] = obj[stat].to_i
+        end
+      end
+    end
+
+    def normalize_name(name)
+      name.downcase.tr(" ", "-").tr("--", "-").gsub(/[^0-9A-Za-z\-\_]/, '')
+    end
+
+  end # class
+end # module

data/lib/cloudstats/version.rb

@@ -0,0 +1,3 @@
+module Cloudstats
+  VERSION = "0.5.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: cloudstats
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- niwo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: cloudstack_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+description: Collect project and account statistics from the CloudStack API and feeds
+  them into a influxdb.
+email:
+- nik.wolfgramm@gmail.com
+executables:
+- cloudstats
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/cloudstats
+- bin/console
+- bin/setup
+- cloudstats.gemspec
+- lib/cloudstats.rb
+- lib/cloudstats/cli.rb
+- lib/cloudstats/collect.rb
+- lib/cloudstats/feed.rb
+- lib/cloudstats/version.rb
+homepage: https://github.com/niwo/cloudstats
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Collect CloudStack stats and feed them to influxdb.
+test_files: []