Service Endpoints for Monitoring

The AtScale product consists of five services that contain health-check endpoints that you can access by means of HTTP URLs. These endpoints test the network routing, port mapping, and process state of each service. The endpoints use few system resources, so that they can be polled at regular intervals by monitoring tools without impeding system performance.

note

Note: You should also submit SQL or MDX queries through the appropriate cube endpoint to monitor responses specific to your datasets and corporate workflow. To see what these endpoints are for a published cube, open the Overview page for the project in which the cube appears. Select the published cube for the project, and then select the Connect tab to view the connection information for that cube.

note

Note: If your AtScale installation uses HTTPS, then substitute https for http in the endpoint URLs below.

List of services, their endpoints, their response codes, and their payloads

Authentication Service
This application handles authentication between the AtScale applications.

Endpoint
http://<AtScaleHost>:10503/health

Expected HTTP Response Code
200

Expected Payload

{"id":"authDB",  
"name":"Auth DB (PostgreSQL)",  
"status":"good",  
"metadata": {"server":"localhost",  
            "Port":"10518",  
            "databaseName":"atscale",  
            "dbEnv":"development"},  
"type":"authDB"}

The value of the `status` field can be either good or bad.

Design Center
This web-based application is for creating and publishing virtual cubes.

Endpoint
http://<AtScaleHost>:10500/ping

10500 is the default port. Contact your system administrator for the port that is actually being used in your AtScale installation.

Expected HTTP Response Code
200

Expected Payload
**** design center OK ****

Engine
This application is the AtScale engine.

Endpoint
http://<AtScaleHost>:10502/ping

10502 is the default port. Contact your system administrator for the port that is actually being used in your AtScale installation.

Expected HTTP Response Code
200

Expected Payload
OK

Engine (Clustered AtScale only)
For the AtScale engine configured with an external load balancer for Clustered AtScale, a different endpoint is used.

Endpoint
http://<AtScaleHost>:10502/health

10502 is the default port. Contact your system administrator for the port that is actually being used in your AtScale installation.

Expected HTTP Response Code
200

Expected Payload
OK