awesome_fluent_logger 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1684e8418e704f1c67b8d2de819c643aaea45c519b5434238f2c212cff61dac5
-  data.tar.gz: 9392912355c358904c46de8321a4efeaae97a12a4ce80671f0544ba2eab6347e
+  metadata.gz: e2f2060607f90e202c8a113ffa5f912e7d3043d8f6a4daac4bb7cdc92d5f471c
+  data.tar.gz: 26e74d65295d1759338dba1ef7943a964c7cad12fb9f354e7d18256c3e0f4666
 SHA512:
-  metadata.gz: d2df0d2b0f0961670b964ea835a4d170bb19ad4a279e48a34d3731143c93f55d79a986e2ff06129ba2a8b31cf53a76b64fead02075b2b948ccc9b6a2fdbddedb
-  data.tar.gz: 40a62cd6d6e5cda5c7b5f166b7f58387a36a1b6b24e0f78c64e08ed4bde962ad234bbb1507bf5f7f1a6346d74dfb2ee30453a142d7493e05023051ede896c395
+  metadata.gz: acab544566c8a34ff28319f6bb2d4c720291b3538d4b5b43b9e4c0164082faaefea0bab104740043b06c29908f5ec70d6bb246e1878f36f5bef5f91195999e63
+  data.tar.gz: 385cdb68c5c833f22154cd6efde8e8bd2949eaf9c502ac35343a899e43589865b88f61816f6b45129ce992f25b1260267f04e6a7ef036bf74ae16f977834fb39

data/.github/workflows/ci.yml

@@ -8,35 +8,22 @@ jobs:
   rspec:
     runs-on: ubuntu-latest
     strategy:
-      fail-fast: true
+      fail-fast: false
       matrix:
         ruby-version:
-          - 2.5
-          - 2.6
-          - 2.7
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
 
     steps:
       - uses: actions/checkout@v2
 
-      - uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gems-${{ hashFiles('api/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-
-
       - name: Setup Ruby v${{ matrix.ruby-version }}
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
-          ruby_version: ${{ matrix.ruby-version }}
-
-      - name: Install bundler
-        run: gem install bundler -v "~> 1.17"
-
-      - name: Execute bundle install
-        run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
 
       - name: Run rspec
         run: bundle exec rspec --format documentation

data/.github/workflows/release.yml

@@ -12,10 +12,10 @@ jobs:
     steps:
     - uses: actions/checkout@v2
 
-    - name: Set up Ruby 2.6
+    - name: Set up Ruby 2.7
       uses: actions/setup-ruby@v1
       with:
-        - 2.6
+        ruby-version: 2.7
 
     - name: Publish to RubyGems
       env:

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# 1.0.1
+
+* Support Ruby 3 - [#1](https://github.com/windyakin/awesome_fluent_logger/pull/1)
+
+# 1.0.0
+
+* Stable release
+
+# 0.1.0
+
+* Development release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    awesome_fluent_logger (1.0.0)
+    awesome_fluent_logger (1.0.1)
       fluent-logger (~> 0.9)
 
 GEM

data/README.md

@@ -1,6 +1,11 @@
 # 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.
+[![Gem Version](https://img.shields.io/gem/v/awesome_fluent_logger.svg?color=orange&logo=rubygems)](https://rubygems.org/gems/awesome_fluent_logger)
+![ci](https://github.com/windyakin/awesome_fluent_logger/workflows/ci/badge.svg)
+
+This library can mimic Ruby's built-in Logger class to forward logs to Fluentd. You can use this library not only for Rails but also for pure-Ruby apps.
+
+Commentary: [シンプルに Fluentd にログ転送ができる RubyGem "awesome_fluent_logger" をつくった](https://windyakin.hateblo.jp/entry/2021/01/24/143242) (日本語/Japanese)
 
 ## Installation
 
@@ -47,18 +52,65 @@ Rails configure file (`config/application.rb` or `config/environments/{RAILS_ENV
 
 ```ruby
 logger = AwesomeFluentLogger.new(fluent: { host: 'localhost', port: 24224 })
-config.logger = ActiveSupport::TaggedLogging(logger)
+config.logger = ActiveSupport::TaggedLogging.new(logger)
 ```
 
-### Set fluent-logger instance
+### Can be set fluent-logger instance in initialize parameters
 
-`fluent` of initialize argument can be passed an instance of [fluent-logger](https://github.com/fluent/fluent-logger-ruby)
+`:fluent` of initialize argument can be set an instance of [Fluent::Logger::FluentLogger](https://github.com/fluent/fluent-logger-ruby) class.
 
 ```ruby
-fluent = Fluent::Logger.new(nil, host: 'localhost', port: 24224)
+fluent = Fluent::Logger::FluentLogger.new(nil, socket_path: '/tmp/fluent.sock')
 logger = AwesomeFluentLogger.new(fluent: fluent)
 ```
 
+### Fluent tags
+
+If the initialize parameter `[:fluent][:tag_prefix]` is specified, it will be inserted at the beginning of the Fluentd tag.
+
+```ruby
+logger = AwesomeFluentLogger.new(fluent: { tag_prefix: 'kanan', host: 'localhost', port: 24224 })
+logger.info('ご機嫌いかがかなん？')
+```
+
+```
+2021-01-23 13:28:46.000000000 +0000 kanan.info: {"severity":"INFO", ...
+```
+
+The same effect is given by specifying `progname`.
+
+```ruby
+logger = AwesomeFluentLogger.new(fluent: { host: 'localhost', port: 24224 }, progname: 'chika')
+logger.info('かんかんみかん')
+```
+
+```
+2021-01-23 13:28:46.000000000 +0000 chika.info: {"severity":"INFO", ...
+```
+
+If both are specified, they will be nested. In this case, tag_prefix will be added first.
+
+```ruby
+logger = AwesomeFluentLogger.new(fluent: { tag_prefix: 'kanan', host: 'localhost', port: 24224 }, progname: 'chika')
+logger.info('2人は幼馴染です')
+```
+
+```
+2021-01-23 13:28:46.000000000 +0000 kanan.chika.info: {"severity":"INFO", ...
+```
+
+### Initialize parameters
+
+Other initialization parameters are based on the Logger class of the Ruby standard library.
+
+| Key | Default | Descriptions |
+|:---|:---|:---|
+| `fluent` | (none) | `Fluent::Logger::FluentLogger` initialize paramater hash or `Fluent::Logger::FluentLogger` class instance |
+| `level` | `Logger::DEBUG` | [Logger severity level constant](https://docs.ruby-lang.org/en/master/Logger.html) |
+| `progname` | `nil` | Program name to include in log messages **and Fluentd tag** |
+| `formatter` | [`AwesomeFluentLogger::Formatter`](lib/awesome_fluent_logger/formatter.rb) | Inherited `Logger::Formatter` class instance |
+| `datetime_format` | `%Y-%m-%d %H:%M:%S.%6N %z` | `%iso8601` or [`Time#strftime` formatted text](https://docs.ruby-lang.org/en/master/Time.html#method-i-strftime) |
+
 ## 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).
@@ -66,4 +118,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+[MIT License](LICENSE.txt)

data/lib/awesome_fluent_logger.rb

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

data/lib/awesome_fluent_logger/version.rb

@@ -1,3 +1,3 @@
 module AwesomeFluentLogger
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awesome_fluent_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - windyakin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-23 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluent-logger
@@ -79,6 +79,7 @@ files:
 - ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -115,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Awesome logger with fluent-logger for Ruby