Cleanup lograge config (#367)

* Update SUMMARY.md * Update SUMMARY.md * Delete config file * Update README.md * Fix link * Wrap lograge config in conditional
renuo · May 26, 2024 · 05b1003 · 05b1003
1 parent 7b02653
commit 05b1003
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 25 deletions.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -50,7 +50,7 @@
       - [Bootstrap](ruby_on_rails/bootstrap.md)
       - [FontAwesome](ruby_on_rails/font_awesome.md)
       - [Bullet](ruby_on_rails/bullet.md)
-      - [Lograge](ruby_on_rails/lograge.md)
+      - [Lograge](ruby_on_rails/appsignal.md)
       - [Hotjar](ruby_on_rails/hotjar.md)
       - [Wicked PDF](ruby_on_rails/wicked_pdf.md)
       - [Recaptcha v3](ruby_on_rails/recaptcha.md)

diff --git a/ruby_on_rails/README.md b/ruby_on_rails/README.md
@@ -60,7 +60,7 @@ useful services:
 1. [bootstrap](bootstrap.md)
 1. [font-awesome](font_awesome.md)
 1. [bullet](bullet.md) `gem 'bullet'`
-1. [lograge](lograge.md) `gem 'lograge'`
+1. [lograge](appsignal.md) `gem 'lograge'`
 1. Rack Tracker (Google Analytics) `gem 'rack-tracker'` --> see [Google Analytics](../google_analytics.md)
 1. [Typescript](https://github.com/typescript-ruby/typescript-rails)
 1. Favicons

diff --git a/ruby_on_rails/appsignal.md b/ruby_on_rails/appsignal.md
@@ -89,7 +89,7 @@ end
 
 ### Lograge
 
-We use [lograge](lograge.md) in many projects. Here is how to configure
+We use [lograge](https://github.com/roidrage/lograge) in many projects. Here is how to configure
 it with AppSignal to get properly tagged logs.
 
 Using this configuration we get the fully tagged lograge lines and also
@@ -100,17 +100,19 @@ us to filter by request id with one click and get all relevant log data at once.
 
 ```ruby
 # config/initializers/lograge.rb
-Rails.application.configure do
-  config.lograge.enabled = true
-  config.lograge.keep_original_rails_log = true
-  config.lograge.logger = Appsignal::Logger.new(
-    "rails",
-    format: Appsignal::Logger::LOGFMT
-  )
-  config.lograge.custom_payload do |controller|
-    {
-      request_id: controller.request.request_id
-    }
+if ENV['LOGRAGE_ENABLED'] == 'true'
+  Rails.application.configure do
+    config.lograge.enabled = true
+    config.lograge.keep_original_rails_log = true
+    config.lograge.logger = Appsignal::Logger.new(
+      "rails",
+      format: Appsignal::Logger::LOGFMT
+    )
+    config.lograge.custom_payload do |controller|
+      {
+        request_id: controller.request.request_id
+      }
+    end
   end
 end
 ```

diff --git a/ruby_on_rails/lograge.md b/ruby_on_rails/lograge.md