fish.payara.jmx.monitoring.admin.SetJMXMonitoringConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) [2018-2021] Payara Foundation and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://github.com/payara/Payara/blob/master/LICENSE.txt
* See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* The Payara Foundation designates this particular file as subject to the "Classpath"
* exception as provided by the Payara Foundation in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package fish.payara.jmx.monitoring.admin;
import com.sun.enterprise.config.serverbeans.Config;
import com.sun.enterprise.config.serverbeans.Domain;
import com.sun.enterprise.config.serverbeans.MonitoringService;
import fish.payara.admin.amx.config.AMXConfiguration;
import fish.payara.internal.notification.NotifierUtils;
import fish.payara.jmx.monitoring.JMXMonitoringService;
import fish.payara.jmx.monitoring.configuration.MonitoredAttribute;
import fish.payara.jmx.monitoring.configuration.MonitoringServiceConfiguration;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyVetoException;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import jakarta.inject.Inject;
import org.glassfish.api.ActionReport;
import org.glassfish.api.I18n;
import org.glassfish.api.Param;
import org.glassfish.api.admin.AdminCommand;
import org.glassfish.api.admin.AdminCommandContext;
import org.glassfish.api.admin.CommandLock;
import org.glassfish.api.admin.CommandRunner;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.ParameterMap;
import org.glassfish.api.admin.RestEndpoint;
import org.glassfish.api.admin.RestEndpoints;
import org.glassfish.api.admin.RuntimeType;
import org.glassfish.config.support.CommandTarget;
import org.glassfish.config.support.TargetType;
import org.glassfish.hk2.api.PerLookup;
import org.glassfish.hk2.api.ServiceLocator;
import org.glassfish.internal.api.Target;
import org.jvnet.hk2.annotations.Service;
import org.jvnet.hk2.config.ConfigSupport;
import org.jvnet.hk2.config.SingleConfigCode;
import org.jvnet.hk2.config.TransactionFailure;
/**
* Asadmin command to set the JMX monitoring service's configuration.
*
* @since 5.183
* @author savage
*/
@Service(name = "set-jmx-monitoring-configuration")
@PerLookup
@CommandLock(CommandLock.LockType.NONE)
@I18n("set.jmx.monitoring.configuration")
@ExecuteOn(RuntimeType.DAS)
@TargetType(value = {CommandTarget.DAS, CommandTarget.STANDALONE_INSTANCE, CommandTarget.CLUSTER, CommandTarget.CLUSTERED_INSTANCE, CommandTarget.CONFIG, CommandTarget.DEPLOYMENT_GROUP})
@RestEndpoints({
@RestEndpoint(configBean = Domain.class,
opType = RestEndpoint.OpType.POST,
path = "set-jmx-monitoring-configuration",
description = "Set JMX Monitoring Configuration")
})
public class SetJMXMonitoringConfiguration implements AdminCommand {
@Inject
ServiceLocator serviceLocator;
@Inject
protected Target targetUtil;
@Inject
JMXMonitoringService jmxMonitoringService;
@Param(name = "enabled", optional = true)
private Boolean enabled;
/**
*
* @deprecated Since 5.182. Use set-amx-enabled command instead.
*/
@Deprecated
@Param(name = "amx", optional = true)
private Boolean amx;
@Param(name = "logfrequency", optional = true)
private String logfrequency;
@Param(name = "logfrequencyunit", optional = true, acceptableValues = "NANOSECONDS,MILLISECONDS,SECONDS,MINUTES,HOURS,DAYS")
private String logfrequencyunit;
@Param(name = "addattribute", optional = true, multiple = true, alias = "addproperty")
private List attributesToAdd;
@Param(name = "delattribute", optional = true, multiple = true, alias = "delproperty")
private List attributesToRemove;
@Param(name = "dynamic", optional = true, defaultValue = "false")
protected Boolean dynamic;
@Param(name = "target", optional = true, defaultValue = "server-config")
protected String target;
@Param(name = "enableNotifiers", alias = "enable-notifiers", optional = true)
private List enableNotifiers;
@Param(name = "disableNotifiers", alias = "disable-notifiers", optional = true)
private List disableNotifiers;
@Param(name = "setNotifiers", alias = "set-notifiers", optional = true)
private List setNotifiers;
@Inject
protected Logger logger;
private MonitoringServiceConfiguration jmxMonitoringConfig;
@Override
public void execute(AdminCommandContext context) {
final ActionReport actionReport = context.getActionReport();
Config config = targetUtil.getConfig(target);
if (config == null) {
actionReport.setMessage("Cound not find target: " + target);
actionReport.setActionExitCode(ActionReport.ExitCode.FAILURE);
}
final JMXMonitoringService jmxMonitoringService = serviceLocator.getService(JMXMonitoringService.class);
if (jmxMonitoringService == null) {
actionReport.appendMessage("Could not find a monitoring service.");
actionReport.setActionExitCode(ActionReport.ExitCode.FAILURE);
return;
}
jmxMonitoringConfig = config.getExtensionByType(MonitoringServiceConfiguration.class);
try {
ConfigSupport.apply(new SingleConfigCode() {
@Override
public Object run(final MonitoringServiceConfiguration monitoringConfigProxy) throws PropertyVetoException, TransactionFailure {
updateConfiguration(monitoringConfigProxy);
updateAttributes(monitoringConfigProxy, actionReport);
actionReport.setActionExitCode(ActionReport.ExitCode.SUCCESS);
return monitoringConfigProxy;
}
}, jmxMonitoringConfig);
if (dynamic) {
enableOnTarget(actionReport, context, enabled);
}
//If the JMX Monitoring is enabled, enable Mbeans too as without it you have nothing to monitor
if (enabled != null && enabled) {
MonitoringService monitoringService = config.getMonitoringService();
ConfigSupport.apply(new SingleConfigCode() {
@Override
public Object run(final MonitoringService monitoringServiceProxy) throws PropertyVetoException, TransactionFailure {
monitoringServiceProxy.setMbeanEnabled((String.valueOf(enabled)));
return monitoringServiceProxy;
}
}, monitoringService);
}
} catch (TransactionFailure ex) {
logger.log(Level.WARNING, "Falied to excute the command " + "set-jmx-monitoring-configuration: " + ex.getCause().getMessage());
actionReport.setMessage(ex.getCause().getMessage());
actionReport.setActionExitCode(ActionReport.ExitCode.FAILURE);
}
}
/**
* Updates the configuration attributes for the
* MonitoringServiceConfiguration given to it.
*
* @param monitoringConfig
* @throws PropertyVetoException
*/
private void updateConfiguration(MonitoringServiceConfiguration monitoringConfig) throws PropertyVetoException, TransactionFailure {
if (null != enabled) {
monitoringConfig.setEnabled(String.valueOf(enabled));
}
if (null != amx) {
AMXConfiguration amxConfig = serviceLocator.getService(AMXConfiguration.class);
ConfigSupport.apply(new SingleConfigCode() {
@Override
public Object run(final AMXConfiguration amxConfigProxy) throws PropertyVetoException, TransactionFailure {
amxConfigProxy.setEnabled((String.valueOf(amx)));
return amxConfigProxy;
}
}, amxConfig);
monitoringConfig.setAmx(null);
}
if (null != logfrequency) {
monitoringConfig.setLogFrequency(logfrequency);
}
if (null != logfrequencyunit) {
monitoringConfig.setLogFrequencyUnit(logfrequencyunit);
}
final Set notifierNames = NotifierUtils.getNotifierNames(serviceLocator);
List notifiers = monitoringConfig.getNotifierList();
if (enableNotifiers != null) {
for (String notifier : enableNotifiers) {
if (notifierNames.contains(notifier)) {
if (!notifiers.contains(notifier)) {
notifiers.add(notifier);
}
} else {
throw new PropertyVetoException("Unrecognised notifier " + notifier,
new PropertyChangeEvent(monitoringConfig, "notifiers", notifiers, notifiers));
}
}
}
if (disableNotifiers != null) {
for (String notifier : disableNotifiers) {
if (notifierNames.contains(notifier)) {
notifiers.remove(notifier);
} else {
throw new PropertyVetoException("Unrecognised notifier " + notifier,
new PropertyChangeEvent(monitoringConfig, "notifiers", notifiers, notifiers));
}
}
}
if (setNotifiers != null) {
notifiers.clear();
for (String notifier : setNotifiers) {
if (notifierNames.contains(notifier)) {
if (!notifiers.contains(notifier)) {
notifiers.add(notifier);
}
} else {
throw new PropertyVetoException("Unrecognised notifier " + notifier,
new PropertyChangeEvent(monitoringConfig, "notifiers", notifiers, notifiers));
}
}
}
}
/**
*
* @param actionReport
* @param context
* @param enabled
*/
private void enableOnTarget(ActionReport actionReport, AdminCommandContext context, Boolean enabled) {
CommandRunner runner = serviceLocator.getService(CommandRunner.class);
ActionReport subReport = context.getActionReport().addSubActionsReport();
CommandRunner.CommandInvocation invocation;
if (target.equals("server-config")) {
invocation = runner.getCommandInvocation("__enable-jmx-monitoring-service-on-das", subReport, context.getSubject());
} else {
invocation = runner.getCommandInvocation("__enable-jmx-monitoring-service-on-instance", subReport, context.getSubject());
}
// Build the parameters
ParameterMap params = new ParameterMap();
enabled = Boolean.valueOf(jmxMonitoringConfig.getEnabled());
params.add("enabled", enabled.toString());
params.add("target", target);
invocation.parameters(params);
invocation.execute();
}
/**
* Updates monitoring attributes through adding a new property and/or
* deleting an existing one.
*
* @param actionReport
* @param monitoringConfig
* @throws PropertyVetoException
* @throws TransactionFailure
*/
private void updateAttributes(MonitoringServiceConfiguration monitoringConfig, ActionReport report) throws PropertyVetoException, TransactionFailure {
List attributes = monitoringConfig.getMonitoredAttributes();
// If there are attributes to be removed
if (attributesToRemove != null && !attributesToRemove.isEmpty()) {
// Loop through them
for (String attributeToRemove : attributesToRemove) {
// Parse the provided attribute
MonitoredAttribute monitoredAttribute = parseToMonitoredAttribute(attributeToRemove, monitoringConfig.createChild(MonitoredAttribute.class));
boolean removed = false;
// Find the attribute matching the one specified
for (MonitoredAttribute attribute : attributes) {
if (attribute.equals(monitoredAttribute)) {
attributes.remove(attribute);
report.appendMessage(jmxMonitoringService.getLocalStringManager().getLocalString(
"jmxmonitoring.configure.attribute.remove",
"Attribute 'objectName={0} attributeName={1}' successfully deleted.",
monitoredAttribute.getObjectName(), monitoredAttribute.getAttributeName()) + "\n");
removed = true;
break;
}
}
if (!removed) {
report.appendMessage(jmxMonitoringService.getLocalStringManager().getLocalString(
"jmxmonitoring.configure.attribute.remove.error",
"Attribute 'objectName={0} attributeName={1}' doesn't exist, so was ignored.",
monitoredAttribute.getObjectName(), monitoredAttribute.getAttributeName()) + "\n");
}
}
}
if (attributesToAdd != null && !attributesToAdd.isEmpty()) {
for (String attributeToAdd : attributesToAdd) {
MonitoredAttribute monitoredAttribute = parseToMonitoredAttribute(attributeToAdd, monitoringConfig.createChild(MonitoredAttribute.class));
boolean attributeExists = false;
for (MonitoredAttribute attribute : attributes) {
if (attribute.equals(monitoredAttribute)) {
attributeExists = true;
report.appendMessage(jmxMonitoringService.getLocalStringManager().getLocalString(
"jmxmonitoring.configure.attribute.add.error",
"Attribute 'objectName={0} attributeName={1}' already exists, so was ignored.",
monitoredAttribute.getObjectName(), monitoredAttribute.getAttributeName()) + "\n");
break;
}
}
if (!attributeExists) {
attributes.add(monitoredAttribute);
report.appendMessage(jmxMonitoringService.getLocalStringManager().getLocalString(
"jmxmonitoring.configure.attribute.add",
"Attribute 'objectName={0} attributeName={1}' successfully added.",
monitoredAttribute.getObjectName(), monitoredAttribute.getAttributeName()) + "\n");
}
}
}
}
/**
* Produces a
* {@link fish.payara.jms.monitoring.configuration.MonitoredBean MonitoredAttribute}
* from a given string. The string should be in the following format:
* 'attribute=something objectName=something description=something'.
*
* @param input the string to be parsed
* @param property the property to configure as per the input string.
* @return a constructed Property.
* @throws PropertyVetoException if a config listener vetoes a property
* attribute value.
*/
private MonitoredAttribute parseToMonitoredAttribute(String input, MonitoredAttribute monitoredAttribute) throws PropertyVetoException {
String[] attributeTokens = input.split("(?=objectName ?=)|(?=attributeName ?=)|(?=description ?=)");
String attributeName = null;
String objectName = null;
String description = null;
if (attributeTokens.length < 2) {
throw new IllegalArgumentException(jmxMonitoringService.getLocalStringManager().getLocalString(
"jmxmonitoring.configure.attributes.too.few",
"Too few properties. Required properties are 'objectName' and 'attributeName'."));
}
for (String token : attributeTokens) {
token = token.replaceAll("\\\\", "");
String[] param = token.split("=", 2);
if (param.length != 2) {
throw new IllegalArgumentException(jmxMonitoringService.getLocalStringManager().getLocalString(
"jmxmonitoring.configure.attributes.too.few",
"Too few properties. Required properties are 'objectName' and 'attributeName'."));
}
switch (param[0]) {
case "attributeName":
case "name":
attributeName = param[1].trim();
break;
case "objectName":
case "value":
objectName = param[1].trim();
break;
case "description":
description = param[1].trim();
break;
default:
throw new IllegalArgumentException(jmxMonitoringService.getLocalStringManager().getLocalString(
"jmxmonitoring.configure.attributes.unknown",
"Unknown property: {0}. Valid properties are: 'objectName', 'attributeName' and 'description'.",
param[0]));
}
}
if (attributeName == null || attributeName.isEmpty()) {
throw new IllegalArgumentException(jmxMonitoringService.getLocalStringManager().getLocalString(
"jmxmonitoring.configure.attributes.invalid",
"Invalid property: {0}.",
"attributeName"));
}
if (objectName == null || objectName.isEmpty()) {
throw new IllegalArgumentException(jmxMonitoringService.getLocalStringManager().getLocalString(
"jmxmonitoring.configure.attributes.invalid",
"Invalid property: {0}.",
"objectName"));
}
monitoredAttribute.setAttributeName(attributeName);
monitoredAttribute.setObjectName(objectName);
if (description != null) {
monitoredAttribute.setDescription(description);
}
return monitoredAttribute;
}
}