uc3-dmp-cloudwatch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f71f6ea7b2f3dc39de9eab5bf201e93899cb1537ca935a144d5e4eb5e9e42d9c
+  data.tar.gz: 9dcc25d1cb233a77508d35541bf217ebf43834bbbdf01039c71e196333c97ca3
+SHA512:
+  metadata.gz: 272f2017c217f5f79fb92e5b22e589f16df76d7a77af39bb964a5ad833dea458187d67809ed9e19917b5ddbab9271efc0d2ddce3137be85776fb044dca9a09c7
+  data.tar.gz: 3ffe51067739dc79e82222f1631f0717d77c9a752507f0191118987bd3f55ca55dfea7b77af01a29c249355a89d604852dbad5a7db26feba3814a2f3f6fc47f3

data/README.md

@@ -0,0 +1,3 @@
+# uc3-dmp-logger
+
+Logger service to write CloudWatch logs in a specific format

data/lib/uc3-dmp-cloudwatch/logger.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Uc3DmpCloudwatch
+  class LoggerError < StandardError; end
+
+  # Helper functions for working with Dynamo JSON
+  class Logger
+    attr_accessor :source, :event, :request_id, :level
+
+    LOG_LEVELS = %w[none error info debug]
+
+    def initialize(**args)
+      @level = args.fetch(:level, 'info')&.to_s&.downcase
+      @level = 'info' unless LOG_LEVELS.include?(@level)
+
+      @source = args[:source]
+      @event = args[:event]
+      @request_id = args[:request_id]
+    end
+
+    def error(message:, details: {})
+      return false if @level == 'none' || message.nil?
+
+      _format_msg(mode: 'error', msg: message)
+      _format_msg(mode: 'error', msg: details) unless details.nil? || (details.is_a?(Hash) && details.keys.empty?)
+      _log_event(mode: 'error')
+    end
+
+    def info(message:, details: {})
+      return false if %w[none error].include?(@level) || message.nil?
+
+      _format_msg(mode: 'info', msg: message)
+      _format_msg(mode: 'info', msg: details) unless details.nil? || (details.is_a?(Hash) && details.keys.empty?)
+    end
+
+    def debug(message:, details: {})
+      return false if %w[none error info].include?(@level) || message.nil?
+
+      _format_msg(mode: 'debug', msg: message)
+      _format_msg(mode: 'debug', msg: details) unless details.nil? || (details.is_a?(Hash) && details.keys.empty?)
+    end
+
+    private
+
+    # Format the start of the message with a prefix and the AWS request id if available
+    def _prefix(prefix: 'INFO')
+      prefix = @request_id.nil? ? "#{prefix} " : "#{prefix} RequestId: #{@request_id},"
+      prefix += " SOURCE: #{@source}," unless @source.nil?
+    end
+
+    # Format the message
+    def _format_msg(mode: 'info', msg:)
+      message = msg.is_a?(Array) ? msg.join(', ') : msg
+      puts "#{_prefix(prefix: mode.upcase)} #{message.is_a?(String) ? "MESSAGE: #{message}" : "PAYLOAD: #{message}"}"
+    end
+
+    # Write the event Hash
+    def _log_event(mode: 'info')
+      puts "#{_prefix(prefix: mode)} Event: #{@event}"
+    end
+  end
+end

data/lib/uc3-dmp-cloudwatch/version.rb

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

data/lib/uc3-dmp-cloudwatch.rb

@@ -0,0 +1,9 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'uc3-dmp-cloudwatch/logger'
+
+module Uc3DmpCloudwatch
+
+end
+# rubocop:enable Naming/FileName

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: uc3-dmp-cloudwatch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Riley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.50.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+description: Helper for working with Lambda logs
+email:
+- brian.riley@ucop.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/uc3-dmp-cloudwatch.rb
+- lib/uc3-dmp-cloudwatch/logger.rb
+- lib/uc3-dmp-cloudwatch/version.rb
+homepage: https://github.com/CDLUC3/dmp-hub-cfn/blob/main/src/sam/gems/uc3-dmp-cloudwatch
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'false'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: DMPTool gem that provides support for writing standardized logs to CloudWatch
+test_files: []