metricsspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec302ec862e5a74663f45ff5acc08c7d95115012
+  data.tar.gz: 561bde76d5faa0e507886b7d07585f4e58abaa88
+SHA512:
+  metadata.gz: d1cfe07dce729c8bec39f449676cacade41005343c19454e17db5288e28d9ebd83ae3b9382e8ff28ca75783621e9b450bf761692122fc1b685d97ae8700b092c
+  data.tar.gz: 507dad5c9061360725b8b0d5bd3fecd6baedaa3b62924b6f9c64b725b6558f691c3c3953e0ac0db87d2ab52629e93b81924b33480c6a276afa1265caf1084a6b

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Masaki Matsushita
+
+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,30 @@
+# MetricSspec
+
+MetricSpec is a tool for testing your server's metrics in elasticsearch.
+
+## Usage
+
+```ruby:spec_helper.rb
+require "metricsspec"
+
+RSpec.configure do |c|
+  c.elasticsearch = {
+    host: "localhost"
+  }
+end
+
+```
+
+```ruby:cpu_spec.rb
+describe metrics("@tag:dstat.cpu-usr").avg("value") do
+  it { should be < 90 }
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/metricsspec/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/metricsspec/field.rb

@@ -0,0 +1,41 @@
+module MetricsSpec
+  class Field
+    def initialize(metrics, field)
+      @metrics = metrics
+      @field = field.freeze
+    end
+
+    def inspect
+      "#<#{self.class.name}:\"#{@field}\" metrics=#{@metrics.inspect}>"
+    end
+
+    SingleValueAggs = [:min, :max, :sum, :avg, :value_count, :cardinality].freeze
+    SingleValueAggs.each do |aggregation_type|
+      define_method(aggregation_type) do
+        return @metrics.aggs(aggregation_type, @field)["value"]
+      end
+    end
+
+    MultiValueAggs = [:stats, :extended_stats, :percentiles].freeze
+    MultiValueAggs.each do |aggregation_type, **options|
+      define_method(aggregation_type) do
+        return @metrics.aggs(aggregation_type, @field)
+      end
+    end
+
+    def last(n=1)
+      hits = @metrics.last(n)
+      case hits
+      when Hash
+        hits[@field]
+      when Array
+        hits.map {|hit| hit[@field] }
+      end
+    end
+
+    def minmax
+      stats = stats()
+      return stats["min"], stats["max"]
+    end
+  end
+end

data/lib/metricsspec/helpers.rb

@@ -0,0 +1,15 @@
+module MetricsSpec
+  module Helpers
+    def metrics(query_string, **options)
+      return Metrics.new(query_string)
+    end
+
+    def search(*args)
+      ::MetricsSpec.client.search(*args)
+    end
+
+    def localhost
+      RSpec.configuration.host
+    end
+  end
+end

data/lib/metricsspec/metrics.rb

@@ -0,0 +1,115 @@
+module MetricsSpec
+  class Metrics
+    HostField = "@host"
+
+    def initialize(query_string, host_field: nil)
+      @query_string = query_string
+      @filters = []
+    end
+
+    attr_reader :query_string, :aggs, :filters
+
+    def initialize_copy(orig)
+      @filters = orig.filters.dup
+    end
+
+    def [](field)
+      Field.new(self, field)
+    end
+
+    def count
+      body = Jbuilder.encode do |json|
+        json.query do
+          json.query_string do
+            json.query @query_string
+          end
+        end
+        json.filter build_filters() unless @filters.empty?
+      end
+      return MetricsSpec.client.count(body: body)["count"]
+    end
+
+    TimestampDescSorter = [{ "@timestamp" => { order: "desc" } }]
+
+    def last(n=1)
+      body = Jbuilder.encode do |json|
+        json.size n
+        json.sort do
+          json.array! TimestampDescSorter
+        end
+      end
+      hits = search(body)["hits"]["hits"]
+      hits.map! {|hit| hit["_source"] }
+      return hits.first if n == 1
+      return hits
+    end
+
+    def empty?
+      count.zero?
+    end
+
+    def term(field, term)
+      filter = {
+        term: {
+          field => term
+        }
+      }
+      return filtered(filter)
+    end
+
+    def range(field, **range)
+      range.compact!
+      filter = {
+        range: {
+          field => range
+        }
+      }
+      return filtered(filter)
+    end
+
+    DefaultHostField = "@host"
+    DefaultTimeField = "@timestamp"
+
+    def at(host, field: DefaultHostField)
+      term(field, host)
+    end
+
+    def within(seconds, field: DefaultTimeField)
+      range(field, gte: "now-#{seconds}s")
+    end
+
+    def aggs(aggregation_type, field, **options)
+      field = field.to_s
+      query = Jbuilder.encode do |json|
+        json.size 0
+        json.aggs do
+          json.set! field do
+            json.set! aggregation_type do
+              json.field field
+              json.merge! options unless options.empty?
+            end
+          end
+        end
+        json.filter build_filters() unless @filters.empty?
+      end
+      return search(query)["aggregations"][field]
+    end
+
+    private
+
+    def search(body)
+      MetricsSpec.client.search(q: @query_string, body: body)
+    end
+
+    def build_filters
+      return @filters.first if @filters.size == 1
+      return Jbuilder.new {|json| json.and @filters }
+    end
+
+    def filtered(filter)
+      duped = self.dup
+      duped.filters.push(filter)
+      return duped
+    end
+  end
+end

data/lib/metricsspec/version.rb

@@ -0,0 +1,3 @@
+module Metricsspec
+  VERSION = "0.0.1"
+end

data/lib/metricsspec.rb

@@ -0,0 +1,26 @@
+require "socket"
+require "rspec/core"
+require "jbuilder"
+require "active_support/core_ext/numeric"
+require "elasticsearch"
+
+module MetricsSpec
+  module_function
+
+  def client
+    @@client ||= ::Elasticsearch::Client.new(RSpec.configuration.elasticsearch)
+  end
+end
+
+require "metricsspec/version"
+require "metricsspec/metrics"
+require "metricsspec/field"
+require "metricsspec/helpers"
+
+RSpec.configure do |c|
+  c.add_setting :host, default: Socket.gethostname
+  c.add_setting :host_field, default: "@host"
+  c.add_setting :elasticsearch
+end
+
+include MetricsSpec::Helpers

data/metricsspec.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'metricsspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "metricsspec"
+  spec.version       = Metricsspec::VERSION
+  spec.authors       = ["Masaki Matsushita"]
+  spec.email         = ["glass.saga@gmail.com"]
+  spec.summary       = %q{a tool for testing your server's metrics in elasticsearch}
+  spec.description   = %q{a tool for testing your server's metrics in elasticsearch}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "elasticsearch", "~> 1.0"
+  spec.add_dependency "activesupport", "~> 4.1"
+  spec.add_dependency "jbuilder", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+end

data/spec/metrics_spec.rb

@@ -0,0 +1,181 @@
+require_relative "spec_helper"
+
+include MetricsSpec
+
+describe MetricsSpec do
+  describe Helpers do
+    describe "metrics" do
+      before { include Helpers }
+      subject { metrics("foo") }
+      it { should be_a Metrics }
+    end
+  end
+
+  describe Metrics do
+    let(:query_string) { "@tag:foo.bar" }
+    subject  { Metrics.new(query_string) }
+    it { expect(subject.query_string).to eq query_string }
+
+    describe "count" do
+      let(:count) { 1 }
+
+      before do 
+        client = double("client")
+        expect(client).to receive(:count) do
+          { "count" => count }
+        end
+        expect(MetricsSpec).to receive(:client) { client }
+      end
+
+      it { expect(subject.count).to eq count }
+    end
+
+    describe "empty?" do
+      before do
+        client = double("client")
+        expect(client).to receive(:count) do
+          { "count" => 0 }
+        end
+        expect(MetricsSpec).to receive(:client) { client }
+      end
+
+      subject { metrics("foo") }
+
+      it { should be_empty }
+    end
+
+    describe "last" do
+      let(:item1) do
+        { 
+          "_source" => {
+            "foo" => "bar"
+          }
+        }
+      end
+
+      let(:item2) do
+        { 
+          "_source" => {
+            "hoge" => "fuga"
+          }
+        }
+      end
+
+      before do 
+        client = double("client")
+        expect(client).to receive(:search) do
+          { 
+            "hits" => {
+              "hits" => [
+                item1,
+                item2
+              ]
+            }
+          }
+        end
+        expect(MetricsSpec).to receive(:client) { client }
+      end
+
+      context "without arguments" do
+        it { expect(subject.last).to eq item1["_source"] }
+      end
+
+      context "n = 2" do
+        it { expect(subject.last(2)).to eq [item1["_source"], item2["_source"]] }
+      end
+    end
+
+
+
+    describe "range" do
+      let(:range_metrics) { metrics("foo").range("field", gt: "now-2m") }
+      let(:expected_filter) do
+        {
+          range: {
+            "field" => {
+              gt: "now-2m"
+            }
+          }
+        }
+      end
+
+      subject { range_metrics.filters }
+      it { expect(subject).to include expected_filter }
+
+      context "chain" do
+        let(:range_metrics) { metrics("foo").range("field1", gt: "now-2m").range("field2", gt: "now-2m") }
+        let(:filter1) do
+          {
+            range: {
+              "field1" => {
+                gt: "now-2m"
+              }
+            }
+          }
+        end
+        let(:filter2) do
+          {
+            range: {
+              "field2" => {
+                gt: "now-2m"
+              }
+            }
+          }
+        end
+
+        subject { range_metrics.filters }
+        it { expect(subject).to include filter1 }
+        it { expect(subject).to include filter2 }
+      end
+    end
+  end
+
+  describe Field do
+    let(:_metrics) { metrics("foo") }
+
+    describe "min" do
+      let(:field_name) { "value" }
+      let(:field) { _metrics[field_name] }
+      let(:min) { 42 }
+
+      before do 
+        client = double("client")
+        expect(client).to receive(:search) do
+          { 
+            "aggregations" => { 
+              field_name => {
+                "value" => min
+              }
+            }
+          }
+        end
+        expect(MetricsSpec).to receive(:client) { client }
+      end
+
+      it { expect(field.min).to eq min }
+    end
+
+    describe "stats" do
+      let(:field_name) { "value" }
+      let(:field) { _metrics[field_name] }
+      let(:avg) { 42 }
+      let(:stats_expected) { { "avg" => avg } }
+
+      before do 
+        client = double("client")
+        expect(client).to receive(:search) do
+          { 
+            "aggregations" => { 
+              field_name => {
+                "avg" => avg
+              }
+            }
+          }
+        end
+        expect(MetricsSpec).to receive(:client) { client }
+      end
+
+      it { expect(field.stats).to eq stats_expected }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative "../lib/metricsspec"

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: metricsspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Masaki Matsushita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: a tool for testing your server's metrics in elasticsearch
+email:
+- glass.saga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/metricsspec.rb
+- lib/metricsspec/field.rb
+- lib/metricsspec/helpers.rb
+- lib/metricsspec/metrics.rb
+- lib/metricsspec/version.rb
+- metricsspec.gemspec
+- spec/metrics_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: a tool for testing your server's metrics in elasticsearch
+test_files:
+- spec/metrics_spec.rb
+- spec/spec_helper.rb
+has_rdoc: