influxer 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f441918c927f139e08eaa0e07e66171c130b5f35
-  data.tar.gz: c26b9d64e124409ae490d391457010497b6dcea9
+  metadata.gz: 3bb445897c491a860d94249f174bc02e9ad6b61f
+  data.tar.gz: 011778f550be687a6d1503618f98ec70dd454c2a
 SHA512:
-  metadata.gz: 942b9ff9c5960df2ee79188431373b24575d0cf5965136631fc993edbfbe7635adc6f321a15464a6a3904eed169f843bb4480af7d15e8ee3aecd9774144b69af
-  data.tar.gz: 63662390624e4c40b3c6cb14ee103157a6b30f27c15a1c7de6bc4354c7f0dd045b27386998d6a27510de02cd730fca1d4b4726d83071ffd879740d9995e335b9
+  metadata.gz: 85e6922159fc728186d5b3a0736ff1c9950f1af0a1d70f8452e91f6e1759e2508a1e1566d9f55482ffefe62a01b39d2843aea81aec8e5382217e015291b26dd5
+  data.tar.gz: 232e5a9108e36d1378134a1e26fbc9d25367a569cae4a3f7ab752c2c48f3da5ea47e395019032fd2896cc6ed90421c6e8b07283b94690453e2d8ec120b0fe144

data/.gitignore

@@ -33,5 +33,4 @@ spec/dummy/tmp/
 
 Gemfile.lock
 .rspec
-
-
+*.gem

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 rvm:
   - 2.0.0
   - 2.1
@@ -14,8 +15,8 @@ matrix:
     - rvm: 2.1
       gemfile: gemfiles/rails40.gemfile
 
-    - rvm: 2.0.0
+    - rvm: 2.1
       gemfile: gemfiles/rails41.gemfile
 
     - rvm: 2.1
-      gemfile: gemfiles/rails41.gemfile
+      gemfile: gemfiles/rails42.gemfile

data/Changelog.md

@@ -0,0 +1,19 @@
+## 0.1.0
+- Add logs
+- Add `foreign_key` param to `has_metrics` options
+
+## 0.1.0-rc
+- Fix `Relation#to_a` (now returns array of points correctrly)
+- Fix fanout queries with array args (now use `merge(Regexp)`)
+
+## 0.1.0-alpha
+- Add `time` method to Relation to group by time with constants (`:hour`, `:day`, etc) and fill support
+- Series names now properly quoted with double-quotes
+- Using regexps, ranges and arrays within `where` clause
+- `where.not(...)` support
+- Add `past` and `since` methods
+- Add `merge` method and support for regexp series
+- Add `delete_all` support
+- Add cache support (using `Rails.cache`)
+- Scopes (default and named)
+- Support for fanout series

data/Gemfile

@@ -1,16 +1,3 @@
 source "https://rubygems.org"
-
-# Declare your gem's dependencies in influxer.gemspec.
-# Bundler will treat runtime dependencies like base dependencies, and
-# development dependencies will be added by default to the :development group.
-gem 'sqlite3'
-gem 'pry-byebug'
 gemspec
 
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
-
-# To use debugger
-# gem 'debugger'

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 YOURNAME
+Copyright 2014 palkan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,14 +2,59 @@
 
 ## Influxer
 
-Use InfluxDB in your Rails (>4.0) application.
+ActiveRecord-like wrapper for [influxdb-ruby](https://github.com/influxdb/influxdb-ruby) with many useful features, such as:
+- Familar query language (use `select`, `where`, `not`, `group` etc).
+- Support for Regex conditions: `where(page_id: /^home\/.*/) #=> select * ... where page_id=~/^home\/.*/`.
+- Special query methods for InfluxDB: 
+    - `time` - group by time (e.g. `Metrics.time(:hour) => # select * ... group by time(1h)`);
+    - `past` - get only points for last hour/minute/whatever (e.g. `Metrics.past(:day) => # select * ... where time > now() - 1d`);
+    - `since` - get only points since date (e.g. `Metrics.since(Time.utc(2014,12,31)) => # select * ... where time > 1419984000s`);
+    - `merge` - merge series.
+- Scopes support
+    ```
+    class Metrics < Influxer::Metrics
+        default_scope -> { time(:hour).limit(1000) }
+        scope :unlimited, -> { limit(nil) }
+        scope :by_account, -> (id) { where(account_id: id) if id.present? }
+    end
 
-### Basic support
+    Metrics.by_account(1)
+    # => select * from "metrics" group by time(1h) where account_id=1 limit 1000
 
-ToDo
+    Metrics.unlimited.by_account(1).time(:week)
+    # => select * from "metrics" group by time(1w) where account_id=1
 
-### ActiveRecord 
+    ```
+- Support for handling fanout series as one metrics.
+    ```
+    class Metrics < Influxer::Metrics
+        fanout :account, :user, :page
+    end
 
-`has_metrics`
+    Metrics.where(account: 1)
+    # => select * from "metrics_account_1" 
 
-ToDo
+
+    Metrics.where(page: 'home').where(user: 12)
+    # => select * from "metrics_user_12_page_home" 
+
+    Metrics.where(page: /(home|faq)/).where(account: 1).where(user: 12)
+    # => select * from /^metrics_account_1_user_12_page_(home|faq)$/ 
+
+    ``` 
+- Integrate with your model:
+    ```
+    class UserVisits < Influxer::Metrics
+    end
+    
+    class User < ActiveRecord::Base
+        has_metrics :visits
+    end
+
+    user = User.find(1)
+    user.visits.write(page_id: 'home')
+    #=> < creates point {user_id: 1, page_id: 'home'} in 'user_visits' series >
+
+    user.visits.where(page_id: 'home')
+    #=> select * from user_visits where page_id='home'
+    ```

data/gemfiles/rails42.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'sqlite3', platform: :mri
+gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+gem 'rails', '~> 4.2.0'
+
+gemspec path: '..'

data/influxer.gemspec

@@ -1,16 +1,14 @@
 $:.push File.expand_path("../lib", __FILE__)
 
-# Maintain your gem's version:
 require "influxer/version"
 
-# Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
   s.name        = "influxer"
   s.version     = Influxer::VERSION
   s.authors     = ["Vlad Dem"]
   s.email       = ["dementiev.vm@gmail.com"]
   s.homepage    = "http://github.com/palkan/influxer"
-  s.summary     = "InfluxDB support for Rails"
+  s.summary     = "InfluxDB for Rails"
   s.description = "InfluxDB the Rails way"
   s.license     = "MIT"
 
@@ -22,6 +20,10 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "timecop"
   s.add_development_dependency "simplecov", ">= 0.3.8"
-  s.add_development_dependency "rspec", "~> 3.0.0"
-  s.add_development_dependency "rspec-rails", "~> 3.0.0"
+
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency "rspec", "~> 3.1.0"
+  s.add_development_dependency "rspec-rails", "~> 3.1.0"
 end

data/lib/influxer/client.rb

@@ -3,7 +3,53 @@ require 'influxdb'
 module Influxer
   class Client < ::InfluxDB::Client
     def initialize
+      @instrumenter = ActiveSupport::Notifications.instrumenter
       super Influxer.config.database, Influxer.config.as_json.symbolize_keys!
     end
+
+    def cached_query(sql)
+      log(sql) do
+        unless Influxer.config.cache == false
+          Rails.cache.fetch(normalized_cache_key(sql), cache_options(sql)) { self.query(sql) }
+        else
+          self.query(sql)
+        end
+      end
+    end
+    
+    private
+
+      def log(sql)
+        return yield unless logger.debug?
+
+        _start = Time.now
+        res = yield
+        _duration = (Time.now - _start)*1000
+        
+        name  = "InfluxDB SQL (#{_duration.round(1)}ms)"
+
+        # bold black name and blue query string
+        msg = "\e[1m\e[30m#{name}\e[0m  \e[34m#{sql}\e[0m"
+        logger.debug msg
+        res
+      end
+
+      def cache_options(sql=nil)
+        options = Influxer.config.cache.dup
+        # if sql contains 'now()' set expires to 1 minute or :cache_now_for value of config.cache if defined
+        if sql =~ /\snow\(\)/
+          options[:expires_in] = options[:cache_now_for] || 60
+        end
+        options
+      end
+
+      # add prefix; remove whitespaces
+      def normalized_cache_key(sql)
+        "influxer:#{sql.gsub(/\s*/, '')}"
+      end
+
+      def logger
+        Rails.logger
+      end
   end
 end

data/lib/influxer/config.rb

@@ -7,6 +7,7 @@ module Influxer
                   :password,
                   :use_ssl,
                   :async,
+                  :cache,
                   :retry,
                   :time_precision,
                   :initial_delay,
@@ -20,6 +21,7 @@ module Influxer
       @port = 8083
       @use_ssl = false
       @async = true
+      @cache = false
       @retry = false
       @time_precision = 's'
       @max_delay = 30
@@ -42,6 +44,14 @@ module Influxer
       config.each do |key, val| 
         self.send("#{key}=",val)
       end
+
+      # we want pass @cache value as options to cache store, so we want it to be a Hash
+      if @cache == true
+        @cache = {}
+      elsif @cache != false
+        # cache keys should be symbols to work as Rails.cache options
+        @cache.symbolize_keys!
+      end
     end
   end
 end

data/lib/influxer/metrics/fanout.rb

@@ -0,0 +1,53 @@
+module Influxer
+  module Fanout
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :fanouts, :fanouts_by_name, :fanout_options
+      self.fanouts = []
+      self.fanouts_by_name = {} # to use within `fanout?`
+      self.fanout_options = {delimeter: "_"} 
+    end 
+    
+    module ClassMethods
+      # Define fanouts for metrics as array of keys.
+      # Order of keys is important.
+      # Fanout delimeter can be set with 'delimiter' option (defaults to '_').
+      # 
+      #   class MyMetrics < Influxer::Metrics
+      #     set_series "my_points"
+      #     fanout :account_id, :user_id
+      #   end
+      #   
+      #   MyMetrics.where(user_id: 1).where(account_id: 10)
+      #   # select * from my_points_account_id_10_user_id_1
+      #   
+      #   class MyMetrics < Influxer::Metrics
+      #     set_series "my_points"
+      #     fanout :account_id, :user_id, delimiter: "."
+      #   end
+      #   
+      #   MyMetrics.where(user_id: 1).where(account_id: 10).where("req_time > 1000")
+      #   # select * from my_points.account_id.10.user_id.1 where req_time > 1000
+         
+      def fanout(*args, **hargs)
+        self.fanout_options = self.fanout_options.merge hargs
+
+        names = args.map(&:to_s) # convert all to strings (because args can be both Symbols and Strings)
+        
+        self.fanouts = (self.fanouts+names).uniq
+
+        names_hash = {}
+        names.each do |name|
+          names_hash[name] = 1
+        end
+
+        self.fanouts_by_name = self.fanouts_by_name.merge names_hash
+      end      
+
+      def fanout?(key)
+        self.fanouts_by_name.key?(key.to_s)
+      end
+    end
+  end
+end

data/lib/influxer/metrics/metrics.rb

@@ -1,3 +1,6 @@
+require 'influxer/metrics/scoping'
+require 'influxer/metrics/fanout'
+
 module Influxer
   class MetricsError < StandardError; end
   class MetricsInvalid < MetricsError; end
@@ -7,10 +10,13 @@ module Influxer
     include ActiveModel::Validations
     extend ActiveModel::Callbacks
 
+    include Influxer::Scoping
+    include Influxer::Fanout
+
     define_model_callbacks :write
 
     class << self
-      delegate :select, :where, :group, :limit, :delete_all, to: :all
+      delegate :select, :where, :group, :merge, :time, :past, :since, :limit, :fill, :delete_all, to: :all
 
       def attributes(*attrs)
         attrs.each do |name|
@@ -32,14 +38,14 @@ module Influxer
         if args.empty?
           matches = self.to_s.match(/^(.*)Metrics$/)
           if matches.nil?
-            @series = self.to_s.underscore
+            @series = self.superclass.respond_to?(:series) ? self.superclass.series : self.to_s.underscore
           else
             @series = matches[1].split("::").join("_").underscore
           end
         elsif args.first.is_a?(Proc)
           @series = args.first
         else
-          @series = args.join(",")
+          @series = args
         end
       end
 
@@ -48,7 +54,11 @@ module Influxer
       end
 
       def all
-        Relation.new self
+        if current_scope
+          current_scope.clone
+        else
+          default_scoped
+        end          
       end
     end
 
@@ -83,13 +93,31 @@ module Influxer
     end
 
     def series
-      self.class.series.is_a?(Proc) ? self.class.series.call(self) : self.class.series
+      quote_series(self.class.series)
     end
 
     def client
       Influxer.client
     end
 
+    def quote_series(val)
+      case val
+      when Regexp
+        val.inspect
+      when Proc
+        quote_series(self.class.series.call(self))
+      when Array
+        if val.length > 1
+          "merge(#{ val.map{ |s| quote_series(s) }.join(',') })"
+        else
+          quote_series(val.first)
+        end
+      else
+        '"'+val.to_s.gsub(/\"/){ %q{\"} }+'"'  
+      end
+    end
+
     attributes :time
+  
   end
 end 

data/lib/influxer/metrics/relation/fanout_query.rb

@@ -0,0 +1,33 @@
+module Influxer
+  module FanoutQuery
+    # Instance methods are included to Relation    
+    def build_fanout(key, val)
+      @values[:has_fanout] = true
+      if val.is_a?(Regexp)
+        @values[:fanout_rxp] = true
+        fanout_values[key.to_s] = val.inspect[1..-2]     
+      else
+        fanout_values[key.to_s] = val.to_s
+      end
+    end
+
+    def build_series_name
+      if @values[:has_fanout] == true
+        fan_parts = [@instance.series[1..-2]]
+        @klass.fanouts.each do |name|
+          if fanout_values.key?(name)
+            fan_parts << name
+            fan_parts << fanout_values[name]
+          end
+        end  
+        if @values[:fanout_rxp] == true
+          "merge(/^#{ fan_parts.join( @klass.fanout_options[:delimeter] ) }$/)"
+        else
+          @instance.quote_series(fan_parts.join(@klass.fanout_options[:delimeter]))
+        end
+      else
+        @instance.series
+      end
+    end
+  end
+end

data/lib/influxer/metrics/relation/time_query.rb

@@ -0,0 +1,73 @@
+module Influxer
+  module TimeQuery
+    TIME_ALIASES = {
+      hour: '1h',
+      minute: '1m',
+      second: '1s',
+      ms: '1u',
+      week: '1w',
+      day: '1d',
+      month: '30d'        
+    }
+
+    # Add group value to relation. To be used instead of `group("time(...)").
+    # Accepts symbols and strings.
+    # 
+    # You can set fill value within options.
+    #
+    #    Metrics.time(:hour)
+    #    # select * from metrics group by time(1h)
+    #    
+    #    Metrics.time("4d", fill: 0)
+    #    # select * from metrics group by time(4d) fill(0)
+
+    def time(val, options={})
+      if val.is_a?(Symbol)
+        @values[:time] = TIME_ALIASES[val] || '1'+val.to_s
+      else
+        @values[:time] = val
+      end
+
+      unless options[:fill].nil?
+        fill( (options[:fill] == :null) ? 'null' : options[:fill].to_i)
+      end
+      self
+    end
+
+    # Shortcut to define time interval with regard to current time.
+    # Accepts symbols and numbers.
+    #
+    #    Metrics.past(:hour)
+    #    # select * from metrics where time > now() - 1h
+    #    
+    #    Metrics.past(:d)
+    #    # select * from metrics where time > now() - 1d    
+    #        
+    #    Metrics.past(2.days)
+    #    # select * from metrics where time > now() - 172800s
+
+    def past(val)
+      case val
+      when Symbol
+        where("time > now() - #{ TIME_ALIASES[val] || ('1'+val.to_s) }")
+      when String
+        where("time > now() - #{val}")
+      else
+        where("time > now() - #{val.to_i}s")
+      end
+    end
+
+    # Shortcut to define start point of the time interval.
+    # Accepts DateTime objects.
+    #
+    #    Metrics.since(1.day.ago) # assume that now is 2014-12-31 12:00:00 UTC 
+    #    # select * from metrics where time > 1420027200s
+    #    
+    #    Metrics.since(Time.local(2014,12,31))
+    #    # select * from metrics where time > 1419984000s
+
+    def since(val)
+      where("time > #{val.to_i}s")
+    end
+  end
+end