Updated Branches: refs/heads/master 323008c50 -> 9fd52855a
CAMEL-6476: Introducing StreamCachingStrategy SPI to make it easier to configure and allow 3rd party to plugin custom strategies. Work in progress. Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/d8b8dc14 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/d8b8dc14 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/d8b8dc14 Branch: refs/heads/master Commit: d8b8dc1441a4104703e80f3f21290861c21a9dec Parents: 323008c Author: Claus Ibsen <[email protected]> Authored: Sun Jul 21 22:19:50 2013 +0200 Committer: Claus Ibsen <[email protected]> Committed: Sun Jul 21 22:19:50 2013 +0200 ---------------------------------------------------------------------- .../ManagedStreamCachingStrategyMBean.java | 10 +++ .../impl/DefaultStreamCachingStrategy.java | 95 +++++++++++++------- .../mbean/ManagedStreamCachingStrategy.java | 21 ++++- .../apache/camel/spi/StreamCachingStrategy.java | 62 +++++++++---- .../xml/AbstractCamelContextFactoryBean.java | 4 + .../CamelStreamCachingStrategyDefinition.java | 10 +++ .../camel/karaf/commands/ContextInfo.java | 12 +-- 7 files changed, 157 insertions(+), 57 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/d8b8dc14/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedStreamCachingStrategyMBean.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedStreamCachingStrategyMBean.java b/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedStreamCachingStrategyMBean.java index 7cf3bf4..124365c 100644 --- a/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedStreamCachingStrategyMBean.java +++ b/camel-core/src/main/java/org/apache/camel/api/management/mbean/ManagedStreamCachingStrategyMBean.java @@ -17,6 +17,7 @@ package org.apache.camel.api.management.mbean; import org.apache.camel.api.management.ManagedAttribute; +import org.apache.camel.api.management.ManagedOperation; public interface ManagedStreamCachingStrategyMBean { @@ -59,4 +60,13 @@ public interface ManagedStreamCachingStrategyMBean { @ManagedAttribute(description = "Total accumulated number of bytes which has been stream cached for spooled StreamCache") long getCacheSpoolSize(); + @ManagedAttribute(description = "Whether utilization statistics is enabled") + boolean isStatisticsEnabled(); + + @ManagedAttribute(description = "Whether utilization statistics is enabled") + void setStatisticsEnabled(boolean enabled); + + @ManagedOperation(description = "Reset the utilization statistics") + void resetStatistics(); + } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/d8b8dc14/camel-core/src/main/java/org/apache/camel/impl/DefaultStreamCachingStrategy.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/impl/DefaultStreamCachingStrategy.java b/camel-core/src/main/java/org/apache/camel/impl/DefaultStreamCachingStrategy.java index 5e57f2e..f32c0e7 100644 --- a/camel-core/src/main/java/org/apache/camel/impl/DefaultStreamCachingStrategy.java +++ b/camel-core/src/main/java/org/apache/camel/impl/DefaultStreamCachingStrategy.java @@ -37,7 +37,6 @@ public class DefaultStreamCachingStrategy extends org.apache.camel.support.Servi // TODO: logic for spool to disk in this class so we can control this // TODO: add memory based watermarks for spool to disk - // TODO: add statistics on|off option and also have avg size stats @Deprecated public static final String THRESHOLD = "CamelCachedOutputStreamThreshold"; @@ -58,10 +57,7 @@ public class DefaultStreamCachingStrategy extends org.apache.camel.support.Servi private String spoolChiper; private int bufferSize = IOHelper.DEFAULT_BUFFER_SIZE; private boolean removeSpoolDirectoryWhenStopping = true; - private volatile long cacheMemoryCounter; - private volatile long cacheSpoolCounter; - private volatile long cacheMemorySize; - private volatile long cacheSpoolSize; + private final UtilizationStatistics statistics = new UtilizationStatistics(); public CamelContext getCamelContext() { return camelContext; @@ -123,36 +119,22 @@ public class DefaultStreamCachingStrategy extends org.apache.camel.support.Servi this.removeSpoolDirectoryWhenStopping = removeSpoolDirectoryWhenStopping; } - public long getCacheMemoryCounter() { - return cacheMemoryCounter; - } - - public long getCacheSpoolCounter() { - return cacheSpoolCounter; - } - - public long getCacheMemorySize() { - return cacheMemorySize; - } - - public long getCacheSpoolSize() { - return cacheSpoolSize; + public Statistics getStatistics() { + return statistics; } public StreamCache cache(Exchange exchange) { StreamCache cache = exchange.getIn().getBody(StreamCache.class); - try { - if (cache != null) { + if (cache != null && statistics.isStatisticsEnabled()) { + try { if (cache.inMemory()) { - cacheMemoryCounter++; - cacheMemorySize += cache.length(); + statistics.updateMemory(cache.length()); } else { - cacheSpoolCounter++; - cacheSpoolSize += cache.length(); + statistics.updateSpool(cache.length()); } + } catch (Exception e) { + LOG.debug("Error updating cache statistics. This exception is ignored.", e); } - } catch (Exception e) { - LOG.debug("Error updating cache statistics. This exception is ignored.", e); } return cache; } @@ -257,10 +239,7 @@ public class DefaultStreamCachingStrategy extends org.apache.camel.support.Servi FileUtil.removeDir(spoolDirectory); } - cacheMemoryCounter = 0; - cacheSpoolCounter = 0; - cacheMemorySize = 0; - cacheSpoolSize = 0; + statistics.reset(); } @Override @@ -271,4 +250,58 @@ public class DefaultStreamCachingStrategy extends org.apache.camel.support.Servi + ", spoolChiper=" + spoolChiper + ", bufferSize=" + bufferSize + "]"; } + + /** + * Represents utilization statistics + */ + private final class UtilizationStatistics implements Statistics { + + private boolean statisticsEnabled; + private volatile long memoryCounter; + private volatile long memorySize; + private volatile long spoolCounter; + private volatile long spoolSize; + + void updateMemory(long size) { + memoryCounter++; + memorySize += size; + } + + void updateSpool(long size) { + spoolCounter++; + spoolSize += size; + } + + public long getCacheMemoryCounter() { + return memoryCounter; + } + + public long getCacheSpoolCounter() { + return spoolCounter; + } + + public long getCacheMemorySize() { + return memorySize; + } + + public long getCacheSpoolSize() { + return spoolSize; + } + + public void reset() { + memoryCounter = 0; + memorySize = 0; + spoolCounter = 0; + spoolSize = 0; + } + + public boolean isStatisticsEnabled() { + return statisticsEnabled; + } + + public void setStatisticsEnabled(boolean statisticsEnabled) { + this.statisticsEnabled = statisticsEnabled; + } + } + } http://git-wip-us.apache.org/repos/asf/camel/blob/d8b8dc14/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedStreamCachingStrategy.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedStreamCachingStrategy.java b/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedStreamCachingStrategy.java index a731c6e..cd97df7 100644 --- a/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedStreamCachingStrategy.java +++ b/camel-core/src/main/java/org/apache/camel/management/mbean/ManagedStreamCachingStrategy.java @@ -83,18 +83,31 @@ public class ManagedStreamCachingStrategy extends ManagedService implements Mana } public long getCacheMemoryCounter() { - return streamCachingStrategy.getCacheMemoryCounter(); + return streamCachingStrategy.getStatistics().getCacheMemoryCounter(); } public long getCacheSpoolCounter() { - return streamCachingStrategy.getCacheSpoolCounter(); + return streamCachingStrategy.getStatistics().getCacheSpoolCounter(); } public long getCacheMemorySize() { - return streamCachingStrategy.getCacheMemorySize(); + return streamCachingStrategy.getStatistics().getCacheMemorySize(); } public long getCacheSpoolSize() { - return streamCachingStrategy.getCacheSpoolSize(); + return streamCachingStrategy.getStatistics().getCacheSpoolSize(); } + + public boolean isStatisticsEnabled() { + return streamCachingStrategy.getStatistics().isStatisticsEnabled(); + } + + public void setStatisticsEnabled(boolean enabled) { + streamCachingStrategy.getStatistics().setStatisticsEnabled(enabled); + } + + public void resetStatistics() { + streamCachingStrategy.getStatistics().reset(); + } + } http://git-wip-us.apache.org/repos/asf/camel/blob/d8b8dc14/camel-core/src/main/java/org/apache/camel/spi/StreamCachingStrategy.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/spi/StreamCachingStrategy.java b/camel-core/src/main/java/org/apache/camel/spi/StreamCachingStrategy.java index 858b50e..7bc2d22 100644 --- a/camel-core/src/main/java/org/apache/camel/spi/StreamCachingStrategy.java +++ b/camel-core/src/main/java/org/apache/camel/spi/StreamCachingStrategy.java @@ -28,6 +28,49 @@ import org.apache.camel.StreamCache; public interface StreamCachingStrategy extends Service { /** + * Utilization statistics of stream caching. + */ + interface Statistics { + + /** + * Gets the counter for number of in-memory {@link StreamCache} created. + */ + long getCacheMemoryCounter(); + + /** + * Gets the counter for number of spooled (not in-memory) {@link StreamCache} created. + */ + long getCacheSpoolCounter(); + + /** + * Gets the total accumulated number of bytes which has been stream cached for in-memory stream caches. + */ + long getCacheMemorySize(); + + /** + * Gets the total accumulated number of bytes which has been stream cached for spooled stream caches. + */ + long getCacheSpoolSize(); + + /** + * Reset the counters + */ + void reset(); + + /** + * Whether statistics is enabled. + */ + boolean isStatisticsEnabled(); + + /** + * Sets whether statistics is enabled. + * + * @param statisticsEnabled <tt>true</tt> to enable + */ + void setStatisticsEnabled(boolean statisticsEnabled); + } + + /** * Sets whether the stream caching is enabled. * <p/> * <b>Notice:</b> This cannot be changed at runtime. @@ -86,24 +129,9 @@ public interface StreamCachingStrategy extends Service { boolean isRemoveSpoolDirectoryWhenStopping(); /** - * Gets the counter for number of in-memory {@link StreamCache} created. - */ - long getCacheMemoryCounter(); - - /** - * Gets the counter for number of spooled (not in-memory) {@link StreamCache} created. - */ - long getCacheSpoolCounter(); - - /** - * Gets the total accumulated number of bytes which has been stream cached for in-memory stream caches. - */ - long getCacheMemorySize(); - - /** - * Gets the total accumulated number of bytes which has been stream cached for spooled stream caches. + * Gets the utilization statistics. */ - long getCacheSpoolSize(); + Statistics getStatistics(); /** * Caches the body aas a {@link StreamCache}. http://git-wip-us.apache.org/repos/asf/camel/blob/d8b8dc14/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelContextFactoryBean.java ---------------------------------------------------------------------- diff --git a/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelContextFactoryBean.java b/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelContextFactoryBean.java index 15b1c2d..4b2de19 100644 --- a/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelContextFactoryBean.java +++ b/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelContextFactoryBean.java @@ -397,6 +397,10 @@ public abstract class AbstractCamelContextFactoryBean<T extends ModelCamelContex if (remove != null) { getContext().getStreamCachingStrategy().setRemoveSpoolDirectoryWhenStopping(remove); } + Boolean statisticsEnabled = CamelContextHelper.parseBoolean(getContext(), streamCaching.getStatisticsEnabled()); + if (statisticsEnabled != null) { + getContext().getStreamCachingStrategy().getStatistics().setStatisticsEnabled(statisticsEnabled); + } } protected void initPropertyPlaceholder() throws Exception { http://git-wip-us.apache.org/repos/asf/camel/blob/d8b8dc14/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelStreamCachingStrategyDefinition.java ---------------------------------------------------------------------- diff --git a/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelStreamCachingStrategyDefinition.java b/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelStreamCachingStrategyDefinition.java index 4a526d5..157ff41 100644 --- a/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelStreamCachingStrategyDefinition.java +++ b/components/camel-core-xml/src/main/java/org/apache/camel/core/xml/CamelStreamCachingStrategyDefinition.java @@ -50,6 +50,9 @@ public class CamelStreamCachingStrategyDefinition extends IdentifiedType { @XmlAttribute private String removeSpoolDirectoryWhenStopping; + @XmlAttribute + private String statisticsEnabled; + public String getEnabled() { return enabled; } @@ -98,4 +101,11 @@ public class CamelStreamCachingStrategyDefinition extends IdentifiedType { this.removeSpoolDirectoryWhenStopping = removeSpoolDirectoryWhenStopping; } + public String getStatisticsEnabled() { + return statisticsEnabled; + } + + public void setStatisticsEnabled(String statisticsEnabled) { + this.statisticsEnabled = statisticsEnabled; + } } \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/d8b8dc14/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextInfo.java ---------------------------------------------------------------------- diff --git a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextInfo.java b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextInfo.java index c6b3f7f..6e77b7f 100644 --- a/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextInfo.java +++ b/platforms/karaf/commands/src/main/java/org/apache/camel/karaf/commands/ContextInfo.java @@ -153,11 +153,13 @@ public class ContextInfo extends OsgiCommandSupport { camelContext.getStreamCachingStrategy().getBufferSize(), camelContext.getStreamCachingStrategy().isRemoveSpoolDirectoryWhenStopping()))); - System.out.println(StringEscapeUtils.unescapeJava(String.format("\t [cacheMemoryCounter=%s, cacheMemorySize=%s, cacheSpoolCounter=%s, cacheSpoolSize=%s]", - camelContext.getStreamCachingStrategy().getCacheMemoryCounter(), - camelContext.getStreamCachingStrategy().getCacheMemorySize(), - camelContext.getStreamCachingStrategy().getCacheSpoolCounter(), - camelContext.getStreamCachingStrategy().getCacheSpoolSize()))); + if (camelContext.getStreamCachingStrategy().getStatistics().isStatisticsEnabled()) { + System.out.println(StringEscapeUtils.unescapeJava(String.format("\t [cacheMemoryCounter=%s, cacheMemorySize=%s, cacheSpoolCounter=%s, cacheSpoolSize=%s]", + camelContext.getStreamCachingStrategy().getStatistics().getCacheMemoryCounter(), + camelContext.getStreamCachingStrategy().getStatistics().getCacheMemorySize(), + camelContext.getStreamCachingStrategy().getStatistics().getCacheSpoolCounter(), + camelContext.getStreamCachingStrategy().getStatistics().getCacheSpoolSize()))); + } } long activeRoutes = 0;
