aliyun-log 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d6196edae2aaeb7e8075c3b28b84a7381973910ae2f519ba6147f17980119b1
-  data.tar.gz: dbba3f0046ffac4762e13cebac50a7a883e6a5a74585c54c8bdda6c43dc7d95a
+  metadata.gz: 4cc759f537d07276e59933f681a0014ae89066e65c98b236c70e541f52173d85
+  data.tar.gz: a3fcb9eff51e48f11b3b578e47cbfc878d3796f0f9c1b0ad5ffa0638f9024ff6
 SHA512:
-  metadata.gz: f22410d5c16d83e0b54f9435301a17b4ec75ff72fbca11c583a95c0f40a8fa734311da4974eb7b0f22fad03b5b0f129bccf9b3f0ae6cdf91800500002bd1a476
-  data.tar.gz: ddc6c2fa7ad08f0cadeade94268997eae1241ade19b046a9439a4a52cf4e4735bbbc4936835139a5b479ef4d2b07b8e220e4b97b20294f8f5260cee86d54f972
+  metadata.gz: e7a836e5dc43c44fc22a22304fa1a140d0b230fde3047271fb65a70f8c866dfc0ec014e86b12666f2ce9cb7de73487038cab63698e5a21a6a423d7f69f8a3419
+  data.tar.gz: 46e1132a1d9a81af0e2279a6f847abe73f2c23265a7aea018f289b63b85a6bdfa6a5415031c1df45087c8aca8f1e61b02e22a6ce76f8e4e0401278673893962e

data/lib/aliyun/log.rb

@@ -9,11 +9,33 @@ require_relative 'log/protobuf'
 require_relative 'log/protocol'
 require_relative 'log/request'
 require_relative 'log/server_error'
+require_relative 'log/record'
 
 module Aliyun
   module Log
-    def self.configure
+    extend self
+
+    def configure
       block_given? ? yield(Config) : Config
     end
+    alias config configure
+
+    def included_models
+      @included_models ||= []
+    end
+
+    def record_connection
+      unless @record_connection
+        @record_connection = Protocol.new(Config.new)
+      end
+      @record_connection
+    end
+
+    def init_logstore
+      @included_models.each do |model|
+        model.create_logstore
+        modle.sync_index
+      end
+    end
   end
 end

data/lib/aliyun/log/config.rb

@@ -9,9 +9,11 @@ module Aliyun
       @read_timeout = 120
       @log_file = 'aliyun_log.log'
       @log_level = Logger::DEBUG
+      @timestamps = true
       class << self
         attr_accessor :endpoint, :access_key_id, :access_key_secret,
-                      :open_timeout, :read_timeout, :log_file, :log_level
+                      :open_timeout, :read_timeout, :log_file, :log_level,
+                      :timestamps, :project
 
         def configure
           yield self

data/lib/aliyun/log/protocol.rb

@@ -66,7 +66,7 @@ module Aliyun
 
       def create_logstore(project_name, logstore_name, opt = {})
         body = {
-          logstore_name: logstore_name,
+          logstoreName: logstore_name,
           ttl: opt[:ttl] || 365,
           shardCount: opt[:shard_count] || 2,
           autoSplit: opt[:auto_split].nil? ? false : opt[:auto_split],
@@ -105,10 +105,17 @@ module Aliyun
         @http.post({ project: project_name, logstore: logstore_name, is_pb: true }, content)
       end
 
-      def put_log(project_name, logstore_name, log_attr)
-        contents = log_attr.compact.map { |k, v| { key: k, value: v } }
-        log_pb = Protobuf::Log.new(time: Time.now.to_i, contents: contents)
-        lg_pb = Protobuf::LogGroup.new(logs: [log_pb])
+      def build_log_pb(attrs, time = Time.now.to_i)
+        logs = attrs.is_a?(Array) ? attrs : [attrs]
+        logs.map do |log_attr|
+          contents = log_attr.compact.map { |k, v| { key: k, value: v.to_s } }
+          Protobuf::Log.new(time: time, contents: contents)
+        end
+      end
+
+      def put_log(project_name, logstore_name, logs, opts = {})
+        logs = build_log_pb(logs, opts[:time] || Time.now.to_i)
+        lg_pb = Protobuf::LogGroup.new(logs: logs, topic: opts[:topic])
         @http.post({ project: project_name, logstore: logstore_name, is_pb: true }, lg_pb)
       end
 
@@ -175,8 +182,8 @@ module Aliyun
           keys: {}
         }
         fields.each do |k, v|
+          v[:token] = INDEX_DEFAULT_TOKEN if %w[text json].include?(v[:type].to_s) && v[:token].blank?
           body[:keys][k] = v
-          v[:token] = INDEX_DEFAULT_TOKEN if %w[text json].include?(v[:type]) && v[:token].blank?
         end
         @http.post({ project: project_name, logstore: logstore_name, action: 'index' }, body.to_json)
       end
@@ -189,8 +196,8 @@ module Aliyun
           keys: {}
         }
         fields.each do |k, v|
+          v[:token] = INDEX_DEFAULT_TOKEN if %w[text json].include?(v[:type].to_s) && v[:token].blank?
           body[:keys][k] = v
-          v[:token] = INDEX_DEFAULT_TOKEN if v[:type] == 'text' && v[:token].blank?
         end
         @http.put({ project: project_name, logstore: logstore_name, action: 'index' }, body.to_json)
       end

data/lib/aliyun/log/record.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/time'
+require 'active_support/core_ext'
+require 'active_model'
+require 'forwardable'
+
+require_relative 'record/exception'
+require_relative 'record/field'
+require_relative 'record/persistence'
+require_relative 'record/relation'
+
+module Aliyun
+  module Log
+    module Record
+      extend ActiveSupport::Concern
+
+      included do
+        extend ActiveModel::Callbacks
+        include ActiveModel::Validations
+
+        class_attribute :options, instance_accessor: false, default: {}
+        class_attribute :base_class, instance_accessor: false, default: self
+        class_attribute :log_connection, instance_accessor: false
+        class_attribute :_schema_load, default: false
+
+        Log.included_models << self unless Log.included_models.include? self
+
+        field :created_at, :text if Config.timestamps
+
+        define_model_callbacks :save, :create, :initialize
+
+        after_initialize :set_created_at
+      end
+
+      include Field
+      include Persistence
+
+      include ActiveModel::AttributeMethods
+
+      module ClassMethods
+        def logstore(options = {})
+          if options[:timestamps] && !Config.timestamps
+            field :created_at, :text
+          elsif options[:timestamps] == false && Config.timestamps
+            remove_field :created_at
+          end
+          self._schema_load = true if options[:auto_sync] == false
+          self.options = options
+        end
+
+        Relation.instance_methods(false).each do |method|
+          define_method(method) do |args|
+            relation.public_send(method, args)
+          end
+        end
+
+        %i[count load result].each do |method|
+          define_method(method) do
+            relation.public_send(method)
+          end
+        end
+
+        private
+
+        def relation
+          Relation.new(self)
+        end
+      end
+
+      def initialize(attrs = {})
+        run_callbacks :initialize do
+          @new_record = true
+          @attributes ||= {}
+
+          attrs_with_defaults = self.class.attributes.each_with_object({}) do |(attribute, options), res|
+            res[attribute] = if attrs.key?(attribute)
+                               attrs[attribute]
+                             elsif options.key?(:default)
+                               evaluate_default_value(options[:default])
+                             end
+          end
+
+          attrs_virtual = attrs.slice(*(attrs.keys - self.class.attributes.keys))
+
+          attrs_with_defaults.merge(attrs_virtual).each do |key, value|
+            if respond_to?("#{key}=")
+              send("#{key}=", value)
+            else
+              raise UnknownAttributeError, "unknown attribute '#{key}' for #{@record.class}."
+            end
+          end
+        end
+      end
+
+      def inspect
+        inspection = if defined?(@attributes) && @attributes
+                       self.class.attributes.keys.collect do |name|
+                         "#{name}: #{attribute_for_inspect(name)}" if has_attribute?(name)
+                       end.compact.join(', ')
+                     else
+                       'not initialized'
+        end
+
+        "#<#{self.class} #{inspection}>"
+      end
+
+      def attribute_for_inspect(attr_name)
+        value = read_attribute(attr_name)
+
+        if value.is_a?(String) && value.length > 50
+          "#{value[0, 50]}...".inspect
+        elsif value.is_a?(Date) || value.is_a?(Time)
+          %("#{value.to_s(:db)}")
+        else
+          value.inspect
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/log/record/exception.rb

@@ -0,0 +1,9 @@
+module Aliyun
+  module Log
+    module Record
+      class ArgumentError < StandardError; end
+      class UnknownAttributeError < StandardError; end
+      class ProjectNameError < StandardError; end
+    end
+  end
+end

data/lib/aliyun/log/record/field.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+require "active_support"
+require "active_support/time"
+require "active_support/core_ext"
+require "active_model"
+
+module Aliyun
+  module Log
+    module Record
+      module Field
+        extend ActiveSupport::Concern
+
+        # Types allowed in indexes:
+        PERMITTED_KEY_TYPES = %i[
+          text
+          long
+          double
+          json
+        ].freeze
+
+        DEFAULT_INDEX_TOKEN = ", '\";=()[]{}?@&<>/:\n\t\r".split('')
+
+        included do
+          class_attribute :attributes, instance_accessor: false, default: {}
+        end
+
+        module ClassMethods
+          def field(name, type = :text, options = {})
+            unless PERMITTED_KEY_TYPES.include?(type)
+              raise ArgumentError, "Field #{name} type(#{type}) error, key type only support text/long/double/json"
+            end
+            named = name.to_s
+            self.attributes = attributes.merge(name => { type: type }.merge(options))
+
+            warn_about_method_overriding(name, name)
+            warn_about_method_overriding("#{named}=", name)
+            warn_about_method_overriding("#{named}?", name)
+
+            define_attribute_method(name) # Dirty API
+
+            generated_methods.module_eval do
+              define_method(named) { read_attribute(named) }
+              define_method("#{named}?") do
+                value = read_attribute(named)
+                case value
+                when true        then true
+                when false, nil  then false
+                else
+                  !value.nil?
+                end
+              end
+              define_method("#{named}=") { |value| write_attribute(named, value) }
+            end
+          end
+
+          def remove_field(field)
+            field = field.to_sym
+            attributes.delete(field) || raise('No such field')
+
+            undefine_attribute_methods
+            define_attribute_methods attributes.keys
+
+            generated_methods.module_eval do
+              remove_method field
+              remove_method :"#{field}="
+              remove_method :"#{field}?"
+              remove_method :"#{field}_before_type_cast"
+            end
+          end
+
+          private
+
+          def generated_methods
+            @generated_methods ||= begin
+              Module.new.tap do |mod|
+                include(mod)
+              end
+            end
+          end
+
+          def warn_about_method_overriding(method_name, field_name)
+            if instance_methods.include?(method_name.to_sym)
+              Common::Logging.logger.warn("Method #{method_name} generated for the field #{field_name} overrides already existing method")
+            end
+          end
+        end
+
+        def attribute_names
+          @attributes.keys
+        end
+
+        def has_attribute?(attr_name)
+          @attributes.key?(attr_name.to_sym)
+        end
+
+        def evaluate_default_value(val)
+          if val.respond_to?(:call)
+            val.call
+          elsif val.duplicable?
+            val.dup
+          else
+            val
+          end
+        end
+
+        attr_accessor :attributes
+
+        def write_attribute(name, value)
+          attributes[name.to_sym] = value
+        end
+
+        alias []= write_attribute
+
+        def read_attribute(name)
+          attributes[name.to_sym]
+        end
+        alias [] read_attribute
+
+        def set_created_at
+          self.created_at ||= DateTime.now.in_time_zone(Time.zone).to_s if timestamps_enabled?
+        end
+
+        def timestamps_enabled?
+          self.class.options[:timestamps] || (self.class.options[:timestamps].nil? && Config.timestamps)
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/log/record/persistence.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Aliyun
+  module Log
+    module Record
+      module Persistence
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+          def logstore_name
+            @logstore_name ||= options[:name] || base_class.name.split('::').last.downcase.pluralize
+          end
+
+          def logstore_name=(value)
+            if defined?(@logstore_name)
+              return if value == @logstore_name
+            end
+
+            @logstore_name = value
+          end
+
+          def project_name
+            unless @project_name
+              @project_name = options[:project] || Config.project
+              raise ProjectNameError, "project can't be empty" if @project_name.blank?
+            end
+            @project_name
+          end
+
+          def create_logstore(options = {})
+            Log.record_connection.get_logstore(project_name, logstore_name)
+          rescue ServerError => e
+            Log.record_connection.create_logstore(project_name, logstore_name, options)
+          end
+
+          def sync_index
+            has_index? ? update_index : create_index
+          end
+
+          def auto_load_schema
+            return if _schema_load
+
+            create_logstore
+            sync_index
+            self._schema_load = true
+          end
+
+          def has_index?
+            Log.record_connection.get_index(project_name, logstore_name)
+            true
+          rescue ServerError
+            false
+          end
+
+          def create(data, opts = {})
+            auto_load_schema
+            if data.is_a?(Array)
+              logs = []
+              data.each do |log_attr|
+                logs << new(log_attr).save_array
+              end
+              res = Log.record_connection.put_log(project_name, logstore_name, logs, opts)
+              res.code == 200
+            else
+              new(data).save
+            end
+          end
+
+          private
+
+          def evaluate_default_value(val)
+            if val.respond_to?(:call)
+              val.call
+            elsif val.duplicable?
+              val.dup
+            else
+              val
+            end
+          end
+
+          def field_indices
+            if options[:field_index] == true
+              attributes.reject { |_, value| value[:index] == false }
+            else
+              attributes.select { |_, value| value[:index] == true }
+            end
+          end
+
+          def create_index
+            Log.record_connection.create_index(
+              project_name,
+              logstore_name,
+              field_indices
+            )
+          end
+
+          def update_index
+            conf_res = Log.record_connection.get_index(project_name, logstore_name)
+            raw_conf = JSON.parse(conf_res)
+            index_conf = raw_conf.dup
+            field_indices.each do |k, v|
+              index_conf['keys'][k.to_s] ||= v
+            end
+            return if index_conf['keys'] == raw_conf['keys']
+
+            Log.record_connection.update_index(
+              project_name,
+              logstore_name,
+              index_conf['keys']
+            )
+          end
+        end
+
+        def save
+          self.class.auto_load_schema
+          run_callbacks(:create) do
+            run_callbacks(:save) do
+              if valid?
+                res = Log.record_connection.put_log(self.class.project_name, self.class.logstore_name, attributes)
+                res.code == 200
+              else
+                false
+              end
+            end
+          end
+        end
+
+        def save_array
+          run_callbacks(:create) do
+            run_callbacks(:save) do
+              validate! && attributes
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/log/record/relation.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module Aliyun
+  module Log
+    module Record
+      class Relation
+        def initialize(klass, opts = {})
+          @klass = klass
+          @opts = opts
+          @klass.auto_load_schema
+          @opts[:search] ||= '*'
+        end
+
+        def from(from)
+          ts = from.is_a?(Integer) ? from : from.to_time.to_i
+          @opts[:from] = ts
+          self
+        end
+
+        def to(to)
+          ts = to.is_a?(Integer) ? to : to.to_time.to_i
+          @opts[:to] = ts
+          self
+        end
+
+        def line(val)
+          @opts[:line] = val.to_i
+          self
+        end
+        alias limit line
+
+        def offset(val)
+          @opts[:offset] = val.to_i
+          self
+        end
+
+        def page(val)
+          @opts[:page] = val - 1 if val >= 1
+          self
+        end
+
+        def where(opts)
+          @opts.merge!(opts)
+          self
+        end
+
+        def search(str)
+          @opts[:search] = str
+          self
+        end
+
+        def sql(str)
+          @opts[:sql] = str
+          self
+        end
+
+        def query(opts = {})
+          @opts[:query] = opts
+          self
+        end
+
+        def count
+          query = @opts.dup
+          if query[:query].blank?
+            where_cond = query[:sql].split(/where /i)[1] if query[:sql].present?
+            query[:query] = "#{query[:search]}|SELECT COUNT(*) as count"
+            query[:query] = "#{query[:query]} WHERE #{where_cond}" if where_cond.present?
+          end
+          res = Log.record_connection.get_logs(@klass.project_name, @klass.logstore_name, query)
+          res = JSON.parse(res.body)
+          res[0]['count'].to_i
+        end
+
+        def result
+          query = @opts.dup
+          if query[:page]
+            query[:line] ||= 100
+            query[:offset] = query[:page] * query[:line]
+          end
+          query[:query] = query[:search]
+          query[:query] = "#{query[:query]}|#{query[:sql]}" if query[:sql].present?
+          res = Log.record_connection.get_logs(@klass.project_name, @klass.logstore_name, query)
+          JSON.parse(res)
+        end
+
+        def load
+          result.map do |json_attr|
+            attrs = {}
+            @klass.attributes.keys.each do |k, _|
+              attrs[k] = json_attr[k.to_s]
+            end
+            @klass.new(attrs)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/log/request.rb

@@ -53,24 +53,21 @@ module Aliyun
 
       def do_request(verb, resources, payload)
         resource_path = get_resource_path(resources)
-        headers = {}
-        if verb == 'GET'
-          headers = compact_headers
-          headers['Authorization'] = signature(verb, resource_path, headers, payload)
-        else
-          headers = compact_headers(payload, resources[:is_pb])
-          headers['Authorization'] = signature(verb, resource_path, headers)
-        end
         request_options = {
           method: verb,
           url: get_request_url(resources),
-          headers: headers,
           open_timeout: @config.open_timeout,
           read_timeout: @config.read_timeout
         }
         if verb == 'GET'
+          headers = compact_headers
+          headers['Authorization'] = signature(verb, resource_path, headers, payload)
+          request_options[:headers] = headers
           request_options[:url] = URI.escape(canonicalized_resource(request_options[:url], payload))
         else
+          headers = compact_headers(payload, resources[:is_pb])
+          headers['Authorization'] = signature(verb, resource_path, headers)
+          request_options[:headers] = headers
           payload = Zlib::Deflate.deflate(payload.encode) if resources[:is_pb]
           request_options[:payload] = payload
         end
@@ -104,7 +101,6 @@ module Aliyun
         if is_pb
           compressed = Zlib::Deflate.deflate(body.encode)
           headers['Content-Length'] = compressed.bytesize.to_s
-          # 日志内容包含的日志必须小于3MB和4096条。
           raise 'content length is larger than 3MB' if headers['Content-Length'].to_i > 3_145_728
 
           headers['Content-MD5'] = Digest::MD5.hexdigest(compressed).upcase

data/lib/aliyun/version.rb

@@ -2,6 +2,6 @@
 
 module Aliyun
   module Log
-    VERSION = '0.1.3'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-log
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Yingce Liu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +131,11 @@ files:
 - lib/aliyun/log/project.rb
 - lib/aliyun/log/protobuf.rb
 - lib/aliyun/log/protocol.rb
+- lib/aliyun/log/record.rb
+- lib/aliyun/log/record/exception.rb
+- lib/aliyun/log/record/field.rb
+- lib/aliyun/log/record/persistence.rb
+- lib/aliyun/log/record/relation.rb
 - lib/aliyun/log/request.rb
 - lib/aliyun/log/server_error.rb
 - lib/aliyun/version.rb