healthcheck

Estimated time to read: 1 minute

Experimental-feature notice

This page discusses experimental features. Experimental features are still in progress, and you may encounter bugs or unexpected behavior when using them.

If you experience an issue or want to know more about this feature's status, reach out to us at Era Software.

Acquisition notice

In October 2022, ServiceNow acquired Era Software. The documentation on this site is no longer maintained and is intended for existing Era Software users only.

To get the latest information about ServiceNow's observability solutions, visit their website and documentation.

This command performs a lightweight healthcheck, validating that the EraSearch instance is ready for reads and writes. The healthcheck works by:

Issuing a write to a newly-created index, and then
Querying for the previously-written data

Warning

This command requires both read and write access to the eractl_healthcheck_* index pattern.

usage: eractl healthcheck [-h] [--url URL] [--key KEY]

optional arguments:
  -h, --help  show this help message and exit
  --url URL   EraSearch URL, set via environment with ERACTL_URL (default: http://localhost:9200)
  --key KEY   EraSearch API key, set via environment with ERACTL_API_KEY (default: None)

To run:

eractl healthcheck --url https://erasearch.example.com --key ******

Or to pass arguments from the environment:

export ERACTL_URL="https://erasearch.example.com"
export ERACTL_API_KEY="******"
eractl healthcheck

Last update: August 7, 2023