com.atlassian.jira.health

Interface HealthCheck

All Known Implementing Classes:

AbstractHealthCheck, BuildVersionCheck, CollationHealthCheck, CustomisedConfigurationsHealthCheck, DatabaseSecretStoreRetrievalHealthCheck, DbConfigurationAndConnectionCheck, FakeHealthCheck, FileStoreConfigurationHealthCheck, FileStoreConnectionHealthCheck, HealthCheckTemplate, JdbcDriverHealthCheck, JiraHomeHealthCheck, MinimumUpgradableVersionHealthCheck, MinMemoryHealthCheck, MSSQLDriverMigrationHealthCheck, MySql8ModeHealthCheck, MySQLHealthCheckTemplate, MySqlJdbcUrlHealthCheck, NodeIdHealthCheck, PostgresSchemaHealthCheck, ProhibitedServerLicenseHealthCheck, PublicSchemaHealthCheck, SharedHomeHealthCheck, StandaloneLicenseHealthCheck, SupportedDatabaseVersionHealthCheck, SystemPluginsEnabledHealthCheck, TomcatConfigurationHealthCheck, UnsupportedHsqlHealthCheck

public interface HealthCheck

A health check performed by JIRA during some phase (or phases) of its lifecycle. A check should:

• Return an empty collection on success.
• Return a non-empty collection otherwise, e.g. failure.
• Throw an exception if called during not applicable phase
• Check things that prevent startup or otherwise require attention from the administrator.
• Not check things that JIRA can fix by itself (e.g. creating a needed directory).
• Be short-running, because it is invoked synchronously.
• Release any acquired resources before returning from its perform(LifecyclePhase) method.
• Not have side-effects (e.g. logging its own Johnson events).

Since:

7.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLOCKING_START Boolean indicating whether an event is blocking start.
static String	CAUSE_KEY Checks which send analytics can provide a short cause which is analytics safe, i.e.
static String	CHECK_ID_KEY Checks that wish to have analytics events raised (e.g.
static String	DISMISSIBLE Boolean indicating whether an event is dismissible.
static String	EVENT_ID_KEY The unique ID of an individual Johnson event arising from a HealthCheck.
static String	HELP_URL_KEY Checks that wish to provide a help link to public-facing documentation should set this attribute to the relevant URL on the Johnson event that they return.
static String	INTERACTIVE_JOHNSON The value of the JOHNSON_UI_VERSION attribute that indicates events are to be displayed in the "Better Johnson" UI added by CPU-59.
static String	JOHNSON_UI_VERSION The Johnson event attribute that if present specifies what version of the Johnson UI is meant to display the events returned by this executor.
static String	TEMPLATE_CONTEXT Object to be converted to Json and sent as the value of the 'templateContext' key

Method Summary

Modifier and Type	Method and Description
default String	getId() Returns the unique ID of this check.
Collection<HealthCheck>	getPrerequisites() Returns the checks that must have a non-EventLevel.FATAL result before this check can be run.
boolean	isApplicableFor(LifecyclePhase phase) Checks if current HealthCheck is applicable for given phase
List<HealthCheckResult>	perform(LifecyclePhase phase) Performs health check for given phase

Field Detail

CHECK_ID_KEY

static final String CHECK_ID_KEY

Checks that wish to have analytics events raised (e.g. about their success or failure) should set this attribute to a unique key, e.g. "my-db-check". The value of this key should remain stable for as long as this check is defined.

See Also:

Constant Field Values

EVENT_ID_KEY

static final String EVENT_ID_KEY

The unique ID of an individual Johnson event arising from a HealthCheck.

See Also:

Constant Field Values

HELP_URL_KEY

static final String HELP_URL_KEY

Checks that wish to provide a help link to public-facing documentation should set this attribute to the relevant URL on the Johnson event that they return.

See Also:

Constant Field Values

CAUSE_KEY

static final String CAUSE_KEY

Checks which send analytics can provide a short cause which is analytics safe, i.e. does not contain any user data.

See Also:

Constant Field Values

JOHNSON_UI_VERSION

static final String JOHNSON_UI_VERSION

The Johnson event attribute that if present specifies what version of the Johnson UI is meant to display the events returned by this executor.

See Also:

Event.getAttribute(Object), Constant Field Values

INTERACTIVE_JOHNSON

static final String INTERACTIVE_JOHNSON

The value of the JOHNSON_UI_VERSION attribute that indicates events are to be displayed in the "Better Johnson" UI added by CPU-59.

See Also:

Event.getAttribute(Object), Constant Field Values

DISMISSIBLE

static final String DISMISSIBLE

Boolean indicating whether an event is dismissible.

See Also:

Constant Field Values

BLOCKING_START

static final String BLOCKING_START

Boolean indicating whether an event is blocking start.

See Also:

Constant Field Values

TEMPLATE_CONTEXT

static final String TEMPLATE_CONTEXT

Object to be converted to Json and sent as the value of the 'templateContext' key

See Also:

Constant Field Values

Method Detail

getId

default String getId()

Returns the unique ID of this check.

Returns:

a stable, unique, non-blank ID

getPrerequisites

@Nonnull
Collection<HealthCheck> getPrerequisites()

Returns the checks that must have a non-EventLevel.FATAL result before this check can be run.

Returns:

see above

perform

@Nonnull
List<HealthCheckResult> perform(LifecyclePhase phase)
                                  throws UnsupportedOperationException

Performs health check for given phase

Returns:

a collection of HealthCheckResult

Throws:

{@link - UnsupportedOperationException} if not applicable phase is provided

UnsupportedOperationException

isApplicableFor

boolean isApplicableFor(LifecyclePhase phase)

Checks if current HealthCheck is applicable for given phase

Returns:

true if HealthCheck is applicable for the phase