Tosca Server service health check

Tosca Gateway Service via Consul offers a monitoring function that detects whether a Tosca Server feature or service that you installed is available and running.

To see whether a service is running, access the Tosca Server Landing Page. Unavailable service tiles are light grey.

Configure Tosca services via the Tosca Server Landing Page

You can configure Tosca services in Service Configuration, which you can access from the Tosca Server Landing Page.

To open Service Configuration, click on Settings in the top right corner of the Landing Page.

What to do when Tosca Server services are unavailable?

When a service tile on the Tosca Server Landing Page is grey, it means that the service is not running. In this case, there are multiple ways to try to restart them.

A service is unavailable

If a service is unavailable, restart it in one of the following ways:

  • In Tricentis Service Configuration:

    Open Service Configuration, navigate to the tab of the unavailable service and click Restart.

From Windows Task Manager:

  1. Open Task Manager from the Widows Start menu.

  2. Go to the Services tab and find the unavailable service in the list.

  3. Right-click on the service name and select Start or Restart, depending on which is available.

From Windows Services:

  1. Open Services from the Widows Start menu.

  2. Find the unavailable service in the list.

  3. Right-click on the service name and select Restart.

If restarting doesn't make the service available, go to < Tosca Server installation folder>/<folder of the unavailable service>/appsettings.json. Check the appsettings.json file for faulty entries, such as incorrect endpoints.

All services are unavailable

If all services are unavailable, Consul, the software that hosts Tosca Gateway Service, may be unavailable. In this case, restart Consul Service in one of the following ways:

From Windows Task Manager:

  1. Open Task Manager from the Widows Start menu.

  2. Go to the Services tab and find Consul.Service in the list.

  3. Right-click on the service name and select Start or Restart, depending on which is available.

From Windows Services:

  1. Open Services from the Widows Start menu.

  2. Find Consul.Service in the list.

  3. Right-click on the service name and select Restart.

Landing Page is unavailable

The Tosca Server Landing Page is also a service and can have downtime. If you can't access the Tosca Server Landing Page, restart it in one of the following ways:

From Windows Task Manager:

  1. Open Task Manager from the Widows Start menu.

  2. Go to the Services tab and find Tricentis.GatewayService in the list.

  3. Right-click on the service name and select Start or Restart, depending on which is available.

From Windows Services:

  1. Open Services from the Widows Start menu.

  2. Find Tricentis.GatewayService in the list.

  3. Right-click on the service name and select Restart.

What to do when Service Configuration is unreachable?

If you've configured Tosca Gateway Service and can't reach Service Configuration anymore, you can reset the service.

To do so, follow the steps below:

  1. Open the appsettings.json file located at C:\Program Files (x86)\TRICENTIS\Tosca Server\Gateway.

  2. In the HttpServer section, replace the value of Port with a valid numeric value.

  3. Set the value of Scheme to http.

  4. Remove the value of Thumbprint. It has to be an empty string ("").

  5. In the Discovery section, change the value of ServiceDiscovery to http://localhost:<port>. The port must be the same as the port you specified in the HttpServer section.

  6. Save and close the file.

Continue with the following steps:

  1. Go to the ocelot.json file located at C:\Program Files (x86)\TRICENTIS\Tosca Server\Gateway.

  2. In the GlobalConfiguration section, change the value of BaseUrl to the same value as you specified for ServiceDiscovery in the appsettings.json file.

  3. Change the value of Host to localhost.

  4. Change the value of DownstreamScheme to http.

  5. In the Routes section, change the value of DownstreamScheme to http in all routes where ServiceId has the value LandingPage and in all routes where the ServiceId property doesn't exist.

  6. Change the value of Host to localhost in all routes where ServiceId has the value LandingPage and in all routes where the ServiceId property doesn't exist.

  7. Change the value of Port to the same value as you specified for ServiceDiscovery in the appsettings.json file in all routes where ServiceId has the value LandingPage and in all routes where the ServiceId property doesn't exist.

  8. Save and close the file.

  9. Open Services from the Widows Start menu.

  10. Right-click on the service and select Restart.

If the Service Configuration is still unavailable after you've performed these steps, uninstall Tosca Server and reinstall it.

What to do when the Tosca Gateway Service port is unavailable?

It's possible that the previously used Gateway port is unavailable if you've uninstalled Tosca Server and try to reinstall it immediately. This issue should resolve itself after a waiting period of one or two minutes.