feat: /usr/bin/script wrapper to send full tty output to sentry

devenv/main.py

@@ -2,6 +2,8 @@
 
 import argparse
 import os
+import subprocess
+import sys
 from collections.abc import Sequence
 
 from devenv import bootstrap
@@ -75,17 +77,62 @@ def devenv(argv: Sequence[str], config_path: str) -> ExitCode:
 
 
 def main() -> ExitCode:
-    import sys
+    # this is also used to see if we're the child process
+    script_logfile = os.environ.get("SCRIPT")
+
+    if script_logfile:
+        return devenv(sys.argv, f"{home}/.config/sentry-devenv/config.ini")
+
+    import tempfile
+
+    _, fp = tempfile.mkstemp()
+    # script (macos/linux) runs the subcommand with a tty, and tees the output to a file.
+    # this way we can very easily capture all output from devenv and send it
+    # to sentry as an attachment if an error occurs.
+    cmd = ("/usr/bin/script", "-qe", fp, *sys.argv)
+
+    # the reason we're subprocessing instead of os.execv(cmd[0], cmd)
+    # is that script must exit (so that the complete log file is committed to disk)
+    # before sentry sends the event...
+    rc = subprocess.call(cmd)
+
+    if rc == 0:
+        return rc
+
+    # i'd love to be able to send a full event in the child then
+    # upload the attachment to that event id in the parent, but unfortunately there's
+    # no easy way to add an attachment to an existing event,
+    # so we have to give up getting a python stacktrace,
+    # and can only use sentry-sdk to send an attachment.
     import sentry_sdk
+    from sentry_sdk.scope import Scope
+    import getpass
 
     sentry_sdk.init(
         # https://sentry.sentry.io/settings/projects/sentry-dev-env/keys/
         dsn="https://[email protected]/5723503",
-        # enable performance monitoring
-        enable_tracing=True,
+        # disable performance monitoring
+        enable_tracing=False,
     )
 
-    return devenv(sys.argv, f"{home}/.config/sentry-devenv/config.ini")
+    scope = Scope.get_current_scope()
+
+    # would really like to be able to set filename to the python exception title
+    # because seeing KeyboardInterrupt vs CalledProcessError is more helpful than
+    # "tmp29387ldf", but see above comment
+    scope.add_attachment(path=fp)
+
+    client = Scope.get_client()
+
+    user = getpass.getuser()
+    computer = client.options.get("server_name", "unknown")
+
+    # events are grouped under user@computer
+    scope.fingerprint = [f"{user}@{computer}"]
+
+    sentry_sdk.capture_message(f"{user}@{computer}")
+
+    return rc
 
 
 if __name__ == "__main__":