quapp-common 0.0.13.dev8__tar.gz → 0.0.14.dev1__tar.gz

{quapp_common-0.0.13.dev8/quapp_common.egg-info → quapp_common-0.0.14.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: quapp-common
-Version: 0.0.13.dev8
+Version: 0.0.14.dev1
 Summary: Quapp common library supporting Quapp Platform for Quantum Computing
 Author-email: "CITYNOW Co. Ltd. " <corp@citynow.vn>
 License: The MIT License (MIT)
@@ -114,6 +114,140 @@ Notes:
 
 ## Recently Changes Highlights
 
+### v0.0.14.dev1 — Error taxonomy & error envelope (Phase 1)
+
+Tiếp nối Phase 0. Bổ sung phân loại lỗi có ngữ nghĩa và envelope dùng chung cho
+Function Log lẫn Job Log. **Additive**: `job_result` chỉ thêm field `error`,
+`message` và `exception` giữ nguyên; contract callback URL không đổi.
+
+**Taxonomy — hai chiều phân loại độc lập**
+- `enum/error_category.py`: `ErrorCategory` 13 giá trị, nhóm theo *ai xử lý
+  được* (`owner_of()` → USER / WORKSPACE_ADMIN / PROVIDER / PLATFORM).
+- `enum/runtime_phase.py`: `RuntimePhase` 9 giá trị. Tách được
+  `PROVIDER_INVOCATION` / `COMPILATION` / `EXECUTION` — trước đây auth sai,
+  transpile fail và provider từ chối job đều ra chung nhãn `EXECUTION`.
+  `PHASE_TO_STEP` giữ nguyên contract `InvocationStep` của callback URL.
+
+**Classifier (`util/error_classifier.py`)** — tổ hợp 5 tín hiệu theo độ tin cậy:
+1. `phase` — biết chắc từ context manager, không suy đoán;
+2. `frame_owner()` — code của ai, dựa vào đường dẫn frame sâu nhất
+   (`function/` = user, `quapp_*` = platform, `site-packages/` = SDK);
+3. tên class exception, đi hết **cause chain** qua cả `__cause__` *và*
+   `__context__` — cần thiết vì nhiều provider lib bọc lỗi bằng
+   `raise ValueError(...)` trong khối `except` mà không có `from`;
+4. attribute đọc được: HTTP status, AWS error code, exit code, signal;
+5. message pattern (dùng cuối cùng).
+
+`register_rules()` cho phép lib provider đăng ký rule đặc thù SDK khi import,
+nên `qapp-common` không phải import qiskit/braket. Batch đăng ký sau được xét
+trước; trong cùng batch giữ nguyên thứ tự. Rule ném lỗi bị bỏ qua chứ không làm
+hỏng đường báo lỗi. 20 rule generic sẵn có.
+
+Fallback nhiều tầng nên **không bao giờ trả `UNKNOWN` một cách mù**: không rule
+nào khớp thì suy từ frame ownership, rồi tới phase.
+
+**Envelope (`data/response/error_report.py`)** — `job_result['error']` gồm
+`code`, `category`, `phase`, `owner`, `retryable`, `rootCause` (type + detail +
+file:line), `causeChain`, `stackTrace` (full, đã redact),
+`handlerStackTrace` (stack JS/.NET cho handler không phải Python),
+`context`, `resolution` (summary + steps + docUrl), `retry`, `traceId`.
+`log_fields()` bind cùng vocabulary vào Function Log.
+
+**Timeline (`config/log_context.py`)** — context manager `phase()` phát
+`phase_start` / `phase_end` / `phase_failed` kèm `duration_ms`. Đây là dữ liệu
+để UI vẽ timeline và chỉ ra job chết ở bước nào. `phase_failed` ở mức WARNING để
+thấy được khi chạy `LOG_LEVEL=INFO`.
+
+`_FAILED_PHASE` ghi lại phase mà exception thoát ra: khối `except` xử lý lỗi gần
+như luôn nằm **ngoài** `with phase(...)`, lúc đó phase đang mở đã bị reset trong
+`finally`. Không có nó thì mọi `ErrorReport` đều `phase=None` và fallback theo
+phase không bao giờ chạy. Dùng `effective_phase()` ở đường báo lỗi.
+
+**`config/thread_config.py`** — `ContextAwareThreadPoolExecutor` copy contextvars
+khi submit. `ThreadPoolExecutor` thuần không làm việc này (khác
+`asyncio.to_thread`), nên analysis + finalization chạy trong
+`circuit_running_pool` sẽ mất `job_id` / `trace_id` / `phase`.
+
+**Call-site** — `phase()` bọc PREPROCESSING / DEVICE_SELECTION /
+PROVIDER_INVOCATION / COMPILATION / EXECUTION / ANALYSIS; toàn bộ 13 call-site
+của `build_error_job_response()` truyền `phase=`.
+
+**Test** — `tests/test_error_classifier.py` (52 case: cause chain, HTTP/AWS
+code, frame ownership, phase fallback, rule ordering) và
+`tests/test_error_report.py` (44 case: envelope, timeline, thread pool).
+
+### v0.0.13.dev9 — Error logging & observability (Phase 0)
+
+Mục tiêu: Function Log và Job Log phải chỉ ra được nguyên nhân lỗi. Toàn bộ thay
+đổi trong bản này là **additive hoặc bug fix** — không đổi contract callback,
+không đổi schema `job_result`, không cần frontend/backend sửa gì.
+
+**Logging (`config/`)**
+- Thêm `config/log_context.py`: `bind_job()` / `enrich_job_context()` đặt
+  `job_id`, `trace_id`, `sdk`, `provider`, `device` vào `contextvars`. Mọi log
+  sau đó tự có đủ field, kể cả log của `Provider` / `DeviceSelection` /
+  `*Factory` — những chỗ trước đây rơi vào context `"QuappLibs"` nên không gắn
+  được vào job nào.
+- `configure_logging()` **idempotent**. Trước đây `AsyncInvocationTask.do()` gọi
+  `logger.add(sink=sys.stderr, ...)` cho mỗi request, nên sau N job có N+1 sink
+  và mỗi dòng log in N+1 lần.
+- Thêm `InterceptHandler` + `install_stdlib_intercept()`: đẩy mọi record của
+  stdlib `logging` sang loguru. Cần thiết vì 24/34 template trong
+  `quapp-sdk-templates` dùng `logging.getLogger('index')` mà không cấu hình
+  handler — `debug`/`info` của chúng bị drop im lặng và `exception` in ra không
+  có prefix `[ConsoleJobLog]` lẫn `job_id`. Log của uvicorn/qiskit/botocore cũng
+  về cùng một format.
+- Thêm JSON sink cho structured logging, bật bằng `QUAPP_LOG_FORMAT=json|both`
+  (default `text`, giữ nguyên hành vi cũ). Field: `jobId`, `traceId`, `phase`,
+  `category`, `errorCode`, `sdk`, `provider`, `device`, `event`, `durationMs`.
+- Thêm redaction filter: mask `token` / `apiKey` / `authentication` /
+  `clientSecret` / … trước khi ghi log, áp dụng cả cho stack trace.
+- Fix: text formatter thiếu `{exception}`. Với formatter dạng callable, loguru
+  **không** tự append traceback — nên trước đây mọi `logger.exception()` trong
+  codebase không in ra stack trace nào.
+- Fix: `depth` trong intercept khiến mọi record hiện là
+  `logging:callHandlers:<line>` thay vì file:line của nơi gọi log.
+- Fix: với `enqueue=True`, traceback object không picklable nên bị thay bằng
+  `None` sau khi qua queue. Traceback nay được format sẵn ở filter.
+
+**Error từ runner không phải Python (`component/dispatcher.py`, `bridge.py`)**
+- Bỏ `subprocess.run(..., check=True)`. Nó raise `CalledProcessError` **trước
+  khi** đọc được output, làm nhánh `_extract_error_message()` thành dead code và
+  user chỉ thấy `Command '[...]' returned non-zero exit status 1`.
+- Thêm `HandlerRuntimeError` mang `language`, `action`, `error_type`, `stack`
+  (stack của runtime gốc — JS/.NET), `exit_code`, `signal_name`. Sáu tình huống
+  được phân biệt: runner không có trong image, timeout, bị signal (handler.c
+  segfault → returncode âm, stdout rỗng), structured error trên stdout, exit
+  code khác 0, và output không phải JSON hợp lệ.
+- Đọc được **cả contract cũ** (`error` dạng string, stack trên stderr) nên không
+  cần deploy đồng thời với template.
+- `_format_exception()` đưa `handlerStackTrace` / `language` / `action` /
+  `exitCode` / `signal` lên `job_result` cho lỗi handler JS/Q#/C.
+
+**Đường lỗi (`model/device/device.py`, `util/response_utils.py`, …)**
+- `Device._on_execution` dùng `build_error_job_response()` thay cho
+  `job_result = {"error": str(exception)}` và log ở `ERROR` thay vì `DEBUG`.
+  Đây là đường lỗi quan trọng nhất (submit circuit lên device) và trước đây là
+  đường mất thông tin nhiều nhất.
+- `build_error_job_response()` nay tự phát một log `ERROR` duy nhất cho mọi lỗi,
+  nên Job Log và Function Log không còn lệch nhau.
+- Truyền `stage` cho 8 call-site còn thiếu (trước đây 10/13 call-site rơi vào
+  default `'while running your job'`).
+- Fix `generate_response()`: nhánh `else` truy cập `job_response.status_code`
+  khi `job_response` là falsy → `AttributeError`, thay lỗi gốc bằng lỗi khác.
+- Fix `job_fetching.py`: `__produce_histogram_data` / `__get_execution_time`
+  khai báo `@staticmethod` nhưng dùng `self.logger` → `NameError` khi được gọi.
+- `DeviceSelection`: không log nguyên response (chứa token provider) và không
+  nhét `response.content` thô vào exception (nội dung này chảy vào `job_result`
+  rồi hiện lên UI).
+- `PostProcessingTask`: bỏ `print()` ghi thẳng ra stdout (không qua sink nên
+  không được redact và không có `job_id`).
+
+**Test**
+- `tests/test_logging_config.py` — redaction, idempotent sink, job context,
+  intercept stdlib, exception payload.
+- `tests/test_dispatcher_runner_error.py` — 6 nhánh phân loại lỗi runner.
+
 ### v0.0.13.dev2
 - Fix: `_openqasm_to_braket` in `circuit_adapter.py` now injects a default
   `Probability` result type when the Braket circuit produced by `tk_to_braket`

{quapp_common-0.0.13.dev8 → quapp_common-0.0.14.dev1}/README.md

@@ -73,6 +73,140 @@ Notes:
 
 ## Recently Changes Highlights
 
+### v0.0.14.dev1 — Error taxonomy & error envelope (Phase 1)
+
+Tiếp nối Phase 0. Bổ sung phân loại lỗi có ngữ nghĩa và envelope dùng chung cho
+Function Log lẫn Job Log. **Additive**: `job_result` chỉ thêm field `error`,
+`message` và `exception` giữ nguyên; contract callback URL không đổi.
+
+**Taxonomy — hai chiều phân loại độc lập**
+- `enum/error_category.py`: `ErrorCategory` 13 giá trị, nhóm theo *ai xử lý
+  được* (`owner_of()` → USER / WORKSPACE_ADMIN / PROVIDER / PLATFORM).
+- `enum/runtime_phase.py`: `RuntimePhase` 9 giá trị. Tách được
+  `PROVIDER_INVOCATION` / `COMPILATION` / `EXECUTION` — trước đây auth sai,
+  transpile fail và provider từ chối job đều ra chung nhãn `EXECUTION`.
+  `PHASE_TO_STEP` giữ nguyên contract `InvocationStep` của callback URL.
+
+**Classifier (`util/error_classifier.py`)** — tổ hợp 5 tín hiệu theo độ tin cậy:
+1. `phase` — biết chắc từ context manager, không suy đoán;
+2. `frame_owner()` — code của ai, dựa vào đường dẫn frame sâu nhất
+   (`function/` = user, `quapp_*` = platform, `site-packages/` = SDK);
+3. tên class exception, đi hết **cause chain** qua cả `__cause__` *và*
+   `__context__` — cần thiết vì nhiều provider lib bọc lỗi bằng
+   `raise ValueError(...)` trong khối `except` mà không có `from`;
+4. attribute đọc được: HTTP status, AWS error code, exit code, signal;
+5. message pattern (dùng cuối cùng).
+
+`register_rules()` cho phép lib provider đăng ký rule đặc thù SDK khi import,
+nên `qapp-common` không phải import qiskit/braket. Batch đăng ký sau được xét
+trước; trong cùng batch giữ nguyên thứ tự. Rule ném lỗi bị bỏ qua chứ không làm
+hỏng đường báo lỗi. 20 rule generic sẵn có.
+
+Fallback nhiều tầng nên **không bao giờ trả `UNKNOWN` một cách mù**: không rule
+nào khớp thì suy từ frame ownership, rồi tới phase.
+
+**Envelope (`data/response/error_report.py`)** — `job_result['error']` gồm
+`code`, `category`, `phase`, `owner`, `retryable`, `rootCause` (type + detail +
+file:line), `causeChain`, `stackTrace` (full, đã redact),
+`handlerStackTrace` (stack JS/.NET cho handler không phải Python),
+`context`, `resolution` (summary + steps + docUrl), `retry`, `traceId`.
+`log_fields()` bind cùng vocabulary vào Function Log.
+
+**Timeline (`config/log_context.py`)** — context manager `phase()` phát
+`phase_start` / `phase_end` / `phase_failed` kèm `duration_ms`. Đây là dữ liệu
+để UI vẽ timeline và chỉ ra job chết ở bước nào. `phase_failed` ở mức WARNING để
+thấy được khi chạy `LOG_LEVEL=INFO`.
+
+`_FAILED_PHASE` ghi lại phase mà exception thoát ra: khối `except` xử lý lỗi gần
+như luôn nằm **ngoài** `with phase(...)`, lúc đó phase đang mở đã bị reset trong
+`finally`. Không có nó thì mọi `ErrorReport` đều `phase=None` và fallback theo
+phase không bao giờ chạy. Dùng `effective_phase()` ở đường báo lỗi.
+
+**`config/thread_config.py`** — `ContextAwareThreadPoolExecutor` copy contextvars
+khi submit. `ThreadPoolExecutor` thuần không làm việc này (khác
+`asyncio.to_thread`), nên analysis + finalization chạy trong
+`circuit_running_pool` sẽ mất `job_id` / `trace_id` / `phase`.
+
+**Call-site** — `phase()` bọc PREPROCESSING / DEVICE_SELECTION /
+PROVIDER_INVOCATION / COMPILATION / EXECUTION / ANALYSIS; toàn bộ 13 call-site
+của `build_error_job_response()` truyền `phase=`.
+
+**Test** — `tests/test_error_classifier.py` (52 case: cause chain, HTTP/AWS
+code, frame ownership, phase fallback, rule ordering) và
+`tests/test_error_report.py` (44 case: envelope, timeline, thread pool).
+
+### v0.0.13.dev9 — Error logging & observability (Phase 0)
+
+Mục tiêu: Function Log và Job Log phải chỉ ra được nguyên nhân lỗi. Toàn bộ thay
+đổi trong bản này là **additive hoặc bug fix** — không đổi contract callback,
+không đổi schema `job_result`, không cần frontend/backend sửa gì.
+
+**Logging (`config/`)**
+- Thêm `config/log_context.py`: `bind_job()` / `enrich_job_context()` đặt
+  `job_id`, `trace_id`, `sdk`, `provider`, `device` vào `contextvars`. Mọi log
+  sau đó tự có đủ field, kể cả log của `Provider` / `DeviceSelection` /
+  `*Factory` — những chỗ trước đây rơi vào context `"QuappLibs"` nên không gắn
+  được vào job nào.
+- `configure_logging()` **idempotent**. Trước đây `AsyncInvocationTask.do()` gọi
+  `logger.add(sink=sys.stderr, ...)` cho mỗi request, nên sau N job có N+1 sink
+  và mỗi dòng log in N+1 lần.
+- Thêm `InterceptHandler` + `install_stdlib_intercept()`: đẩy mọi record của
+  stdlib `logging` sang loguru. Cần thiết vì 24/34 template trong
+  `quapp-sdk-templates` dùng `logging.getLogger('index')` mà không cấu hình
+  handler — `debug`/`info` của chúng bị drop im lặng và `exception` in ra không
+  có prefix `[ConsoleJobLog]` lẫn `job_id`. Log của uvicorn/qiskit/botocore cũng
+  về cùng một format.
+- Thêm JSON sink cho structured logging, bật bằng `QUAPP_LOG_FORMAT=json|both`
+  (default `text`, giữ nguyên hành vi cũ). Field: `jobId`, `traceId`, `phase`,
+  `category`, `errorCode`, `sdk`, `provider`, `device`, `event`, `durationMs`.
+- Thêm redaction filter: mask `token` / `apiKey` / `authentication` /
+  `clientSecret` / … trước khi ghi log, áp dụng cả cho stack trace.
+- Fix: text formatter thiếu `{exception}`. Với formatter dạng callable, loguru
+  **không** tự append traceback — nên trước đây mọi `logger.exception()` trong
+  codebase không in ra stack trace nào.
+- Fix: `depth` trong intercept khiến mọi record hiện là
+  `logging:callHandlers:<line>` thay vì file:line của nơi gọi log.
+- Fix: với `enqueue=True`, traceback object không picklable nên bị thay bằng
+  `None` sau khi qua queue. Traceback nay được format sẵn ở filter.
+
+**Error từ runner không phải Python (`component/dispatcher.py`, `bridge.py`)**
+- Bỏ `subprocess.run(..., check=True)`. Nó raise `CalledProcessError` **trước
+  khi** đọc được output, làm nhánh `_extract_error_message()` thành dead code và
+  user chỉ thấy `Command '[...]' returned non-zero exit status 1`.
+- Thêm `HandlerRuntimeError` mang `language`, `action`, `error_type`, `stack`
+  (stack của runtime gốc — JS/.NET), `exit_code`, `signal_name`. Sáu tình huống
+  được phân biệt: runner không có trong image, timeout, bị signal (handler.c
+  segfault → returncode âm, stdout rỗng), structured error trên stdout, exit
+  code khác 0, và output không phải JSON hợp lệ.
+- Đọc được **cả contract cũ** (`error` dạng string, stack trên stderr) nên không
+  cần deploy đồng thời với template.
+- `_format_exception()` đưa `handlerStackTrace` / `language` / `action` /
+  `exitCode` / `signal` lên `job_result` cho lỗi handler JS/Q#/C.
+
+**Đường lỗi (`model/device/device.py`, `util/response_utils.py`, …)**
+- `Device._on_execution` dùng `build_error_job_response()` thay cho
+  `job_result = {"error": str(exception)}` và log ở `ERROR` thay vì `DEBUG`.
+  Đây là đường lỗi quan trọng nhất (submit circuit lên device) và trước đây là
+  đường mất thông tin nhiều nhất.
+- `build_error_job_response()` nay tự phát một log `ERROR` duy nhất cho mọi lỗi,
+  nên Job Log và Function Log không còn lệch nhau.
+- Truyền `stage` cho 8 call-site còn thiếu (trước đây 10/13 call-site rơi vào
+  default `'while running your job'`).
+- Fix `generate_response()`: nhánh `else` truy cập `job_response.status_code`
+  khi `job_response` là falsy → `AttributeError`, thay lỗi gốc bằng lỗi khác.
+- Fix `job_fetching.py`: `__produce_histogram_data` / `__get_execution_time`
+  khai báo `@staticmethod` nhưng dùng `self.logger` → `NameError` khi được gọi.
+- `DeviceSelection`: không log nguyên response (chứa token provider) và không
+  nhét `response.content` thô vào exception (nội dung này chảy vào `job_result`
+  rồi hiện lên UI).
+- `PostProcessingTask`: bỏ `print()` ghi thẳng ra stdout (không qua sink nên
+  không được redact và không có `job_id`).
+
+**Test**
+- `tests/test_logging_config.py` — redaction, idempotent sink, job context,
+  intercept stdlib, exception payload.
+- `tests/test_dispatcher_runner_error.py` — 6 nhánh phân loại lỗi runner.
+
 ### v0.0.13.dev2
 - Fix: `_openqasm_to_braket` in `circuit_adapter.py` now injects a default
   `Probability` result type when the Braket circuit produced by `tk_to_braket`

{quapp_common-0.0.13.dev8 → quapp_common-0.0.14.dev1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "quapp-common"
-version = "0.0.13.dev8"
+version = "0.0.14.dev1"
 description = "Quapp common library supporting Quapp Platform for Quantum Computing"
 readme = "README.md"
 authors = [{ name = "CITYNOW Co. Ltd. ", email = "corp@citynow.vn" }]

{quapp_common-0.0.13.dev8 → quapp_common-0.0.14.dev1}/quapp_common/async_tasks/async_invocation_task.py

@@ -2,7 +2,6 @@
 #  async_invocation_task.py
 #  Copyright © CITYNOW Co. Ltd. All rights reserved.
 import asyncio
-import sys
 
 from starlette.concurrency import run_in_threadpool
 from starlette.responses import JSONResponse
@@ -10,6 +9,7 @@ from starlette.responses import JSONResponse
 from ..async_tasks.async_task import AsyncTask
 from ..component.backend.job_manager import JobManager
 from ..component.callback.update_job_metadata import update_job_metadata
+from ..config.log_context import bind_job
 from ..config.logging_config import logger
 from ..factory.handler_factory import HandlerFactory
 from ..model.invocation import Event, Error, Success
@@ -61,9 +61,12 @@ class AsyncInvocationTask(AsyncTask):
             job_id = self.event.json().get('jobId')
             if job_id is None:
                 raise Exception("Job ID is missing from event")
-            logger.add(sink=sys.stderr,
-                       format="[ConsoleJobLog][" + job_id + "] " + "{level} : {time} : {message}: {process}",
-                       level='DEBUG')
+
+            # Trước đây chỗ này gọi logger.add(sink=sys.stderr, ...) cho MỖI
+            # request: sau N job có N+1 sink và mỗi dòng log in N+1 lần. Sink đã
+            # được cấu hình một lần trong logging_config; ở đây chỉ cần bind
+            # context để mọi log sau đó tự có job_id/trace_id.
+            job_log = bind_job(job_id)
 
             # Define the blocking work
             def _run_handle():
@@ -78,7 +81,7 @@ class AsyncInvocationTask(AsyncTask):
                 if t.cancelled() or t.exception() is None:
                     return
                 exc = t.exception()
-                logger.exception(
+                job_log.bind(event='background_task_failed').exception(
                         f"Background job task failed for job {job_id}: {exc}")
                 try:
                     event_data = self.event.json()
@@ -87,7 +90,8 @@ class AsyncInvocationTask(AsyncTask):
                     if on_error_url:
                         error_response = build_error_job_response(
                                 exc,
-                                message=f"Unhandled background task error: {exc}")
+                                message=f"Unhandled background task error: {exc}",
+                                stage='while running your job in the background')
                         error_response.user_token = event_data.get('userToken')
                         error_response.user_identity = event_data.get(
                                 'userIdentity')
@@ -97,7 +101,7 @@ class AsyncInvocationTask(AsyncTask):
                                 event_data, 'workspaceHeader')
                         update_job_metadata(error_response, on_error_url)
                 except Exception as fallback_exc:
-                    logger.exception(
+                    job_log.bind(event='callback_failed').exception(
                             f"Failed to notify BE of error for job {job_id}: {fallback_exc}")
 
             task.add_done_callback(_on_task_done)

{quapp_common-0.0.13.dev8 → quapp_common-0.0.14.dev1}/quapp_common/async_tasks/post_processing_task.py

@@ -5,6 +5,7 @@ from .async_task import AsyncTask
 from ..config.logging_config import job_logger
 from ..data.promise.post_processing_promise import PostProcessingPromise
 from ..enum.media_type import MediaType
+from ..enum.runtime_phase import RuntimePhase
 from ..util.http_utils import get_job_id_from_url
 from ..util.json_parser_utils import parse
 
@@ -35,15 +36,23 @@ class PostProcessingTask(AsyncTask):
             job_result_post_processing = self.post_processing_fn(
                     self.promise.job_result)
 
-            self.logger.debug("Parsing job result....")
-            print(job_result_post_processing)
+            # print() cũ ghi thẳng ra stdout, không qua sink nên không được
+            # redact và không có job_id.
+            self.logger.debug(
+                    f"Parsing job result: type={type(job_result_post_processing).__name__}")
             job_response.job_result = parse(job_result_post_processing)
 
             update_job_metadata(job_response, self.promise.callback_url.on_done)
 
         except Exception as exception:
-            job_response = build_error_job_response(exception, job_response,
-                                                    message='Error when post processing job result')
+            self.logger.bind(event='job_failed').exception(
+                    f"Post-processing failed: {exception}")
+
+            job_response = build_error_job_response(
+                    exception, job_response,
+                    message='Error when post processing job result',
+                    stage='while post-processing the job result',
+                    phase=RuntimePhase.POST_PROCESSING)
 
             update_job_metadata(job_response,
                                 self.promise.callback_url.on_error)

{quapp_common-0.0.13.dev8 → quapp_common-0.0.14.dev1}/quapp_common/component/backend/invocation.py

@@ -6,6 +6,7 @@ from abc import ABC, abstractmethod
 
 from ..callback.update_job_metadata import update_job_metadata
 from ...component.device.device_selection import DeviceSelection
+from ...config.log_context import bind_job, enrich_job_context, phase
 from ...config.logging_config import job_logger
 from ...config.thread_config import circuit_running_pool
 from ...data.backend.backend_information import BackendInformation
@@ -15,6 +16,7 @@ from ...data.response.authentication import Authentication
 from ...data.response.custom_header import CustomHeader
 from ...data.response.job_response import JobResponse
 from ...enum.invocation_step import InvocationStep
+from ...enum.runtime_phase import RuntimePhase
 from ...enum.sdk import Sdk
 from ...enum.status.status_code import StatusCode
 from ...model.provider.provider import Provider
@@ -82,8 +84,12 @@ class Invocation(ABC):
             return None
 
         try:
-            self.logger.debug("Preparing backend data")
-            self.__prepare_backend_data(circuit)
+            with phase(RuntimePhase.DEVICE_SELECTION):
+                self.__prepare_backend_data(circuit)
+
+            enrich_job_context(
+                    device=self.backend_information.device_name,
+                    provider=self.backend_information.provider_tag.value)
             self.logger.info(
                     f"Backend data prepared: device {self.backend_information.device_name}, provider {self.backend_information.provider_tag.value}")
 
@@ -94,7 +100,8 @@ class Invocation(ABC):
 
             job_response = build_error_job_response(exception,
                                                     message='Error when prepare backend data',
-                                                    stage='while preparing the backend')
+                                                    stage='while preparing the backend',
+                                                    phase=RuntimePhase.DEVICE_SELECTION)
             job_response.authentication = self.authentication
             update_job_metadata(job_response, self.callback_dict.get(
                     InvocationStep.PREPARATION).on_error)
@@ -125,10 +132,15 @@ class Invocation(ABC):
             self.logger.debug(
                     f"Executing job with provider tag: {provider_tag.value}")
 
-            provider = self._create_provider()
+            # PROVIDER_INVOCATION tách riêng khỏi EXECUTION: lỗi authenticate
+            # với provider và lỗi provider từ chối circuit là hai chuyện khác
+            # nhau, trước đây cùng ra nhãn EXECUTION.
+            with phase(RuntimePhase.PROVIDER_INVOCATION):
+                provider = self._create_provider()
 
-            self.logger.debug(f"Executing job with device name: {device_name}")
-            device = self._create_device(provider)
+                self.logger.debug(
+                        f"Executing job with device name: {device_name}")
+                device = self._create_device(provider)
 
         except Exception as exception:
             self.logger.exception(
@@ -137,7 +149,8 @@ class Invocation(ABC):
 
             job_response = build_error_job_response(exception,
                                                     message='Error when create provider or device',
-                                                    stage='while running the circuit on the device')
+                                                    stage='while running the circuit on the device',
+                                                    phase=RuntimePhase.PROVIDER_INVOCATION)
             update_job_metadata(job_response, self.callback_dict.get(
                     InvocationStep.EXECUTION).on_error, )
 
@@ -170,7 +183,8 @@ class Invocation(ABC):
                 InvocationStep.PREPARATION).on_start)
 
         try:
-            circuit = circuit_preparation_fn(self.input)
+            with phase(RuntimePhase.PREPROCESSING):
+                circuit = circuit_preparation_fn(self.input)
 
             if circuit is None:
                 self.logger.warning(
@@ -190,7 +204,8 @@ class Invocation(ABC):
 
             job_response = build_error_job_response(exception, job_response,
                                                     message='Error when prepare circuit',
-                                                    stage='while preparing the circuit')
+                                                    stage='while preparing the circuit',
+                                                    phase=RuntimePhase.PREPROCESSING)
 
             update_job_metadata(job_response, self.callback_dict.get(
                     InvocationStep.PREPARATION).on_error)

{quapp_common-0.0.13.dev8 → quapp_common-0.0.14.dev1}/quapp_common/component/backend/job_fetcher.py

@@ -16,6 +16,7 @@ from ...data.response.custom_header import CustomHeader
 from ...data.response.job_response import JobResponse
 from ...enum.invocation_step import InvocationStep
 from ...enum.media_type import MediaType
+from ...enum.runtime_phase import RuntimePhase
 from ...enum.status.job_status import JobStatus
 from ...enum.status.status_code import StatusCode
 from ...util.json_parser_utils import parse
@@ -131,9 +132,12 @@ class JobFetcher(ABC):
                     f"Exception during job fetch for provider_job_id {self.provider_job_id}: {exception}",
                     exc_info=True)
 
-            job_response = build_error_job_response(exception, job_response,
-                                                    message='Error when fetching job with provider_job_id {0}'.format(
-                                                            self.provider_job_id))
+            job_response = build_error_job_response(
+                    exception, job_response,
+                    message='Error when fetching job with provider_job_id {0}'.format(
+                            self.provider_job_id),
+                    stage='while fetching the job result from the provider',
+                    phase=RuntimePhase.POLLING)
             update_job_metadata(job_response, self.callback_urls[
                 InvocationStep.EXECUTION].on_error)
 
@@ -208,8 +212,11 @@ class JobFetcher(ABC):
             self.logger.exception(f"Exception during analysis: {exception}",
                               exc_info=True)
             from ...util.response_utils import build_error_job_response
-            job_response = build_error_job_response(exception, job_response,
-                                                    message='Error when analyzing job result')
+            job_response = build_error_job_response(
+                    exception, job_response,
+                    message='Error when analyzing job result',
+                    stage='while analysing the job result',
+                    phase=RuntimePhase.ANALYSIS)
 
             update_job_metadata(job_response, callback_url.on_error)
             return None

{quapp_common-0.0.13.dev8 → quapp_common-0.0.14.dev1}/quapp_common/component/backend/job_fetching.py

@@ -17,6 +17,7 @@ from ...data.response.custom_header import CustomHeader
 from ...data.response.job_response import JobResponse
 from ...enum.invocation_step import InvocationStep
 from ...enum.media_type import MediaType
+from ...enum.runtime_phase import RuntimePhase
 from ...enum.status.job_status import JobStatus
 from ...enum.status.status_code import StatusCode
 from ...util.json_parser_utils import parse
@@ -89,13 +90,16 @@ class JobFetching(ABC):
                 job_response.status_code = StatusCode.POLLING
 
         except Exception as exception:
-            self.logger.debug(
+            self.logger.bind(event='job_failed').exception(
                     "Exception when fetch job with provider_job_id {0}: {1}".format(
                             self.provider_job_id, str(exception)))
 
-            job_response = build_error_job_response(exception, job_response,
-                                                    message='Exception when fetch job with provider_job_id {0}'.format(
-                                                            self.provider_job_id))
+            job_response = build_error_job_response(
+                    exception, job_response,
+                    message='Exception when fetch job with provider_job_id {0}'.format(
+                            self.provider_job_id),
+                    stage='while fetching the job result from the provider',
+                    phase=RuntimePhase.POLLING)
 
             update_job_metadata(job_response, self.callback_dict.get(
                     InvocationStep.EXECUTION).on_error)
@@ -156,9 +160,12 @@ class JobFetching(ABC):
                     "Exception when analyst job result with provider_job_id {0}: {1}".format(
                             self.provider_job_id, str(exception)))
 
-            job_response = build_error_job_response(exception, job_response,
-                                                    message='Exception when analyst job result with provider_job_id {0}'.format(
-                                                            self.provider_job_id))
+            job_response = build_error_job_response(
+                    exception, job_response,
+                    message='Exception when analyst job result with provider_job_id {0}'.format(
+                            self.provider_job_id),
+                    stage='while analysing the job result',
+                    phase=RuntimePhase.ANALYSIS)
 
             update_job_metadata(job_response, callback_url.on_error)
 
@@ -183,8 +190,10 @@ class JobFetching(ABC):
         PostProcessingTask(post_processing_fn=post_processing_fn,
                            promise=promise).do()
 
-    @staticmethod
-    def __produce_histogram_data(job_result) -> Any | None:
+    # Trước đây hai method dưới là @staticmethod nhưng vẫn dùng `self.logger`,
+    # nên chúng raise NameError ngay khi được gọi -- biến lỗi analysis thành một
+    # lỗi vô nghĩa hoàn toàn khác. Bỏ @staticmethod để `self` hợp lệ.
+    def __produce_histogram_data(self, job_result) -> Any | None:
         """
 
         @param job_result:
@@ -196,14 +205,13 @@ class JobFetching(ABC):
             histogram_data = job_result.result()[0].data.meas.get_counts()
 
         except Exception as e:
-            self.logger.debug(
+            self.logger.warning(
                     "Can't produce histogram with error: {0}".format(str(e)))
             histogram_data = None
 
         return histogram_data
 
-    @staticmethod
-    def __get_execution_time(job_result):
+    def __get_execution_time(self, job_result):
         """
 
         @param job_result: