Using the asadmin commands
In versions prior to Payara Server 4.1.2.183 or 5.183, the
set-monitoring-configuration and get-monitoring-configuration commands were
used instead. These commands are now deprecated.
|
The JMX Monitoring Service provides two asadmin commands:
set-jmx-monitoring-configuration and get-jmx-monitoring-configuration.
This page documents the options available to these commands and how they
should be used.
set-jmx-monitoring-configuration
- Usage
-
asadmin> set-jmx-monitoring-configuration --dynamic true|false --enabled true|false --amx true|false --logfrequency <long.value> --logfrequencyunit MICROSECONDS|MILLISECONDS|SECONDS|MINUTES|HOURS|DAYS --addattribute 'attributeName=AttributeName objectName=MBeanObjectName description=Option_Description' --delattribute ''attributeName=AttributeName objectName=MBeanObjectName' - Aim
-
Sets the monitoring service configuration and can dynamically reload the configuration.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
String |
The name of the configuration to set the monitoring service configuration on. |
|
no |
|
Boolean |
Whether or not to dynamically reload the configuration. This requires a non-empty configuration to have existed at server startup and can be achieved by setting any option or property to have a value |
|
no |
|
Boolean |
The enabled state of the service. |
|
yes |
|
Boolean |
Whether or not to boot AMX on startup. |
|
no |
|
Long |
The numerical value for the rate at which messages are logged. |
|
no |
|
TimeUnit |
The unit for of rate at which messages are logged. |
|
no |
|
String |
MBean attribute to monitor. Takes a string of the format
|
|
no |
|
String |
MBean attribute to stop monitoring. Takes a string of the format
|
|
no |
get-jmx-monitoring-configuration
- Usage
-
asadmin> get-jmx-monitoring-configuration --pretty false|true - Aim
-
Retrieves the monitoring service configuration and outputs it.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
String |
The name of the configuration to get the monitoring service configuration from. |
|
no |
|
Boolean |
Displays Boolean configuration options as a tick or cross |
|
no |
monitoring-cdieventbus-notifier-configure
- Usage
-
monitoring-cdieventbus-notifier-configure --enabled true|false - Aim
-
Configures the CDI Event Bus Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-datadog-notifier-configure
- Usage
-
monitoring-datadog-notifier-configure --enabled true|false - Aim
-
Configures the Datadog Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-email-notifier-configure
- Usage
-
monitoring-email-notifier-configure --enabled true|false - Aim
-
Configures the eMail Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-eventbus-notifier-configure
- Usage
-
monitoring-eventbus-notifier-configure --enabled true|false - Aim
-
Configures the Event Bus Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-hipchat-notifier-configure
- Usage
-
monitoring-hipchat-notifier-configure --enabled true|false - Aim
-
Configures the Hipchat Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-jms-notifier-configure
- Usage
-
monitoring-jms-notifier-configure --enabled true|false - Aim
-
Configures the JMS Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-log-notifier-configure
- Usage
-
monitoring-log-notifier-configure --enabled true|false - Aim
-
Configures the Log Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-newrelic-notifier-configure
- Usage
-
monitoring-newrelic-notifier-configure --enabled true|false - Aim
-
Configures the New Relic Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-slack-notifier-configure
- Usage
-
monitoring-slack-notifier-configure --enabled true|false - Aim
-
Configures the Slack Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-snmp-notifier-configure
- Usage
-
monitoring-snmp-notifier-configure --enabled true|false - Aim
-
Configures the SNMP Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |
monitoring-xmpp-notifier-configure
- Usage
-
monitoring-xmpp-notifier-configure --enabled true|false - Aim
-
Configures the XMPP Notifier for use with the JMX monitoring service.
Command Options
| Option | Type | Description | Default | Mandatory |
|---|---|---|---|---|
|
Boolean |
Whether or not this notifier should be enabled for JMX monitoring. |
|
yes |
|
Boolean |
When true, this update will not require a server restart before taking effect. |
|
no |
|
String |
The instance or cluster whose monitoring service configuration will be updated. |
|
no |