logging-honeybadger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80dabe97be19b246b488191e5bd116162821ac3054e7b376725588893ffd2f24
+  data.tar.gz: 3bbcf383fef74c6ae93a038a045d2aa644dba148c33e19078f2b63e358fccaeb
+SHA512:
+  metadata.gz: 8496fdffd6e063cc83692c222a56dcc808dcbb7e474f09c48f21b66ae5dff9c8321eb3a68784a4ebc0bca218f61e0c407019b0b37cd051808632135033364cfa
+  data.tar.gz: 2915c0b645b8bde603b4890567bf8be9b97ce1f4a2be020328cd7322e89ca800c8459cc60fc258a52a588e26cee1101d2c23904e4280444812e87a47bc805946

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# Logging Honeybadger
+
+[![CI](https://github.com/sshaw/logging-honeybadger/actions/workflows/ci.yml/badge.svg)](https://github.com/sshaw/logging-honeybadger/actions/workflows/ci.yml)
+
+Honeybadger appender for [the Logging gem](https://github.com/TwP/logging)
+
+## Overview
+
+Install the gem: `gem install logging-honeybadger`.
+
+If you're using Bundler add the following to your `Gemfile`: `gem "logging-honeybadger", :require => false`
+
+Then add the Honeybadger appender:
+
+```rb
+require "logging"
+
+log = Logging.logger[self]
+log.add_appenders(
+  Logging.appenders.honeybadger(
+    :api_key => "123XYZ",
+    :exceptions => { :ignore => %w[SomeThang AnotherThang] }
+  )
+)
+
+# Or
+
+Honeybadger.configure do |cfg|
+  # ...
+end
+
+log.add_appenders(Logging.appenders.honeybadger)
+
+log.info  "Not sent to honeybadger"
+log.error "Honeybadger here I come!"
+log.error SomeError.new("See you @ app.honeybadger.io!")
+```
+
+Note that Logging will load the appender. You do not need to explicitly require it.
+
+## Description
+
+Only events with the `:error` log level are sent to Honeybadger.
+By default the appender will be named `"honeybadger"`. This can be changed by passing a name
+to the `honeybadger` method:
+
+    Logging.appenders.honeybadger("another_name", options)
+
+Honeybadger configuration can be done via `Honeybadger.configure` or via `Logging.appenders.honeybadger`.
+The later accepts (most) Honeybadger options via the `options` `Hash`.
+
+## See Also
+
+[`Logging::Appenders::Airbrake`](https://github.com/sshaw/logging-appenders-airbrake) - Airbrake appender for the Logging gem
+
+## Author
+
+Skye Shaw [sshaw AT gmail.com]
+
+## License
+
+Released under the MIT License: www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+# Only with 5.19 and only >= 2.7
+# require "minitest/test_task"
+# Minitest::TestTask.create
+require "rake/testtask"
+
+Rake::TestTask.new
+
+task :default => :test

data/lib/logging/appenders/honeybadger.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "logging"
+require "honeybadger"
+
+module Logging
+  module Appenders
+    def self.honeybadger(*args)
+      if args.empty?
+        return self[Appenders::Honeybadger::DEFAULT_NAME] || Appenders::Honeybadger.new
+      end
+
+      Appenders::Honeybadger.new(*args)
+    end
+
+    class Honeybadger < Logging::Appender
+      VERSION = "0.0.1"
+      DEFAULT_NAME = "honeybadger"
+
+      # Prevent infinite recursion if this logger is assigned to the Honeybadger logger and it logs errors
+      INTERNAL_BT_FILTER = %r{honeybadger-[^/]+/lib/honeybadger/}
+
+      # Remove calls to this class in the stacktrace sent to Honeybadger.
+      # Only used when logging a String message.
+      HONEYBADGER_BT_FILTER = %r{/logging-[^/]+/lib/logging/}
+
+      # Can't use respond_to?: https://github.com/honeybadger-io/honeybadger-ruby/issues/481
+      HONEYBADGER_SIMPLE_OPTIONS = %i[
+        api_key
+        controller
+        env
+        error_class
+        report_data
+        root
+        revision
+        hostname
+        backend
+        debug
+        send_data_at_exit
+        max_queue_size
+        config_path
+        development_environments
+        plugins
+        skipped_plugins
+      ].freeze
+
+      HONEYBADGER_NESTED_OPTIONS = %i[
+        breadcrumbs
+        connection
+        delayed_job
+        exceptions
+        logging
+        rails
+        request
+        sidekiq
+      ].freeze
+
+      HONEYBADGER_OPTIONS = (HONEYBADGER_SIMPLE_OPTIONS + HONEYBADGER_NESTED_OPTIONS).freeze
+
+      def initialize(*args)
+        args.compact!
+
+        appender = { :level => :error }
+
+        name = args.first.is_a?(String) ? args.shift : DEFAULT_NAME
+        honeybadger = args.last.is_a?(Hash) ? args.pop.dup : {}
+
+        ::Honeybadger.configure do |cfg|
+          honeybadger.keys.each do |name|
+            if HONEYBADGER_OPTIONS.include?(name)
+              set_honeybadger_option(cfg, name, honeybadger[name])
+            else
+              appender[name] = honeybadger.delete(name)
+            end
+          end
+        end
+
+        super(name, appender)
+      end
+
+      private
+
+      def set_honeybadger_option(cfg, name, value)
+        if HONEYBADGER_SIMPLE_OPTIONS.include?(name)
+          cfg.public_send("#{name}=", value)
+          return
+        end
+
+        raise ArgumentError, "Nested option #{name}'s value must be a Hash, got #{value.class}" unless value.is_a?(Hash)
+
+        obj = cfg.public_send(name)
+        value.each do |method, v|
+          setter = "#{method}="
+          if obj.public_send(method).is_a?(Array)
+            obj.public_send(setter, obj.public_send(method) + Array(v))
+          else
+            obj.public_send(setter, v)
+          end
+        end
+      end
+
+      def write(event)
+        return self if caller.any? { |bt| bt =~ INTERNAL_BT_FILTER }
+
+        # Docs say event can be a String too, not sure when/how but we'll check anyways
+        error = event.is_a?(Logging::LogEvent) ? event.data : event
+
+        options = {}
+        options[:context] = Logging.mdc.context if Logging.mdc.context.any?
+
+        if error.is_a?(Exception)
+          options[:backtrace] = error.backtrace
+        else
+          options[:backtrace] = caller.reject { |line| line =~ HONEYBADGER_BT_FILTER }
+        end
+
+        ::Honeybadger.notify(error, options)
+      end
+    end
+  end
+end

data/lib/logging/plugins/honeybadger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Logging
+  module Plugins
+    module Honeybadger
+      VERSION = "0.0.1"
+
+      def self.initialize_honeybadger
+        require File.expand_path("../../appenders/honeybadger", __FILE__)
+      end
+    end
+  end
+end

data/logging-honeybadger.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "logging-honeybadger"
+  spec.version = "0.0.1"
+  spec.authors = ["Skye Shaw"]
+  spec.email = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{Honeybadger appender for the Logging gem}
+  spec.description   = %q{An appender for the Logging gem that sends all messages logged at the :error level to Honeybadger}
+  spec.homepage      = "https://github.com/sshaw/logging-honeybadger"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sshaw/logging-honeybadger"
+
+  # 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 do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Maybe less, but only tested with v5
+  spec.add_dependency "honeybadger", "~> 5.0"
+  spec.add_dependency "logging"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0", "<5.16"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: logging-honeybadger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: honeybadger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: logging
+  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: bundler
+  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: rake
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+description: An appender for the Logging gem that sends all messages logged at the
+  :error level to Honeybadger
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/logging/appenders/honeybadger.rb
+- lib/logging/plugins/honeybadger.rb
+- logging-honeybadger.gemspec
+homepage: https://github.com/sshaw/logging-honeybadger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sshaw/logging-honeybadger
+  source_code_uri: https://github.com/sshaw/logging-honeybadger
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Honeybadger appender for the Logging gem
+test_files: []