telemetry-logger 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 650aaafabdc5a72622435581d70848ae723e45d82e9d34d8315e91db845842af
-  data.tar.gz: 7c9fc8c2364f206204b29b8e0e520ffb67f60a72066e0d750cba0ba55e0b466e
+  metadata.gz: c8b9e5e04fc5b3187ac17652368398e3a67108ad7e4e1a318678d2701a670680
+  data.tar.gz: bae5674c3071ad5b0c91d37b963d87e0fdbbe5c631dc89d0c77cf30d9ee864f3
 SHA512:
-  metadata.gz: 334ad853722b7c2477ff457d9b00524de9d83b6d0e5df7f322e9c0681b5aab2ff43ce999b668feb943f35464bd8250ec883e166f609cabea2222a30446d72283
-  data.tar.gz: 3425c27ced9ab4b2e812c1ffed3c1671c10e3a9974e0242be44500f869257da3d5ca79acab5fab79020194f25dcda0411b4f279fcd12fb368488680dc5b559eb
+  metadata.gz: 83f9d357b6dfd30dec387eb1e20c68214efb867a3430d1cb70647155ce22b58b4e41c73e0a19fe344c28bb96fca391ffb3e5552a3626a210bebc3145985c596a
+  data.tar.gz: dec6bd0514911e187277e354bd8b6079adda89545dacd33f2a2f278bf2ac2f33a10c03d4e74ea89be2491bf6df9e3bea8c6627464c170de1f1842f2bc5f40479

data/.github/workflows/rubocop.yml

@@ -21,4 +21,8 @@ jobs:
           bash -c "
             rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
             [[ $? -ne 2 ]]
-          "
+          "
+      - name: Upload Sarif output
+        uses: github/codeql-action/upload-sarif@v1
+        with:
+          sarif_file: rubocop.sarif

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Telemetry::Logger
 
+## v0.2.0
+* Adding new module called `Telemetry::Logger::ExceptionHandler`
+* Adding methods for `exception` and magic for detecting `ElasticAPM` and `OpenTelemetry`
+* Adding `Upload Sarif output` step to `rubocop` GitHub action
+* Adding `SECURITY.md` file
+
 ## v0.1.1
 * Fixing issue with color option using the wrong method name
 * Removing format logger from the setup command

data/README.md

@@ -1,13 +1,49 @@
 # Telemetry::Logger
 A generic gem to handle logging for all other telemetry gems
 
-Example
+#### Setting up the logger
+```ruby
+Telemetry::Logger.setup(level: 'warn', color: false, log_file: './telemetry.log')
+
+opts = {
+  include_pid: false,
+  level: 'info',
+  log_file: nil,
+  color: true,
+  application: 'telemetry',
+  app_version: Telemetry::Logger::VERSION
+}
+```
+
+#### Example Logging
 ```ruby
 Telemetry::Logger.setup(level: 'info')
 Telemetry::Logger.info 'test info'
+
 Telemetry::Logger.debug 'test debug'
 Telemetry::Logger.warn 'test warn'
 Telemetry::Logger.error 'test error'
 Telemetry::Logger.fatal 'test fatal'
 Telemetry::Logger.unknown 'test unknown'
 ```
+
+#### Example Exception Tracking
+Instead of repeating the same error method all over the place for exceptions, you can use the `exception` method to 
+save on complexity and automatically report exceptions to supported APMs
+
+```ruby
+Telemetry::Logger.setup(level: 'info')
+Telemetry::Logger.exception(StandardError.new('test error'), level: 'warn')
+Telemetry::Logger.exception(StandardError.new('test error'), level: 'fatal')
+Telemetry::Logger.exception(StandardError.new('test error'), handled: true)
+Telemetry::Logger.exception(StandardError.new('test error'), backtrace: true)
+
+# options for exception method
+opts = {
+  level: 'error', # sets the log level
+  handled: true, # tells the apms if we handled this exception
+  backtrace: true, # should we log the backtrace?
+  backtrace_limit: 20, # how many lines should we limit the backtrace to?
+  raise: false, # should we reraise this exception instead of swallowing it?
+}
+```

data/SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.x.x   | :white_check_mark: |
+
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

data/lib/telemetry/logger.rb

@@ -2,6 +2,7 @@ require 'telemetry/logger/version'
 require 'telemetry/logger/defaults'
 require 'telemetry/logger/builder'
 require 'telemetry/logger/methods'
+require 'telemetry/logger/exception_handler'
 
 module Telemetry
   module Logger
@@ -9,8 +10,10 @@ module Telemetry
       include Telemetry::Logger::Defaults
       include Telemetry::Logger::Methods
       include Telemetry::Logger::Builder
+      include Telemetry::Logger::ExceptionHandler
 
       def setup(level: 'info', **opts)
+        @opts = opts
         output(**opts)
         self.log_level = level
         self

data/lib/telemetry/logger/exception_handler.rb

@@ -0,0 +1,33 @@
+module Telemetry
+  module Logger
+    module ExceptionHandler
+      def exception(exc, level: 'error', backtrace: true, backtrace_limit: 20, **opts)
+        level = 'unknown' unless %w[debug info warn error fatal].include? level.to_s
+        Telemetry::Logger.send(level, "#{exc.class}: #{exc.message}")
+        Telemetry::Logger.send(level, exc.backtrace[0..backtrace_limit]) if backtrace && !exc.backtrace.nil?
+
+        send_to_apm(exc, level: level)
+
+        raise(exc) if opts[:raise]
+      end
+
+      def send_to_apm(exc, **opts)
+        handled = opts[:handled] || %w[info debug].include?(opts[:level])
+        ::ElasticAPM.report(exc, handled: handled) if elastic_apm?
+        ::OpenTelemetry.handle_error(exception: exc, message: exc.message) if open_telemetry?
+      end
+
+      def elastic_apm?
+        @elastic_apm unless @elastic_apm.nil?
+
+        @elastic_apm = Kernel.const_defined? 'ElasticAPM'
+      end
+
+      def open_telemetry?
+        @open_telemetry unless @open_telemetry.nil?
+
+        @open_telemetry = Kernel.const_defined? 'OpenTelemetry'
+      end
+    end
+  end
+end

data/lib/telemetry/logger/version.rb

@@ -1,5 +1,5 @@
 module Telemetry
   module Logger
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telemetry-logger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Esity
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-22 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -58,10 +58,12 @@ files:
 - LICENSE
 - NOTICE.txt
 - README.md
+- SECURITY.md
 - attribution.txt
 - lib/telemetry/logger.rb
 - lib/telemetry/logger/builder.rb
 - lib/telemetry/logger/defaults.rb
+- lib/telemetry/logger/exception_handler.rb
 - lib/telemetry/logger/methods.rb
 - lib/telemetry/logger/version.rb
 - sourcehawk.yml
@@ -89,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Telemetry Logging Gem