logsformyfamily 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dfaec509facf534d9217519cf942c917fd076d830fc5366103d426a9a879a399
+  data.tar.gz: c5c65620f5549e91069859873818c29c7599c124d7ceeaa794cb556b0027be14
+SHA512:
+  metadata.gz: 21bfe3aa0e124ce2e6307d28d0797300bf7997d2cac9474f6bf9b262077501a6bb4a5d496609e30d2b7e665bdc25771f1bc81353aa5995f54cf17778145a48af
+  data.tar.gz: 809d8c420eae2cf1b4a29099f8eb8ee9e2450bb5631c65dc0c0c3f03e918c2a8cc94ae39b3c8c84aee87408570d6cde1eb3fda917dd11b224bd43bbba7f42f0e

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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+before_install: gem install bundler -v 1.17.3

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 zerostride@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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in logsformyfamily.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    logsformyfamily (0.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    gem-release (2.2.2)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    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.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gem-release (~> 2.0)
+  logsformyfamily!
+  rspec (~> 3.0)
+  rubocop
+  simplecov (~> 0.17)
+
+BUNDLED WITH
+   2.2.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Pat Wilson
+
+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,43 @@
+# LogsForMyFamily
+
+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/logsformyfamily`. 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 'logsformyfamily'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logsformyfamily
+
+## 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]/logsformyfamily. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Logsformyfamily project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/logsformyfamily/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'logsformyfamily'
+
+# 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/lib/logsformyfamily/logger.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'digest'
+
+module LogsForMyFamily
+  class Logger
+    attr_accessor :backends
+
+    LEVELS = %i[
+      debug
+      info
+      notice
+      warning
+      error
+      critical
+      alert
+      emergency
+      audit
+    ].freeze
+
+    def initialize
+      @backends = LogsForMyFamily.configuration.backends
+      @configuration = LogsForMyFamily.configuration.to_h
+      @request_id = LogsForMyFamily.configuration.request_id
+      @request_config = {}
+      @event_id = 0
+      @filter_level = 0
+      @filter_percent = 1.0
+      @filter_percent_on = nil
+      @filter_percent_below_level = 0
+    end
+
+    def set_request(env)
+      @request_config[:request_id] = @request_id.call(env)
+      self
+    end
+
+    def set_request_id(id)
+      @request_config[:request_id] = id
+      self
+    end
+
+    def set_client_request_info(info)
+      @request_config[:client_request_info] = info
+      self
+    end
+
+    def request_id
+      @request_config[:request_id]
+    end
+
+    def filter_level(level)
+      level = LEVELS.find_index(level) if level.is_a?(Symbol)
+      @filter_level = level
+      self
+    end
+
+    def level
+      LEVELS[@filter_level]
+    end
+
+    def clear_filter_level
+      @filter_level = 0
+      self
+    end
+
+    def proc_for_event_data(*on)
+      proc { |data| (Digest::SHA256.hexdigest(data.dig(*on)).to_i(16) % 2_147_483_647).to_f / 2_147_483_646.0 }
+    end
+
+    def filter_percentage(percent: 1.0, on: proc { rand }, below_level: 1)
+      @filter_percent = percent
+
+      below_level = LEVELS.find_index(below_level) if below_level.is_a?(Symbol)
+      @filter_percent_below_level = below_level < 1 ? 1 : below_level
+
+      @filter_percent_on = on if on.respond_to?(:call) ? on : proc_for_event_data(on)
+      self
+    end
+
+    def clear_filter_percentage
+      @filter_percent_on = nil
+      self
+    end
+
+    LEVELS.each_with_index do |level, index|
+      define_method level do |event_type, event_data = nil|
+        internal_log(index, level, event_type, event_data)
+      end
+    end
+
+    private
+
+    def internal_log(level, level_name, event_type, event_data)
+      timestamp = Time.now.to_f # Do this first before filtering or any other things
+
+      # Filter based on log level
+      return unless level >= @filter_level
+
+      # If we have no event data, but we have an event type, figure we were called using a regular
+      # ruby logger type call, i.e. logger.info('some message'). Rework that to match our structured
+      # log format.
+      if event_data.nil? && !event_type.nil?
+        event_data = event_type
+        event_type = :log_message
+      end
+
+      event_data = { message: event_data } unless event_data.is_a?(Hash)
+
+      merged_data = {
+        pid: Process.pid,
+        timestamp: timestamp,
+        thread_id: Thread.current.object_id,
+        event_id: @event_id,
+        log_version: LogsForMyFamily::VERSION
+      }
+                    .merge(@configuration)
+                    .merge(@request_config)
+                    .merge(event_data)
+
+      # Filter based on log-sampling
+      if @filter_percent_on && level < @filter_percent_below_level
+        val = @filter_percent_on.call(merged_data)
+        return unless val <= @filter_percent
+      end
+
+      # Don't increment until filtering is complete
+      @event_id += 1
+
+      @backends.each do |backend|
+        backend.call(level_name, event_type, merged_data)
+      end
+    end
+  end
+end

data/lib/logsformyfamily/rack.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LogsForMyFamily
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      logger = LogsForMyFamily::Logger.new.set_request(env)
+      LogsForMyFamily.logger = logger
+      @app.call(env)
+    end
+  end
+end

data/lib/logsformyfamily/sidekiq.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module LogsForMyFamily
+  module Sidekiq
+    class Client
+      def call(worker_class, job, queue, redis_pool)
+        logger = LogsForMyFamily.logger
+        if logger
+          job['logsformyfamily.context'] = {
+            request_id: logger.request_id,
+            queue: queue
+          }
+        end
+        yield
+      end
+    end
+
+    class Server
+      def call(worker, job, queue)
+        logger = LogsForMyFamily::Logger.new.set_client_request_info(job['logsformyfamily.context'])
+        logger.set_request_id(job['jid'])
+        LogsForMyFamily.logger = logger
+        yield
+      end
+    end
+  end
+end

data/lib/logsformyfamily/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LogsForMyFamily
+  VERSION = '0.2.1'
+end

data/lib/logsformyfamily.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'logsformyfamily/logger'
+require 'logsformyfamily/rack'
+require 'logsformyfamily/sidekiq'
+require 'logsformyfamily/version'
+
+module LogsForMyFamily
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.logger
+    Thread.current.thread_variable_get(:'logsformyfamily.logger')
+  end
+
+  def self.logger=(val)
+    Thread.current.thread_variable_set(:'logsformyfamily.logger', val)
+  end
+
+  module LocalLogger
+    def logger
+      @logger ||= LogsForMyFamily.logger || LogsForMyFamily::Logger.new
+    end
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :version, :hostname, :app_name, :backends, :request_id
+
+    def initialize
+      @version = `git rev-parse --short HEAD`.chomp
+      @hostname = `hostname`.strip
+      @app_name = ENV['NEWRELIC_APP']
+      @backends = []
+      @request_id = proc { |env| env['core_app.request_id'] }
+    end
+
+    def to_h
+      {
+        version: @version,
+        hostname: @hostname,
+        app_name: @app_name
+      }
+    end
+  end
+
+  self.configuration ||= Configuration.new
+end

data/logsformyfamily.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logsformyfamily/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'logsformyfamily'
+  spec.version       = LogsForMyFamily::VERSION
+  spec.authors       = ['Pat Wilson']
+  spec.email         = ['pat@teak.io']
+
+  spec.summary       = 'Logging for Teak backend services.'
+  spec.homepage      = 'https://github.com/GoCarrot/LogsForMyFamily'
+  spec.license       = 'MIT'
+
+  # 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(__dir__)) 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']
+
+  spec.add_development_dependency 'gem-release', '~> 2.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: logsformyfamily
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Pat Wilson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description:
+email:
+- pat@teak.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logsformyfamily.rb
+- lib/logsformyfamily/logger.rb
+- lib/logsformyfamily/rack.rb
+- lib/logsformyfamily/sidekiq.rb
+- lib/logsformyfamily/version.rb
+- logsformyfamily.gemspec
+homepage: https://github.com/GoCarrot/LogsForMyFamily
+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: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Logging for Teak backend services.
+test_files: []