Merge pull request #11 from onetimesecret/feature/instance-specific-syslog-tags

Add instance-specific syslog tags and journalctl hints

Author: delano

src/ots_containers/commands/instance/_helpers.py

@@ -19,6 +19,27 @@ def format_command(cmd: Sequence[str]) -> str:
     return " ".join(shlex.quote(arg) for arg in cmd)
 
 
+def format_journalctl_hint(instances: dict[InstanceType, list[str]]) -> str:
+    """Generate a journalctl command to view logs for the given instances.
+
+    Args:
+        instances: Dict mapping InstanceType to list of identifiers
+
+    Returns:
+        A journalctl command string with -t flags for each instance.
+    """
+    tags = []
+    for itype, ids in instances.items():
+        for id_ in ids:
+            tags.append(f"onetime-{itype.value}-{id_}")
+
+    if not tags:
+        return ""
+
+    tag_args = " ".join(f"-t {shlex.quote(tag)}" for tag in tags)
+    return f"journalctl {tag_args} -f"
+
+
 def resolve_identifiers(
     identifiers: tuple[str, ...],
     instance_type: InstanceType | None,
@@ -96,6 +117,8 @@ def for_each_instance(
     delay: int,
     action: Callable[[InstanceType, str], None],
     verb: str,
+    *,
+    show_logs_hint: bool = False,
 ) -> int:
     """Run action for each instance with delay between.
 
@@ -104,6 +127,7 @@ def for_each_instance(
         delay: Seconds to wait between operations
         action: Callable taking (instance_type, identifier)
         verb: Present participle for logging (e.g., "Restarting")
+        show_logs_hint: If True, print journalctl command to view logs
 
     Returns:
         Total number of instances processed.
@@ -128,4 +152,10 @@ def for_each_instance(
             time.sleep(delay)
 
     print(f"Processed {total} instance(s)")
+
+    if show_logs_hint:
+        hint = format_journalctl_hint(instances)
+        if hint:
+            print(f"\nView logs: {hint}")
+
     return total

src/ots_containers/commands/instance/app.py

@@ -13,6 +13,7 @@
 from ._helpers import (
     for_each_instance,
     format_command,
+    format_journalctl_hint,
     resolve_identifiers,
 )
 from .annotations import (
@@ -393,7 +394,7 @@ def do_deploy(inst_type: InstanceType, id_: str) -> None:
             raise
 
     instances = {itype: list(identifiers)}
-    for_each_instance(instances, delay, do_deploy, "Deploying")
+    for_each_instance(instances, delay, do_deploy, "Deploying", show_logs_hint=True)
 
 
 @app.command
@@ -505,7 +506,7 @@ def do_redeploy(inst_type: InstanceType, id_: str) -> None:
             raise
 
     verb = "Force redeploying" if force else "Redeploying"
-    for_each_instance(instances, delay, do_redeploy, verb)
+    for_each_instance(instances, delay, do_redeploy, verb, show_logs_hint=True)
 
 
 @app.command
@@ -616,6 +617,10 @@ def start(
             systemd.start(unit)
             print(f"Started {unit}")
 
+    hint = format_journalctl_hint(instances)
+    if hint:
+        print(f"\nView logs: {hint}")
+
 
 @app.command
 def stop(
@@ -682,6 +687,10 @@ def restart(
             systemd.restart(unit)
             print(f"Restarted {unit}")
 
+    hint = format_journalctl_hint(instances)
+    if hint:
+        print(f"\nView logs: {hint}")
+
 
 @app.command
 def enable(

src/ots_containers/quadlet.py

@@ -64,8 +64,8 @@
 Image={image}
 Network=host
 
-# Syslog tag for unified log filtering: journalctl -t onetime -f
-PodmanArgs=--log-opt tag=onetime
+# Syslog tag for per-instance log filtering: journalctl -t onetime-web-7043 -f
+PodmanArgs=--log-opt tag=onetime-web-%i
 
 # Port is derived from instance name: onetime-web@7043 -> PORT=7043
 Environment=PORT=%i
@@ -191,8 +191,8 @@ def write_web_template(cfg: Config, env_file_path: Path | None = None) -> None:
 Image={image}
 Network=host
 
-# Syslog tag for unified log filtering: journalctl -t onetime -f
-PodmanArgs=--log-opt tag=onetime
+# Syslog tag for per-instance log filtering: journalctl -t onetime-worker-1 -f
+PodmanArgs=--log-opt tag=onetime-worker-%i
 
 # Worker ID is derived from instance name: onetime-worker@1 -> WORKER_ID=1
 Environment=WORKER_ID=%i
@@ -293,8 +293,8 @@ def write_worker_template(cfg: Config, env_file_path: Path | None = None) -> Non
 Image={image}
 Network=host
 
-# Syslog tag for unified log filtering: journalctl -t onetime -f
-PodmanArgs=--log-opt tag=onetime
+# Syslog tag for per-instance log filtering: journalctl -t onetime-scheduler-main -f
+PodmanArgs=--log-opt tag=onetime-scheduler-%i
 
 # Scheduler ID is derived from instance name: onetime-scheduler@main -> SCHEDULER_ID=main
 Environment=SCHEDULER_ID=%i

tests/commands/instance/test_helpers.py

@@ -6,11 +6,52 @@
 from ots_containers.commands.instance._helpers import (
     for_each_instance,
     format_command,
+    format_journalctl_hint,
     resolve_identifiers,
 )
 from ots_containers.commands.instance.annotations import InstanceType
 
 
+class TestFormatJournalctlHint:
+    """Test format_journalctl_hint helper."""
+
+    def test_single_web_instance(self):
+        """Should generate journalctl command for single web instance."""
+        instances = {InstanceType.WEB: ["7043"]}
+        result = format_journalctl_hint(instances)
+        assert result == "journalctl -t onetime-web-7043 -f"
+
+    def test_multiple_web_instances(self):
+        """Should generate journalctl command for multiple web instances."""
+        instances = {InstanceType.WEB: ["7043", "7044"]}
+        result = format_journalctl_hint(instances)
+        assert result == "journalctl -t onetime-web-7043 -t onetime-web-7044 -f"
+
+    def test_mixed_instance_types(self):
+        """Should generate journalctl command for mixed instance types."""
+        instances = {
+            InstanceType.WEB: ["7043"],
+            InstanceType.WORKER: ["billing"],
+            InstanceType.SCHEDULER: ["main"],
+        }
+        result = format_journalctl_hint(instances)
+        assert "-t onetime-web-7043" in result
+        assert "-t onetime-worker-billing" in result
+        assert "-t onetime-scheduler-main" in result
+        assert result.endswith(" -f")
+
+    def test_empty_instances(self):
+        """Should return empty string for empty instances."""
+        result = format_journalctl_hint({})
+        assert result == ""
+
+    def test_worker_instance(self):
+        """Should generate journalctl command for worker instance."""
+        instances = {InstanceType.WORKER: ["1"]}
+        result = format_journalctl_hint(instances)
+        assert result == "journalctl -t onetime-worker-1 -f"
+
+
 class TestFormatCommand:
     """Test format_command helper."""
 

tests/test_quadlet.py

@@ -102,8 +102,8 @@ def test_write_web_template_includes_syslog_tag(self, mocker, tmp_path):
         quadlet.write_web_template(cfg)
 
         content = cfg.web_template_path.read_text()
-        # Syslog tag allows: journalctl -t onetime -f
-        assert "PodmanArgs=--log-opt tag=onetime" in content
+        # Syslog tag allows: journalctl -t onetime-web-7043 -f
+        assert "PodmanArgs=--log-opt tag=onetime-web-%i" in content
 
     def test_write_web_template_includes_volumes(self, mocker, tmp_path):
         """Container quadlet should mount config directory and static assets."""
@@ -305,8 +305,8 @@ def test_write_worker_template_includes_syslog_tag(self, mocker, tmp_path):
         quadlet.write_worker_template(cfg)
 
         content = cfg.worker_template_path.read_text()
-        # Syslog tag allows: journalctl -t onetime -f
-        assert "PodmanArgs=--log-opt tag=onetime" in content
+        # Syslog tag allows: journalctl -t onetime-worker-1 -f
+        assert "PodmanArgs=--log-opt tag=onetime-worker-%i" in content
 
     def test_write_worker_template_sets_worker_id_env_var(self, mocker, tmp_path):
         """Worker quadlet should set WORKER_ID env var from instance."""
@@ -530,7 +530,8 @@ def test_write_scheduler_template_includes_syslog_tag(self, mocker, tmp_path):
         quadlet.write_scheduler_template(cfg)
 
         content = cfg.scheduler_template_path.read_text()
-        assert "PodmanArgs=--log-opt tag=onetime" in content
+        # Syslog tag allows: journalctl -t onetime-scheduler-main -f
+        assert "PodmanArgs=--log-opt tag=onetime-scheduler-%i" in content
 
     def test_write_scheduler_template_sets_scheduler_id_env_var(self, mocker, tmp_path):
         """Scheduler quadlet should set SCHEDULER_ID env var from instance."""