Namespace-Related Information
The dashboard of the Solution Envoy displays the run status of the deployed solutions, the storages in use as well as information regarding the messaging components and the underlying infrastructure. Currently, four different overviews are accessible for a namespace:
Solution Overview
The Solution Overview displays the following information for each of the solutions deployed in the namespace:.
| Property | Description |
| Status | Shows the current status of the solutions – whether they are running or not. |
| Open API | A button labelled as Open API. Clicking on the button directs the user to the Swagger UI that displays the APIs populated by the solution.There is also the possibility to download the automatically generated IBM Business Automation Workflow toolkit (if defined for the API Namespace) |
| Pipeline Run | The last successful pipeline run. |
| Available Pods | Shows the number of available pods out of the total number of pods. A pod is a group of one or more containers (such as Docker containers), with shared storage/network, and a specification on how to run the containers. The number of pods is assigned during deployment in the pipeline. They can also be increased in the scenario when there is an increase in load. |
| Agent Health | Shows whether the agents are currently running or not. It is displayed as a Boolean value and assigned as OK/Not OK. Hovering over the value shows the percentage of agents which failed in the last 24 hours. If less than 10% of the agents failed in the last 24 hours, the value’s always OK. The value would be Not OK if more than 10% of agents failed in the last 24 hours. |
| Details | Accessing detail information for a solution. |
Storage
The storage overview shows a cumulated overview of the databases and collections used by the solutions. Please note, that all information is provided by the database itself and therefore logical integrity cannot be guaranteed.
| Property | Description |
| URL | The user can view the URL displayed besides the header. The URL is a technical connection string which represents the connection to the database. |
| Connections used | The number of connections used and the maximal number of possible connections |
| Days uptime | The number of days the database is up and running. |
| Page faults | Shows the number of page faults. Page faults can occur as the database reads from or writes data to parts of its data files that are currently not located in physical memory. |
For each solution also the following database information are presented:
| Property | Description |
| Status | Shows the current state of the database (OK or not OK) |
| Objects | The number of data objects in each database. |
| Avg. Object Size | Shows the average object size. Average object size is calculated as the total data size divided by the number of objects. |
| Data Size | Shows the total size of the data in the database. Calculated as the average object size multiplied by the number of objects. |
| Indexes | Shows the number of indexes in the database. |
Messaging
The user can see all message topics along with their partitions.
Infrastructure
This area provides information on components that are running as infrastructure in a Solution Envoy or that are needed for developing solutions.
- Dashboard
- Pipeline-Manager (API to create, trigger or delete pipelines)
They both show the following information:
| Property | Description |
| Running status | Shows the current status of the solutions – whether they are running or not. |
| Pods available | Shows the pods available out of the total number of pods. |
| Build artifact | Displays the internal name of the component |
| Build version | The version of the component |
| Build ID | The associated build ID of the component |
| Open button | Directs to the Swagger UI of the corresponding component which shows their operations defined. |
Solution CLI Setup
Provides a link to download the config file to set up the CLI connection to the Solution Envoy. To be able to use the Solution CLI for implementing and debugging, it has to be set up using the downloaded file and the command provided in the description. For additional information see also chapter Solution CLI Setup.
Maven Dependencies