chili_logger 0.0.8 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdf566e52a267b06ca8561b8c17192e7cce0ef988418f566ffdf684fd98653d0
-  data.tar.gz: 021bf795a6b256054f622fad78ba9b9372b90adfeea409bd3824918413a32bd1
+  metadata.gz: c91c57ffcdb641479b3174ea6ad523c976d6668f4fe049025d51bcd0574e716a
+  data.tar.gz: d57923238e3c0bba29cc00b209ee30f3b8eaa4e026553d3cae6a1b4586072fef
 SHA512:
-  metadata.gz: 276a50ea4d77dec85187a596d9724d950358cb02e7799ce7a57ca51af2f56cee356b3985ec813bc6bf7fe36d152862301260e560f8eed45d8cf79e37e40f4253
-  data.tar.gz: 14e33d99349ced59521f52eca10426a636836af432139a53ab2cd452b581fb459c6c277084fc24775e193d226fad576c1a289ac711c6062ec49690cbb010d927
+  metadata.gz: 94ef9e11202aff8cc8fa0039eaeb3a758de300cf1913ce20b3536b1187ed931a3bc00f05ff6571e51d3d6d22eeb6d40496b0454f5709f8b8228acfe6d0eeee6d
+  data.tar.gz: 7091ca4a4be36329d7a7e426cc4a1fbb8b0bd9ac67938677fd6fd5fe71295bf8d7f695666987c7755fdee2b254abd62b4607979eb1fbdcf603a45be79c85c7ab

data/.gitignore

@@ -11,3 +11,5 @@ local_tests_cheatsheet.rb
 
 # rspec failure tracking
 .rspec_status
+
+chili_logger-*.gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chili_logger (0.0.8)
+    chili_logger (0.0.12)
       aws-sdk (~> 2.9, >= 2.9.0)
       bunny
       httparty

data/README.md

@@ -24,30 +24,38 @@ ChiliLogger is a gem developed by Chiligum Creatives for internal use. It is use
     * [Putting It All Together](####putting-it-all-together)
 * [Installation](##installation)
 * [Basic Usage](##basic-usage)
+  * [publish_instant_log params](####publish_instant_log-params)
+  * [publish_instant_log usage example](####publish_instant_log-usage-example)
+  * [publish_instant_log default argument values](####publish_instant_log-default-argument-values)
+  * [ChiliLogger's Singleton pattern](####ChiliLoggers-singleton-pattern)
 * [Advanced Usage](##advanced-usage)
   * [Code Example](####advanced-code-example)
   * [Error Logging](####error-logging)
   * [Customizing a Started Log](####customizing-a-started-log)
     * [Accessing the current_log](####accessing-the-current_log)
     * [user](####user)
-    * [overwrite_user](####overwrite_user)
+    * [update_user](####update_user)
     * [desc](####desc)
-    * [overwrite_type](####overwrite_type)
-    * [overwrite_service](####overwrite_service)
-    * [overwrite_action](####overwrite_action)
-    * [overwrite_desc](####overwrite_desc)
+    * [update_type](####update_type)
+    * [update_service](####update_service)
+    * [update_action](####update_action)
+    * [update_desc](####update_desc)
     * [main_content](####main_content)
-    * [overwrite_main_content](####overwrite_main_content)
+    * [update_main_content](####update_main_content)
     * [add_to_main_content](####add_to_main_content)
     * [modified_records](####modified_records)
-    * [overwrite_modified_records](####overwrite_modified_records)
+    * [update_modified_records](####update_modified_records)
     * [add_modified_record](####add_modified_record)
     * [clear_log_info](####clear_log_info)
-* [Copy-Paste Snippets For Quick Logging](##copy-paste-examples-for-quick-logging)
+* [Snippets For Quicker Logging](##snippets-for-quicker-logging)
   * [Papertrail Optional Use](###papertrail-optional-use)
-  * [Logging Transactions](###logging-transactions)
+  * [Logging Transactions in HTP Requests](###logging-transactions-in-http-requests)
+    * [Controllers](####controllers-logging-logic)
+    * [Models](####models-logging-logic)
   * [Logging Rake Tasks](###logging-rake-tasks)
-  * [A Note About ActiveRecords](###a-note-about-activerecords)
+    * [Logging Uncaught task Errors](####logging-uncaught-task-errors)
+    * [Logging Transactions in Tasks](####logging-transactions-in-tasks)
+    * [Logging Heartbeats in Tasks](####logging-heartbeats-in-tasks)
 * [Coverage](##Coverage)
 
 ## READ BEFORE CONTRIBUTING
@@ -117,11 +125,13 @@ The ChiliLogger gem was created to guarantee some level of uniformization in log
     "email": 'exemple@test.com',
     "company_cognito_id": "75",
     "company_name": "Chiligum Creatives",
-    "admin_ghost_user": "not_specified"
+    "ghost_user_cognito_id": "not_specified"
   },
   "transaction": {
     "modified_records": { 
-      "videos": [{ "id": 42, "title": 'Lateralus' }]
+      "videos": [{ "id": 42, "title": 'Lateralus' }],
+      "gallery_tags": [{ "id": 50 }, { "id": 51 }, { "id": 52 }],
+      "tags": [{ "id": 23, "name": "tool" }]
     },
     "errors": [],
     "backtrace": [
@@ -189,12 +199,15 @@ The `user` stores the main infos about the user whose request generated the log.
 #### Main Content 
 ##### (Transaction | Error)
 The `main_content` will have all other data relevant to the log. The main content of a log will be stored in a key with the same name as the log `type`. So a transaction log, as in the example above, willhave its main_content stored in the `transaction` field. In an error log, it would be in an `error` field.
-This is a very customizable attribute and its content will be very context relative. But as often as possible, we want it to store `errors`, `backtrace` and the records that were modified (`modified_records`) during the transaction, so we can later audit them, if needed. The `modified_records` are also used for creating analytics reports.
+It is an object with that accepts the folowwing attributes:
+  - `modified_records`, listing all tables modified and the records themselves;
+  - `errors`, listing errors found during the transaction and will usually be an empty array if the transaction was successful;
+  - `backtrace`, automatically created by the gem itself and showing the backtrace of the transaction and its processing;
 
 ---
 
 #### Ops Metadata
-Based on the configuration data(`:server_url`, `:cloud_provider`) that is passed to ChiliLogger when it is initialized, the log will also have metadata about the server itself where the application is running. 
+Based on the configuration data(`:server_url`, `:cloud_provider`) that is passed to ChiliLogger when it is initialized, the log will also have metadata about the server itself where the application is running.
 
 ---
 
@@ -249,6 +262,7 @@ Add this line to your application's Gemfile:
 gem 'chili_logger'
 ```
 
+#### Basic Initialization
 
 Create a initializer file and configure ChiliLogger passing all the relevant information. It is recommended to deactivate ChiliLogger when running tests:
 
@@ -289,8 +303,27 @@ You ALSO MUST set `fallback_broker` and `fallback_broker_config`. This is the fa
 
 Please note that if ChiliLogger tries to publish a log and both the configured Message Broker and the Error Handler are simultaneously down, the log will be discarded. This behavior makes sure logging problems never cause the app to break.
 
+#### Overwriting RabbitMQ's routing_key
+The [routing_key for all messages sent to rabbit will be created based on the description tag of the log](####description). But, sometimes, specially when testing, you may want to force all messages to be sent with a hardcoded routing_key. In those cases, you can add an optional field to the msg_broker_config: `routing_key_overwriter`.
+```ruby
+ChiliLogger.instance.config({
+  ...
+  msg_broker_name: :rabbitmq,
+  msg_broker_config: {
+    user: ENV['RABBIT_USER'],
+    password: ENV['RABBIT_PASSWORD'],
+    ip: ENV['RABBIT_IP'],
+    port: ENV['RABBIT_PORT'],
+    exchange_name: ENV['RABBIT_EXCHANGE'],
+    routing_key_overwriter: 'a.hardcoded.routing.key'
+  },
+  ...
+})
+```
 
 ## Basic Usage
+
+#### publish_instant_log params
 The easiest way to use ChiliLogger is with the `publish_instant_log` method. It requires a hash with the following optional attributes: 
 ```ruby
 {
@@ -304,7 +337,7 @@ The easiest way to use ChiliLogger is with the `publish_instant_log` method. It
     email: 'example@chiligumvideos.com', # String
     company_cognito_id: 88, # String || Fixnum || Bignum -> ChiliLogger converts company_cognito_id fields with these types to Strings
     company_name: 'Chiligum', # String
-    admin_ghost_user: 420, # String || Fixnum || Bignum -> ChiliLogger converts admin_ghost_user with these types to Strings
+    ghost_user_cognito_id: 420, # String || Fixnum || Bignum -> ChiliLogger converts ghost_user_cognito_id with these types to Strings
   },
   main_content: { # Hash
     modified_records: {  # Hash
@@ -326,22 +359,31 @@ The easiest way to use ChiliLogger is with the `publish_instant_log` method. It
 ```
 `desc` is used for setting the log's [type](###type), [service](###service), and [action](###action). env and layer were already set when ChiliLogger was [initialized and configured](##installation). Only `type`, `service`, and `action` are accepted.
 
-`user` will set the user data. Only `cognito_id`, `email`, `company_cognito_id`, `company_name`, and `admin_ghost_user` are accepted.
+`user` will set the user data. Only `cognito_id`, `email`, `company_cognito_id`, `company_name`, and `ghost_user_cognito_id` are accepted.
 
 `main_content` will set the main information the log is concerned about. It only accepts `modified_records` or `errors`.
 
-These fields must be set with the appropriate primitive types, as specified above. Not doing so [may create invalid logs](##read-before-contributing). ChiliLogger tries its best to enforce that all fields in a log will have consistent primitive types.
+These fields must be set with the appropriate primitive types, as specified above. Not doing so [may create invalid logs](##read-before-contributing). Because of that, ChiliLogger tries its best to enforce that all fields in a log will have consistent primitive types.
+
 
+#### publish_instant_log usage example
 ```ruby
 desc = { type: 'transaction', service: 'videos', action: 'create' }
-agent = { user: { id: 88, email: 'axemple@test.com'}, company: {id: 75, name: 'Chiligum' }}
+user = { 
+    cognito_id: 88, 
+    email: 'exemple@test.com',
+    company_cognito_id: 75,
+    company_name: "Chiligum Creatives",
+    ghost_user_cognito_id: 55
+  },
 main_content = { 
   modified_records: {
+    # notice we have a key 'videos' (the SQS tablename) pointing to an array of hashes
     videos: [{ id: 42, title: 'Lateralus' }]
   }
 }
 
-ChiliLogger.instance.publish_instant_log(desc, agent, main_content)
+ChiliLogger.instance.publish_instant_log(desc: desc, user: user, main_content: main_content)
 # publishes a json like this:
 {
   "env": "development",
@@ -350,15 +392,12 @@ ChiliLogger.instance.publish_instant_log(desc, agent, main_content)
   "service": "videos",
   "action": "create",
   "desc": "development.creatives.transaction.videos.create",
-  "agent": { 
-    "user": { 
-      "id": 88, 
-      "email": 'exemple@test.com'
-    }, 
-    "company": {
-      "id": 75, 
-      "name": 'Chiligum' 
-    }
+  "user": { 
+    "cognito_id": "88", 
+    "email": 'exemple@test.com',
+    "company_cognito_id": "75",
+    "company_name": "Chiligum Creatives",
+    "ghost_user_cognito_id": "55"
   },
   "transaction": {
     "modified_records": {
@@ -375,7 +414,8 @@ ChiliLogger.instance.publish_instant_log(desc, agent, main_content)
 }
 ```
 
-Passing `desc`, `agent`, and `main_content` is optional, since all of them have default values. This is so ChiliLogger is resiliant and doesn't break if any of these arguments is forgotten. But notice that their default values are not very descriptive and it results in low-quality (almost useless) logs:
+#### publish_instant_log default argument values
+Passing `desc`, `agent`, and `main_content` is optional, since all of them have default values. This is so ChiliLogger is resiliant and doesn't break if any of these arguments is forgotten. But notice that their default values are not very descriptive and it results in low-quality, almost useless logs:
 
 ```ruby
 ChiliLogger.instance.publish_instant_log
@@ -387,7 +427,13 @@ ChiliLogger.instance.publish_instant_log
   "type": "not_specified",
   "service": "not_specified",
   "desc": "development.creatives.not_specified.not_specified.not_specified",
-  "agent": "not_specified", 
+  "user": {
+    "cognito_id": 'not_specified',
+    "email": 'not_specified',
+    "company_cognito_id": 'not_specified',
+    "company_name": 'not_specified',
+    "ghost_user_cognito_id": 'not_specified'
+  }, 
   "not_specified": {},
     "backtrace": [
       "app/views/dashboard/controllers/videos_controller.rb:17 in block 'create'"
@@ -399,7 +445,7 @@ ChiliLogger.instance.publish_instant_log
   "timestamp": "2020-06-30T18:08:59-03:00",
 }
 ```
-
+#### ChiliLogger's Singleton pattern
 Notice that ChiliLogger uses the Singleton pattern. So, to call its methods, you must first access the instance method. Calling ChiliLogger.new will return an error:
 ```ruby
 ChiliLogger.publish_instant_log(desc, agent, log)
@@ -482,7 +528,7 @@ end
 
 Notice that the log is started in VideosController#create with some initial info about the agent user and the log description; following, the same log has its main_content customized in Video.add_modified_record_to_log, by accessing ChiliLogger's `current_log` and calling its `add_modified_record` method. And, afterwards, the same log is finished and published with `current_log.publish`, again in VideosController#create.
 
-Check the [Copy-Paste Snippets For Quick Logging](##copy-paste-examples-for-quick-logging) section to see how this functionality can be used to quickly set an all-embracing logging system for your application.
+Check the [Snippets For Quick Logging](##snippets-for-quick-logging) section to see how this functionality can be used to quickly set an all-embracing logging system for your application.
 
 #### Error Logging
 The controller code above could be improved by adding some logic to log unexpected errors:
@@ -501,7 +547,7 @@ class VideosController
   rescue StandardError => error
     #changes log type and publishes it
     current_log.add_to_main_content({ error: error.as_json })
-    current_log.overwrite_type('uncaught_error')
+    current_log.update_type('uncaught_error')
     current_log.publish
   end
 end
@@ -513,29 +559,32 @@ Once a log is started, its main attributes can be customized by accessing the `c
 #### Accessing the current_log
 ```ruby
 current_log = ChiliLogger.instance.current_log
-current_log.agent # returns currently set agent
-current_log.overwrite_agent({ user: { name: 'new_agent' }) # sets new agent
+current_log.user # returns currently set user
+current_log.update_user(cognito_id: '42', company_name: 'Chiligum') # updates user data
 ```
-#### agent
-returns log's currently set agent
+#### user
+returns log's currently set user
 
 ```ruby
-current_log.agent
-# { user: { name: 'not_specified' } }
+current_log.user
+# { cognito_id: 'not_specified', email: 'not_specified', company_cognito_id: 'not_specified',
+#   company_name: 'not_specified', ghost_user_cognito_id: 'not_specified' }
 ```
 
 ---
 
-#### overwrite_agent
-overwrites the currently set agent
+#### update_user
+updates the currently set user
 
 ```ruby
-current_log.agent
-# { user: { name: 'not_specified' } }
-
-current_log.overwrite_agent({ user: { name: 'new_agent' } })
-current_log.agent
-# { user: { name: 'new_agent' }
+current_log.user
+# { cognito_id: 'not_specified', email: 'not_specified', company_cognito_id: 'not_specified',
+#   company_name: 'not_specified', ghost_user_cognito_id: 'not_specified' }
+
+current_log.update_user({ email: 'new_email' } })
+current_log.user
+# { cognito_id: 'not_specified', email: 'new_email', company_cognito_id: 'not_specified',
+#   company_name: 'not_specified', ghost_user_cognito_id: 'not_specified' }
 ```
 
 ---
@@ -550,56 +599,56 @@ current_log.desc
 
 ---
 
-#### overwrite_type
-overwrites the type attribute currently set in the log's description 
+#### update_type
+updates the type attribute currently set in the log's description 
 
 ```ruby
 current_log.desc
 # { type: 'not_specified', service: 'not_specified', action: 'not_specified' }
 
-current_log.overwrite_type('transaction')
+current_log.update_type('transaction')
 current_log.desc
 # { type: 'transaction', service: 'not_specified', action: 'not_specified' }
 ```
 
 ---
 
-#### overwrite_service
-overwrites the service attribute currently set in the log's description 
+#### update_service
+updates the service attribute currently set in the log's description 
 
 ```ruby
 current_log.desc
 # { type: 'not_specified', service: 'not_specified', action: 'not_specified' }
 
-current_log.overwrite_service('videos')
+current_log.update_service('videos')
 current_log.desc
 # { type: 'not_specified', service: 'videos', action: 'not_specified' }
 ```
 
 ---
 
-#### overwrite_action
-overwrites the action attribute currently set in the log's description 
+#### update_action
+updates the action attribute currently set in the log's description 
 
 ```ruby
 current_log.desc
 # { type: 'not_specified', service: 'not_specified', action: 'not_specified' }
 
-current_log.overwrite_action('delete')
+current_log.update_action('delete')
 current_log.desc
 # { type: 'not_specified', service: 'not_specified', action: 'delete' }
 ```
 
 ---
 
-#### overwrite_desc
-overwrites the currently set log's description
+#### update_desc
+updates the currently set log's description
 
 ```ruby
 current_log.desc
 # { type: 'not_specified', service: 'not_specified', action: 'not_specified' }
 
-current_log.overwrite_desc({ type: 'uncaught_error', action: 'create' })
+current_log.update_desc({ type: 'uncaught_error', action: 'create' })
 current_log.desc
 # { type: 'uncaught_error', service: 'not_specified', action: 'create' }
 ```
@@ -611,22 +660,32 @@ returns the currently set main_content
 
 ```ruby
 current_log.main_content
-# { modified_records: {} }
+# { modified_records: {}, errors: [] }
 
 ```
 
 ---
 
-#### overwrite_main_content
-overwrites the currently set main_content
+#### update_main_content
+updates the currently set main_content
 
 ```ruby
 current_log.main_content
-# { modified_records: {} }
+# { modified_records: {}, errors: [] }
 
-current_log.overwrite_main_content({ meaning_of_life: 42 })
+new_content = {
+  modified_records: { 
+    'videos' => [{ title: 'Lateralus', id: 42 }] 
+  }
+}
+current_log.update_main_content(new_content)
 current_log.main_content
-# { meaning_of_life: 42 }
+# {
+#   modified_records: { 
+#     'videos' => [{ title: 'Lateralus', id: 42 }] 
+#   },
+#   errors: []
+# }
 ```
 
 ---
@@ -636,11 +695,11 @@ merges hash with currently set main_content
 
 ```ruby
 current_log.main_content
-# { modified_records: {} }
+# { modified_records: {}, errors: ['err1', 'err2'] }
 
-current_log.add_to_main_content({ meaning_of_life: 42 })
+current_log.add_to_main_content(errors: ['err50'])
 current_log.main_content
-# { modified_records: {}, meaning_of_life: 42 }
+# { modified_records: {}, errors: ['err1', 'err2', 'err50'] }
 ```
 
 ---
@@ -660,7 +719,7 @@ overwrites the modified_records stored in the main_content
 
 ```ruby
 current_log.modified_records
-# {}
+# { tracks: [{ id: 87, title: 'Hips Dont Lie' }] }
 
 current_log.overwrite_modified_records({ tracks: [{ id: 88, title: 'Lateralus' }] })
 current_log.modified_records
@@ -670,18 +729,19 @@ current_log.modified_records
 ---
 
 #### add_modified_record
-merges hash with currently set modified_records
+merges hash with currently set modified_records. Notice it receives two arguments: the `tablename` and the `record` itself;
 
 ```ruby
 current_log.modified_records
 # { tracks: [{ id: 88, title: 'Lateralus' }] }
 
-current_log.overwrite_modified_records(
-  { 
-    tracks: [{ id: 89, title: "Hips Don't lie" }],
-    videos: [{id: 42, title: 'Life Of Brian' }]
-  }
-)
+current_log.add_modified_records('tracks', { id: 89, title: "Hips Don't lie" })
+current_log.modified_records
+# { 
+#   tracks: [{ id: 88, title: 'Lateralus' }, { id: 89, title: "Hips Don't lie" }],
+# }
+
+current_log.add_modified_records('videos', { id: 42, title: 'Life Of Brian' })
 current_log.modified_records
 # { 
 #   tracks: [{ id: 88, title: 'Lateralus' }, { id: 89, title: "Hips Don't lie" }],
@@ -691,15 +751,51 @@ current_log.modified_records
 
 ---
 
+#### errors
+returns the errors stored in the main_content
+
+```ruby
+current_log.errors
+# []
+```
+
+---
+
+#### overwrite_errors
+overwrites the errors stored in the main_content
+
+```ruby
+current_log.errors
+# ['err1', 'err2', 'err3']
+
+current_log.overwrite_errors(['err500'])
+current_log.errors
+# ['err500']
+```
+
+---
+
+#### add_error
+merges hash with currently set errors
+
+```ruby
+current_log.errors
+# ['err1', 'err2', 'err3']
+
+current_log.add_error('err400')
+current_log.errors
+# ['err1', 'err2', 'err3', 'err400']}
+```
+
 #### clear_log_info
-sets agent, desc, and main_content to their default values. 
+sets agent, desc, and main_content to their default values.
 
 
-## Copy-Paste Snippets for Quick Logging
-Following are a series of snippets that can be copied and pasted to your project for quickly setting up some basic logging functionality. 
+## 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.**
 
 ### Papertrail Optional Use
-**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.**
 
 > ChiliLogger works just fine without paper_trail. If you don't want to use paper_trail or if your application doesn't use ActiveRecords, you can skip the following code.
 >
@@ -721,46 +817,286 @@ class ApplicationRecord < ActiveRecord::Base
   has_paper_trail # add this line!
 end
 ```
+If your controllers have a current_user, it usually won't be accessible in the models. When implementing logs, though, it is a behaviour you might be interested in, so you can log changes to the DB knowing who was the user responsible for that change. PaperTrail has a feature called `whodunnit`, which is [used precisely for this purpose](https://github.com/paper-trail-gem/paper_trail/blob/v10.3.1/README.md#setting-whodunnit-with-a-controller-callback).
+```ruby
+# controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  # sets papertrail Whodunit based on user defined in user_for_paper_trail
+  before_action :set_paper_trail_whodunnit
+
+  # customizes method implemented by PaperTrail and that sets PaperTrail.request.whodunnit
+  # PaperTrail.request.whodunnit will be available in all parts of application while a request is being processed  
+  def user_for_paper_trail
+    current_user
+  end
+end
+```
 
+### Logging Transactions in HTTP Requests
+Transactions happen in two main layers of an application: the controllers handling the request and the models persisting data. If your application has an ApplicationController from which all other controllers inherit, and also an ApplicationRecord from which all models inherit, we can quickly set standardized logs for transactions and errors. 
 
-### Logging Transactions
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-### Logging Rake Tasks
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-### A Note About ActiveRecords
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
+#### Controllers Logging Logic
+Just add the following code to your ApplicationController:
+```ruby
+# controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  before_action :start_new_log
+  rescue_from StandardError, with: :publish_error_log
+  after_action :publish_log
+
+  def start_new_log
+    table_name = self.class.name.split('::').last.gsub('Controller', '').underscore
+    # action_name is available in Rails apps, Sinatra apps may need some other solution
+    log_action = action_name == 'destroy' ? 'delete' : action_name
+
+    desc ||= log_description('transaction', table_name, log_action)
+    user = log_user
+
+    ChiliLogger.instance.start_new_log(desc: desc, user: user)
+  end
+
+  # publishes transaction log with the main infos about the request
+  def publish_log
+    # only publish log if current log had modified_records added to it, so we don't clutter logs with index requests
+    return if ChiliLogger.instance.current_log.modified_records.empty?
+
+    ChiliLogger.instance.current_log.publish
+  end
+
+  # if unexpected errors happen, will change log type and publish it for debugging/audit
+  def publish_error_log(error)
+    error = [error.inspect, Rails.backtrace_cleaner.clean(error.backtrace)]
+    current_log = ChiliLogger.instance.current_log
+
+    current_log.add_error(error)
+    current_log.update_type('uncaught_error')
+    current_log.publish
+
+    raise error
+  end
+
+  private
+
+  def log_description(type, service, action)
+    { type: type, service: service, action: action }
+  end
+
+  # customize according to your app's schema
+  def log_user
+    return {} unless current_user
+
+    # use .where instead of .find, because .find raises error if no record is found
+    multi_user_record = MultiUser::User.where(external_id: current_user&.cognito_id).first
+    log_user = { 
+      email: current_user&.email, 
+      cognito_id: multi_user_record&.id,
+      company_name: current_user&.company&.name,
+      company_cognito_id: multi_user_record&.organization&.id
+    }
+    log_user.merge!(ghost_user_cognito_id: admin_ghost_user&.cognito_id) # if app has admins that can log as other users 
+  end
+end
+```
  
+Notice that `start_new_log` will set the log's service and action based on the controller name and the method being called. So if VideosController has its create method called, it would generate a log with service="videos" and action="create". Individual controllers and methods can be customized by using the [current_log accessors](###customizing-a-started-log). 
+
+For example, suppose we would like the GalleryFilesController to generate custom logs with service='gallery' and we would like GalleryFilesController#find_files to define action='filter'. We could do the following:
+```ruby
+# app/controllers/gallery_files.rb
+class GalleryFilesController < ApplicationController
+  before_action :overwrite_log_service
+
+  def find_files
+    ChiliLogger.instance.current_log.update_action('filter')
+    # method's usual code...
+  end
+
+  private
+
+  # customizes logs created by ApplicationController's start_new_log method
+    def overwrite_log_service
+      ChiliLogger.instance.current_log.update_service('gallery')
+    end
+end
+```
+
+#### Models Logging Logic
+The code above implements automatic logs for requests made to controllers. We can further improve the logs being created by adding the DB records that were modified during the request:
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  after_create -> { add_modified_record_to_log('create') }, on: :create
+  after_update -> { add_modified_record_to_log('update') }, on: :update
+  before_destroy -> { add_modified_record_to_log('destroy') }, on: :destroy
+
+  has_paper_trail # if you are using paper_trail
+
+  # enriches logs by automatically adding modified_records to them
+  def add_modified_record_to_log(action_verb, modified_record = self)
+    # only adds to log if record was created, changed or destroyed
+    return if !new_record? && !saved_changes? && action_verb != 'destroy'
+
+    current_log = ChiliLogger.instance.current_log
+    current_log.update_type('transaction_error') unless modified_record.errors.messages.empty?
+    current_log.add_modified_record(self.class.table_name, modified_record.to_denormalized_hash)
+  end
+
+  # ChiliLogger requires modified_records to be hashes. 
+  # This method converts ActiveRecords instances to hashes and adds some extra useful data
+  def to_denormalized_hash(record_hash = as_json)
+    record_hash[:last_changes] = versions.last.changeset if versions.last #if you are using paper_trail
+    record_hash[:errors] = errors
+
+    record_hash
+  end
+end
+```
+
+The code above will add all modified records to the transaction logs. We implement a `to_denormalized_hash` method, which converts the ActiveRecord isntance to a hash, as ChiliLogger requires. This method can be customized in individual models, to generate logs with even more information (for instance, denormalizing the main ActiveRecords relations):
+```ruby
+# app/models/banner.rb
+class Banner < ApplicationRecord
+  # customizes inherited ApplicationRecord's method, denormalizing the record's main relations
+  def to_denormalized_hash(record_hash = as_json)
+    relations = Banner.includes(:campaign)
+                      .includes(template: %i[category template_collection])
+                      .find(id)
+
+    record_hash[:campaign] = relations.campaign.as_json
+    record_hash[:template] = relations.template.as_json
+    record_hash[:template][:category] = relations.template.category.as_json
+    record_hash[:template][:template_collection] = relations.template.template_collection.as_json
+
+    super(record_hash) # calls ActiveRecords's to_denormalized_hash
+  end
+end
+```
+
+### Logging Rake Tasks
+When logging transactions made in tasks, we have three main concerns: logging uncaught errors in the task, logging transactions performed by the task and log whether the task is up and running, for monitoring.
+
+#### Logging Uncaught Task Errors
+For this, we must create a standardized way of handling task errors. The best wayto do it is with a monkey-patch to rake, by creating the following file:
+```ruby
+# config/initializers/task.rb
+require 'rake/task'
+
+module Rake
+  class Task
+    alias :original_execute :execute
+
+    # customizes the execute method of Rake::Task
+    def execute(args=nil)
+      begin
+        # start storing default log infos for rake tasks before they even begin
+        log_desc = { log_type: 'error', service: 'automated_task', action: 'uncaught_error' }
+        log_user = { email: 'automated_task', cognito_id: 'automated_task' }
+        ChiliLogger.instance.start_new_log(desc: log_desc, user: log_user)
+
+        original_execute(args)
+
+      rescue StandardError => error
+        current_log = ChiliLogger.instance.current_log
+
+        current_task = Rake.application.top_level_tasks.first
+        current_log.update_service(current_task.split(':').first)
+        current_log.update_action(current_task.split(':').last)
+
+        current_log.add_error(error.inspect)
+        current_log.update_type('uncaught_error')
+        current_log.publish
+
+        raise error
+      end
+    end
+  end
+end
+```
+
+#### Logging Transactions in Tasks 
+Unfortunately, for the time being, we still haven't found a practical way to log all Task transactions with minimal setup. The way most of our tasks are implemented - as infinite loops - requires us to add logging logic to each and every task, by doing so:
+```ruby
+# lib/tasks/example_task.rake
+namespace :excel do
+  task validation: :environment do
+    loop do
+      # start storing infos for validation log
+      transaction_desc = { type: 'transaction', service: 'excel', action: 'validation' }
+      log_user = { email: 'automated_task', cognito_id: 'automated_task' 
+      current_log = ChiliLogger.instance.start_new_log(desc: log_desc, user: log_user)
+
+      usual task code...
+      
+      # only publish log if current log had modified_records added to it - so we don't clutter DB with meaningless logs
+      current_log.publish unless current_log.modified_records.empty?
+
+      sleep 5
+    end
+end
+```
+Until we come up with a better solution, this will have to be done to each and every task of interest. Notice that the snippet above assumes you have [edited the models to enrich logs with modified_records](####models-logging-logic).
+
+#### Logging Heartbeats in Tasks
+Besides monitoring transactions and unexpected errors, it is also important to monitor whether all main parts of an application are up and running. For servers, we do that by pinging specific endpoints to see if the server is up and responding. Tasks pose a different problem, since they have no endpoint we can ping. Besides, a task maybe up and with a 'running' status, but being stuck all the same and not processing new data. For that reason, we use ChiliLogger to monitor tasks' healht. 
+
+Unfortunately, due to the way most of our tasks are implemented - as infinite loops - we must add logging logic to each and every task, by doing so:
+```ruby
+# lib/tasks/example_task.rake
+namespace :excel do
+  task validation: :environment do
+    loop do
+      heartbeat_desc = { type: 'monitoring', service: 'excel', action: 'validation' }
+      log_user = { email: 'automated_task', cognito_id: 'automated_task' 
+      ChiliLogger.instance.publish_instant_log(desc: heartbeat_desc, user: log_user)
+
+      usual task code...
+
+      sleep 5
+    end
+end
+
+``` 
+
 ## Coverage
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
-<!-- TODO -->
+ChiliLogger keeps a coverage report, showing what kinds of logs are being created. This can be usefull to see whether all important points of an application are being satisfactorily monitored and also to have an overview of how these logs description tags are looking like. This coverage report can be found in `app_root/log/chili-logger-coverage.yml`. It is an YAML file with 4 dimensions:
+  - first dimension: type;
+  - second dimension: service;
+  - third dimension: action;
+  - fourth dimension: an array with the backtrace of the last created log to a given type, service and action combination;
+
+```yaml
+transaction: #log's type
+  videos: # log's service
+    create: # log's action
+      - "backtrace_path_1" # backtrace for transaction.videos.create
+      - "backtrace_path_2"
+      - "backtrace_path_3"
+    update: # log's action
+      - "backtrace_path_1" # backtrace for transaction.videos.update
+      - "backtrace_path_2"
+      - "backtrace_path_3"
+  banners:
+    create: # log's action
+      - "backtrace_path_1" # backtrace for transaction.banners.create
+      - "backtrace_path_2"
+      - "backtrace_path_3"
+    accept: # log's action
+      - "backtrace_path_1" # backtrace for transaction.banners.accept
+      - "backtrace_path_2"
+      - "backtrace_path_3"
+
+uncaught_error: #log's type
+  gallery: # log's service
+    index: # log's action
+      - "backtrace_path_1" # backtrace for uncaught_error.gallery_index
+      - "backtrace_path_2"
+      - "backtrace_path_3"
+
+monitoring: #log's type
+  campaigns: # log's service
+    validate_sheet: # log's action
+      - "backtrace_path_1" # backtrace for monitoring.campaigns.validate_sheet
+      - "backtrace_path_2"
+      - "backtrace_path_3"
+```

data/chili_logger.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://gitlab.com/chiligumdev/chili_logger'
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
-  spec.add_dependency 'aws-sdk', '~> 2.9', '>= 2.9.0'
+  spec.add_dependency 'aws-sdk-sqs', '~> 1.30.0'
   spec.add_dependency 'bunny'
   spec.add_dependency 'httparty'
 

data/lib/brokers/rabbit_broker.rb

@@ -46,13 +46,8 @@ class ChiliLogger
       # if no routing_key was provided when configuring RabbitBroker, than use the one received by the method here
       # temporary solution so we can force configure ChiliLogger to use a specific routing_key
       key = @routing_key_overwriter || routing_key
-      puts key
-      puts key
-      puts key
-      puts key
-      puts key
-      puts key
       @exchange.publish(message.to_json, routing_key: key)
+      puts "sent message to #{@exchange_name}, with routing_key = '#{key}'"
 
     rescue StandardError => e
       @logging_error_handler.handle_error(e, message)
@@ -69,16 +64,11 @@ class ChiliLogger
     end
 
     def connection_config
-      # shouldn't try to recover connection,
-      # it may cause app in production to collapse if reconnection doesn't work or takes too many attempts!!!
-      recovery_attempts = 0
-
       {
         user: @user,
         password: @password,
         host: @ip,
-        port: @port,
-        recovery_attempts: recovery_attempts
+        port: @port
       }
     end
 

data/lib/brokers/sqs_broker.rb

@@ -1,4 +1,4 @@
-require 'aws-sdk'
+require 'aws-sdk-sqs'
 
 # class for centralizing Creative's logging logic
 class ChiliLogger

data/lib/chili_logger/version.rb

@@ -1,3 +1,3 @@
 class ChiliLogger
-  VERSION = "0.0.8"
+  VERSION = '0.0.12'.freeze
 end

data/lib/current_log_accessor.rb

@@ -3,7 +3,6 @@ require 'helpers/values/default'
 require 'helpers/values/type_uniformizer/desc'
 require 'helpers/values/type_uniformizer/main_content'
 require 'helpers/values/type_uniformizer/user'
-require 'byebug'
 
 # class for centralizing Creative's logging logic
 class ChiliLogger

data/log/chili-logger-coverage.yml

@@ -0,0 +1,99 @@
+---
+test:
+  console:
+    publish_test:
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/chili_logger-0.0.8/lib/chili_logger.rb:61:in
+      `publish_instant_log'"
+    - "(pry):28:in `__pry__'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:290:in
+      `eval'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:290:in
+      `evaluate_ruby'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:659:in
+      `handle_line'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:261:in
+      `block (2 levels) in eval'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:260:in
+      `catch'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:260:in
+      `block in eval'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:259:in
+      `catch'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:259:in
+      `eval'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:77:in `block
+      in repl'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:67:in `loop'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:67:in `repl'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:38:in `block
+      in start'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/input_lock.rb:61:in
+      `__with_ownership'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/input_lock.rb:78:in
+      `with_ownership'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:38:in `start'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:15:in `start'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_class.rb:191:in
+      `start'"
+    - "/home/lucas/.irbrc:8:in `<top (required)>'"
+    - "/usr/share/rvm/scripts/irbrc.rb:40:in `load'"
+    - "/usr/share/rvm/scripts/irbrc.rb:40:in `<top (required)>'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:54:in
+      `require'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:54:in
+      `require'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/.irbrc:11:in `<top (required)>'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/irb/init.rb:231:in `load'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/irb/init.rb:231:in `run_config'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/irb/init.rb:20:in `setup'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/irb.rb:378:in `start'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/bin/irb:11:in `<main>'"
+transaction:
+  console:
+    publish_test:
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/chili_logger-0.0.12/lib/chili_logger.rb:61:in
+      `publish_instant_log'"
+    - "(pry):50:in `__pry__'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:290:in
+      `eval'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:290:in
+      `evaluate_ruby'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:659:in
+      `handle_line'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:261:in
+      `block (2 levels) in eval'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:260:in
+      `catch'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:260:in
+      `block in eval'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:259:in
+      `catch'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_instance.rb:259:in
+      `eval'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:77:in `block
+      in repl'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:67:in `loop'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:67:in `repl'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:38:in `block
+      in start'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/input_lock.rb:61:in
+      `__with_ownership'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/input_lock.rb:78:in
+      `with_ownership'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:38:in `start'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/repl.rb:15:in `start'"
+    - "/home/lucas/.rvm/gems/ruby-2.3.3/gems/pry-0.13.1/lib/pry/pry_class.rb:191:in
+      `start'"
+    - "/home/lucas/.irbrc:8:in `<top (required)>'"
+    - "/usr/share/rvm/scripts/irbrc.rb:40:in `load'"
+    - "/usr/share/rvm/scripts/irbrc.rb:40:in `<top (required)>'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:54:in
+      `require'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:54:in
+      `require'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/.irbrc:11:in `<top (required)>'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/irb/init.rb:231:in `load'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/irb/init.rb:231:in `run_config'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/irb/init.rb:20:in `setup'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/lib/ruby/2.3.0/irb.rb:378:in `start'"
+    - "/usr/share/rvm/rubies/ruby-2.3.3/bin/irb:11:in `<main>'"

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: chili_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.12
 platform: ruby
 authors:
 - lucas sandeville
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-sqs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: 1.30.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.9.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: 1.30.0
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
@@ -81,8 +75,6 @@ files:
 - assets/images/rabbit-topic-explanation.webp
 - bin/console
 - bin/setup
-- chili_logger-0.0.6.gem
-- chili_logger-0.0.7.gem
 - chili_logger.gemspec
 - lib/brokers/rabbit_broker.rb
 - lib/brokers/sqs_broker.rb
@@ -100,6 +92,7 @@ files:
 - lib/helpers/values/type_uniformizer/user.rb
 - lib/message_writer/aws_ops_metadata.rb
 - lib/message_writer/message_writer.rb
+- log/chili-logger-coverage.yml
 homepage: https://gitlab.com/chiligumdev/chili_logger
 licenses:
 - MIT