SPY-133: Add additional metrics support.

This changeset adds basic metrics for performance measurement and
debug support. It is optional and can be enabled through the factory
or via a system property.

The collected values can be exported through:
 - The Console
 - JMX
 - CSV
 - SLF4J

These output reporters can also be configured through properties, by
default the console reporter will be used.

Change-Id: If206f0be0c0bd6c6ff11d63f1be25debab2e524e
Reviewed-on: http://review.couchbase.org/28575
Reviewed-by: Michael Nitschinger <[email protected]>
Tested-by: Michael Nitschinger <[email protected]>

Author: daschl

build.xml

@@ -505,6 +505,7 @@
       <dependency group="log4j" artifact="log4j" version="${log4j.version}" optional="true" />
       <dependency group="org.slf4j" artifact="slf4j-api" version="${slf4j.version}" optional="true" />
       <dependency group="org.springframework" artifact="spring-beans" version="${spring-beans.version}" optional="true" />
+      <dependency group="com.codahale.metrics" artifact="metrics-core" version="${codahale.metrics.version}" optional="true" />
     </ivy:makepom>
 
     <ivy:makepom ivyfile="ivy/spymemcached-test.xml"
@@ -516,6 +517,7 @@
       <dependency group="log4j" artifact="log4j" version="${log4j.version}" optional="true" />
       <dependency group="org.slf4j" artifact="slf4j-api" version="${slf4j.version}" optional="true" />
       <dependency group="org.springframework" artifact="spring-beans" version="${spring-beans.version}" optional="true" />
+      <dependency group="com.codahale.metrics" artifact="metrics-core" version="${codahale.metrics.version}" />
    </ivy:makepom>
 
     <!-- Change the version in the pom file to reflect our claimed version. -->
@@ -700,8 +702,8 @@
         <exclude name="LICENSE.txt" />
         <exclude name="README.markdown" />
         <exclude name=".gitreview" />
-	<exclude name=".git/** />
-	<exclude name=".idea/** />
+	<exclude name=".git/**" />
+	<exclude name=".idea/**" />
       </fileset>
     </delete>
   </target>

ivy.xml

@@ -58,6 +58,8 @@ SOFTWARE.
         conf="common->master" />
     <dependency org="org.springframework" name="spring-beans"
         rev="${spring-beans.version}" conf="common->master" />
+    <dependency org="com.codahale.metrics" name="metrics-core"
+	rev="${codahale.metrics.version}" conf="common->master" />
     <dependency org="checkstyle" name="checkstyle" rev="${checkstyle.version}"
         conf="checkstyle->default" />
     <dependency org="com.google.code.findbugs" name="findbugs"

ivy/libraries.properties

@@ -30,3 +30,4 @@ junit.version=4.7
 log4j.version=1.2.16
 slf4j.version=1.7.5
 spring-beans.version=3.0.3.RELEASE
+codahale.metrics.version=3.0.1

src/main/java/net/spy/memcached/ConnectionFactory.java

@@ -1,5 +1,6 @@
 /**
  * Copyright (C) 2006-2009 Dustin Sallings
+ * Copyright (C) 2009-2013 Couchbase, Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -31,6 +32,8 @@
 import java.util.concurrent.BlockingQueue;
 
 import net.spy.memcached.auth.AuthDescriptor;
+import net.spy.memcached.metrics.MetricCollector;
+import net.spy.memcached.metrics.MetricType;
 import net.spy.memcached.ops.Operation;
 import net.spy.memcached.transcoders.Transcoder;
 
@@ -158,4 +161,14 @@ MemcachedNode createMemcachedNode(SocketAddress sa, SocketChannel c,
    * Maximum number of timeout exception for shutdown connection.
    */
   int getTimeoutExceptionThreshold();
+
+  /**
+   * If true, metric collections are enabled.
+   */
+  MetricType enableMetrics();
+
+  /**
+   * The currently active {@link MetricCollector}.
+   */
+  MetricCollector getMetricCollector();
 }

src/main/java/net/spy/memcached/ConnectionFactoryBuilder.java

@@ -1,6 +1,6 @@
 /**
  * Copyright (C) 2006-2009 Dustin Sallings
- * Copyright (C) 2009-2011 Couchbase, Inc.
+ * Copyright (C) 2009-2013 Couchbase, Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -29,6 +29,8 @@
 import java.util.concurrent.BlockingQueue;
 
 import net.spy.memcached.auth.AuthDescriptor;
+import net.spy.memcached.metrics.MetricCollector;
+import net.spy.memcached.metrics.MetricType;
 import net.spy.memcached.ops.Operation;
 import net.spy.memcached.ops.OperationQueueFactory;
 import net.spy.memcached.protocol.ascii.AsciiOperationFactory;
@@ -69,6 +71,9 @@ public class ConnectionFactoryBuilder {
   protected int timeoutExceptionThreshold =
       DefaultConnectionFactory.DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD;
 
+  protected MetricType metricType = null;
+  protected MetricCollector collector = null;
+
   /**
    * Set the operation queue factory.
    */
@@ -91,6 +96,7 @@ public ConnectionFactoryBuilder(ConnectionFactory cf) {
     setTimeoutExceptionThreshold(cf.getTimeoutExceptionThreshold());
     setTranscoder(cf.getDefaultTranscoder());
     setUseNagleAlgorithm(cf.useNagleAlgorithm());
+    setEnableMetrics(cf.enableMetrics());
   }
 
   public ConnectionFactoryBuilder setOpQueueFactory(OperationQueueFactory q) {
@@ -264,6 +270,26 @@ public ConnectionFactoryBuilder setTimeoutExceptionThreshold(int to) {
     return this;
   }
 
+  /**
+   * Enable or disable metric collection.
+   *
+   * @param type the metric type to use (or disable).
+   */
+  public ConnectionFactoryBuilder setEnableMetrics(MetricType type) {
+    metricType = type;
+    return this;
+  }
+
+  /**
+   * Set a custom {@link MetricCollector}.
+   *
+   * @param collector the metric collector to use.
+   */
+  public ConnectionFactoryBuilder setMetricCollector(MetricCollector collector) {
+    this.collector = collector;
+    return this;
+  }
+
   /**
    * Get the ConnectionFactory set up with the provided parameters.
    */
@@ -370,6 +396,16 @@ public int getTimeoutExceptionThreshold() {
         return timeoutExceptionThreshold;
       }
 
+      @Override
+      public MetricType enableMetrics() {
+        return metricType == null ? super.enableMetrics() : metricType;
+      }
+
+      @Override
+      public MetricCollector getMetricCollector() {
+        return collector == null ? super.getMetricCollector() : collector;
+      }
+
     };
 
   }

src/main/java/net/spy/memcached/DefaultConnectionFactory.java

@@ -1,6 +1,6 @@
 /**
  * Copyright (C) 2006-2009 Dustin Sallings
- * Copyright (C) 2009-2011 Couchbase, Inc.
+ * Copyright (C) 2009-2013 Couchbase, Inc.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -37,6 +37,10 @@
 
 import net.spy.memcached.auth.AuthDescriptor;
 import net.spy.memcached.compat.SpyObject;
+import net.spy.memcached.metrics.DefaultMetricCollector;
+import net.spy.memcached.metrics.MetricCollector;
+import net.spy.memcached.metrics.MetricType;
+import net.spy.memcached.metrics.NoopMetricCollector;
 import net.spy.memcached.ops.Operation;
 import net.spy.memcached.protocol.ascii.AsciiMemcachedNodeImpl;
 import net.spy.memcached.protocol.ascii.AsciiOperationFactory;
@@ -105,10 +109,17 @@ public class DefaultConnectionFactory extends SpyObject implements
    */
   public static final int DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD = 998;
 
+  /**
+   * Turn off metric collection by default.
+   */
+  public static final MetricType DEFAULT_METRIC_TYPE = MetricType.OFF;
+
   protected final int opQueueLen;
   private final int readBufSize;
   private final HashAlgorithm hashAlg;
 
+  private MetricCollector metrics;
+
   /**
    * Construct a DefaultConnectionFactory with the given parameters.
    *
@@ -121,6 +132,7 @@ public DefaultConnectionFactory(int qLen, int bufSize, HashAlgorithm hash) {
     opQueueLen = qLen;
     readBufSize = bufSize;
     hashAlg = hash;
+    metrics = null;
   }
 
   /**
@@ -345,6 +357,31 @@ public int getTimeoutExceptionThreshold() {
     return DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD;
   }
 
+  @Override
+  public MetricType enableMetrics() {
+    String metricType = System.getProperty("net.spy.metrics.type");
+    return metricType == null
+      ? DEFAULT_METRIC_TYPE : MetricType.valueOf(metricType.toUpperCase());
+  }
+
+  @Override
+  public MetricCollector getMetricCollector() {
+    if (metrics != null) {
+      return metrics;
+    }
+
+    String enableMetrics = System.getProperty("net.spy.metrics.enable");
+    if (enableMetrics().equals(MetricType.OFF) || enableMetrics == "false") {
+      getLogger().debug("Metric collection disabled.");
+      metrics =  new NoopMetricCollector();
+    } else {
+      getLogger().info("Metric collection enabled (Profile " + enableMetrics() + ").");
+      metrics = new DefaultMetricCollector();
+    }
+
+    return metrics;
+  }
+
   protected String getName() {
     return "DefaultConnectionFactory";
   }