Check system health#

System health provides a clear overview of the general health status of EclecticIQ Intelligence Center.

Check system health using the GUI#

Requires:

User with read configurations permissions

To check the system health of your Intelligence Center instance:

In the side navigation bar, select Settings .
Depending on the current system health, you will see a button displaying either:
- System running
- System partially running
Select it.

This displays a modal with the following information:

Services tab: Health of running services
Celery tab: Health of Celery workers

The following table describes the services displayed in the Services tab.

Service	Description
`elasticsearch`	Elasticsearch service.
`kibana`	Kibana service. Dashboards get data from this service to display in graphs.
`logstash`	Logstash service. For log and data aggregation, data pipeline and funneling.
`neo4j`	Neo4j graph database service.
`eclecticiq-neo4jbatcher`	Neo4j graph database batch processing application.
`nginx`	Web server.
`opentaxii`	TAXII server.
`postfix`	Email server.
`postgresql-11`	PostgreSQL database. The main datastore.
`redis`	Redis service. For queue handling and message brokering.

Check system health via the API#

Requires:

User with read configurations permissions
API token for that user

You can also do a system health check by sending a GET request to /private/status:

$ curl -X GET \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer ${token}" \
      --url https://${ic_host}/private/status

Example response:

{
  "data": {
    "celery_states": [
      {
        "health": "RED",
        "name": "outgoing-transports",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "enrichers-priority",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "utilities",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "entity-rules-priority",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "outgoing-transports-priority",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "outgoing-feeds-priority",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "enrichers",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "discovery",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "retention-policies",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "retention-policies-priority",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "incoming-transports-priority",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "discovery-priority",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "extract-rules-priority",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "incoming-transports",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "utilities-priority",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "outgoing-feeds",
        "state": "no worker"
      },
      {
        "health": "RED",
        "name": "reindexing",
        "state": "no worker"
      }
    ],
    "health": "RED",
    "process_states": [],
    "service_states": [
      {
        "health": "GREEN",
        "name": "configuration",
        "state": "active"
      },
      {
        "health": "GREEN",
        "name": "elasticsearch",
        "state": "active"
      },
      {
        "health": "GREEN",
        "name": "kibana",
        "state": "active"
      },
      {
        "health": "GREEN",
        "name": "mail-server",
        "state": "active"
      },
      {
        "health": "GREEN",
        "name": "neo4j",
        "state": "active"
      },
      {
        "health": "GREEN",
        "name": "neo4j-batcher",
        "state": "active"
      },
      {
        "health": "RED",
        "name": "opentaxii",
        "state": "cannot connect to OpenTAXII server"
      },
      {
        "health": "GREEN",
        "name": "postgresql-11",
        "state": "active"
      },
      {
        "health": "GREEN",
        "name": "postgresql-timezone",
        "state": "active"
      },
      {
        "health": "GREEN",
        "name": "redis",
        "state": "active"
      },
      {
        "health": "GREEN",
        "name": "statsite",
        "state": "active"
      },
      {
        "health": "GREEN",
        "name": "timezone",
        "state": "active"
      }
    ]
  }
}