Archive runtime reports via QuantPlatformKit

Author: Pigbibi

.github/workflows/sync-cloud-run-env.yml

@@ -31,6 +31,7 @@ jobs:
       ACCOUNT_REGION: ${{ vars.ACCOUNT_REGION || 'HK' }}
       LONGPORT_SECRET_NAME: ${{ vars.LONGPORT_SECRET_NAME }}
       NOTIFY_LANG: ${{ vars.NOTIFY_LANG }}
+      EXECUTION_REPORT_GCS_URI: ${{ vars.EXECUTION_REPORT_GCS_URI }}
       GLOBAL_TELEGRAM_CHAT_ID: ${{ vars.GLOBAL_TELEGRAM_CHAT_ID }}
       TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
     steps:
@@ -134,6 +135,12 @@ jobs:
           secret_pairs+=("LONGPORT_APP_SECRET=${LONGPORT_APP_SECRET_SECRET_NAME}:latest")
           remove_env_vars+=("LONGPORT_APP_SECRET")
 
+          if [ -n "${EXECUTION_REPORT_GCS_URI:-}" ]; then
+            env_pairs+=("EXECUTION_REPORT_GCS_URI=${EXECUTION_REPORT_GCS_URI}")
+          else
+            remove_env_vars+=("EXECUTION_REPORT_GCS_URI")
+          fi
+
           gcloud_args=(
             run services update "${CLOUD_RUN_SERVICE}"
             --region "${CLOUD_RUN_REGION}"
@@ -172,6 +179,7 @@ jobs:
       ACCOUNT_REGION: ${{ vars.ACCOUNT_REGION || 'SG' }}
       LONGPORT_SECRET_NAME: ${{ vars.LONGPORT_SECRET_NAME }}
       NOTIFY_LANG: ${{ vars.NOTIFY_LANG }}
+      EXECUTION_REPORT_GCS_URI: ${{ vars.EXECUTION_REPORT_GCS_URI }}
       GLOBAL_TELEGRAM_CHAT_ID: ${{ vars.GLOBAL_TELEGRAM_CHAT_ID }}
       TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
     steps:
@@ -275,6 +283,12 @@ jobs:
           secret_pairs+=("LONGPORT_APP_SECRET=${LONGPORT_APP_SECRET_SECRET_NAME}:latest")
           remove_env_vars+=("LONGPORT_APP_SECRET")
 
+          if [ -n "${EXECUTION_REPORT_GCS_URI:-}" ]; then
+            env_pairs+=("EXECUTION_REPORT_GCS_URI=${EXECUTION_REPORT_GCS_URI}")
+          else
+            remove_env_vars+=("EXECUTION_REPORT_GCS_URI")
+          fi
+
           gcloud_args=(
             run services update "${CLOUD_RUN_SERVICE}"
             --region "${CLOUD_RUN_REGION}"

main.py

@@ -6,7 +6,7 @@
 import os
 import time
 import traceback
-from datetime import datetime
+from datetime import datetime, timezone
 
 from flask import Flask
 
@@ -29,6 +29,12 @@
     build_sender,
     build_translator,
 )
+from quant_platform_kit.common.runtime_reports import (
+    append_runtime_report_error,
+    build_runtime_report_base,
+    finalize_runtime_report,
+    persist_runtime_report,
+)
 from runtime_logging import RuntimeLogContext, build_run_id, emit_runtime_log
 from quant_platform_kit.longbridge import (
     build_contexts,
@@ -114,6 +120,35 @@ def log_runtime_event(log_context, event, **fields):
     )
 
 
+def build_execution_report(log_context):
+    return build_runtime_report_base(
+        platform=log_context.platform,
+        deploy_target=log_context.deploy_target,
+        service_name=log_context.service_name,
+        strategy_profile=STRATEGY_PROFILE,
+        strategy_domain=RUNTIME_SETTINGS.strategy_domain,
+        account_scope=log_context.account_scope,
+        account_region=log_context.account_region,
+        run_id=log_context.run_id,
+        run_source="cloud_run",
+        started_at=datetime.now(timezone.utc),
+        summary={
+            "managed_symbols": list(MANAGED_SYMBOLS),
+            "account_prefix": ACCOUNT_PREFIX,
+        },
+    )
+
+
+def persist_execution_report(report):
+    persisted = persist_runtime_report(
+        report,
+        base_dir=os.getenv("EXECUTION_REPORT_OUTPUT_DIR"),
+        gcs_prefix_uri=os.getenv("EXECUTION_REPORT_GCS_URI"),
+        gcp_project_id=PROJECT_ID,
+    )
+    return persisted.gcs_uri or persisted.local_path
+
+
 def is_filled_status(status):
     return notifications_is_filled_status(status)
 
@@ -228,6 +263,7 @@ def resolve_rebalance_plan(*, indicators, account_state):
 
 def run_strategy():
     log_context = RUNTIME_LOG_CONTEXT.with_run(build_run_id())
+    report = build_execution_report(log_context)
     try:
         log_runtime_event(
             log_context,
@@ -253,6 +289,13 @@ def run_strategy():
                 "outside_market_hours",
                 message="Outside market hours; skip execution",
             )
+            finalize_runtime_report(
+                report,
+                status="skipped",
+                diagnostics={
+                    "skip_reason": "market_closed",
+                },
+            )
             print(with_prefix("Outside market hours; skip."), flush=True)
             return
         run_rebalance_cycle(
@@ -276,13 +319,21 @@ def run_strategy():
             estimate_max_purchase_quantity=estimate_max_purchase_quantity,
             submit_order_with_alert=submit_order_with_alert,
         )
+        finalize_runtime_report(report, status="ok")
         log_runtime_event(
             log_context,
             "strategy_cycle_completed",
             message="Strategy execution completed",
         )
 
     except Exception as exc:
+        append_runtime_report_error(
+            report,
+            stage="strategy_cycle",
+            message=str(exc),
+            error_type=type(exc).__name__,
+        )
+        finalize_runtime_report(report, status="error")
         log_runtime_event(
             log_context,
             "strategy_cycle_failed",
@@ -294,6 +345,12 @@ def run_strategy():
         err = traceback.format_exc()
         print(with_prefix(f"Strategy error:\n{err}"), flush=True)
         send_tg_message(f"{t('error_title')}\n{err}")
+    finally:
+        try:
+            report_path = persist_execution_report(report)
+            print(f"execution_report {report_path}", flush=True)
+        except Exception as persist_exc:
+            print(f"failed to persist execution report: {persist_exc}", flush=True)
 
 @app.route("/", methods=["POST", "GET"])
 def handle_trigger():

requirements.txt

@@ -1,12 +1,13 @@
 flask
 gunicorn
-quant-platform-kit @ git+https://github.com/QuantStrategyLab/QuantPlatformKit.git@v0.7.0
+quant-platform-kit @ git+https://github.com/QuantStrategyLab/QuantPlatformKit.git@v0.7.1
 us-equity-strategies @ git+https://github.com/QuantStrategyLab/UsEquityStrategies.git@v0.7.0
 pandas
 requests
 pytz
 pandas_market_calendars
 google-cloud-secret-manager
+google-cloud-storage
 
 google-auth
 longport

tests/test_request_handling.py

@@ -52,6 +52,20 @@ def run(self, *args, **kwargs):
     cloud_run_module = types.ModuleType("entrypoints.cloud_run")
     cloud_run_module.is_market_open_now = lambda: True
 
+    runtime_config_support_module = types.ModuleType("runtime_config_support")
+    runtime_config_support_module.load_platform_runtime_settings = lambda **_kwargs: types.SimpleNamespace(
+        project_id=None,
+        secret_name="longport_token_hk",
+        account_prefix="HK",
+        service_name="longbridge-quant-semiconductor-rotation-income-hk",
+        strategy_profile="semiconductor_rotation_income",
+        strategy_domain="us_equity",
+        account_region="HK",
+        notify_lang="en",
+        tg_token=None,
+        tg_chat_id="shared-chat-id",
+    )
+
     qpk_longbridge_module = types.ModuleType("quant_platform_kit.longbridge")
     qpk_longbridge_module.build_contexts = lambda *args, **kwargs: ("quote-context", "trade-context")
     qpk_longbridge_module.calculate_rotation_indicators = lambda *args, **kwargs: {}
@@ -105,6 +119,7 @@ def run(self, *args, **kwargs):
         "flask": flask_module,
         "requests": requests_module,
         "entrypoints.cloud_run": cloud_run_module,
+        "runtime_config_support": runtime_config_support_module,
         "quant_platform_kit.longbridge": qpk_longbridge_module,
         "google": google_module,
         "google.auth": google_auth_module,
@@ -191,6 +206,29 @@ def test_run_strategy_emits_structured_runtime_events(self):
         )
         self.assertTrue(all(run_id == "run-001" for run_id, _event, _fields in observed))
 
+    def test_run_strategy_persists_machine_readable_report(self):
+        module = load_module()
+        observed_reports = []
+
+        module.build_run_id = lambda: "run-001"
+        module.emit_runtime_log = lambda *args, **kwargs: None
+        module.is_market_open_now = lambda: True
+        module.run_rebalance_cycle = lambda **_kwargs: None
+        module.persist_execution_report = (
+            lambda report: observed_reports.append(dict(report)) or "/tmp/runtime-report.json"
+        )
+
+        module.run_strategy()
+
+        self.assertEqual(len(observed_reports), 1)
+        report = observed_reports[0]
+        self.assertEqual(report["platform"], "longbridge")
+        self.assertEqual(report["run_source"], "cloud_run")
+        self.assertEqual(report["status"], "ok")
+        self.assertEqual(report["strategy_profile"], module.STRATEGY_PROFILE)
+        self.assertEqual(report["account_scope"], module.ACCOUNT_REGION)
+        self.assertEqual(report["summary"]["managed_symbols"], list(module.MANAGED_SYMBOLS))
+
 
 if __name__ == "__main__":
     unittest.main()