Set-Metrics-Configuration
Modifies the configuration settings of the MicroProfile Metrics service.
Synopsis
asadmin [asadmin-options] set-metrics-configuration [--help]
[--enabled={true|false}]
[--securityEnabled={true|false}]
[--roles=<role-list>]
[--dynamic={true|false}]
[--endpoint=<context-root[default:metrics]>]
[--target=<instance-name[default:server]>]
[--virtualservers=<virtualserver-list>]
Description
The set-metrics-configuration provides a way to set the configuration of the metrics service of the targeted config.
Options
asadmin-options:
Options for the asadmin utility. For information about these options, see the asadmin help page.
--help:
-?:
Displays the help text for the subcommand.
--enabled:
Defaults to true. Enables or disables the Metrics service.
--securityEnabled:
Defaults to false. Specifies whether secure access to the metrics endpoint is enabled or disabled.
--roles:
Defaults to microprofile. If defined, the endpoint will be assigned to a list of the role specified as a comma-separated.
--dynamic:
Defaults to true. If set to true, applies the changes instantly without a restart.
+ Otherwise, a restart is required.
--endpoint:
Defaults to metrics. Specifies the context root used to expose the metrics endpoint.
--target:
Specifies the target for its respective configuration.
Valid values are as follows:
server;;
Specifies the DAS (default).
instance-name;;
Specifies a Payara Server instance.
cluster-name;;
Specifies a cluster.
configuration-name;;
Specifies a named configuration.
--virtualservers:
If defined, the endpoint will be assigned to a list of virtual servers specified as a comma-separated list of names.
+ Otherwise, the endpoint will be assigned to all virtual servers available.
Example
Example 1 Setting the configuration of the Metrics service
This example sets the metrics service configuration for the specified target instance1.
asadmin set-metrics-configuration --enabled=true --securityEnabled=true --dynamic=true --target instance1