This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hop.git
The following commit(s) were added to refs/heads/main by this push:
new 1957c50a57 Execution results: Logging, Metrics, Problems and Revisions
tabs, with new screenshots. fixes #9056 (#9224)
1957c50a57 is described below
commit 1957c50a57402a1efaa2ce30f7a5b5d47198e901
Author: Adalennis <[email protected]>
AuthorDate: Wed Nov 4 09:30:15 2026 +0100
Execution results: Logging, Metrics, Problems and Revisions tabs, with new
screenshots. fixes #9056 (#9224)
* Execution results: Logging, Metrics, Problems and Revisions tabs, with
new screenshots. #9056
* Execution results: Revisions column order, git option link and
outside-repository message, linter findings as on the linting page, after
review. #9056
---
.../images/hop-gui/pipeline/logging-pipeline.png | Bin 20143 -> 285408 bytes
.../images/hop-gui/pipeline/problems-pipeline.png | Bin 0 -> 107134 bytes
.../pipeline/transform-metrics-pipeline.png | Bin 12135 -> 144214 bytes
.../pages/pipeline/run-preview-debug-pipeline.adoc | 41 +++++++++++++++++----
.../ROOT/pages/workflow/run-debug-workflow.adoc | 5 ++-
5 files changed, 38 insertions(+), 8 deletions(-)
diff --git
a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/logging-pipeline.png
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/logging-pipeline.png
index 5e41578f2d..4042dbab52 100644
Binary files
a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/logging-pipeline.png
and
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/logging-pipeline.png
differ
diff --git
a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/problems-pipeline.png
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/problems-pipeline.png
new file mode 100644
index 0000000000..e0d7fa03af
Binary files /dev/null and
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/problems-pipeline.png
differ
diff --git
a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/transform-metrics-pipeline.png
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/transform-metrics-pipeline.png
index 1c15d49cac..0a44d4c6cc 100644
Binary files
a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/transform-metrics-pipeline.png
and
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/pipeline/transform-metrics-pipeline.png
differ
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/run-preview-debug-pipeline.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/run-preview-debug-pipeline.adoc
index 3066cc0125..2b6c67bcd2 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/run-preview-debug-pipeline.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/run-preview-debug-pipeline.adoc
@@ -69,23 +69,50 @@ Hover your mouse over the red error triangle to take a
quick peek at the error m
image::hop-gui/pipeline/failed-pipeline.png[Failed pipeline,75%,align="left"]
+[[execution-results]]
After each run the execution results are displayed in the panel on the bottom
of your window.
-The Execution Results contains two tabs:
+The panel has these tabs:
-* Transform Metrics
-* Logging
+* *Logging*: the log of the pipeline.
+* *Metrics*: the metrics of each transform.
+* *Problems*: the results of the checks of the pipeline and of the linter.
+* *Revisions*: the git history of the pipeline file, when Git is enabled.
-The Transform Metrics tab displays metrics per transform.
+The same tabs are shown for a workflow, see
xref:workflow/run-debug-workflow.adoc[Run and Debug a Workflow].
-image::hop-gui/pipeline/transform-metrics-pipeline.png[Transform Metrics
pipeline,75%,align="left"]
+=== Logging
+
+The Logging tab displays the log of the pipeline according to the log level
chosen on execution.
+
+image::hop-gui/pipeline/logging-pipeline.png[Logging pipeline,75%,align="left"]
+
+=== Metrics
+
+The Metrics tab displays metrics per transform.
+
+image::hop-gui/pipeline/transform-metrics-pipeline.png[Metrics
pipeline,75%,align="left"]
Following metrics are displayed:
include::../snippets/pipeline-metrics-table.adoc[]
-The logging tab displays the log of the pipeline according to the log level
chosen on execution.
+=== Problems
-image::hop-gui/pipeline/logging-pipeline.png[Logging pipeline,75%,align="left"]
+When the xref:linting/index.adoc[linter] is installed and switched on, the
Problems tab lists its findings for the file as soon as the file has been
linted: when you open it, when you save it, and shortly after you stop editing.
+*Verify this pipeline* on the toolbar adds the remarks of Hop's own checks
next to them.
+Double-click a remark to open the transform it is about.
+The toolbar of the tab can collapse and expand all remarks, and *Force
refresh* clears the database cache and checks the pipeline again.
+
+image::hop-gui/pipeline/problems-pipeline.png[Problems
pipeline,75%,align="left"]
+
+=== Revisions
+
+The Revisions tab lists the commits of the pipeline file, with the columns
*Message*, *Author*, *Date* and *Commit*.
+It is shown when *Enable the git plugin* is on (see
xref:hop-gui/hop-gui-git.adoc#_git_configuration_options[Git Configuration
options]) and Hop has found a git repository for the project, see
xref:hop-gui/hop-gui-git.adoc[Working with git].
+For a file that isn't saved yet, that is outside the git repository, or that
has no commit yet, the tab shows a message instead of the list.
+
+Select a commit and use *Show text diff* or *Show visual diff* on the toolbar
of the tab to compare that version with the file as it is saved now;
double-clicking a commit also shows the text diff.
+When the pipeline has changes that aren't saved yet, Hop warns that the
comparison is made with the last saved version.
== Preview and debug a pipeline
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/run-debug-workflow.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/run-debug-workflow.adoc
index 87963a6890..4ddd1f2986 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/run-debug-workflow.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/run-debug-workflow.adoc
@@ -57,4 +57,7 @@ Make sure your configuration is selected and hit 'Launch'.
image::getting-started/getting-started-run-workflow-with-config.png[Hop - New
Workflow With Config Dialog,75%,align="left"]
This workflow with our very basic pipeline should execute in less than one
second.
-You'll now have the execution results pane which again looks very similar to
the pipeline execution results.
+You'll now have the execution results pane, with the same tabs as for a
pipeline: *Logging*, *Metrics*, *Problems* and *Revisions*.
+On the Metrics tab a workflow shows a row for each action that ran, with among
others its *Result*, *Reason* and *Duration*.
+The Problems tab lists the findings of the linter, when it is installed and
switched on, and *Verify this workflow* adds the remarks of Hop's own checks.
+See xref:pipeline/run-preview-debug-pipeline.adoc#execution-results[the
execution results of a pipeline] for the four tabs.