The latest articles on DEV Community by nishikawa1031 (@nishikawa1031). https://dev.to/nishikawa1031 https://media2.dev.to/dynamic/image/width=90,height=90,fit=cover,gravity=auto,format=auto/https:%2F%2Fdev-to-uploads.s3.amazonaws.com%2Fuploads%2Fuser%2Fprofile_image%2F1165900%2F643c63de-4492-4310-b84b-2867fc19fe50.jpeg https://dev.to/nishikawa1031 en nishikawa1031 Wed, 20 Sep 2023 10:01:53 +0000 https://dev.to/nishikawa1031/a-new-gem-that-eliminates-the-hassle-of-launching-the-rails-app-every-time-just-to-check-the-logs-1pp8 https://dev.to/nishikawa1031/a-new-gem-that-eliminates-the-hassle-of-launching-the-rails-app-every-time-just-to-check-the-logs-1pp8 <h2> Introduction </h2> <p>During Rails development, I found that the wait time to start the Rails server was surprisingly stressful. On the other hand, the logs output to <code>development.log</code> were often overwhelming...</p> <p>So, I created a gem that divides and outputs the logs by each controller's action in separate folders, allowing for easier management of logs during each request.</p> <p><a href="https://rubygems.org/gems/custom_log_space">custom_log_space | RubyGems.org | Community Gem Hosting Service</a></p> <h2> Installation </h2> <p>Add <code>gem 'custom_log_space'</code> to your Gemfile as shown below and run <code>bundle install</code>.<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight diff"><code><span class="p">group :development do </span> + gem 'custom_log_space' <span class="p">end </span></code></pre> </div> <h2> Usage </h2> <p>Launch your Rails app locally. When you access a page, logs will be generated in the <code>log/custom_log_space</code> directory, following the naming convention below.<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight plaintext"><code>log/custom_log_space/#{controller_name}/#{action_name}/#{date}/#{time}.log </code></pre> </div> <p>Example:<br> </p> <div class="highlight js-code-highlight"> <pre class="highlight plaintext"><code>user log % tree . ├── custom_log_space │   └── articles_controller │   ├── index │   │   ├── 2023-09-19 │   │   │   ├── 09:13.log │   │   │   └── 20:00.log │   │   └── saved │   └── show │   ├── 2023-09-18 │   │   ├── 21:29.log │   │   └── 22:02.log │   ├── 2023-09-19 │   │   └── 20:00.log │   └── saved └── development.log </code></pre> </div> <h2> Log Retention Policy </h2> <ul> <li>The maximum number of <code>#{date}</code> folders retained is two, and for <code>#{time}.log</code>, up to 10 files. Once these limits are exceeded, older files will be deleted sequentially.</li> <li>Please move important logs to the saved directory. <code>log/custom_log_space/#{controller_name}/#{action_name}/saved/</code> </li> </ul> <h2> Caveats </h2> <ul> <li>If a single request triggers multiple controller actions, logs will be organized into separate folders for each action. Therefore, caution is needed when tracing the logs.</li> <li>However, even after introducing this gem, the output to the existing <code>development.log</code> remains unchanged. You can continue to refer to it as needed.</li> </ul> programming rails gem ruby