Skip to main content
Version: 2.8

D1, Conversion Service and platform health checks overview

You can perform a number of health checks by using one or more of the supported methods:

  • Use platform health check scrips
  • Run health checks in the Document.One UI
  • Run health checks via REST API

Platform health check script

D1 and Conversion Service packages contain a scripted health check which you can use to verify the status of the hosting platform.

In the folder where you unzipped the deployment package, open the terminal and run the ./check-health.sh --url https://[HOST]:[PORT] command.

Command info

You need to change the command accordingly so that it is referring to your server's (Conversion Service or D1) port and transfer protocol (http/https). You can reference the environment variable script while running health check by adding --environment ../environment.sh to the command (adapt the path accordingly if you saved your environment script elsewhere).

After the health check has finished (it may take a few minutes), there are two possible outcomes:

  • Successfully completed health check. Deployed services are available. - everything is OK.
  • Health check failed! For more information see health-check-result.json and/or run health check directly via http://localhost:8080/tribefire-services/healthz - there is a problem that needs to be fixed.

Health checks in the user interface

You can run a number of health checks from D1 UI. For information about how to do this, see:

Health checks via REST API

You can run a number of checks via REST API. For information about how to do this, see: