Add trace ID to clipboard debug info and title bar (#9157)

equinor · Nov 12, 2024 · efb812c · efb812c
1 parent e50f2d3
commit efb812c
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 2 deletions.
diff --git a/src/ert/gui/main_window.py b/src/ert/gui/main_window.py
@@ -33,6 +33,7 @@
 from ert.gui.tools.plugins import PluginHandler, PluginsTool
 from ert.gui.tools.workflows import WorkflowsTool
 from ert.plugins import ErtPluginManager
+from ert.trace import get_trace_id
 
 BUTTON_STYLE_SHEET: str = """
     QToolButton {
@@ -78,7 +79,9 @@ def __init__(
         self.config_file = config_file
         self.log_handler = log_handler
 
-        self.setWindowTitle(f"ERT - {config_file} - {find_ert_info()}")
+        self.setWindowTitle(
+            f"ERT - {config_file} - {find_ert_info()} - {get_trace_id()[:8]}"
+        )
         self.plugin_manager = plugin_manager
         self.central_widget = QFrame(self)
         self.central_layout = QHBoxLayout(self.central_widget)

diff --git a/src/ert/gui/simulation/experiment_panel.py b/src/ert/gui/simulation/experiment_panel.py
@@ -33,6 +33,7 @@
     format_running_time,
     get_ert_memory_usage,
 )
+from ert.trace import get_trace_id
 
 from ..summarypanel import SummaryPanel
 from .combobox_with_description import QComboBoxWithDescription
@@ -385,6 +386,7 @@ def populate_clipboard_debug_info(self) -> None:
                 kv[field.name.replace("_", " ").capitalize()] = str(field_value)
 
         kv["**Status**"] = ""
+        kv["Trace ID"] = get_trace_id()
         kv["Running time"] = (
             format_running_time(self._model.get_runtime()).split(":")[1].strip()
         )

diff --git a/src/ert/trace.py b/src/ert/trace.py
@@ -9,3 +9,7 @@
 trace.set_tracer_provider(tracer_provider)
 
 tracer = trace.get_tracer("ert.main")
+
+
+def get_trace_id() -> str:
+    return trace.format_trace_id(trace.get_current_span().get_span_context().trace_id)
diff --git a/tests/ert/unit_tests/gui/simulation/test_run_dialog.py b/tests/ert/unit_tests/gui/simulation/test_run_dialog.py
@@ -624,7 +624,12 @@ def test_that_debug_info_button_provides_data_in_clipboard(qtbot: QtBot, storage
 
         clipboard_text = QApplication.clipboard().text()
 
-        for keyword in ["Single realization test-run", "Local", r"minimal\_config.ert"]:
+        for keyword in [
+            "Single realization test-run",
+            "Local",
+            r"minimal\_config.ert",
+            "Trace ID",
+        ]:
             assert keyword in clipboard_text