awesome_fluent_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a9f02fd640b82cdb17a5a98e32f671bddcd0e9b557d0b957ae8eb4db0cfabbd8
+  data.tar.gz: 8d6c67be73f34ca7318fee1e80027695f37de5b5dea07a8c637c70552e27eaf6
+SHA512:
+  metadata.gz: 3a468f11227b633a7818df13a5f380738ce71af8cbf33ddff3fec5fe26285960678e7f385efc2f675125a8c5acee1f5b761e61d601e1973f7be240b1f20d30fd
+  data.tar.gz: 9a8e0ef35d7bed7d85289a55fdbffe9a5f2f22e520725e76cfca9a11324cf0f93f6a30f199e2bc0fba06d4375a47bf9ba29efa7b410185e019503ac3d6219e68

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at windyakin@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in awesome_fluent_logger.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    awesome_fluent_logger (0.1.0)
+      fluent-logger (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    fluent-logger (0.9.0)
+      msgpack (>= 1.0.0, < 2)
+    method_source (1.0.0)
+    msgpack (1.3.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    timecop (0.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_fluent_logger!
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  timecop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 windyakin
+
+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,44 @@
+# AwesomeFluentLogger
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/awesome_fluent_logger`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'awesome_fluent_logger'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install awesome_fluent_logger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/awesome_fluent_logger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/awesome_fluent_logger/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AwesomeFluentLogger project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/awesome_fluent_logger/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/awesome_fluent_logger.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/awesome_fluent_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "awesome_fluent_logger"
+  spec.version       = AwesomeFluentLogger::VERSION
+  spec.authors       = ["windyakin"]
+  spec.email         = ["windyakin@gmail.com"]
+
+  spec.summary       = "Awesome logger with fluent-logger for Ruby"
+  spec.description   = "This library can mimic Ruby's built-in Logger class to forward logs to fluent."\
+    "You can use this library not only for Rails but also for pure-Ruby apps."
+  spec.homepage      = "https://github.com/windyakin/awesome_fluent_logger"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.add_dependency 'fluent-logger', '~> 0.9'
+
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'pry-byebug'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/windyakin/awesome_fluent_logger"
+  spec.metadata["changelog_uri"] = "https://github.com/windyakin/awesome_fluent_logger/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "awesome_fluent_logger"
+require 'fluent-logger'
+
+# 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(__FILE__)

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/fluent/fluent.conf

@@ -0,0 +1,11 @@
+# This file is example of fluent config
+
+<source>
+  @type forward
+  bind 0.0.0.0
+  port 24224
+</source>
+
+<match **>
+  @type stdout
+</match>

data/lib/awesome_fluent_logger.rb

@@ -0,0 +1,10 @@
+require "awesome_fluent_logger/version"
+require 'awesome_fluent_logger/logger'
+require 'awesome_fluent_logger/formatter'
+
+module AwesomeFluentLogger
+  def self.new(*args)
+    AwesomeFluentLogger::Logger.new(*args)
+  end
+  class FluentConnectionError < StandardError; end
+end

data/lib/awesome_fluent_logger/formatter.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module AwesomeFluentLogger
+  class Formatter < ::Logger::Formatter
+    def call(severity, time, progname, data)
+      {
+        severity: severity,
+        time: format_datetime(time),
+        progname: progname,
+        message: data
+      }
+    end
+
+    def datetime_format=(format)
+      if format == '%iso8601'
+        @datetime_format = '%Y-%m-%dT%H:%M:%S%:z'
+      else
+        @datetime_format = format
+      end
+    end
+
+    protected
+
+    def format_datetime(time)
+      time.strftime(@datetime_format || "%Y-%m-%d %H:%M:%S.%6N %z")
+    end
+  end
+end

data/lib/awesome_fluent_logger/logger.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'fluent-logger'
+require 'logger'
+
+module AwesomeFluentLogger
+  class Logger < ::Logger
+    attr_reader :logger
+    def initialize(fluent: nil, level: DEBUG, progname: nil, formatter: nil, datetime_format: nil)
+      super(nil, 0, 0, level: level, progname: progname, formatter: formatter, datetime_format: datetime_format)
+
+      if fluent.is_a?(Hash)
+        tag_prefix = fluent.fetch(:tag_prefix, progname)
+        @logger = ::Fluent::Logger::FluentLogger.new(tag_prefix, **fluent)
+      elsif fluent.respond_to?(:post)
+        @logger = fluent
+      else
+        raise ArgumentError
+      end
+
+      @default_formatter = Formatter.new
+      @default_formatter.datetime_format = datetime_format
+    end
+
+    def add(severity, message = nil, progname = nil)
+      severity ||= UNKNOWN
+
+      if @logger.nil? or severity < level
+        return true
+      end
+
+      if progname.nil?
+        progname = @progname
+      end
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = progname
+          progname = @progname
+        end
+      end
+
+      data = format_message(format_severity(severity), Time.now, progname, message)
+
+      unless data.is_a?(Hash)
+        data = {data: data}
+      end
+
+      @logger.post(nil, data)
+      true
+    end
+
+    def <<(msg)
+      @logger&.post(nil, msg)
+    end
+
+    def close
+      @logger&.close
+    end
+  end
+end

data/lib/awesome_fluent_logger/version.rb

@@ -0,0 +1,3 @@
+module AwesomeFluentLogger
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: awesome_fluent_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- windyakin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluent-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This library can mimic Ruby's built-in Logger class to forward logs to
+  fluent.You can use this library not only for Rails but also for pure-Ruby apps.
+email:
+- windyakin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- awesome_fluent_logger.gemspec
+- bin/console
+- bin/setup
+- fluent/fluent.conf
+- lib/awesome_fluent_logger.rb
+- lib/awesome_fluent_logger/formatter.rb
+- lib/awesome_fluent_logger/logger.rb
+- lib/awesome_fluent_logger/version.rb
+homepage: https://github.com/windyakin/awesome_fluent_logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/windyakin/awesome_fluent_logger
+  source_code_uri: https://github.com/windyakin/awesome_fluent_logger
+  changelog_uri: https://github.com/windyakin/awesome_fluent_logger/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
+specification_version: 4
+summary: Awesome logger with fluent-logger for Ruby
+test_files: []