logrithm 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86cba65ebff7f5967d1adbfb48940c461ba76511
-  data.tar.gz: 7a10a6397937fa1500de32f65123776e27003ed5
+  metadata.gz: 19a6cbd393a80271537a01e19d935283dbb6a81b
+  data.tar.gz: 3705919f41dffebd5129156fcb4c3591c49067af
 SHA512:
-  metadata.gz: b5a0d7e43974711935fe2e8f5faefc7c5e9dd663fe3ff683f9c4b810cb0528c8478880841c8bf7126fcaa58a10008e0386b27ec36a46f475d0943c3040eb5054
-  data.tar.gz: 445167639261857670d8e2f72cbc55ae801d4e3abe5116410d0f935f0ef4805465780edbfd40d23bfc268544275490c5e5e0eae41d6b43f576832ddaca6ce1b3
+  metadata.gz: a5f25429828c665325913a0834e3a5f924a242a2dd719321099c43ebc51d708db8b2fb1f4c8cc6f9ec249d7e35195bfea6ae96f017c28eceecaeefa985f5efe3
+  data.tar.gz: af291bd299bb3e7bc281a06175635302baf02711a436f0d0c18b76ccf486a727d18bc3a9f78b86d2ad97b0847862c07415881347c19185b72d1c67e477999ad9

data/lib/logrithm.rb

@@ -38,6 +38,7 @@ end
 
 require 'logrithm/log'
 require 'logrithm/utils/output'
+require 'logrithm/utils/airslack'
 require 'logrithm/spitters'
 
 # This require is to be put into Rails initializer

data/lib/logrithm/utils/airslack.rb

@@ -0,0 +1,107 @@
+module Logrithm
+  module Utils
+    class Airslack
+      require 'slack-notifier'
+
+      SLACK_CHANNEL = Logrithm::Log.option :general, :slack, :channel
+
+      SETTINGS = {
+        dbg: { color: '#999999', preface: "Debugged error" },
+        wrn: { color: '#DD00DD', preface: "Expected error" },
+        err: { color: '#DD0000', preface: "Internal server error" },
+        ftl: { color: '#FF9900', preface: "Unexpected error" }
+      }.freeze
+
+      class << self
+        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/AbcSize
+        def notify(**params)
+          # {
+          #   :cause => #<ZeroDivisionError: divided by 0>,
+          #   :controller => Api::V1::CompaniesController < Api::V1::BaseController,
+          #   :current_api_user => "#<ApiUser id: 2, login: \"api_user_1@kantox.com\", email: ...
+          #   :current_company => "#<Profile id: 1, group_id: 1, company_name: \"usd\", elegible_for_matching: nil, ...
+          #   :current_power_class => "Power",
+          #   :hide_locale_switcher => "false",
+          #   :message => "Error #200 :: “divided by 0”",
+          #   :owner => Api::GetCompany < Mutations::Command,
+          #   :sender => "Kantox::Herro::ReportedError",
+          #   :wrap => #<Kantox::Herro::Reporter:0x000000057eed20 @cause=#<Kantox::Herro::ReportedError: Error #200 :: “divided by 0”>>
+          # }
+
+          # {
+          #   "text": "New Help Ticket Received:",
+          #   "attachments": [
+          #       {
+          #           "title": "App hangs on reboot",
+          #           "title_link": "http://domain.com/ticket/123456",
+          #           "text": "If I restart my computer without quitting your app, it stops the reboot sequence.\nhttp://domain.com/ticket/123456",
+          #       }
+          #   ]
+          # }
+          fields = params.reject do |k, _|
+            %i(type cause message owner sender wrap backtrace).include? k
+          end.map do |k, v|
+            value = case v
+                    when String then [v.to_s[0...64]]
+                    when Array then v.map(&:to_s)
+                    when Hash
+                      [
+                        v[:id] ? "id=“#{v[:id]}”" : nil,
+                        v[:reference] ? "ref=“#{v[:reference]}”" : nil,
+                        v[:name] ? "name=“#{v[:name]}”" : nil
+                      ]
+                    else
+                      [
+                        v.respond_to?(:id) ? "id=“#{v.id}”" : nil,
+                        v.respond_to?(:reference) ? "ref=“#{v.reference}”" : nil,
+                        v.respond_to?(:name) ? "name=“#{v.name}”" : nil
+                      ]
+                    end.compact.join(', ')
+
+            value = v.to_s[0...64] if value.empty?
+            { title: k, value: value, short: value.length <= 64 }
+          end
+
+          preface = SETTINGS[params[:type] || :ftl][:preface]
+          msg = "_#{preface}:_ #{params[:cause].try(:class)} | *#{params[:cause].try(:message)}*"
+          atts = [
+            {
+              fallback: "#{preface} in #{params[:owner] || '[see backtrace]'}",
+              color: SETTINGS[params[:type] || :ftl][:color],
+              title: "#{preface} in #{params[:owner] || '[see backtrace]'}",
+              fields: fields,
+              mrkdwn_in: [:text],
+              text: "```\n" << params[:cause].to_s << "\n```",
+              author_name: params[:owner].to_s
+            },
+            {
+              fallback: "Backtrace is available for desktop clients only",
+              color: '#DDDDDD',
+              title: "Backtrace (Rails.root related only)",
+              mrkdwn_in: [:text, :title],
+              text: "```\n" << params[:backtrace].map.with_index { |bt, i| bt =~ /#{Rails.root}/ ? "[#{i.to_s.rjust(3, '0')}] #{bt}" : nil }.compact.join($RS) << "\n```"
+            }
+          ]
+          SLACK.ping msg, attachments: atts
+        rescue => e
+          Kantox::Rescuer.log_error(e).airbrake
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
+
+        def my_first_private_ipv4
+          ip_priv = Socket.ip_address_list.detect(&:ipv4_private?)
+          ip_priv && ip_priv.ip_address || 'Unknown server'
+        end
+      end
+
+      SLACK = ::Slack::Notifier.new(
+        SLACK_CHANNEL[:endpoint],
+        channel: SLACK_CHANNEL[:channel],
+        icon_emoji: ':vertical_traffic_light:',
+        username: Airslack.my_first_private_ipv4
+      ) if SLACK_CHANNEL.is_a?(Hash)
+    end
+  end
+end

data/lib/logrithm/version.rb

@@ -1,3 +1,3 @@
 module Logrithm
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/logrithm.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'awesome_print'
 
   spec.add_dependency 'kungfuig', '~> 0.7', '>= 0.7.5'
+  spec.add_dependency 'slack-notifier', '~> 1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logrithm
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Aleksei Matiushkin
@@ -100,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Some improvements to standard logger, such as detailed colored logger
   messages etc.
 email:
@@ -128,6 +142,7 @@ files:
 - lib/logrithm/spitters.rb
 - lib/logrithm/spitters/exception.rb
 - lib/logrithm/spitters/string.rb
+- lib/logrithm/utils/airslack.rb
 - lib/logrithm/utils/color.rb
 - lib/logrithm/utils/helpers.rb
 - lib/logrithm/utils/output.rb