Allow toggling live logging for pipelines

Signed-off-by: Keshav Priyadarshi <git@keshav.space>

Author: keshav-space

vulnerabilities/migrations/0094_pipelineschedule_live_logging.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.2.20 on 2025-05-24 16:10
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("vulnerabilities", "0093_pipelineschedule_execution_timeout"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="pipelineschedule",
+            name="live_logging",
+            field=models.BooleanField(
+                db_index=True,
+                default=False,
+                help_text="When enabled logs will be streamed live during pipeline execution. For legacy importers and improvers, logs are always made available only after execution completes.",
+            ),
+        ),
+    ]

vulnerabilities/models.py

@@ -2129,6 +2129,16 @@ class PipelineSchedule(models.Model):
         ),
     )
 
+    live_logging = models.BooleanField(
+        null=False,
+        db_index=True,
+        default=False,
+        help_text=(
+            "When enabled logs will be streamed live during pipeline execution. "
+            "For legacy importers and improvers, logs are always made available only after execution completes."
+        ),
+    )
+
     run_interval = models.PositiveSmallIntegerField(
         validators=[
             MinValueValidator(1, message="Interval must be at least 1 day."),

vulnerabilities/pipelines/__init__.py

@@ -58,10 +58,15 @@ def __init__(
         self.current_step = ""
 
     def append_to_log(self, message):
-        if self.run:
+        if self.run and self.run.pipeline.live_logging:
             self.run.append_to_log(message)
         self.execution_log.append(message)
 
+    def update_final_run_log(self):
+        if self.run and not self.run.pipeline.live_logging:
+            final_log = "\n".join(self.execution_log)
+            self.run.append_to_log(final_log, is_multiline=True)
+
     def set_current_step(self, message):
         self.current_step = message
 
@@ -106,6 +111,7 @@ def execute(self):
                 self.on_failure()
                 on_failure_run_time = timer() - on_failure_start_time
                 self.log(f"Completed [on_failure] tasks in {humanize_time(on_failure_run_time)}")
+                self.update_final_run_log()
 
                 return 1, self.output_from_exception(exception)
 
@@ -115,6 +121,7 @@ def execute(self):
         self.set_current_step("")  # Reset the `current_step` field on completion
         pipeline_run_time = timer() - pipeline_start_time
         self.log(f"Pipeline completed in {humanize_time(pipeline_run_time)}")
+        self.update_final_run_log()
 
         return 0, ""
 

vulnerabilities/templates/pipeline_run_details.html

@@ -112,6 +112,16 @@ <h1 class="title">{{ pipeline_name }} Run Log</h1>
             </div>
         </div>
 
+        {% if not run.run_end_date and not run.pipeline.live_logging %}
+            <div class="notification is-info is-light has-text-centered">
+                <p class="is-size-6 has-text-grey-dark">
+                    <i class="fa fa-exclamation-triangle mr-1"></i>
+                    Live logging is disabled for this pipeline.
+                    Logs will be available after the pipeline has finished running.
+                </p>
+            </div>
+        {% endif %}
+
         {% if run.run_output|strip %}
         <div class="box">
             <h2 class="subtitle mb-2">Run Error</h2>