Snapshot version

You are browsing the docs for the snapshot version of Nexus, the latest release is available here

Supervision

This endpoint returns information about the projections running on the current node.

Fetch projections

GET /v1/supervision/projections

Fetches the projections running on the current node.

Example

Request
sourcecurl "http://localhost:8080/v1/supervision/projections"
Response
source{
  "@context": "https://bluebrain.github.io/nexus/contexts/supervision.json",
  "projections": [
    {
      "executionStrategy": "PersistentSingleNode",
      "metadata": {
        "module": "module",
        "name": "name",
        "project": "myorg/myproject"
      },
      "progress": {
        "discarded": 1,
        "failed": 1,
        "instant": "1970-01-01T00:00:00Z",
        "offset": {
          "@type": "Start"
        },
        "processed": 1
      },
      "restarts": 1,
      "status": "Running"
    },
    {
      "executionStrategy": "TransientSingleNode",
      "metadata": {
        "module": "module",
        "name": "name",
        "project": "myorg/myproject"
      },
      "progress": {
        "discarded": 1,
        "failed": 1,
        "instant": "1970-01-01T00:00:00Z",
        "offset": {
          "@type": "Start"
        },
        "processed": 1
      },
      "restarts": 0,
      "status": "Running"
    }
  ]
}

Projects health

GET /v1/supervision/projects

Indicates whether there are any unhealthy projects. A project is considered healthy if it has been correctly provisioned on creation.

Example

Request
sourcecurl -X GET "http://localhost:8080/v1/supervision/projects"
Response (healthy) 
source{
  "status": "All projects are healthy."
}
Response (unhealthy) 
source{
  "status": "Some projects are unhealthy.",
  "unhealthyProjects": [
    "myorg/myproject"
  ]
}

Project healing

POST /v1/supervision/projects/{orgLabel}/{projectLabel}/heal

Attempts to heal a project. This will attempt to run again the provisioning process for the project.

Example

Request
sourcecurl -X POST "http://localhost:8080/v1/supervision/projects/myorg/myproject/heal"
Response
source{
  "message": "Project 'myorg/myproject' has been healed."
}
Snapshot