chili_logger 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61d8df3241131a360ca82cbc122ccde86989a46b8b67227e9f686136b792115b
-  data.tar.gz: 5250e4ba9b5f27b8ed56ef0d6bb619b306783c390c17d27ee34dada2e29a862b
+  metadata.gz: fc07fd046be4d08dd0bf3e972ab83f5db6468186ca7d41c2ec868dd698f308d7
+  data.tar.gz: 850be7ee87e9e30fd203236d274755d02c75976ec8a1e467a94c83c50fd9894c
 SHA512:
-  metadata.gz: 00fbfa5e42ac2ec4190665535d7e30d6faf47528a0be7924714a15a6dda60dcf65d9c629ddec9b1201d69164201df4cde86fd07a3191b4fabad189ba65046ebe
-  data.tar.gz: e1a02abebf9d9f437d707647d94c26bd03f22853029f3053c94cf05ec7ebaa1920482bf0cef6eb6499cdae9f4301dfe17c361a38387e3e7c447de47d64fbf3a9
+  metadata.gz: 322027d12c0e96b227d67e0c60cca022c65945da4477fd8f7dfac8749dd194111db11cd5a8ca09e44334807ab949b510bf8b169ea0258ba1472a854d7bb5d00c
+  data.tar.gz: c79b0c42deadf14c4119ab6084151977c0e31f829ce9d3323cdf92502d9a79f9977cbfe4ed944cded842c6f2b48825774afce8390cce1ef40589e49423aa7631

data/.byebug_history

@@ -1,4 +1,30 @@
 continue
+sqs_queue_attrs.attributes['ApproximateNumberOfMessages'].to_i.positive?
+sqs_queue_attrs.attributes['ApproximateNumberOfMessages'].to_i
+sqs_queue_attrs
+continue
+sqs_queue_attrs
+continue
+sqs_queue_attrs
+continue
+sqs_queue_attrs
+continue
+remaining_msgs
+remaining_msgs.positive?
+continue
+remaining_msgs.positive?
+remaining_msgs
+continue
+remaining_msgs
+continue
+remaining_msgs
+quit
+remaining_msgs
+messages
+quit
+msgs.count
+msgs
+continue
 @sqs_config[:region]
 @sqs_config['region']
 @sqs_config

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chili_logger (0.1.2)
+    chili_logger (0.1.3)
       aws-sdk-secretsmanager (~> 1.36.0)
       aws-sdk-sqs (~> 1.30.0)
       bunny

data/README.md

@@ -49,6 +49,7 @@ ChiliLogger is a gem developed by Chiligum Creatives for internal use. It is use
     * [update_modified_records](#update_modified_records)
     * [add_modified_record](#add_modified_record)
     * [clear_log_info](#clear_log_info)
+  * [Republishing Unpublished Logs](#republishing-unpublished-logs)
 * [Snippets For Quicker Logging](#snippets-for-quicker-logging)
   * [Papertrail Optional Use](#papertrail-optional-use)
   * [Logging Transactions in HTP Requests](#logging-transactions-in-http-requests)
@@ -104,9 +105,11 @@ So if you are going to change anything in ChiliLogger, you have to keep this in
 
 ![ChiliLogger usual Flow](assets/images/chili-logger-flow.png)
 
+Every time we use ChiliLogger to publish a log, it will try to publish it to what has been configured as its `msg_broker`. If the msg_broker is down or some other unexpected error occurs, ChiliLogger will send the log and error message to what has been configured as its `fallback_broker`. This way, no logs are lost and [ChiliLogger can later try to republish these unpublished logs](#republishing-unpublished-logs).
+
 For the time being, only `RabbitMQ` is supported as the main message broker. Only `AWS SQS` is available as a fallback broker.
 
-If both the main message broker and the fallback message broker are down, ChiliLogger wil discard the log to keep the application running without raising any error. That's because raising errors would make the app crash and make it impossible to be used while the brokers are down.
+If both the main message broker and the fallback message broker are down, ChiliLogger wil discard the log to keep the application running without raising any error. That's because raising errors would make the app crash and make it impossible to be used while the brokers are down. For this reason, it is important to use a main message broker and a fallback broker with high availability.
 
 
 ### Anatomy of a Chiligum Log
@@ -809,6 +812,19 @@ current_log.errors
 sets user, desc, and main_content to their default values.
 
 
+### Republishing Unpublished Logs
+>
+> This functionality was introduced in version 0.1.2 of ChiliLogger. If you are using ChiliLogger 0.0.12 or below, you must first upgrade it.
+>
+
+[As previously explained](#overview), if logs can't be published to the main `message broker`, then these unpublished logs will be sent to the `fallback broker`. We can easily tell ChiliLogger to try and republish these logs any time, just by running the following:
+
+```ruby
+ChiliLogger.instance.republish_unpublished_logs
+```
+When running the above snippet, ChiliLogger will fetch the unpublished logs and try to republish them to the main `message broker`. If the main message broker is still unavailable, ChiliLogger will once again send the logs to `fallback broker`.
+
+
 ## Snippets for Quicker Logging
 Following is a series of snippets for quickly setting up some basic logging functionality. 
 **Please notice that the snippets in this section use the [paper_trail gem](https://github.com/paper-trail-gem/paper_trail/blob/v9.2.0/README.md#1c-basic-usage) for improving logs. Its use is optional, but recommended.**

data/lib/brokers/sqs_broker.rb

@@ -32,12 +32,12 @@ class ChiliLogger
       def fetch_messages
         return if ChiliLogger.instance.deactivated
 
-        remaining_msgs = num_of_msgs_in_queue
         messages = []
+        remaining_msgs = num_of_msgs_in_queue
+        return messages unless remaining_msgs.positive?
 
         @poller.poll do |sqs_msg|
-          log = JSON.parse(sqs_msg.body)['body']['log']
-          messages << { log: log, fallback_broker_msg: sqs_msg }
+          messages << { fallback_broker_msg: sqs_msg, log: JSON.parse(sqs_msg.body)['body']['log'] }
 
           remaining_msgs -= 1
           throw :stop_polling if remaining_msgs <= 0 # prevents infinite loop
@@ -66,8 +66,8 @@ class ChiliLogger
       end
 
       def num_of_msgs_in_queue
-        sqs_queue_attrs = @sqs.get_queue_attributes(queue_url: queue_url(@queue_name), attribute_names: ['All']).attributes
-        sqs_queue_attrs['ApproximateNumberOfMessages'].to_i
+        sqs_queue_attrs = @sqs.get_queue_attributes(queue_url: queue_url(@queue_name), attribute_names: ['All'])
+        sqs_queue_attrs.attributes['ApproximateNumberOfMessages'].to_i
       end
 
       def sqs_config(custom_config)

data/lib/chili_logger/version.rb

@@ -1,3 +1,3 @@
 class ChiliLogger
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/lib/helpers/values/secrets/aws_secrets_manager.rb

@@ -19,7 +19,6 @@ class ChiliLogger
 
         private
 
-        # rubocop:disable Metrics/MethodLength
         # Use this code snippet in your app.
         # If you need more information about configurations or implementing the sample code, visit the AWS docs:
         # https://aws.amazon.com/developers/getting-started/ruby/
@@ -29,34 +28,11 @@ class ChiliLogger
           # See https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_GetSecretValue.html
           # We rethrow the exception by default.
           get_secret_value_response = @client.get_secret_value(secret_id: secret_name)
-        rescue Aws::SecretsManager::Errors::DecryptionFailure => _e
-          # Secrets Manager can't decrypt the protected secret text using the provided KMS key.
-          # Deal with the exception here, and/or rethrow at your discretion.
-          raise
-        rescue Aws::SecretsManager::Errors::InternalServiceError => _e
-          # An error occurred on the server side.
-          # Deal with the exception here, and/or rethrow at your discretion.
-          raise
-        rescue Aws::SecretsManager::Errors::InvalidParameterException => _e
-          # You provided an invalid value for a parameter.
-          # Deal with the exception here, and/or rethrow at your discretion.
-          raise
-        rescue Aws::SecretsManager::Errors::InvalidRequestException => _e
-          # You provided a parameter value that is not valid for the current state of the resource.
-          # Deal with the exception here, and/or rethrow at your discretion.
-          raise
-        rescue Aws::SecretsManager::Errors::ResourceNotFoundException => _e
-          # We can't find the resource that you asked for.
-          # Deal with the exception here, and/or rethrow at your discretion.
-          raise
-        else
-          # This block is ran if there were no exceptions.
 
           # Decrypts secret using the associated KMS CMK.
           # Depending on whether the secret is a string or binary, one of these fields will be populated.
           get_secret_value_response.secret_string || Base64.decode64(get_secret_value_response.secret_binary)
         end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/lib/unpublished_logs_manager/unpublished_logs_manager.rb

@@ -16,6 +16,7 @@ class ChiliLogger
 
     def republish
       unpub_logs = @logging_error_handler.fetch_unpublished_logs
+
       unpub_logs.each do |unpub_log|
         fallback_broker_msg = unpub_log[:fallback_broker_msg]
         log = unpub_log[:log]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chili_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - lucas sandeville
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs