make logging under control

.gitignore

@@ -1,4 +1,5 @@
 /config/settings.local.yml
+/config/settings/*.local.yml
 
 # Used instead of dotenv library to load environment variables.
 /.env.rb
@@ -8,3 +9,4 @@
 /Gemfile.lock
 
 /log
+!/log/.keep

.rubocop.yml

@@ -38,3 +38,10 @@ Metrics/BlockLength:
   Exclude:
     - Rakefile
     - app/routes/**/*
+
+Style/ClassVars:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - .env.rb

Gemfile

@@ -19,11 +19,14 @@ gem 'faraday'
 
 gem 'bunny'
 
+gem 'ougai', require: 'ougai'
+
 group :development do
   gem 'pry'
 end
 
 group :development, :test do
+  gem 'amazing_print'
   gem 'rubocop', require: false
   gem 'rubocop-rspec', require: false
 end

README.md

@@ -1,9 +1,9 @@
-# Geocoder Microservice (synchronous RabbitMQ)
-Geocoder microservice for RabbitMQ synchronous [Ads Microservice](https://github.com/rubygitflow/ads_microservice/tree/rabbitmq_synchro) from Ruby Microservices course
+# Geocoder Microservice (on RabbitMQ)
+Geocoder microservice for [Ads Microservice](https://github.com/rubygitflow/ads_microservice/tree/logging) on RabbitMQ from Ruby Microservices course
 
 It's set up so you can clone this repository and base your application on it:
 ```bash
-$ git clone git@github.com:rubygitflow/geocoder_microservice.git app_geo --single-branch --branch rabbitmq_synchro && cd app_geo && rm -r -f .git/
+$ git clone git@github.com:rubygitflow/geocoder_microservice.git app_geo --single-branch --branch logging && cd app_geo && rm -r -f .git/
 ```
 Initialize and configure a new Git repository (you need to have a [personal access token](https://github.com/settings/tokens)):
 ```bash
@@ -24,6 +24,14 @@ $ git push -u origin master
 ```
 For more details, see the [github docs](https://docs.github.com/en/rest/repos/repos#create-a-repository-for-the-authenticated-user)
 
+Add config file `.env.rb` with correct data:
+```ruby
+ENV['RABBITMQ_HOST']='127.0.0.1'
+ENV['RABBITMQ_USER']='RabbitMQ_UserName'
+ENV['RABBITMQ_PASSWORD']='RabbitMQ_Password'
+ENV['ADS_URL'] = 'http://localhost:3001/api/v1'
+```
+
 ## Environment setup
 ```bash
 $ bundle install
@@ -33,16 +41,13 @@ $ bundle install
 You can either set up configuration into `config/initializers/config.rb`, `config/settings/*.yml` and `config/settings.yml` or `config/settings.local.yml` before running
 
 ```bash
+$ bin/app
 $ bin/console
 ```
 or run the application with modified configuration using environment variables as well
 ```bash
 $ RACK_ENV=test bin/console
-```
-
-## HTTP-requests to the app
-```bash
-$ bin/app
+$ LOG_SERVICE=stdout bin/app
 ```
 
 ## Run tests

app/lib/ads_service/rpc_client.rb

@@ -46,7 +46,7 @@ def publish(payload, opts = {})
         @queue.publish(
           payload,
           opts.merge(
-            app_id: 'geocoder',
+            app_id: Settings.app.name,
             correlation_id: @correlation_id,
             reply_to: @reply_queue.name
           )

app/lib/geocoder.rb

@@ -12,7 +12,7 @@ def geocode(city)
   end
 
   def data
-    @data ||= load_data!
+    @@data ||= load_data!
   end
 
   private

app/lib/rabbit_mq.rb

@@ -7,7 +7,11 @@ module RabbitMq
 
   def connection
     @mutex.synchronize do
-      @connection ||= Bunny.new.start
+      @connection ||= Bunny.new(
+        host: Settings.rabbitmq.host,
+        username: Settings.rabbitmq.username,
+        password: Settings.rabbitmq.password
+      ).start
     end
   end
 

config/application.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 class Application
-  def self.root
-    ApplicationLoader.root
-  end
+  class << self
+    attr_accessor :logger
+
+    def root
+      ApplicationLoader.root
+    end
 
-  def self.environment
-    ENV.fetch('RACK_ENV').to_sym
+    def environment
+      ENV.fetch('RACK_ENV').to_sym
+    end
   end
 end

config/application_loader.rb

@@ -5,6 +5,7 @@ module ApplicationLoader
 
   def load_app!
     init_config
+    init_logger
     require_app
     init_app
   end
@@ -19,6 +20,10 @@ def init_config
     require_file 'config/initializers/config'
   end
 
+  def init_logger
+    require_file 'config/initializers/logger'
+  end
+
   def require_app
     require_file 'config/application'
     require_dir 'app/contracts'

config/environment.rb

@@ -2,6 +2,12 @@
 
 ENV['RACK_ENV'] ||= 'development'
 
+begin
+  require_relative '../.env'
+rescue LoadError
+  # do nothing
+end
+
 require 'bundler/setup'
 Bundler.require(:default, ENV['RACK_ENV'])
 

config/initializers/consumer.rb

@@ -4,10 +4,17 @@
 queue = channel.queue('geocoding', durable: true)
 
 # https://www.rabbitmq.com/tutorials/tutorial-two-ruby.html
-queue.subscribe(manual_ack: true) do |delivery_info, _properties, payload|
+queue.subscribe(manual_ack: true) do |delivery_info, properties, payload|
+  Thread.current[:request_id] = properties.headers['request_id']
   payload = JSON(payload)
   coordinates = Geocoder.geocode(payload['city'])
 
+  Application.logger.info(
+    'Update city coordinates',
+    city: payload['city'],
+    coordinates: coordinates
+  )
+
   if coordinates.present?
     client = AdsService::HttpClient.new
     client.update_coordinates(payload['id'], coordinates)

config/initializers/logger.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../application'
+
+def stdout?
+  ENV['LOG_SERVICE'] == 'stdout'
+end
+
+logger_path = case ENV['LOG_SERVICE']
+              when 'stdout'
+                $stdout
+              when nil
+                "#{Application.root}/#{Settings.logger.path}"
+              else
+                "#{Application.root}/#{ENV['LOG_SERVICE']}"
+              end
+
+logger = Ougai::Logger.new(
+  logger_path,
+  level: Settings.logger.level
+)
+
+logger.formatter = Ougai::Formatters::Readable.new if stdout?
+
+logger.before_log = lambda do |data|
+  data[:service] = { name: Settings.app.name }
+  data[:request_id] ||= Thread.current[:request_id]
+end
+
+Application.logger = logger

config/settings.yml

@@ -1,2 +1,4 @@
+app:
+  name: geocoder
 rabbitmq:
   consumer_pool: 10

config/settings/development.yml

@@ -0,0 +1,7 @@
+logger:
+  path: log/development.log
+  level: <%= Logger::DEBUG %>
+rabbitmq:
+  host: <%= ENV.fetch('RABBITMQ_HOST') %>
+  username: <%= ENV.fetch('RABBITMQ_USER') %>
+  password: <%= ENV.fetch('RABBITMQ_PASSWORD') %>

config/settings/production.yml

@@ -0,0 +1,7 @@
+logger:
+  path: log/production.log
+  level: <%= Logger::INFO %>
+rabbitmq:
+  host: <%= ENV.fetch('RABBITMQ_HOST') %>
+  username: <%= ENV.fetch('RABBITMQ_USER') %>
+  password: <%= ENV.fetch('RABBITMQ_PASSWORD') %>

config/settings/test.yml

@@ -0,0 +1,7 @@
+logger:
+  path: log/test.log
+  level: <%= Logger::FATAL %>
+rabbitmq:
+  host: <%= ENV.fetch('RABBITMQ_HOST') %>
+  username: <%= ENV.fetch('RABBITMQ_USER') %>
+  password: <%= ENV.fetch('RABBITMQ_PASSWORD') %>