From e953a23d25d0939db246acd93c399c25459cbbd2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Glauco=20Cust=C3=B3dio?= <glauco.custodio@gmail.com>
Date: Thu, 4 Aug 2016 17:45:08 -0300
Subject: [PATCH] Add syntax highlighting to README.md (#30)

---
 README.md | 89 ++++++++++++++++++++++++++++++-------------------------
 1 file changed, 48 insertions(+), 41 deletions(-)

diff --git a/README.md b/README.md
index 7d512af..bde3fdf 100644
--- a/README.md
+++ b/README.md
@@ -20,9 +20,11 @@ Or install it yourself as:
 
 In your api file (somewhere on the top)
 
-    require 'grape_logging'
-    logger.formatter = GrapeLogging::Formatters::Default.new
-    use GrapeLogging::Middleware::RequestLogger, { logger: logger }
+```ruby
+require 'grape_logging'
+logger.formatter = GrapeLogging::Formatters::Default.new
+use GrapeLogging::Middleware::RequestLogger, { logger: logger }
+```
 
 **ProTip:** If your logger doesn't support setting formatter you can remove this line - it's optional
 
@@ -37,23 +39,25 @@ With the default configuration you will get nice log message
 If you prefer some other format I strongly encourage you to do pull request with new formatter class ;)
 
 You can change the formatter like so
-
-    class MyAPI < Grape::API
-      use GrapeLogging::Middleware::RequestLogger, logger: logger, format: MyFormatter.new
-    end
+```ruby
+class MyAPI < Grape::API
+  use GrapeLogging::Middleware::RequestLogger, logger: logger, format: MyFormatter.new
+end
+```
 
 ### Customising What Is Logged
 
 You can include logging of other parts of the request / response cycle by including subclasses of `GrapeLogging::Loggers::Base`
-
-    class MyAPI < Grape::API
-      use GrapeLogging::Middleware::RequestLogger,
-        logger: logger,
-        include: [ GrapeLogging::Loggers::Response.new,
-                   GrapeLogging::Loggers::FilterParameters.new,
-                   GrapeLogging::Loggers::ClientEnv.new,
-                   GrapeLogging::Loggers::RequestHeaders.new ]
-    end
+```ruby
+class MyAPI < Grape::API
+  use GrapeLogging::Middleware::RequestLogger,
+    logger: logger,
+    include: [ GrapeLogging::Loggers::Response.new,
+               GrapeLogging::Loggers::FilterParameters.new,
+               GrapeLogging::Loggers::ClientEnv.new,
+               GrapeLogging::Loggers::RequestHeaders.new ]
+end
+```
 
 #### FilterParameters
 The `FilterParameters` logger will filter out sensitive parameters from your logs. If mounted inside rails, will use the `Rails.application.config.filter_parameters` by default. Otherwise, you must specify a list of keys to filter out.
@@ -67,45 +71,48 @@ The `RequestHeaders` logger will add `request headers` in your log.
 ### Logging to file and STDOUT
 
 You can log to file and STDOUT at the same time, you just need to assign new logger
-
-    log_file = File.open('path/to/your/logfile.log', 'a')
-    log_file.sync = true
-    logger Logger.new GrapeLogging::MultiIO.new(STDOUT, log_file)
+```ruby
+log_file = File.open('path/to/your/logfile.log', 'a')
+log_file.sync = true
+logger Logger.new GrapeLogging::MultiIO.new(STDOUT, log_file)
+```
 
 ### Logging via Rails instrumentation
 
 You can choose to not pass the logger to ```grape_logging``` but instead send logs to Rails instrumentation in order to let Rails and its configured Logger do the log job, for example.
 First, config ```grape_logging```, like that:
-
-    class MyAPI < Grape::API
-      use GrapeLogging::Middleware::RequestLogger,
-        instrumentation_key: 'grape_key',
-        include: [ GrapeLogging::Loggers::Response.new,
-                   GrapeLogging::Loggers::FilterParameters.new ]
-    end
+```ruby
+class MyAPI < Grape::API
+  use GrapeLogging::Middleware::RequestLogger,
+    instrumentation_key: 'grape_key',
+    include: [ GrapeLogging::Loggers::Response.new,
+               GrapeLogging::Loggers::FilterParameters.new ]
+end
+```
 
 and then add an initializer in your Rails project:
+```ruby
+# config/initializers/instrumentation.rb
 
-    # config/initializers/instrumentation.rb
-
-    # Subscribe to grape request and log with Rails.logger
-    ActiveSupport::Notifications.subscribe('grape_key') do |name, starts, ends, notification_id, payload|
-      Rails.logger.info payload
-    end
+# Subscribe to grape request and log with Rails.logger
+ActiveSupport::Notifications.subscribe('grape_key') do |name, starts, ends, notification_id, payload|
+  Rails.logger.info payload
+end
+```
 
 The idea come from here: https://gist.github.com/teamon/e8ae16ffb0cb447e5b49
 
 ### Logging exceptions
 
 If you want to log exceptions you can do it like this
-
-    class MyAPI < Grape::API
-      rescue_from :all do |e|
-        MyAPI.logger.error e
-        #do here whatever you originally planned to do :)
-      end
-    end
-
+```ruby
+class MyAPI < Grape::API
+  rescue_from :all do |e|
+    MyAPI.logger.error e
+    #do here whatever you originally planned to do :)
+  end
+end
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.