System

As clients publish to the MQTT broker and log information the Connectware collects that information and temporarily stores it. The metrics tab provides usage data information while the status tab allows you to view the current state, configuration and logs of Connectware containers.

Metrics

  1. On the navigation panel click on System to expand the menu.

../_images/system_menu.png
  1. Go to the Metrics menu.

../_images/metrics_menu.png
  1. A metric, that shows the total amount of bytes received by the broker.

../_images/metrics.png

Overview

The metrics view provides the following information

Message Flow

The amount of messages hitting the broker per second.

Message Count

Overall messages received by the broker.

Data Flow

The amount of bytes received by the broker per second.

Data Count

The amount of data received in total.

Status

  1. On the navigation panel click on System to expand the menu.

../_images/system_menu.png
  1. Go to the Status menu.

../_images/status_menu.png

3. This opens the status view which contains information about all running Connectware containers.

../_images/status.png

Overview

The status view contains the following information

Name

The name of the container.

State

The Connectware containers can enter one of the following states:

  • running -> The container is working as expected.

  • starting -> The container is currently in the process of starting.

  • stopping -> The container is currently stopping.

  • restarting -> The container has triggered the restarting procedure.

  • exited -> The container was shut down and won’t restart automatically.

  • created -> The container was created but not yet started.

Uptime

The time the container is already running.

Controls

../_images/status_restart.png

You can restart Connectware containers from this view by selecting one or more instances (1.) and then selecting restart (2.) from the options menu.

Container Details view

The container details view contains more information about a single container. To open this view, select one of the containers displayed in the status view. A window similar to the picture below will open.

../_images/status_details.png

To unfold the individual resources just click on the appropriate tab.

Config

../_images/status_details_config.png

The config sections shows information about container settings including

  • capAdd -> Added capabilities.

  • exposedPorts -> Ports exposed by the container.

  • image -> The docker image used by the container.

  • privileged -> Shows if the container is running in privileged mode.

  • workingDir -> The working directory inside the container.

Environmental Variables

../_images/status_details_envs.png

This tab shows all environmental variables available to the processes inside the container at runtime.

Logs

../_images/status_details_logs.png

The Logs tab shows the logging message of the selected container. In the toolbar at the top right of this section, there are the following buttons:

  • Search for log entries containing the entered keyword. This also filters the current table.

  • Download CSV to download the displayed rows of the log file as a CSV (Comma-Separated-Value) text file (Note: Log lines outside of the window are not downloaded, and the complete download is limited to the most recent 500 lines; use Download raw log for a complete log download)

  • View columns to select the columns to be shown

  • Filter table to select filter criteria to have only a subset of rows shown

  • Download raw logs to download the full log file in order to pass on this file to Cybus Support for in-depth issue resolution. See below for an explanation of the file format.

  • and Refresh to refresh (reload) the currently shown log messages.

The “Download raw logs” button returns the stream output of “docker logs” directly, whereby each log line is prepended by some control characters. The exact stream format is described in the Docker API documentation of the “Attach” endpoint, see e.g. https://docs.docker.com/engine/api/v1.41/#operation/ContainerAttach . Basically, each line is prepended by an eight byte header and another two byte marker. For text file processing, the first 10 bytes of each line should hence be ignored. A suitable Linux command line tool for that would be cut -b11- < inputfile.log where the output lines are printed from the 11th byte onwards each.

Controls

../_images/status_details_controls.png

The details view offers capabilities to

  • Stop -> Stop the selected container.

  • Restart -> Restart the selected container.

  • Delete -> Delete the selected container (the container has to be stopped first).

  • Expand all Resources -> Unfold all of the tabs described above.

In addition to these global controls, each details tab provides individual controls to filter, organize, or search the data provided.

Search
../_images/search.png

Search for entries containing the entered keywords. This also filters the current table.

Show Columns
../_images/columns.png

Select the columns to be shown.

Filter
../_images/filter.png

(Not in Logs section.) Select from available options to filter the rows to be shown.

Refresh
../_images/refresh.png

(Only in Logs section.) This option is only available in the logs section and executes a manual refresh (reload) of the logs shown.

Retrieving more system information

The Connectware REST interface provides a unique /api/system/info endpoint that can be used to retrieve more in depth system information.

Overview

The information provided by the endpoint are as follows:

License

Indepth information about the license file used to active the currently running Connectware instance. This includes:

File A schematic display of the license features and expiration.

Name The license name. This name corresponds to an existing customer license in the Cybus Portal.

Valid The current license state. As long as a valid license is provided the value will be true.

Time

Timestamp of the query.

Version

The version of the currently running Connectware instance.

How to access the endpoint

Requirements

To access the REST endpoint a user has to authenticate with the Connectware first. HTTP read permissions for the /api/system/info path have to be added to the user account before attempting to connect with the endpoint. To learn more about user permissions, please read the User Section of the documentation.

Example

A short example query using curl.

curl -u <USERNAME>:<PASSWORD> https://<HOSTNAME>:443/api/system/info --insecure

System Health

The Connectware REST interface provides a unique /api/system/health endpoint that can be used to retrieve health data information about system containers.

Overview

The information provided by the endpoint are as follows:

System

Overall object key

Status Array of system container

Name Name of the system container

Status Current status of the system container

Resources

Not implemented yet

Requirements

To access the REST endpoint a user has to authenticate with the Connectware first. HTTP read permissions for the /api/system/info path have to be added to the user account before attempting to connect with the endpoint. To learn more about user permissions, please read the User Section of the documentation.

curl -u <USERNAME>:<PASSWORD> https://<HOSTNAME>:443/api/system/health --insecure