org.apache.camel.management.mbean.ManagedRoute Maven / Gradle / Ivy
The newest version!
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.management.mbean;
import java.io.InputStream;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.TimeUnit;
import javax.management.AttributeValueExp;
import javax.management.MBeanServer;
import javax.management.ObjectName;
import javax.management.Query;
import javax.management.QueryExp;
import javax.management.StringValueExp;
import javax.management.openmbean.CompositeData;
import javax.management.openmbean.CompositeDataSupport;
import javax.management.openmbean.CompositeType;
import javax.management.openmbean.TabularData;
import javax.management.openmbean.TabularDataSupport;
import org.apache.camel.CamelContext;
import org.apache.camel.ExtendedCamelContext;
import org.apache.camel.ManagementStatisticsLevel;
import org.apache.camel.Route;
import org.apache.camel.RuntimeCamelException;
import org.apache.camel.ServiceStatus;
import org.apache.camel.TimerListener;
import org.apache.camel.api.management.ManagedResource;
import org.apache.camel.api.management.mbean.CamelOpenMBeanTypes;
import org.apache.camel.api.management.mbean.ManagedProcessorMBean;
import org.apache.camel.api.management.mbean.ManagedRouteMBean;
import org.apache.camel.api.management.mbean.ManagedStepMBean;
import org.apache.camel.api.management.mbean.RouteError;
import org.apache.camel.model.Model;
import org.apache.camel.model.ModelCamelContext;
import org.apache.camel.model.RouteDefinition;
import org.apache.camel.model.RoutesDefinition;
import org.apache.camel.spi.InflightRepository;
import org.apache.camel.spi.ManagementStrategy;
import org.apache.camel.spi.RoutePolicy;
import org.apache.camel.support.PluginHelper;
import org.apache.camel.util.ObjectHelper;
import org.apache.camel.xml.LwModelHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@ManagedResource(description = "Managed Route")
public class ManagedRoute extends ManagedPerformanceCounter implements TimerListener, ManagedRouteMBean {
public static final String VALUE_UNKNOWN = "Unknown";
private static final Logger LOG = LoggerFactory.getLogger(ManagedRoute.class);
protected final Route route;
protected final String description;
protected final String configurationId;
protected final String sourceLocation;
protected final String sourceLocationShort;
protected final CamelContext context;
private final LoadTriplet load = new LoadTriplet();
private final LoadThroughput thp = new LoadThroughput();
private final String jmxDomain;
public ManagedRoute(CamelContext context, Route route) {
this.route = route;
this.context = context;
this.description = route.getDescription();
this.configurationId = route.getConfigurationId();
this.sourceLocation = route.getSourceLocation();
this.sourceLocationShort = route.getSourceLocationShort();
this.jmxDomain = context.getManagementStrategy().getManagementAgent().getMBeanObjectDomainName();
}
@Override
public void init(ManagementStrategy strategy) {
super.init(strategy);
boolean enabled
= context.getManagementStrategy().getManagementAgent().getStatisticsLevel() != ManagementStatisticsLevel.Off;
setStatisticsEnabled(enabled);
}
public Route getRoute() {
return route;
}
public CamelContext getContext() {
return context;
}
@Override
public String getRouteId() {
String id = route.getId();
if (id == null) {
id = VALUE_UNKNOWN;
}
return id;
}
@Override
public String getNodePrefixId() {
return route.getNodePrefixId();
}
@Override
public String getRouteGroup() {
return route.getGroup();
}
@Override
public boolean isCreatedByRouteTemplate() {
return "true".equals(route.getProperties().getOrDefault(Route.TEMPLATE_PROPERTY, "false"));
}
@Override
public boolean isCreatedByKamelet() {
return "true".equals(route.getProperties().getOrDefault(Route.KAMELET_PROPERTY, "false"));
}
@Override
public TabularData getRouteProperties() {
try {
final Map properties = route.getProperties();
final TabularData answer = new TabularDataSupport(CamelOpenMBeanTypes.camelRoutePropertiesTabularType());
final CompositeType ct = CamelOpenMBeanTypes.camelRoutePropertiesCompositeType();
// gather route properties
for (Map.Entry entry : properties.entrySet()) {
final String key = entry.getKey();
final String val = context.getTypeConverter().convertTo(String.class, entry.getValue());
CompositeData data = new CompositeDataSupport(
ct,
new String[] { "key", "value" },
new Object[] { key, val });
answer.put(data);
}
return answer;
} catch (Exception e) {
throw RuntimeCamelException.wrapRuntimeCamelException(e);
}
}
@Override
public String getDescription() {
return description;
}
@Override
public String getSourceLocation() {
return sourceLocation;
}
@Override
public String getSourceLocationShort() {
return sourceLocationShort;
}
@Override
public String getRouteConfigurationId() {
return configurationId;
}
@Override
public String getEndpointUri() {
if (route.getEndpoint() != null) {
return route.getEndpoint().getEndpointUri();
}
return VALUE_UNKNOWN;
}
@Override
public String getState() {
// must use String type to be sure remote JMX can read the attribute without requiring Camel classes.
ServiceStatus status = context.getRouteController().getRouteStatus(route.getId());
// if no status exists then its stopped
if (status == null) {
status = ServiceStatus.Stopped;
}
return status.name();
}
@Override
public String getUptime() {
return route.getUptime();
}
@Override
public long getUptimeMillis() {
return route.getUptimeMillis();
}
@Override
public String getCamelId() {
return context.getName();
}
@Override
public String getCamelManagementName() {
return context.getManagementName();
}
@Override
public Boolean getTracing() {
return route.isTracing();
}
@Override
public void setTracing(Boolean tracing) {
route.setTracing(tracing);
}
@Override
public Boolean getMessageHistory() {
return route.isMessageHistory();
}
@Override
public Boolean getLogMask() {
return route.isLogMask();
}
@Override
public String getRoutePolicyList() {
List policyList = route.getRoutePolicyList();
if (policyList == null || policyList.isEmpty()) {
// return an empty string to have it displayed nicely in JMX consoles
return "";
}
StringBuilder sb = new StringBuilder();
for (int i = 0; i < policyList.size(); i++) {
RoutePolicy policy = policyList.get(i);
sb.append(policy.getClass().getSimpleName());
sb.append("(").append(ObjectHelper.getIdentityHashCode(policy)).append(")");
if (i < policyList.size() - 1) {
sb.append(", ");
}
}
return sb.toString();
}
@Override
public String getLoad01() {
double load1 = load.getLoad1();
if (Double.isNaN(load1)) {
// empty string if load statistics is disabled
return "";
} else {
return String.format("%.2f", load1);
}
}
@Override
public String getLoad05() {
double load5 = load.getLoad5();
if (Double.isNaN(load5)) {
// empty string if load statistics is disabled
return "";
} else {
return String.format("%.2f", load5);
}
}
@Override
public String getLoad15() {
double load15 = load.getLoad15();
if (Double.isNaN(load15)) {
// empty string if load statistics is disabled
return "";
} else {
return String.format("%.2f", load15);
}
}
@Override
public String getThroughput() {
double d = thp.getThroughput();
if (Double.isNaN(d)) {
// empty string if load statistics is disabled
return "";
} else {
return String.format("%.2f", d);
}
}
@Override
public void onTimer() {
load.update(getInflightExchanges());
thp.update(getExchangesTotal());
}
@Override
public void start() throws Exception {
if (!context.getStatus().isStarted()) {
throw new IllegalArgumentException("CamelContext is not started");
}
try {
context.getRouteController().startRoute(getRouteId());
} catch (Exception e) {
LOG.warn("Error starting route: {} due to: {}. This exception is ignored.", getRouteId(), e.getMessage(), e);
throw e;
}
}
@Override
public void stop() throws Exception {
if (!context.getStatus().isStarted()) {
throw new IllegalArgumentException("CamelContext is not started");
}
try {
context.getRouteController().stopRoute(getRouteId());
} catch (Exception e) {
LOG.warn("Error stopping route: {} due to: {}. This exception is ignored.", getRouteId(), e.getMessage(), e);
throw e;
}
}
@Override
public void stopAndFail() throws Exception {
if (!context.getStatus().isStarted()) {
throw new IllegalArgumentException("CamelContext is not started");
}
Throwable cause = new RejectedExecutionException("Route " + getRouteId() + " is forced stopped and marked as failed");
context.getRouteController().stopRoute(getRouteId(), cause);
}
@Override
public void stop(long timeout) throws Exception {
if (!context.getStatus().isStarted()) {
throw new IllegalArgumentException("CamelContext is not started");
}
context.getRouteController().stopRoute(getRouteId(), timeout, TimeUnit.SECONDS);
}
@Override
public boolean stop(Long timeout, Boolean abortAfterTimeout) throws Exception {
if (!context.getStatus().isStarted()) {
throw new IllegalArgumentException("CamelContext is not started");
}
return context.getRouteController().stopRoute(getRouteId(), timeout, TimeUnit.SECONDS, abortAfterTimeout);
}
/**
* @deprecated not in use
*/
@Deprecated(since = "4.8.0")
public void shutdown() throws Exception {
if (!context.getStatus().isStarted()) {
throw new IllegalArgumentException("CamelContext is not started");
}
String routeId = getRouteId();
context.getRouteController().stopRoute(routeId);
context.removeRoute(routeId);
}
/**
* @deprecated not in use
*/
@Deprecated(since = "4.8.0")
public void shutdown(long timeout) throws Exception {
if (!context.getStatus().isStarted()) {
throw new IllegalArgumentException("CamelContext is not started");
}
String routeId = getRouteId();
context.getRouteController().stopRoute(routeId, timeout, TimeUnit.SECONDS);
context.removeRoute(routeId);
}
@Override
public boolean remove() throws Exception {
if (!context.getStatus().isStarted()) {
throw new IllegalArgumentException("CamelContext is not started");
}
return context.removeRoute(getRouteId());
}
@Override
public void restart() throws Exception {
restart(1);
}
@Override
public void restart(long delay) throws Exception {
stop();
if (delay > 0) {
try {
LOG.debug("Sleeping {} seconds before starting route: {}", delay, getRouteId());
Thread.sleep(delay * 1000);
} catch (InterruptedException e) {
LOG.info("Interrupted while waiting before starting the route");
Thread.currentThread().interrupt();
}
}
start();
}
@Override
public String dumpRouteAsXml() throws Exception {
return dumpRouteAsXml(false);
}
@Override
public String dumpRouteAsXml(boolean resolvePlaceholders) throws Exception {
return dumpRouteAsXml(resolvePlaceholders, true);
}
@Override
public String dumpRouteAsXml(boolean resolvePlaceholders, boolean generatedIds) throws Exception {
String id = route.getId();
RouteDefinition def = context.getCamelContextExtension().getContextPlugin(Model.class).getRouteDefinition(id);
if (def != null) {
// if we are debugging then ids is needed for the debugger
if (context.isDebugging()) {
generatedIds = true;
}
return PluginHelper.getModelToXMLDumper(context).dumpModelAsXml(context, def, resolvePlaceholders, generatedIds);
}
return null;
}
@Override
public String dumpRouteAsYaml() throws Exception {
return dumpRouteAsYaml(false, false);
}
@Override
public String dumpRouteAsYaml(boolean resolvePlaceholders) throws Exception {
return dumpRouteAsYaml(resolvePlaceholders, false, true);
}
@Override
public String dumpRouteAsYaml(boolean resolvePlaceholders, boolean uriAsParameters) throws Exception {
return dumpRouteAsYaml(resolvePlaceholders, uriAsParameters, true);
}
@Override
public String dumpRouteAsYaml(boolean resolvePlaceholders, boolean uriAsParameters, boolean generatedIds) throws Exception {
String id = route.getId();
RouteDefinition def = context.getCamelContextExtension().getContextPlugin(Model.class).getRouteDefinition(id);
if (def != null) {
return PluginHelper.getModelToYAMLDumper(context).dumpModelAsYaml(context, def, resolvePlaceholders,
uriAsParameters, generatedIds);
}
return null;
}
@Override
public String dumpRouteStatsAsXml(boolean fullStats, boolean includeProcessors) throws Exception {
// in this logic we need to calculate the accumulated processing time for the processor in the route
// and hence why the logic is a bit more complicated to do this, as we need to calculate that from
// the bottom -> top of the route but this information is valuable for profiling routes
StringBuilder sb = new StringBuilder();
// need to calculate this value first, as we need that value for the route stat
long processorAccumulatedTime = 0L;
// gather all the processors for this route, which requires JMX
if (includeProcessors) {
sb.append(" \n");
MBeanServer server = getContext().getManagementStrategy().getManagementAgent().getMBeanServer();
if (server != null) {
// get all the processor mbeans and sort them accordingly to their index
String prefix = getContext().getManagementStrategy().getManagementAgent().getIncludeHostName() ? "*/" : "";
ObjectName query = ObjectName.getInstance(
jmxDomain + ":context=" + prefix + getContext().getManagementName() + ",type=processors,*");
Set names = server.queryNames(query, null);
List mps = new ArrayList<>();
for (ObjectName on : names) {
ManagedProcessorMBean processor = context.getManagementStrategy().getManagementAgent().newProxyClient(on,
ManagedProcessorMBean.class);
// the processor must belong to this route
if (getRouteId().equals(processor.getRouteId())) {
mps.add(processor);
}
}
mps.sort(new OrderProcessorMBeans());
// walk the processors in reverse order, and calculate the accumulated total time
Map accumulatedTimes = new HashMap<>();
Collections.reverse(mps);
for (ManagedProcessorMBean processor : mps) {
processorAccumulatedTime += processor.getTotalProcessingTime();
accumulatedTimes.put(processor.getProcessorId(), processorAccumulatedTime);
}
// and reverse back again
Collections.reverse(mps);
// and now add the sorted list of processors to the xml output
for (ManagedProcessorMBean processor : mps) {
int line = processor.getSourceLineNumber() != null ? processor.getSourceLineNumber() : -1;
sb.append(" \n");
}
// route self time is route total - processor accumulated total)
long routeSelfTime = getTotalProcessingTime() - processorAccumulatedTime;
if (routeSelfTime < 0) {
// ensure we don't calculate that as negative
routeSelfTime = 0;
}
StringBuilder answer = new StringBuilder();
answer.append("\n");
if (includeProcessors) {
answer.append(sb);
}
answer.append("");
return answer.toString();
}
@Override
public String dumpStepStatsAsXml(boolean fullStats) throws Exception {
// in this logic we need to calculate the accumulated processing time for the processor in the route
// and hence why the logic is a bit more complicated to do this, as we need to calculate that from
// the bottom -> top of the route but this information is valuable for profiling routes
StringBuilder sb = new StringBuilder();
// gather all the steps for this route, which requires JMX
sb.append(" \n");
MBeanServer server = getContext().getManagementStrategy().getManagementAgent().getMBeanServer();
if (server != null) {
// get all the processor mbeans and sort them accordingly to their index
String prefix = getContext().getManagementStrategy().getManagementAgent().getIncludeHostName() ? "*/" : "";
ObjectName query = ObjectName
.getInstance(jmxDomain + ":context=" + prefix + getContext().getManagementName() + ",type=steps,*");
Set names = server.queryNames(query, null);
List mps = new ArrayList<>();
for (ObjectName on : names) {
ManagedStepMBean step
= context.getManagementStrategy().getManagementAgent().newProxyClient(on, ManagedStepMBean.class);
// the step must belong to this route
if (getRouteId().equals(step.getRouteId())) {
mps.add(step);
}
}
mps.sort(new OrderProcessorMBeans());
// and now add the sorted list of steps to the xml output
for (ManagedStepMBean step : mps) {
int line = step.getSourceLineNumber() != null ? step.getSourceLineNumber() : -1;
sb.append(" \n");
StringBuilder answer = new StringBuilder();
answer.append("\n");
answer.append(sb);
answer.append("");
return answer.toString();
}
@Override
public String dumpRouteSourceLocationsAsXml() throws Exception {
StringBuilder sb = new StringBuilder();
sb.append("");
MBeanServer server = getContext().getManagementStrategy().getManagementAgent().getMBeanServer();
if (server != null) {
String prefix = getContext().getManagementStrategy().getManagementAgent().getIncludeHostName() ? "*/" : "";
List processors = new ArrayList<>();
// gather all the processors for this CamelContext, which requires JMX
ObjectName query = ObjectName
.getInstance(jmxDomain + ":context=" + prefix + getContext().getManagementName() + ",type=processors,*");
Set names = server.queryNames(query, null);
for (ObjectName on : names) {
ManagedProcessorMBean processor
= context.getManagementStrategy().getManagementAgent().newProxyClient(on, ManagedProcessorMBean.class);
// the processor must belong to this route
if (getRouteId().equals(processor.getRouteId())) {
processors.add(processor);
}
}
processors.sort(new OrderProcessorMBeans());
// grab route consumer
RouteDefinition rd = ((ModelCamelContext) context).getRouteDefinition(route.getRouteId());
if (rd != null) {
String id = rd.getRouteId();
int line = rd.getInput().getLineNumber();
String location = getSourceLocation() != null ? getSourceLocation() : "";
sb.append("\n ",
route.getRouteId(), id, 0, location, line));
}
for (ManagedProcessorMBean processor : processors) {
// the step must belong to this route
if (route.getRouteId().equals(processor.getRouteId())) {
int line = processor.getSourceLineNumber() != null ? processor.getSourceLineNumber() : -1;
String location = processor.getSourceLocation() != null ? processor.getSourceLocation() : "";
sb.append("\n ",
route.getRouteId(), processor.getProcessorId(), processor.getIndex(), location, line));
}
}
}
sb.append("\n ");
return sb.toString();
}
@Override
public void reset(boolean includeProcessors) throws Exception {
reset();
load.reset();
thp.reset();
// and now reset all processors for this route
if (includeProcessors) {
MBeanServer server = getContext().getManagementStrategy().getManagementAgent().getMBeanServer();
if (server != null) {
// get all the processor mbeans and sort them accordingly to their index
String prefix = getContext().getManagementStrategy().getManagementAgent().getIncludeHostName() ? "*/" : "";
ObjectName query = ObjectName.getInstance(
jmxDomain + ":context=" + prefix + getContext().getManagementName() + ",type=processors,*");
QueryExp queryExp = Query.match(new AttributeValueExp("RouteId"), new StringValueExp(getRouteId()));
Set names = server.queryNames(query, queryExp);
for (ObjectName name : names) {
server.invoke(name, "reset", null, null);
}
}
}
}
@Override
public void updateRouteFromXml(String xml) throws Exception {
// check whether this is allowed
if (!isUpdateRouteEnabled()) {
throw new IllegalAccessException("Updating route is not enabled");
}
// convert to model from xml
ExtendedCamelContext ecc = context.getCamelContextExtension();
InputStream is = context.getTypeConverter().convertTo(InputStream.class, xml);
RoutesDefinition routes = LwModelHelper.loadRoutesDefinition(is);
if (routes == null || routes.getRoutes().isEmpty()) {
return;
}
RouteDefinition def = routes.getRoutes().get(0);
// if the xml does not contain the route-id then we fix this by adding the actual route id
// this may be needed if the route-id was auto-generated, as the intend is to update this route
// and not add a new route, adding a new route, use the MBean operation on ManagedCamelContext instead.
if (ObjectHelper.isEmpty(def.getId())) {
def.setId(getRouteId());
} else if (!def.getId().equals(getRouteId())) {
throw new IllegalArgumentException(
"Cannot update route from XML as routeIds does not match. routeId: "
+ getRouteId() + ", routeId from XML: " + def.getId());
}
LOG.debug("Updating route: {} from xml: {}", def.getId(), xml);
try {
// add will remove existing route first
ecc.getContextPlugin(Model.class).addRouteDefinition(def);
} catch (Exception e) {
// log the error as warn as the management api may be invoked remotely over JMX which does not propagate such exception
String msg = "Error updating route: " + def.getId() + " from xml: " + xml + " due: " + e.getMessage();
LOG.warn(msg, e);
throw e;
}
}
@Override
public boolean isUpdateRouteEnabled() {
// check whether this is allowed
Boolean enabled = context.getManagementStrategy().getManagementAgent().getUpdateRouteEnabled();
return enabled != null ? enabled : false;
}
@Override
public boolean isRemoteEndpoint() {
if (route.getEndpoint() != null) {
return route.getEndpoint().isRemote();
}
return false;
}
@Override
public boolean equals(Object o) {
return this == o || o != null && getClass() == o.getClass() && route.equals(((ManagedRoute) o).route);
}
@Override
public int hashCode() {
return route.hashCode();
}
private InflightRepository.InflightExchange getOldestInflightEntry() {
return getContext().getInflightRepository().oldest(getRouteId());
}
@Override
public Long getOldestInflightDuration() {
InflightRepository.InflightExchange oldest = getOldestInflightEntry();
if (oldest == null) {
return null;
} else {
return oldest.getDuration();
}
}
@Override
public String getOldestInflightExchangeId() {
InflightRepository.InflightExchange oldest = getOldestInflightEntry();
if (oldest == null) {
return null;
} else {
return oldest.getExchange().getExchangeId();
}
}
@Override
public Boolean getHasRouteController() {
return route.getRouteController() != null;
}
@Override
public RouteError getLastError() {
org.apache.camel.spi.RouteError error = route.getLastError();
if (error == null) {
return null;
} else {
return new RouteError() {
@Override
public Phase getPhase() {
if (error.getPhase() != null) {
switch (error.getPhase()) {
case START:
return Phase.START;
case STOP:
return Phase.STOP;
case SUSPEND:
return Phase.SUSPEND;
case RESUME:
return Phase.RESUME;
case SHUTDOWN:
return Phase.SHUTDOWN;
case REMOVE:
return Phase.REMOVE;
default:
throw new IllegalStateException();
}
}
return null;
}
@Override
public Throwable getException() {
return error.getException();
}
@Override
public Date getDate() {
return error.getDate();
}
};
}
}
@Override
public Collection processorIds() throws Exception {
List ids = new ArrayList<>();
MBeanServer server = getContext().getManagementStrategy().getManagementAgent().getMBeanServer();
if (server != null) {
String prefix = getContext().getManagementStrategy().getManagementAgent().getIncludeHostName() ? "*/" : "";
// gather all the processors for this CamelContext, which requires JMX
ObjectName query = ObjectName
.getInstance(jmxDomain + ":context=" + prefix + getContext().getManagementName() + ",type=processors,*");
Set names = server.queryNames(query, null);
for (ObjectName on : names) {
ManagedProcessorMBean processor
= context.getManagementStrategy().getManagementAgent().newProxyClient(on, ManagedProcessorMBean.class);
// the processor must belong to this route
if (getRouteId().equals(processor.getRouteId())) {
ids.add(processor.getProcessorId());
}
}
}
return ids;
}
private Integer getInflightExchanges() {
return (int) super.getExchangesInflight();
}
/**
* Used for sorting the processor mbeans accordingly to their index.
*/
private static final class OrderProcessorMBeans implements Comparator, Serializable {
@Override
public int compare(ManagedProcessorMBean o1, ManagedProcessorMBean o2) {
return o1.getIndex().compareTo(o2.getIndex());
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy