Health check reports

Monitor the health and stability of your organization by creating and reviewing health check reports in ArcGIS Enterprise Manager. Reports can be created or scheduled to run at a later time by an administrator. Basic healths checks are also created by ArcGIS Enterprise when there is a major event in the organization such as an upgrade, update, or a removal of updates.

Report types

The available report types are basic health checks and operational health checks. The following sections contain details about each type.

Basic health checks

Basic health check reports conduct a suite of functional and availability health checks to validate overall organization health.

This type of report runs the following tests:

TestDescription

Portal API endpoint is available

Checks that the ArcGIS Portal Directory is accessible.

Relational store health check

Captures health information of the relational store.

Object store health check

Captures health information of the object store.

Spatiotemporal and index store health check

Captures health information of the spatiotemporal and index store.

ArcGIS Enterprise portal endpoint is available

Checks that the ArcGIS Enterprise portal endpoint is available.

ArcGIS Enterprise Manager endpoint is available

Checks that ArcGIS Enterprise Manager is accessible.

Ingress health check

Captures health information of the ingress controller.

System publishing tools health check

Captures health information of system publishing tools.

Shared map services health check

Captures health information of shared map services.

Spatial analysis service health check

Captures health information of spatial analysis services.

Geometry service health check

Captures health information of geometry services.

Can query logs

Checks that the organization can query log messages.

Users, groups, and items indices are in sync

Checks that indices are in sync.

Operational health checks

Operational health checks conduct a suite of tests that provide insights into operational efficiency and enable early detection of potential issues across multiple areas of ArcGIS Enterprise.

Each test is categorized by the area of the product it affects. The following sections are organized according to these categories and contain descriptions of each test.

Backup

The following tests are related to your organization's backups and backup stores:

TestSeverityDescription

An organizational backup store is available

Critical

Checks that at least one valid backup store is registered with your organization.

An organizational backup is available

Critical

Checks that at least one valid backup of your organization exists.

An organizational backup from within the last seven days is available

Important

Checks that a valid backup created in the past seven days exists.

Backups are scheduled to run at regular intervals

Recommended

Checks that at least one enabled backup schedule exists.

All backup stores associated with backup schedules are valid

Critical

Checks that all backup stores that are associated with backup schedules are healthy.

If necessary, register a backup store and create a backup. It is recommended that you schedule frequent backups.

Data store

Tests related to your organization's required storage only run when the storage is provisioned as persistent volumes. The following tests are included:

TestSeverityDescription

Relational store has sufficient available storage

Important

Checks if the primary relational store pod is available and has sufficient storage.

Object store has sufficient available storage

Important

Checks if object store pods are available and have sufficient storage.

Spatiotemporal and index store has sufficient available storage

Important

Checks if spatiotemporal and index store pods are available and have sufficient storage.

Relational store replication between Primary and Standby pod is current

Critical

Checks if the standby relational store pod is available and running as expected.

If necessary, increase the volume size of stores.

High availability

Tests in this section only run when your organization's required storage is provisioned as persistent volumes. The following tests are included:

TestSeverityDescription

The architectural integrity of the Relational store is sustained

Critical

Checks if there is a discrepancy in the expected and total number of relational store pods.

The architectural integrity of the Object store is sustained

Critical

Checks if there is a discrepancy in the expected and total number of object store pods.

The architectural integrity of the Spatiotemporal and index store is sustained

Critical

Checks if there is a discrepancy in the expected and total number of spatiotemporal and index store pods.

License

The following tests are related to your organization's ArcGIS Enterprise license:

TestSeverityDescription

The ArcGIS Enterprise license is valid for 7 or more days

Critical

Checks if the license is valid for seven or more days. If this test fails, the certificate will expire within 7 days.

The ArcGIS Enterprise license is valid for 14 or more days

Important

Checks if the license is valid for 14 or more days. If the test fails, the license will expire in between 7 and 14 days.

The ArcGIS Enterprise licenses is valid for 30 or more days

Recommended

Checks if the license is valid for 30 or more days. If the test fails, the license will expire in between 14 and 30 days.

After your license expires, your organization will no longer have access to ArcGIS Enterprise on Kubernetes. To avoid disruption, obtain an authorization file from My Esri. For further assistance, contact your account manager.

Security

The following tests are related to your organization's identity certificates:

TestSeverityDescription

Identity certificates are valid for 7 or more days

Critical

Checks if the certificate is valid for 7 or more days. If this test fails, the certificate will expire within 7 days.

Identity certificates are valid for 14 or more days

Important

Checks if the certificate is valid for 14 or more days. If the test fails, the certificate will expire in between 7 and 14 days.

Identity certificates are valid for 30 or more days

Recommended

Checks if the certificate is valid for 30 or more days. If the test fails, the certificate will expire in between 14 and 30 days.

It is recommended that you update the identity certificate before it expires. See Import an identity certificate for more information.

Other

The following miscellaneous tests are included in the report:

TestSeverityDescription

Federated servers have been validated

Critical

If you have ArcGIS Server sites federated with your organization, this test checks whether they validate successfully.

Log level is appropriate for general use

Important

Checks if the default log level set for your organization is appropriate for general use. Log levels considered appropriate for general use include Verbose, Fine, Info, Warning, and Severe. The Debug log level is not considered appropriate for general use. Update the log level from ArcGIS Enterprise Manager.


In this topic
  1. Report types