don't enable logstruct JSON logging by default for rake or rails console

Author: ndbroadbent

README.md

@@ -6,7 +6,7 @@ We support all your other favorite gems too, like Sidekiq, Sentry, and Shrine. (
 
 ## Features
 
-- JSON logging enabled by default in production and test environments
+- JSON logging enabled by default for server processes in production and test environments (automatically disabled for console and Rake tasks)
 - ActionMailer integration for email delivery logging
 - ActiveJob integration for job execution logging
 - Sidekiq integration for background job logging
@@ -58,11 +58,13 @@ Once initialized (and enabled), the gem automatically includes its modules into
 - Rails `config.filter_parameters` are merged into LogStruct's filters and then cleared (to avoid double filtering). Configure sensitive keys via `LogStruct.config.filters`.
 - When `RAILS_LOG_TO_STDOUT` is set, we log to STDOUT only. Otherwise, we log to STDOUT by default without adding a file appender to avoid duplicate logs.
 
-### Development behavior
+### Default behavior by process type
 
-- Disabled by default in development. Enable explicitly via `LOGSTRUCT_ENABLED=true` or `LogStruct.configure { |c| c.enabled = true }`.
-- When enabled in development, LogStruct now defaults to production‑style JSON output so you can preview exactly what will be shipped in prod.
-- You can opt back into the colorful human formatter with:
+- **Server processes** (`rails server`): JSON logging is enabled by default in production and test environments
+- **Console and Rake tasks** (`rails console`, `rake`, etc.): JSON logging is disabled by default in all environments, providing human-readable logs instead
+- **Development environment**: Disabled by default for all process types. Enable explicitly via `LOGSTRUCT_ENABLED=true` or `LogStruct.configure { |c| c.enabled = true }`.
+
+When enabled in development, LogStruct defaults to production‑style JSON output so you can preview exactly what will be shipped in prod. You can opt back into the colorful human formatter with:
 
 ```ruby
 LogStruct.configure do |c|
@@ -71,6 +73,8 @@ LogStruct.configure do |c|
 end
 ```
 
+To force JSON logs in console or Rake tasks (e.g., for debugging), set `LOGSTRUCT_ENABLED=true` in your environment.
+
 ## Documentation
 
 Please see the [documentation](https://logstruct.com/docs) for more details. (All code examples are type-checked and tested, and it's harder to keep a README up to date.)

docs/app/docs/configuration/page.tsx

@@ -58,7 +58,10 @@ export default function ConfigurationPage() {
           </strong>{' '}
           is undefined, LogStruct will be <strong>enabled</strong> if the
           current Rails environment is listed in{' '}
-          <code>config.enabled_environments</code>.
+          <code>config.enabled_environments</code> <strong>AND</strong> the
+          process is a server process (not console or Rake tasks). This ensures
+          humans using <code>rails console</code> or <code>rake</code> tasks get
+          human-readable logs, while server processes get JSON logs.
         </li>
         <li>
           Finally, you can manually set <code>config.enabled</code> in an
@@ -118,6 +121,14 @@ end`}
         <code>config.enabled_environments</code>.
       </Callout>
 
+      <Callout type="info">
+        To force JSON logs in console or Rake tasks (e.g., for debugging or
+        inspecting the exact JSON output), set{' '}
+        <code>LOGSTRUCT_ENABLED=true</code> when running the command:
+        <br />
+        <code>LOGSTRUCT_ENABLED=true rails console</code>
+      </Callout>
+
       <HeadingWithAnchor id="integration-configuration">
         Integration Configuration
       </HeadingWithAnchor>

docs/app/docs/getting-started/page.tsx

@@ -29,7 +29,7 @@ export default function GettingStartedPage() {
       <CodeBlock language="bash">bundle install</CodeBlock>
 
       <p className="text-neutral-600 dark:text-neutral-400 mt-6">
-        {`LogStruct is now installed and will automatically enable JSON structured logging in the test and production environments.`}
+        {`LogStruct is now installed and will automatically enable JSON structured logging for server processes in the test and production environments. Console and Rake tasks will use human-readable logs by default.`}
       </p>
 
       <HeadingWithAnchor id="basic-configuration" level={2}>

docs/app/docs/page.tsx

@@ -22,7 +22,8 @@ export default function DocsPage() {
       </HeadingWithAnchor>
       <ul className="list-disc list-inside space-y-2 text-neutral-600 dark:text-neutral-400">
         <li>
-          JSON logging enabled by default in production and test environments.
+          JSON logging enabled by default for server processes in production and
+          test environments (automatically disabled for console and Rake tasks).
         </li>
         <li>
           Sets up <a href="https://github.com/roidrage/lograge">Lograge</a> for

lib/log_struct/concerns/configuration.rb

@@ -45,14 +45,16 @@ def set_enabled_from_rails_env!
           #    - Sets enabled=true only when value is "true", "yes", "1", etc.
           #    - Sets enabled=false when value is any other value
           # 2. Otherwise, check if current Rails environment is in enabled_environments
+          #    AND Rails::Server is defined (to exclude console and Rake tasks)
           # 3. Otherwise, leave as config.enabled (defaults to true)
 
           # Then check if LOGSTRUCT_ENABLED env var is set
           config.enabled = if ENV["LOGSTRUCT_ENABLED"]
             # Override to true only if env var is "true"
             %w[true t yes y 1].include?(ENV["LOGSTRUCT_ENABLED"]&.strip&.downcase)
           else
-            config.enabled_environments.include?(::Rails.env.to_sym)
+            # Only enable for server processes, not console or Rake tasks
+            config.enabled_environments.include?(::Rails.env.to_sym) && !!defined?(::Rails::Server)
           end
         end