chili_logger 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e49414c8428f038f87301e96eace682892b68a6962c0e3f2081beaf60ebd9569
-  data.tar.gz: 2fa17c2d0599ba5beba8f483e9514b6ef25d9ed093b71a802adc9d8e27b529e6
+  metadata.gz: fdf566e52a267b06ca8561b8c17192e7cce0ef988418f566ffdf684fd98653d0
+  data.tar.gz: 021bf795a6b256054f622fad78ba9b9372b90adfeea409bd3824918413a32bd1
 SHA512:
-  metadata.gz: d1d36617a2c983490b0edc92eca2c9b8f4f96e701bdbb2aabaf0b9abf676b2b34d75e5dc8b712b2b1573ffd5a73a5438a5719d3e88656fbd5228d56ae34b7dc2
-  data.tar.gz: ebd5d8ef5bfebc12bab504975e17c19850664701f811765aa06a30a9ce9f40c2cec05f26e50f0f8d993938d30fc62d9af67fc36f47b010a16b567a9e58b058e9
+  metadata.gz: 276a50ea4d77dec85187a596d9724d950358cb02e7799ce7a57ca51af2f56cee356b3985ec813bc6bf7fe36d152862301260e560f8eed45d8cf79e37e40f4253
+  data.tar.gz: 14e33d99349ced59521f52eca10426a636836af432139a53ab2cd452b581fb459c6c277084fc24775e193d226fad576c1a289ac711c6062ec49690cbb010d927

data/.byebug_history

@@ -1,4 +1,82 @@
 continue
+options
+continue
+options
+continue
+@desc_uniformizer.desc([])
+@desc_uniformizer.desc(options[:desc])
+@desc_uniformizer.desc
+@desc_uniformizer.desc(options[:desc])
+options
+continue
+options
+continue
+main_content.merge(uniformized_content)
+main_content
+continue
+main_content
+uniformized_content
+continue
+desc
+continue
+uniformized_content
+continue
+uniformized_content
+quit
+val.first.is_a?(Hash)
+val.first.is_a?(Hash) ? {} : record
+modified_record(val.first)
+val
+uniformized_val
+quit
+continue
+error.inspect.is_a?(String)
+error.inspect
+error.class.ancestors.include?(Exception)
+error
+new_error
+errors
+all_errors
+continue
+new_error.is_a?(String)
+continue
+new_error.is_a?(String)
+new_error.class
+new_error
+continue
+new_error
+continue
+new_error
+continue
+error
+new_error
+quit
+main_content[:errors] ||= @default.log_errors
+errors
+continue
+user[:cognito_id]
+new_user[:cognito_id]
+continuenew_user[:cognito_id]
+continue
+new_user
+continue
+user
+Thread.current[:current_log_user]
+Thread.current[:current_log_user] ||= default_user
+continue
+Thread.current[:current_log_user] ||= default_user
+continue
+Thread.current[:current_log_user] ||= default_user
+continue
+Thread.current[:current_log_user] ||= default_user
+user
+continue
+log_user
+continue
+Thread.current[:current_log_user] ||= default_user
+Thread.current[:current_log_user]
+user
+continue
 e.class
 e.is_a?(Bunny:TCPConnectionFailed)
 e

data/Gemfile

@@ -12,3 +12,5 @@ gem 'rspec', '~> 3.0'
 gem 'rubocop', '~> 0.60.0', require: false
 
 gem 'httparty', '~> 0.18.1'
+
+gem "simplecov", "~> 0.17.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chili_logger (0.0.7)
+    chili_logger (0.0.8)
       aws-sdk (~> 2.9, >= 2.9.0)
       bunny
       httparty
@@ -38,6 +38,7 @@ GEM
     byebug (11.0.1)
     concurrent-ruby (1.1.6)
     diff-lcs (1.4.2)
+    docile (1.3.2)
     httparty (0.18.1)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
@@ -45,6 +46,7 @@ GEM
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     jmespath (1.4.0)
+    json (2.3.1)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
@@ -78,6 +80,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     thread_safe (0.3.6)
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
@@ -96,6 +103,7 @@ DEPENDENCIES
   rake (~> 12.0)
   rspec (~> 3.0)
   rubocop (~> 0.60.0)
+  simplecov (~> 0.17.1)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -1,29 +1,257 @@
 # ChiliLogger
 
-ChiliLogger is gem developed for internal use in Chiligum Creatives. It is used to monitor our applications and generate logs with some uniformization.
+ChiliLogger is a gem developed by Chiligum Creatives for internal use. It is used to monitor our ruby applications and generate logs with some uniformization.
+
+## Table of Contents
+* [READ BEFORE CONTRIBUTING](##read-before-contributing)
+* [How it Works](##how-it-works)
+  * [Overview](###overview)
+  * [Anatomy of a Chiligum Log](###anatomy-of-a-chiligum-log)
+    * [Example Log](####example-log)
+    * [Environment](####environment)
+    * [Layer](####layer)
+    * [Type](####type)
+    * [Service](####service)
+    * [Action](####action)
+    * [Description](####description)
+    * [User](####user)
+    * [Main Content](####main-content)
+    * [Ops Metadata](####ops-metadata)
+    * [Timestamp](####timestamp)
+  * [A Primer on RabbitMQ and ElasticSearch](###a-primer-on-rabbitmq-and-elasticsearch)
+    * [RabbitMQ](####rabbitmq)
+    * [ElasticSearch](####elasticsearch)
+    * [Putting It All Together](####putting-it-all-together)
+* [Installation](##installation)
+* [Basic Usage](##basic-usage)
+* [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)
+    * [desc](####desc)
+    * [overwrite_type](####overwrite_type)
+    * [overwrite_service](####overwrite_service)
+    * [overwrite_action](####overwrite_action)
+    * [overwrite_desc](####overwrite_desc)
+    * [main_content](####main_content)
+    * [overwrite_main_content](####overwrite_main_content)
+    * [add_to_main_content](####add_to_main_content)
+    * [modified_records](####modified_records)
+    * [overwrite_modified_records](####overwrite_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)
+  * [Papertrail Optional Use](###papertrail-optional-use)
+  * [Logging Transactions](###logging-transactions)
+  * [Logging Rake Tasks](###logging-rake-tasks)
+  * [A Note About ActiveRecords](###a-note-about-activerecords)
+* [Coverage](##Coverage)
+
+## READ BEFORE CONTRIBUTING
+The main thing you need to know before changing Chililogger's source code is this: we send our logs in JSON format and [Logstash parses and converts them to Elasticsearch objects](####elasticsearch), requiring all fields to have consistent primitive types. So suppose you send these logs: 
+```json
+// first log
+{
+  "user": {
+    "name": "Joe Doe"
+  }
+}
+
+// second log
+{
+  "user": "Mary Jane"
+}
+
+// third log
+{
+  "user": {
+    "name": {
+      "first": "Francis",
+      "last": "Coppola"
+    }
+  }
+}
+
+// fourth log
+{
+  "client": {
+    "name": "Angela"
+  }
+}
+```
+After receiving the first log, `Logstash` will parse it and define that the `user` field is always an object and that it **may** have a field called `name`, which is a string. Notice that it is not mandatory for logs to have a `user` and a `user.name`. But, if a log does have these fields, then they **must** be an object and a string, respectively.
+
+When Logstash receives the second log, it will see an inconsistency, because this time `user` is a string, not an object. Because of that, Logstash will ignore this log - in other words, **this log will not be saved to Elasticsearch**. When the third log arrives, the same will happen. It will see that `user` is consistent with what it expected, but that the field `user.name` is now an object, intead of being a string as was expected. This log will also be ignored by Logstash. The fourth log would be accepted though, since `client.name` hasn't been set yet.
+
+So if you are going to change anything in ChiliLogger, you have to keep this in mind: **the primitive types of fields in an Elasticsearch index must always be consistent**. If your changes generate logs with fields that already existed in the Elasticsearch index, but now have a different primitive type, Logstash will ignore these logs. This is important because Logstash just ignores incorrect logs without raising errors - so it may take a long time before the problem is noticed. If you need to change the type of a previously set field, you will need to create a new index/Logstash and make sure the logs are sent to this new Logstash.
 
 ## How it works
 
+### Overview
+
+![ChiliLogger usual Flow](assets/images/chili-logger-flow.png)
+
+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.
+
+
+### Anatomy of a Chiligum Log
+
+The ChiliLogger gem was created to guarantee some level of uniformization in logs generated by all our ruby applications. So, to better understand its functioning and usage, it is helpful to first understand what kind of logs it is trying to generate. An example log would look like the following:
+
+#### Example Log
+```json
+{
+  "env": "development",
+  "layer": "creatives",
+  "type": "transaction",
+  "service": "videos",
+  "action": "create",
+  "desc": "development.creatives.transaction.videos.create",
+  "user": { 
+    "cognito_id": "88", 
+    "email": 'exemple@test.com',
+    "company_cognito_id": "75",
+    "company_name": "Chiligum Creatives",
+    "admin_ghost_user": "not_specified"
+  },
+  "transaction": {
+    "modified_records": { 
+      "videos": [{ "id": 42, "title": 'Lateralus' }]
+    },
+    "errors": [],
+    "backtrace": [
+      "app/views/dashboard/controllers/videos_controller.rb:17 in block 'create'"
+    ],
+  },
+  "ops_metadata": {
+    "server_url": "https://app.chiligumvideos.com"
+  },
+  "timestamp": "2020-06-30T18:08:59-03:00"
+}
+
+```
+Below is a short explanation of each one of the log attributes.
+
+#### Environment
+The `env` attribute is used for tagging the log and tells in which environment the app was running when the log was created. We are mainly concerned with three possible environments: `production`, `staging`, and `development`. Needless to say, logs from a production environment are the most important to us, but staging and development logs can be useful for debugging/testing.
+
 ---
 
-## Installation
+#### Layer
+The `layer` attribute is also used for tagging and tells us in which layer of the Chiligum platform the log was created. Usually, the layer will correspond to the name of the application/service where ChiliLogger was installed. For instance, it could be 'creatives', 'api', 'render', etc...
 
-Add this line to your application's Gemfile:
+---
+
+#### Type
+Also a tagging attribute, tells what type of log it is. Chiligum has 3 main types of logs: 
+  - `transaction` is used for logging transactions made by users, such as creating a campaign, uploading a file to the gallery, etc...
+  - `uncaught_error` is used for logging internal server errors and to help us find problematic points in our applications;
+  - `monitoring` is used to monitor the health of our servers, providing information such as CPU usage, uptime, etc...
 
+ChiliLogger is concerned only with `transaction` and `uncaught_errors`, since they are the only ones that can be generated in the application itself. Monitoring logs are created by other monitoring services, like ElasticSearch Beats or AWS Cloudwatch.
+
+---
+
+#### Service
+The `service` tagging attribute is used to tell what group of features the user was trying to interact with. Services can be things like 'videos', 'campaigns', 'banners', 'gallery' and will usually have the similar names to the Controllers in an application.
+
+---
+
+#### Action
+The `action` tagging attribute describes what action exactly the user was trying to perform in our platform. Usual values for it are 'create', 'update, and 'delete'. Usually, action tags will have similar names to Controllers' methods.
+
+---
+
+#### Description
+The `desc` is the last of the tagging attributes and is used to combine all of the previous attributes in a single tag, allowing any person that is examining a log to quickly identify what the log is about. It is structured in the following manner:
 ```ruby
-gem 'chili_logger'
+"#{env}.#{layer}.#{type}.#{service}.#{action}"
 ```
+Notice that the tags are separated by a `.` period. That's because the `desc` tag is also used to create the [routing_key for topic exchanges](https://www.rabbitmq.com/tutorials/amqp-concepts.html#exchange-topic) when ChiliLogger is using RabbitMQ as its MessageBroker.
 
-And then execute:
+---
 
-    $ bundle install
+#### User
+The `user` stores the main infos about the user whose request generated the log. The user is an object that accepts five attributes: 
+  - `cognito_id`, the user's global ID, the one the identifies it in Cognito's DB;
+  - `email`, so we can easily know who the user is;
+  - `company_cognito_id`, the global ID of the user's company;
+  - `company_name`;
+  - `ghost_user_cognito_id`, for cases when admin users can log as other users. In these cases, the admin's global ID should be stored in the ghost_user_cognito_id;
+
+---
+
+#### 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.
+
+---
+
+#### 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. 
+
+---
+
+#### Timestamp
+ChiliLogger automatically adds a `timestamp` to the log.
+
+### A Primer on RabbitMQ and ElasticSearch
+Since Chiligum's logging system is entirely based on RabbitMQ and ElasticSearch, it's useful to have at least a high level understanding of how they work and how they are being used together.
+
+#### RabbitMQ
+RabbitMQis a popular message broker that can handle a high traffic of messages. Its role in our logging system is to simply receive all incoming logs and put them in appropriate queues, so other services can have access to these logs and process and/or store them in a central database.
+
+RabbitMQ has 4 main entities: 
+  * `publishers`, which create the messages (in our case, it's ChiliLogger creating the logs);
+  * `exchanges`, where publishers send the messages to;
+  * `queues`, which receive just the messages from the exchange that are relevant to them.
+  * `consumers`, which get messages from specific queues (in our case, that's Logstash/Elasticsearch)
 
-Or install it yourself as:
+![explanation for RabbitMQ basic functioning](assets/images/rabbit-basic-functioning.png)
 
-    $ gem install chili_logger
+All messages are published to an exchange with a `routing_key`, which allows the exchange to know which queues should receive that message. RabbitMQ has a couple of possible exchange types and each one of them has a different way of distributing the messages among the queues. At Chiligum, we use only the `topic` type, the most flexible one and the one that can simulate all other types if needed. 
 
+In topic exchanges, the routing_key will be composed of keywords separated by dots ("."). Queues, on the other hand, will define which keywords they are interested at by defining their `binding_keys`. So a message with `production.creatives.videos` as routing_key would bedelivered to any queue with a matching binding_key of `production.creatives.videos`. Queues can use wildcards(`*`, `#`) in their binding keys. It's easier to understand it with the exemple from the RabbitMQ tutorials itself:
+
+> `*` can substitute for exactly one word. `#` can substitute for zero or more words.
+>
+> In this example, we're going to send messages which all describe animals. The messages will be sent with a routing key that consists of three words (two dots). The first word in the routing key will describe a celerity, second a colour and third a species: "`<celerity>.<colour>.<species>`".
+
+![explanation for RabbitMQ topic excahnges](assets/images/rabbit-topic-explanation.webp)
+>
+> We created three bindings: Q1 is bound with binding key "`*.orange.*`" and Q2 with "`*.*.rabbit`" and "`lazy.#`". These bindings can be summarised as:
+>
+> Q1 is interested in all the orange animals. Q2 wants to hear everything about rabbits, and everything about lazy animals.
+>
+> A message with a routing key set to "`quick.orange.rabbit`" will be delivered to both queues. Message "`lazy.orange.elephant`" also will go to both of them. On the other hand "quick.orange.fox" will only go to the first queue, and "`lazy.brown.fox`" only to the second. "`lazy.pink.rabbit`" will be delivered to the second queue only once, even though it matches two bindings. "`quick.brown.fox`" doesn't match any binding so it will be discarded.
+
+
+
+#### ElasticSearch
+ElasticSearch is part of the so-called Elastic Stack. It is an open source database that offers powerful, fast querying of data. It is usually used with Logstash, also a tool of the Elastic Stack. Logstash can fetch or receive data from many different sources and can parse this data so it is in compliance with ElasticSearch data structures. At Chiligum, we create logs in JSON format and it is Logstash who converts it to Elasticsearch objects. Logstash can also work with RabbitMQ, creating queues and receiving data form them.  
+
+#### Putting It All Together
+By now, perhaps it has already become clear how RabbitMQ and ElasticSearch are being used for Chiligum's logging system. `ChiliLogger` will create logs and publish them to a topic exchange in `RabbitMQ` with the appropriate routing_keys. RabbitMQ will distribute these logs to the queues created by `Logstash` instances. The distribution of messages will be according to the queues' binding_keys. Logstash instances will keep polling the queues, fetching messages, parsing them to Elasticsearch objects and storing them in `Elasticsearch indexes`. An Elasticsearch index is analogous to a SQS table, it's basically a collection of stored data.
+
+![video showing Chiligum's logging system in action](assets/images/chiligum-logging-system.gif)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chili_logger'
+```
+
+
+Create a initializer file and configure ChiliLogger passing all the relevant information. It is recommended to deactivate ChiliLogger when running tests:
 
-Create a initializer file and configure ChiliLogger passing all the relevant informations:
 ```ruby
 # config/initializers/chili_logger.rb 
 require 'chili_logger'
@@ -32,21 +260,20 @@ is_deactivated = Rails.env.test?
 
 ChiliLogger.instance.config({
   deactivated: is_deactivated,
-  log_env: 'development',
-  log_layer: 'creatives',
-  server_url: ENV['SERVER_URL'],
-  cloud_provider: ENV['CLOUD_PROVIDER'],
-  msg_broker_name: :rabbitmq,
+  log_env: Rails.env, # sets the log's env attribute
+  log_layer: ENV['APPLICATION_NAME'], # sets the log's layer attribute
+  server_url: ENV['SERVER_URL'], # used for log's ops_metadata attribute
+  cloud_provider: ENV['CLOUD_PROVIDER'], # used for log's ops_metadata attribute
+  msg_broker_name: :rabbitmq, # ChiliLogger's Message Broker
   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: ENV['RABBIT_ROUTING_KEY']
   },
-  error_handler: :aws_sqs,
-  error_handler_config: {
+  fallback_broker: :aws_sqs, # Chiligum's fallback option in case of Message Broker being down
+  fallback_broker_config: {
     region: ENV['CHILI_LOGGER_SQS_HANDLER_REGION'],
     access_key_id: ENV['CHILI_LOGGER_SQS_HANDLER_KEY_ID'],
     secret_access_key: ENV['CHILI_LOGGER_SQS_HANDLER_SECRET_KEY'],
@@ -54,55 +281,486 @@ ChiliLogger.instance.config({
   }
 })
 ```
+The attributes `log_env` and `log_layer` set the fields ['env'](###environment) and ['layer'](###layer) in all logs that will be published by ChiliLogger.
 
-When configuring ChiliLogger, you MUST set msg_broker_name and msg_broker_config. All logs are published to this message broker and, without it, ChiliLogger can't work. For the time being, only :rabbitmq is supported.
-
-You ALSO MUST set error_handler and error_handler_config. The error handler is the fallback option if the message broker is not available and, without it, ChiliLogger will break the application every time the message broker is down. For the time being, only :aws_sqs is supported.
+When configuring ChiliLogger, you MUST set `msg_broker_name` and `msg_broker_config`. All logs are published to the configured message broker and, without it, ChiliLogger can't work. For the time being, only `:rabbitmq` is supported.
 
-Please note that if ChiliLogger tries to publish a log and both the 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.
+You ALSO MUST set `fallback_broker` and `fallback_broker_config`. This is the fallback option if the Message Broker is not available and, without it, ChiliLogger would break the application every time the Message Broker was down. For the time being, only `:aws_sqs` is supported.
 
+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.
 
----
 
 ## Basic Usage
-The easiest way to use ChiliLogger is with the `publish_instant_log` method. It requires three arguments: `desc`, `agent` and `main_content`, which are used to create the log. All of them are optional arguments and have default values:
+The easiest way to use ChiliLogger is with the `publish_instant_log` method. It requires a hash with the following optional attributes: 
 ```ruby
-desc = { type: }
-ChiliLogger.instance.publish_instant_log(desc, agent, log)
+{
+  desc: { # Hash
+    type: 'transaction', # String,
+    service: 'videos', # String
+    action: 'create', # String
+  },
+  user: { 
+    cognito_id: 100, # String || Fixnum || Bignum -> ChiliLogger converts cognito_id fields with these types to Strings
+    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
+  },
+  main_content: { # Hash
+    modified_records: {  # Hash
+      "#{tablename}": [ # Array of Hashes
+        { id: 42, title: 'Example video 1' },
+        { id: 42, title: 'Example video 2' },
+      ],
+      "#{another_tablename}": [ # Array of Hashes
+        { id: 42, title: 'Example banner 1' },
+        { id: 42, title: 'Example banner 2' },
+      ],
+    },
+    errors: [ # Array of Strings or Exception descendents -> ChiliLogger converts Exception descendents to Strings
+      'first error',
+      StandardError.new('second error')
+    ]
+  },
+}
+```
+`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.
 
-ChiliLogger.instance.publish_instant_log
+`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.
+
+```ruby
+desc = { type: 'transaction', service: 'videos', action: 'create' }
+agent = { user: { id: 88, email: 'axemple@test.com'}, company: {id: 75, name: 'Chiligum' }}
+main_content = { 
+  modified_records: {
+    videos: [{ id: 42, title: 'Lateralus' }]
+  }
+}
+
+ChiliLogger.instance.publish_instant_log(desc, agent, main_content)
+# publishes a json like this:
+{
+  "env": "development",
+  "layer": "creatives",
+  "type": "transaction",
+  "service": "videos",
+  "action": "create",
+  "desc": "development.creatives.transaction.videos.create",
+  "agent": { 
+    "user": { 
+      "id": 88, 
+      "email": 'exemple@test.com'
+    }, 
+    "company": {
+      "id": 75, 
+      "name": 'Chiligum' 
+    }
+  },
+  "transaction": {
+    "modified_records": {
+      "videos": [{ "id": 42, "title": 'Lateralus' }]
+    },
+    "backtrace": [
+      "app/views/dashboard/controllers/videos_controller.rb:17 in block 'create'"
+    ]
+  },
+  "ops_metadata": {
+    "server_url": "https://app.chiligumvideos.com"
+  },
+  "timestamp": "2020-06-30T18:08:59-03:00",
+}
 ```
 
+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
+# publishes a json like this:
+{
+  "action": "not_specified",
+  "layer": "creatives",
+  "env": "development",
+  "type": "not_specified",
+  "service": "not_specified",
+  "desc": "development.creatives.not_specified.not_specified.not_specified",
+  "agent": "not_specified", 
+  "not_specified": {},
+    "backtrace": [
+      "app/views/dashboard/controllers/videos_controller.rb:17 in block 'create'"
+    ]
+  },
+  "ops_metadata": {
+    "server_url": "https://app.chiligumvideos.com"
+  },
+  "timestamp": "2020-06-30T18:08:59-03:00",
+}
+```
 
 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)
+# undefined method `publish_instant_log' for ChiliLogger:Class
+
+ChiliLogger.new.publish_instant_log(desc, agent, log)
 # NoMethodError: private method `new' called for ChiliLogger:Class
 
 ChiliLogger.instance.publish_instant_log(desc, agent, log)
 # works fine
 ```
 
----
 
 ## Advanced Usage
+It will often happen that the information needed for a log is distributed in many parts of the application and can't be accessed in a single moment nor in a single place of the code base. For instance, you may want to set the log's agent with information about the current_user that's only available in the Controllers Layer. And you might want to add data to the log every time a DB record is modified, which is easier to do in the Models Layer. For these use cases, ChiliLogger's `publish_instant_log` will not be suitable and you should use more advanced features.
+
+ChiliLogger takes advantage of Ruby's Thread class and allows you to start a log and keep adding information to it during the current thread's lifespan. This is particularly useful when logging requests to a controller, since these requests will run from beginning to end in a single thread.
+
+Once a log is started, it can be accessed and modified by using ChiliLogger's `start_new_log` method and `current_log` accessor.
+
+#### Advanced Code Example
+```ruby
+# controllers/videos_controller.rb
+class VideosController
+  def create
+    desc = { type: 'transaction', service: 'videos', action: 'create' }
+    agent = { user: current_user.as_json, company: current_user.as_json }
+    current_log = ChiliLogger.instance.start_new_log(desc, agent) # Step One
+
+    Video.create(title: 'Lateralus') # Step Two happens in the Video model
+
+    current_log.publish # Step Three
+  end
+end
+
+# models/video.rb
+class Video < ApplicationRecord
+  after_create :add_modified_record_to_log
+
+  def add_modified_record_to_log
+    current_log = ChiliLogger.instance.current_log
+    modified_record = self.as_json
+
+    current_log.add_modified_record(self.class.table_name, modified_record) # Step Two
+  end
+end
+
+# resulting log (simplified)
+{
+  "env": "development",
+  "layer": "creatives",
+  "type": "transaction",
+  "service": "videos",
+  "action": "create",
+  "desc": "development.creatives.transaction.videos.create",
+  "agent": { 
+    "user": { 
+      "id": 88, 
+      "email": 'exemple@test.com'
+    }, 
+    "company": {
+      "id": 75, 
+      "name": 'Chiligum' 
+    }
+  },
+  "transaction": {
+    "modified_records": {
+      "videos": [{ "id": 42, "title": 'Lateralus' }]
+    },
+    "backtrace": [
+      "app/views/dashboard/controllers/videos_controller.rb:17 in block 'create'"
+    ]
+  },
+  "ops_metadata": {
+    "server_url": "https://app.chiligumvideos.com"
+  },
+  "timestamp": "2020-06-30T18:08:59-03:00",
+}
+```
+
+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.
+
+#### Error Logging
+The controller code above could be improved by adding some logic to log unexpected errors:
+```ruby
+# controllers/videos_controller.rb
+class VideosController
+  def create
+    desc = { type: 'transaction', service: 'videos', action: 'create' }
+    agent = { user: current_user.as_json, company: current_user.as_json } # .as_json converts ActiveReacords into Hash
+    current_log = ChiliLogger.instance.start_new_log(desc, agent)
+
+    Video.create(title: 'Lateralus')
+
+    current_log.publish
+
+  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.publish
+  end
+end
+```
+A [full list of methods](###customizing-a-started-log) for customizing a `current_log` is available
+
+### Customizing a Started Log
+Once a log is started, its main attributes can be customized by accessing the `current_log` and calling one of its many customizing methods.
+#### 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
+```
+#### agent
+returns log's currently set agent
+
+```ruby
+current_log.agent
+# { user: { name: 'not_specified' } }
+```
 
 ---
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### overwrite_agent
+overwrites the currently set agent
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+current_log.agent
+# { user: { name: 'not_specified' } }
+
+current_log.overwrite_agent({ user: { name: 'new_agent' } })
+current_log.agent
+# { user: { name: 'new_agent' }
+```
 
 ---
 
-## Contributing
+#### desc
+returns currently set log's description. Notice that, for the time being, `env` and `layer` can't be overwritten, these description attributes can only be set during [ChiliLogger's configuration](##installation)
+
+```ruby
+current_log.desc
+# { type: 'not_specified', service: 'not_specified', action: 'not_specified' }
+```
+
+---
+
+#### overwrite_type
+overwrites 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.desc
+# { type: 'transaction', service: 'not_specified', action: 'not_specified' }
+```
+
+---
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chili_logger.
+#### overwrite_service
+overwrites 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.desc
+# { type: 'not_specified', service: 'videos', action: 'not_specified' }
+```
+
+---
+
+#### overwrite_action
+overwrites 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.desc
+# { type: 'not_specified', service: 'not_specified', action: 'delete' }
+```
+
+---
+
+#### overwrite_desc
+overwrites 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.desc
+# { type: 'uncaught_error', service: 'not_specified', action: 'create' }
+```
+
+---
+
+#### main_content
+returns the currently set main_content
+
+```ruby
+current_log.main_content
+# { modified_records: {} }
+
+```
+
+---
+
+#### overwrite_main_content
+overwrites the currently set main_content
+
+```ruby
+current_log.main_content
+# { modified_records: {} }
+
+current_log.overwrite_main_content({ meaning_of_life: 42 })
+current_log.main_content
+# { meaning_of_life: 42 }
+```
+
+---
+
+#### add_to_main_content
+merges hash with currently set main_content
+
+```ruby
+current_log.main_content
+# { modified_records: {} }
+
+current_log.add_to_main_content({ meaning_of_life: 42 })
+current_log.main_content
+# { modified_records: {}, meaning_of_life: 42 }
+```
+
+---
+
+#### modified_records
+returns the modified_records stored in the main_content
+
+```ruby
+current_log.modified_records
+# {}
+```
+
+---
+
+#### overwrite_modified_records
+overwrites the modified_records stored in the main_content
+
+```ruby
+current_log.modified_records
+# {}
+
+current_log.overwrite_modified_records({ tracks: [{ id: 88, title: 'Lateralus' }] })
+current_log.modified_records
+# { tracks: [{ id: 88, title: 'Lateralus' }] }
+```
+
+---
+
+#### add_modified_record
+merges hash with currently set modified_records
+
+```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.modified_records
+# { 
+#   tracks: [{ id: 88, title: 'Lateralus' }, { id: 89, title: "Hips Don't lie" }],
+#   videos: [{id: 42, title: 'Life Of Brian' }]
+# }
+```
+
+---
+
+#### clear_log_info
+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. 
+
+### 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.
+>
+> Papertrail allows us to keep a history of changes made to ActiveRecords entities, which is great for logging. To install and setup `paper_trail`, add the following code:
+
+    // optional code if you want to use Papertrail to enrich logs
+    $ bundle add paper_trail
+    $ bundle install
+    $ bundle exec rails generate paper_trail:install
+    $ bundle exec rake db:migrate
+and then:
+```ruby
+# optional code if you want to use Papertrail to enrich logs
+
+# models/application_record.rb
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  has_paper_trail # add this line!
+end
+```
 
-## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+### 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 -->
+ 
+## Coverage
+<!-- TODO -->
+<!-- TODO -->
+<!-- TODO -->
+<!-- TODO -->
+<!-- TODO -->
+<!-- TODO -->
+<!-- TODO -->
+<!-- TODO -->
+<!-- TODO -->