aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorrope252 <gareth.roper@est.tech>2021-05-26 11:19:42 +0100
committerrope252 <gareth.roper@est.tech>2021-05-26 13:28:55 +0100
commitfd7f014ba55bfd973ac1b2854fdc236cb3cc348a (patch)
tree10ae334890473d5ddca3aa442cabef09605aa452
parentc6276a6e0ca148213a9d7b66cec184e419da3916 (diff)
Add SO_Admin_Cockpit Images to Documentation
Change-Id: I7ba4d127556a4fe65626154a69beb06fdabf634a Issue-ID: SO-3492 Signed-off-by: rope252 <gareth.roper@est.tech>
-rw-r--r--docs/developer_info/SO_Admin_Cockpit_User_Guide.rst10
-rw-r--r--docs/images/soAdminCockpitGetError.pngbin0 -> 34710 bytes
-rw-r--r--docs/images/soAdminCockpitStatistics.pngbin0 -> 18137 bytes
-rw-r--r--docs/images/soAdminCockpitUi.pngbin0 -> 116613 bytes
-rw-r--r--docs/images/soAdminCockpitUi2.pngbin0 -> 140388 bytes
-rw-r--r--docs/images/soAdminCockpitUi3.pngbin0 -> 28193 bytes
-rw-r--r--pom.xml6
7 files changed, 13 insertions, 3 deletions
diff --git a/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst b/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst
index 2144bf8c05..ed729664a8 100644
--- a/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst
+++ b/docs/developer_info/SO_Admin_Cockpit_User_Guide.rst
@@ -68,15 +68,23 @@ Now simply go to the “Application Catalog” tab on the left of the page, then
Searching/Viewing BPMN Workflows
--------------------------------
+.. image:: ../images/soAdminCockpitUi.png
+
In order to find the workflow that you are attempting to monitor you will need at least one of the following values of the service instance: Service Instance ID, Request ID, Service Name or the time/date range in which the workflow started/ended. You can use the filter drop-down boxes to the left of the parameter boxes, i.e. “EQUAL”, “NOT EQUAL” and “LIKE”. Also, you can filter by the status of a workflow, with the status drop-down box, to further filter your results. Simply enter any of these pieces of information into the search page, ensure the start and end date range includes when the workflow would have run and press the search button. Once your results list has been returned you can click on a result to see the workflow in the graphical BPMN viewer.
+.. image:: ../images/soAdminCockpitUi2.png
+
From here you can inspect the different calls and variables throughout the workflow, by using the "Activity Instances" and "Variable Instances" tabs. Clicking on one of the sub process call, within the diagram, to open them in the graphical BPMN viewer (The boxes with a + at the bottom of them are call activities to sub processes. This is how you drill down through a workflow, you can also safely traverse back “up” through the flows with your browser’s back button. The cyan highlighting shows the flow of the path taken by the workflow, and this will go down through each of the sub processes as well.
+.. image:: ../images/soAdminCockpitUi3.png
+
In the BPMN viewer, manipulation of the returned illustrated flow is possible by using the following methods. On the left side of the viewer window there are three symbols for Zooming in/out and fitting the flow to the full window. Along with these controls, the user can left-click and drag to move the flow within the canvas to the user desired position.
SO-Monitoring Service Statistics
--------------------------------
+.. image:: ../images/soAdminCockpitStatistics.png
+
You can see a summary of the status of all of the workflows from one of your search results by clicking on the "Service Statistics" tab, found just above your list of results. Here you can find a percentile breakdown of each workflow's, in the list of results you received, statuses.
Troubleshooting SO-Admin-Cockpit
@@ -105,6 +113,8 @@ This can be dealt with in two ways. Either using an extension or by disabling CO
Internal Service Error occurred for operation : GET please check backend service log. status code: 500
-------------------------------------------------------------------------------------------------------
+.. image:: ../images/soAdminCockpitGetError.png
+
This can be checked by following the below steps:
- Open the developers mode in your browser
diff --git a/docs/images/soAdminCockpitGetError.png b/docs/images/soAdminCockpitGetError.png
new file mode 100644
index 0000000000..32325bde47
--- /dev/null
+++ b/docs/images/soAdminCockpitGetError.png
Binary files differ
diff --git a/docs/images/soAdminCockpitStatistics.png b/docs/images/soAdminCockpitStatistics.png
new file mode 100644
index 0000000000..bb0a4d3316
--- /dev/null
+++ b/docs/images/soAdminCockpitStatistics.png
Binary files differ
diff --git a/docs/images/soAdminCockpitUi.png b/docs/images/soAdminCockpitUi.png
new file mode 100644
index 0000000000..1e1781b3f6
--- /dev/null
+++ b/docs/images/soAdminCockpitUi.png
Binary files differ
diff --git a/docs/images/soAdminCockpitUi2.png b/docs/images/soAdminCockpitUi2.png
new file mode 100644
index 0000000000..88ef083034
--- /dev/null
+++ b/docs/images/soAdminCockpitUi2.png
Binary files differ
diff --git a/docs/images/soAdminCockpitUi3.png b/docs/images/soAdminCockpitUi3.png
new file mode 100644
index 0000000000..bb2d0563c5
--- /dev/null
+++ b/docs/images/soAdminCockpitUi3.png
Binary files differ
diff --git a/pom.xml b/pom.xml
index 198ffbbbba..a665440d04 100644
--- a/pom.xml
+++ b/pom.xml
@@ -849,17 +849,17 @@
<dependency>
<groupId>org.onap.logging-analytics</groupId>
<artifactId>logging-slf4j</artifactId>
- <version>1.6.9-SNAPSHOT</version>
+ <version>1.6.10-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.onap.logging-analytics</groupId>
<artifactId>logging-filter-base</artifactId>
- <version>1.6.9-SNAPSHOT</version>
+ <version>1.6.10-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.onap.logging-analytics</groupId>
<artifactId>logging-filter-spring</artifactId>
- <version>1.6.9-SNAPSHOT</version>
+ <version>1.6.10-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.apache.httpcomponents</groupId>