flog_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d3b3da22d214f61a1580ace6ed446bce8b9dcc9
+  data.tar.gz: 25457d30e980c0c3800fad7b8be99cbbcca3a1a7
+SHA512:
+  metadata.gz: 222bb9bcf2d3f7f006f67cb00cab86fb0d476d95f5b6d106a8a48259dce76fed3d8139557746cdd51ade99a9a2d6c7e612c576e693cdc9ac71e60008287a52fe
+  data.tar.gz: 8b874f91d68ac1865477fddbf539689b13c1953add11b19515d9e92c3e59177dcc094e7c65a9cb76d90dc5fb666b32529a2634910d38419685752abe73632f3a

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ruijian Cao
+
+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,60 @@
+# Make log and consume business info easily in your rails application!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flog_ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flog_ruby
+
+## Usage
+
+### Get and use flogger
+
+`flogger = Flog.get(:api)`  
+
+Here `api` is a business log group.
+
+log your business info as your normal logger, but in better hash format.
+
+```ruby
+flogger.info :project_visit, user_id: 123, project_id: 234, extra: {data: 'other context info.'}
+```
+
+### Environment and Rsyslog support
+
+In development environment, flog write log into `log/flog/*.log` by default.
+
+In other environment, you can configure it use rsyslog mechanism to send info to remote logger service!
+
+```bash
+SYSLOG_ORIGIN:    log entry point origin source
+SYSLOG_FACILITY:  rsyslog facility, default: local0 
+FLOG_LEVEL:       logger level, default: debug 
+FLOG_NOT_SYSLOG:  force not use rsyslog, use multi-log files
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/flog_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flog_ruby"
+
+# 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/flog_ruby.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flog_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flog_ruby"
+  spec.version       = FlogRuby::VERSION
+  spec.authors       = ["Ruijian Cao"]
+  spec.email         = ["cao7113@hotmail.com"]
+
+  spec.summary       = %q(Make log and inspect business info easily.)
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/cao7113/flog_ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/flog_ruby.rb

@@ -0,0 +1,7 @@
+require "flog_ruby/version"
+require "flog_ruby/logger_factory"
+
+module FlogRuby
+end
+
+Flog = FlogRuby::LoggerFactory

data/lib/flog_ruby/logger_factory.rb

@@ -0,0 +1,256 @@
+require 'logger'
+require 'pathname'
+require 'fileutils'
+require 'syslog/logger'
+
+module FlogRuby
+  module Floggable
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :group
+
+      ::Logger::Severity.constants.map(&:downcase).each do |level|
+        alias_method "raw_#{level}", level
+
+        define_method level do |tag, opts = {}|
+          flog(level, tag, opts)
+        end
+      end
+
+      def flog(level, tag, opts = {})
+        attrs = (opts || {}).with_indifferent_access
+        extra = attrs.delete(:extra) || {}
+
+        opt_tag = attrs.delete(:tag)
+        if opt_tag
+          extra[:msg] ||= tag
+          tag = opt_tag
+        end
+
+        # resource
+        resource = attrs.delete :resource
+        if resource
+          attrs[:resource_type] ||= resource.class.name
+          attrs[:resource_id] ||= resource&.id
+        end
+
+        # distinct_id
+        if attrs[:distinct_id].nil?
+          attrs[:distinct_id] = attrs[:user_id] ? attrs[:user_id] : attrs[:client_ip]
+        end
+
+        # role
+        uid = attrs[:user_id]
+        attrs[:role] = Flog.user_klass.find_by(id: uid)&.role if attrs[:role].nil? && uid
+
+        # error
+        err = extra.delete :error
+        extra[:backtrace] = err.backtrace.first(10).join('; ') if err && err.is_a?(Exception)
+
+        # 添加来源信息origin
+        origin = ENV.fetch('SYSLOG_ORIGIN', group)
+
+        body = {origin: origin, properties: attrs, extra: extra}.to_json.to_s
+        blk = lambda { body }
+        clevel = ::Logger.const_get(level.upcase)
+        stag = [group, tag].compact.join('_')
+        add(clevel, nil, stag, &blk)
+        #send "raw_#{level}", nil, &blk
+      end
+    end
+  end
+
+  # 写文件方式
+  class Flogger < Logger
+    include Floggable
+
+    attr_accessor :log_path
+
+    def initialize(logpath, shift_age = 0, shift_size = 1_048_576)
+      if logpath
+        if logpath.is_a?(Pathname)
+          logpath.dirname.mkpath
+          @log_path = logpath
+        elsif logpath.is_a?(IO)
+          @log_path = nil
+        else
+          raise "Invalid flog! #{logpath.inspect}"
+        end
+      else
+        raise "Invalid flog! #{logpath.inspect}"
+      end
+      super(logpath, shift_age, shift_size)
+    end
+
+    def logdev
+      instance_variable_get('@logdev')
+    end
+
+    def logdev2
+      logdev.try(:dev)
+    end
+
+    # Deprecated!
+    def method_missing(mthd, *margs, &_blk)
+      self.class.class_eval do
+        define_method mthd do |*args|
+          opts = args.extract_options! || {}
+          level = opts.delete(:level) || :info
+          send(level, mthd, opts)
+        end
+      end
+      send(mthd, *margs)
+    end
+
+    class Formatter < ::Logger::Formatter
+      def call(severity, time, progname, msg)
+        format = "%s, [%s] %s: %s\n".freeze
+        format % [severity[0..0], format_datetime(time), progname, msg2str(msg)]
+      end
+
+      private
+
+      def format_datetime(time)
+        #raw: time.strftime(@datetime_format || "%Y-%m-%dT%H:%M:%S.%6N ".freeze)
+        #Time.zone.now.iso8601(3) #=> "2016-12-06T13:04:01.703+08:00"
+        (time || Time.zone.now).iso8601(3) # 需要毫秒
+      end
+    end
+  end
+
+  # 走Syslog转发机制
+  class Syslogger < Syslog::Logger
+    include Floggable
+
+    def initialize(program_name = nil, facility = nil)
+      program_name = program_name.to_s
+
+      fac = (ENV['SYSLOG_FACILITY'] || 'local0').upcase
+      log_fac = "LOG_#{fac}"
+      facility ||= Syslog.const_get(log_fac)
+
+      super(program_name, facility)
+    end
+
+    def add(severity, message = nil, progname = nil, &block)
+      severity ||= ::Logger::UNKNOWN
+      progname ||= group
+      @level <= severity and
+        @@syslog.log((LEVEL_MAP[severity] | @facility), '%s', formatter.call(severity, Time.zone.now, progname, (message || block.call)))
+      true
+    end
+
+    class Formatter < ::Syslog::Logger::Formatter
+      def call(severity, time, progname, msg)
+        format = "%s, [%s] %s: %s\n".freeze
+        sev_str = format_severity(severity)
+        format % [sev_str[0..0], format_datetime(time), progname, clean(msg)]
+      end
+
+      private
+
+      # Clean up messages so they're nice and pretty.
+      def clean(message)
+        message = message.to_s.strip
+        message.gsub!(/\e\[[0-9;]*m/, '') # remove useless ansi color codes
+        message
+      end
+
+      # Severity label for logging (max 5 chars).
+      SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL ANY).each(&:freeze).freeze
+      
+      def format_severity(severity)
+        SEV_LABEL[severity] || 'ANY'
+      end
+
+      def format_datetime(time)
+        #(time || Time.zone.now).to_s(:iso8601)
+        #Time.zone.now.iso8601(3) #=> "2016-12-06T13:04:01.703+08:00"
+        (time || Time.zone.now).iso8601(3) # 需要毫秒
+      end
+    end
+  end
+
+  class LoggerFactory
+    cattr_accessor :root, :loggers, :mloggers, :user_klass
+    self.root = Pathname.new('log').join('flog')
+    self.loggers = {}
+    self.mloggers = {}
+
+    class << self
+      def user_klass
+        @user_klass ||= ::User
+      end
+
+      # e.g. api, core, default: to STDOUT
+      def get(biz_name = :stdout, level = nil)
+        return Flogger.new(STDOUT) if biz_name.nil? || biz_name == :stdout
+
+        biz_name = biz_name.to_sym
+        findit = loggers[biz_name]
+        return findit if findit
+
+        level ||= default_level
+        if syslog?
+          logger = Syslogger.new(biz_name)
+          logger.formatter = Syslogger::Formatter.new
+          logger.level = level
+        else
+          log_path = root.join("#{biz_name}.log")
+          logger = Flogger.new(log_path, 3, 10_240_000) #10M
+          logger.formatter = Flogger::Formatter.new
+          logger.level = level
+          logger.logdev2.sync = true
+        end
+
+        logger.group = biz_name
+        loggers[biz_name] = logger
+      end
+
+      def default_level
+        if ENV['FLOG_LEVEL']
+          l = ENV['FLOG_LEVEL'].upcase
+          return Logger::Severity.const_get(l)
+        end
+        Logger::DEBUG
+      end
+
+      # just temp monitor log in: log/xx.log
+      def mget(biz_name = :stdout, level = Logger::DEBUG)
+        return Flogger.new(STDOUT) if biz_name.nil? || biz_name == :stdout
+
+        biz_name = biz_name.to_sym
+        findit = mloggers[biz_name]
+        return findit if findit
+
+        # different path!!!
+        log_path = Pathname.new('log').join("#{biz_name}.log")
+        logger = Flogger.new(log_path, 3, 10_240_000) #10M
+
+        logger.formatter = Flogger::Formatter.new
+        logger.level = level
+        logger.logdev2.sync = true
+        mloggers[biz_name] = logger
+      end
+
+      # 获取有轮滚的logger
+      def lget(filepath, opts = {})
+        ::Logger.new(filepath, 3, 10_240_000)
+      end
+
+      def syslog?
+        return false if ENV['FLOG_NOT_SYSLOG']
+        Rails.env.production? || Rails.env.staging? ||
+          File.exist?('tmp/flog_using_syslog')
+      end
+
+      def tail(log_file, lines = nil)
+        return [] if log_file.blank?
+        lines = lines.to_i
+        lines = 10 if lines < 10
+        `tail -n #{lines} #{log_file}`.to_s.split("\n").reverse
+      end
+    end
+  end
+end

data/lib/flog_ruby/version.rb

@@ -0,0 +1,3 @@
+module FlogRuby
+  VERSION = "0.1.0".freeze
+end

data/sh/boot-syslog.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+#Rsyslog client configuration!
+set -e
+
+[ -d /etc/rsyslog.d ] || { echo No found rsyslog && exit; }
+
+flog_conf=/etc/rsyslog.d/forward_flog.conf
+flog_server=${SYSLOG_SERVER:-log.logserver.ip}
+if [ -n "$SYSLOG_PORT" ];then
+  flog_port=$SYSLOG_PORT
+else
+  if [ "$RAILS_ENV" = 'staging' ];then
+    # 将测试环境的和正式的区分开
+    flog_port=1524
+  else
+    flog_port=1514
+  fi
+fi
+flog_facility=${SYSLOG_FACILITY:-local0}
+
+mv /etc/rsyslog.d /etc/rsyslog.d.bak
+mkdir -p /etc/rsyslog.d
+
+# use tcp protocol
+rule="$flog_facility.*  @@$flog_server:$flog_port"
+echo $rule > $flog_conf
+echo config rsyslog: update rule $rule into $flog_conf
+
+service rsyslog start
+echo ==rsyslog has started

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: flog_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ruijian Cao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Make log and inspect business info easily.
+email:
+- cao7113@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flog_ruby.gemspec
+- lib/flog_ruby.rb
+- lib/flog_ruby/logger_factory.rb
+- lib/flog_ruby/version.rb
+- sh/boot-syslog.sh
+homepage: https://github.com/cao7113/flog_ruby
+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: Make log and inspect business info easily.
+test_files: []