Enables or disables the Healthcheck of a specific performance metric service.

This command is deprecated and will be removed in a future release as it has been replaced by the set-healthcheck-service-configuration command.


asadmin [asadmin-options] healthcheck-configure-service
[--target target]


Enables and disables the monitoring of a HealthCheck performance metric service. The command also configures the frequency of monitoring for that metric.



Options for the asadmin utility. For information about these options, see the asadmin help page.


Displays the help text for the subcommand.


This option helps specify the target on which you are configuring the Healthcheck performance metric service. Valid values are:


Applies to the default server instance. This is the default value.


Applies to every server instance in the cluster.


Applies to a specified server instance.


Defaults to false. Enables or disables the healthcheck service


Defaults to false. When set to true, applies the changes without a server restart.


The performance service metric name. Required.

One of:

  • connection-pool or cp

  • cpu-usage or cu

  • garbage-collector or gc

  • heap-memory-usage or hmu

  • hogging-threads or ht

  • machine-memory-usage or mmu

  • stuck-thread or st

  • mp-health or mh

  • mp-metrics or mm


A user determined name for easy identification of the checker.

This should be unique among the services you have configured, to avoid confusion on the notification messages.

Depends on the service checker. One of:

  • CONP

  • CPUC

  • GBGC

  • HEAP

  • HOGT

  • MEMM

  • MP

  • MPM


Defaults to false. When enabled, the checker results are displayed on MicroProfile Health REST endpoints as a readiness check.


Defaults to 5. The amount of time units that the service will use to periodically monitor the metric.


Defaults to MINUTES. The time unit to set the frequency of the metric monitoring.

Must correspond to a valid java.util.concurrent.TimeUnit


Example 1 Basic Configuration

A very basic example command to simply enable the GC checker and activate it without needing a restart would be as follows:

asadmin healthcheck-configure-service --enabled=true --serviceName=healthcheck-gc --name=MYAPP-GC --dynamic=true

Exit Status


subcommand executed successfully


error in executing the subcommand

See Also