Monitor your services

Progress Data Cloud provides several ways to monitor the health, status, and usage of your services. You can use the user interface, the REST API, or the Progress Data Cloud status page.

User interface

In the Progress Data Cloud user interface, you can see the service status indicators, review the service statistics timeline, and export usage data.

Service status indicators

Each service card on the Services page displays a status indicator that shows the status of the service.

To see the current status:

1. Select Services from the menu on the navigation bar.
2. Check the status indicator on the service card.
   The status indicator shows whether a service is online.

Available statuses

The available statuses are:

• Online
• Offline
• Provisioning
• Removing

Service statistics timeline

Each service card includes a service statistics timeline that provides a visual summary of service activity over a date range. Hover along the timeline to see statistics such as:

• Number of requests
• Amount of data transferred
• Number of documents transferred

The timeline date range and total data transferred appear below the graph.

Export usage data

You can export up to the last 30 days of detailed usage data for a service as a CSV file.

To export usage data:

1. On the Services page, locate the service card for the service you want to review.
2. Click the drop-down icon on the service card.
3. Select Export Usage Data.
4. Specify the start and end dates.

Note:

You can only export up to the last 30 days of usage data.

5. Click Export.
6. Save the file in the desired location.

For the full list of available actions per service, see Service card actions.

REST API

Service status information can be retrieved programmatically by using the Management API.

Access the API

You can access the API in Swagger by:

• In the navigation bar > > Management API.
• Browsing to https://{tenancy-URL}/swagger.

Tenant status endpoint

The api/tenant/status endpoint returns the status of your services. No parameters are required in a GET request. For instructions on authenticating and using the REST API, see API integration.

API response

This is a sample response from the api/tenant/status endpoint. It includes the healthy and alive parameters:

• alive — This parameter is available on all services and on the tenancy itself. It indicates whether the service process is running and reachable (a liveness check). A service can be alive, but not necessarily functioning correctly — it simply means the process is up and responding to basic probes.
• healthy — Only present on certain service types. Indicates whether the service is operating correctly — that is, it is not only running but also able to handle requests as expected (a readiness/health check). This is a deeper check than alive.

{
  "dnsName": "test",
  "displayName": "Test Tenancy",
  "version": "1.4.1",
  "lastUpdate": 1774276657.320601,
  "alive": true,
  "services": [
    {
      "dnsName": "cons",
      "displayName": "Concepts Server",
      "alive": true,
      "version": "5.8.5",
      "environmentDnsName": "custprod",
      "environmentDisplayName": "Customer Production",
      "studioDnsName": "studio58",
      "studioDisplayName": "studio58",
      "serviceType": "cons",
      "lastUpdate": 1774276657.320601
    },
   
    {
      "dnsName": "fraclus",
      "displayName": "Test Fractional gfraclus",
      "alive": true,
      "healthy": true,
      "version": "12.0.0",
      "environmentDnsName": "dev",
      "environmentDisplayName": "Development",
      "studioDnsName": "studio510",
      "studioDisplayName": "studio510",
      "serviceType": "marklogic-server",
      "lastUpdate": 1774276657.320601
    },
    {
      "dnsName": "service3",
      "displayName": "Service Three",
      "alive": true,
      "healthy": true,
      "version": "2.1.0",
      "environmentDnsName": "prod",
      "environmentDisplayName": "Production",
      "studioDnsName": "studio99",
      "studioDisplayName": "studio99",
      "serviceType": "service-type",
      "lastUpdate": 1774276657.320601
    }
  ]
}

Progress Data Cloud status page

For general platform status information, including planned maintenance and incident reports, see the Progress Data Cloud status page.