Environment health check

You can see the health of your environment infrastructure in Collibra Console indicated by a colored disc in front of the infrastructure element.

We also provide a REST API to monitor all the infrastructure elements.

Infrastructure element API documentation Example response
Environment https://<your-console-url>/docs/rest/index.html#/environment/findAll_1 Example - Environment details
https://<your-console-url>/rest/environment/
[{
"createdDate":1699578732.344000000,
"modifiedDate":1699578732.344000000,
"id":"<uuid of environment>",
"name":"Default environment",
"serviceIdSet":["<uuid service 1>","<uuid service 2>","<uuid service 3>","<uuid service 4>"],
"status":"RUNNING"
}]
Service https://<your-console-url>/docs/rest/index.html#managed-services/findAll_2 Example - Services details
https://<your-console-url>/rest/service
[
{
"createdDate":1699578732.134000000,
"modifiedDate":1699578732.134000000,
"id":"<uuid of service",
"nodeId":"<uuid of node>",
"status":"RUNNING",
"errorMessage":"",
"requiredDependencies":["SEARCH","REPOSITORY"],
"optionalDependencies":["SPARK"],
"type":"DGC"
},
{
"createdDate":1699578732.118000000,
"modifiedDate":1699578732.118000000,
"id":"<uuid of dgc service>",
"nodeId":"<uuid of node>",
"status":"RUNNING",
"errorMessage":"",
"requiredDependencies":[],
"optionalDependencies":[],
"type":"SPARK"
},
{
"createdDate":1699578732.076000000,
"modifiedDate":1699578732.076000000,
"id":"<uuid of search service>",
"nodeId":"<uuid of node>",
"status":"RUNNING",
"errorMessage":"",
"requiredDependencies":[],
"optionalDependencies":[],
"type":"SEARCH"
},
{
"createdDate":1699578732.098000000,
"modifiedDate":1699578732.098000000,
"id":"<uuid of repo service>",
"nodeId":"<uuid of node>",
"status":"RUNNING",
"errorMessage":"",
"requiredDependencies":[],
"optionalDependencies":[],
"type":"REPOSITORY"}
]
Node
  • https://<your-console-url>/docs/rest/index.html#/node/findAll_3
  • https://<your-console-url>/docs/rest/index.html#/node/status
  • Example 1 - Node details
    https://<your-console-url>/rest/node
    [{
"createdDate":1699578732.031000000,
"modifiedDate":1699578733.670000000,
"id":"<uuid of node>",
"hostName":"localhost",
"port":4401,
"name":"Default node",
"managedServiceIdSet":
  ["<uuid of service 1 on this node>",
   "<uuid of service 2 on this node>",
   "<uuid of service 3 on this node>",
   "<uuid of service 4 on this node>"]
}]
  • Example 2 - Status of a node
    https://<your-console-url>/rest/node/<node uuid>/status
    "UP"