Orbit Metrics Round 2

actors/extensions/metrics/pom.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--~
+Copyright (C) 2015 Electronic Arts Inc.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1.  Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+2.  Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+3.  Neither the name of Electronic Arts, Inc. ("EA") nor the names of
+    its contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY ELECTRONIC ARTS AND ITS CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL ELECTRONIC ARTS OR ITS CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+  -->
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <groupId>com.ea.orbit</groupId>
+        <artifactId>orbit-actors-parent</artifactId>
+        <version>0.3.2-SNAPSHOT</version>
+        <relativePath>../..</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <name>Orbit Actors Extension: Metrics Support</name>
+    <artifactId>orbit-actors-metrics</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.ea.orbit</groupId>
+            <artifactId>orbit-actors-core</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.ea.orbit</groupId>
+            <artifactId>orbit-metrics</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+
+</project>

actors/extensions/metrics/src/main/java/com/ea/orbit/actors/extensions/metrics/MetricsLifetimeExtension.java

@@ -0,0 +1,82 @@
+/*
+Copyright (C) 2015 Electronic Arts Inc.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1.  Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+2.  Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+3.  Neither the name of Electronic Arts, Inc. ("EA") nor the names of
+    its contributors may be used to endorse or promote products derived
+    from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY ELECTRONIC ARTS AND ITS CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL ELECTRONIC ARTS OR ITS CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+package com.ea.orbit.actors.extensions.metrics;
+
+import com.ea.orbit.actors.extensions.LifetimeExtension;
+import com.ea.orbit.actors.runtime.AbstractActor;
+import com.ea.orbit.actors.runtime.ActorReference;
+import com.ea.orbit.concurrent.Task;
+import com.ea.orbit.metrics.MetricsManager;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * {@link MetricsLifetimeExtension} allows for automatic registration and deregistration of annotated Orbit Metrics
+ *
+ */
+public class MetricsLifetimeExtension implements LifetimeExtension
+{
+    private static final Logger logger = LoggerFactory.getLogger(MetricsLifetimeExtension.class);
+    @Override
+    public Task preActivation(AbstractActor actor)
+    {
+        try
+        {
+            String actorId = ActorReference.getId(ActorReference.from(actor)).toString();
+            MetricsManager.getInstance().registerExportedMetrics(actor, actorId);
+        }
+        catch(Exception ex)
+        {
+           logger.error("Unexpected error while registering Actor Metrics for " + actor.getClass().getName() + ": " + ex.getMessage());
+        }
+        finally
+        {
+            return Task.done();
+        }
+    }
+
+    @Override
+    public Task postDeactivation(final AbstractActor<?> actor)
+    {
+        try
+        {
+            String actorId = ActorReference.getId(ActorReference.from(actor)).toString();
+            MetricsManager.getInstance().unregisterExportedMetrics(actor, actorId);
+        }
+        catch(Exception ex)
+        {
+            logger.error("Unexpected error while unregistering Actor Metrics for " + actor.getClass().getName() + ": " + ex.getMessage());
+        }
+        finally
+        {
+            return Task.done();
+        }
+    }
+}

actors/pom.xml

@@ -53,6 +53,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
         <module>extensions/postgresql</module>
         <module>extensions/spring</module>
         <module>extensions/memcached</module>
+        <module>extensions/metrics</module>
         <module>test/actor-tests</module>
         <module>actors-all</module>
     </modules>

actors/stage/pom.xml

@@ -70,5 +70,12 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
             <artifactId>guava</artifactId>
             <version>18.0</version>
         </dependency>
+
+        <dependency>
+            <groupId>com.ea.orbit</groupId>
+            <artifactId>orbit-metrics</artifactId>
+            <version>${project.version}</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 </project>

actors/stage/src/main/java/com/ea/orbit/actors/Stage.java

@@ -34,6 +34,7 @@
 import com.ea.orbit.actors.cluster.NodeAddress;
 import com.ea.orbit.actors.extensions.LifetimeExtension;
 import com.ea.orbit.actors.extensions.ActorExtension;
+import com.ea.orbit.metrics.config.ReporterConfig;
 import com.ea.orbit.actors.runtime.Execution;
 import com.ea.orbit.actors.runtime.Hosting;
 import com.ea.orbit.actors.runtime.NodeCapabilities;
@@ -51,10 +52,12 @@
 
 import javax.inject.Singleton;
 
+import java.lang.reflect.Method;
 import java.time.Clock;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.ExecutorService;
 
 @Singleton
@@ -74,6 +77,9 @@ public class Stage implements Startable
     @Config("orbit.actors.extensions")
     private List<ActorExtension> extensions = new ArrayList<>();
 
+    @Config("orbit.metrics.reporters")
+    private List<ReporterConfig> metricsConfig = new ArrayList<>();
+
     @Wired
     Container container;
 
@@ -241,6 +247,8 @@ public Task<?> start()
         hosting.start();
         execution.start();
 
+        startMetrics();
+
         Task<?> future = clusterPeer.join(clusterName, nodeName);
         if (mode == StageMode.HOST)
         {
@@ -281,7 +289,7 @@ public void setClusterPeer(final ClusterPeer clusterPeer)
 
     /**
      * Installs extensions to the stage.
-     * <p/>
+     * <p>
      * Example:
      * <pre>
      * stage.addExtension(new MongoDbProvider(...));
@@ -306,7 +314,9 @@ public Task<?> stop()
         // * wait pending tasks execution
         // * stop the network
         return execution.stop()
-                .thenRun(clusterPeer::leave);
+                .thenRun(clusterPeer::leave).thenRun(() -> {
+                    unregisterMetrics();
+                });
     }
 
     /**
@@ -365,15 +375,15 @@ public void cleanup(boolean block)
     /**
      * Binds this stage to the current thread.
      * This tells ungrounded references to use this stage to call remote methods.
-     * <p/>
+     * <p>
      * An ungrounded reference is a reference created with {@code Actor.getReference} and used outside of an actor method.
-     * <p/>
+     * <p>
      * This is only necessary when there are <i>two or more</i> OrbitStages active in the same virtual machine and
      * remote calls need to be issued from outside an actor.
      * This method was created to help with test cases.
-     * <p/>
+     * <p>
      * A normal application will have a single stage and should have no reason to call this method.
-     * <p/>
+     * <p>
      * This method writes a weak reference to the runtime in a thread local.
      * No cleanup is necessary, so none is available.
      */
@@ -404,4 +414,48 @@ public NodeCapabilities.NodeState getState()
     {
         return execution.getState();
     }
+
+    private void startMetrics()
+    {
+        try
+        {
+            Class mmClazz = Class.forName("com.ea.orbit.metrics.MetricsManager"); //make sure the metrics manager is on the classpath.
+            Method getInstanceMethod = mmClazz.getDeclaredMethod("getInstance");
+            Method initializeMetricsMethod = mmClazz.getDeclaredMethod("initializeMetrics", List.class);
+            Method registerExportedMetricsMethod = mmClazz.getDeclaredMethod("registerExportedMetrics", Object.class, String.class);
+
+            Object managerObject = getInstanceMethod.invoke(null, null);
+            initializeMetricsMethod.invoke(managerObject, metricsConfig);
+            registerExportedMetricsMethod.invoke(managerObject, execution, execution.runtimeIdentity());
+        }
+        catch (ClassNotFoundException ex)
+        {
+            //OK. Just means that metrics isn't being used.
+        }
+        catch (Exception ex)
+        {
+            logger.error("Unexpected error while initializing Orbit Metrics: " + ex.getMessage());
+        }
+    }
+
+    private void unregisterMetrics()
+    {
+        try
+        {
+            Class mmClazz = Class.forName("com.ea.orbit.metrics.MetricsManager"); //make sure the metrics manager is on the classpath.
+            Method getInstanceMethod = mmClazz.getDeclaredMethod("getInstance");
+            Method unregisterExportedMetricsMethod = mmClazz.getDeclaredMethod("unregisterExportedMetrics", Object.class, String.class);
+
+            Object managerObject = getInstanceMethod.invoke(null, null);
+            unregisterExportedMetricsMethod.invoke(managerObject, execution, execution.runtimeIdentity());
+        }
+        catch (ClassNotFoundException ex)
+        {
+            //OK. Just means that metrics isn't being used.
+        }
+        catch (Exception ex)
+        {
+            logger.error("Unexpected error while unregistering execution metrics: " + ex.getMessage());
+        }
+    }
 }

actors/stage/src/main/java/com/ea/orbit/actors/runtime/Execution.java

@@ -40,6 +40,8 @@
 import com.ea.orbit.actors.extensions.LifetimeExtension;
 import com.ea.orbit.actors.extensions.ActorExtension;
 import com.ea.orbit.actors.extensions.InvocationContext;
+import com.ea.orbit.metrics.annotations.ExportMetric;
+import com.ea.orbit.metrics.annotations.MetricScope;
 import com.ea.orbit.concurrent.ExecutorUtils;
 import com.ea.orbit.concurrent.Task;
 import com.ea.orbit.container.Startable;
@@ -1199,4 +1201,28 @@ public NodeCapabilities.NodeState getState()
     {
         return state;
     }
+
+    @ExportMetric(name="localActorCount", scope=MetricScope.PROTOTYPE)
+    public long getLocalActorCount()
+    {
+        return localActors.size();
+    }
+
+    @ExportMetric(name="messagesReceived", scope=MetricScope.PROTOTYPE)
+    public long getMessagesReceived()
+    {
+        return messagesReceived.longValue();
+    }
+
+    @ExportMetric(name="messagesHandled", scope=MetricScope.PROTOTYPE)
+    public long getMessagesHandled()
+    {
+        return messagesHandled.longValue();
+    }
+
+    @ExportMetric(name="refusedExecutions",scope=MetricScope.PROTOTYPE)
+    public long getRefusedExecutions()
+    {
+        return refusedExecutions.longValue();
+    }
 }

pom.xml

@@ -49,6 +49,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
         <module>samples</module>
         <module>packaging/all-docs</module>
         <module>utils/agent-loader</module>
+        <module>utils/metrics</module>
         <module>utils/rest-client</module>
     </modules>
 

samples/chat/chat-actors/pom.xml

@@ -99,6 +99,17 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
             <version>0.3.2-SNAPSHOT</version>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>com.ea.orbit</groupId>
+            <artifactId>orbit-metrics</artifactId>
+            <version>${orbit.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.ea.orbit</groupId>
+            <artifactId>orbit-actors-metrics</artifactId>
+            <version>${orbit.version}</version>
+            <scope>runtime</scope>
+        </dependency>
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>

samples/chat/chat-actors/src/main/java/com/ea/orbit/samples/chat/ChatActor.java

@@ -32,6 +32,8 @@
 import com.ea.orbit.actors.runtime.AbstractActor;
 import com.ea.orbit.annotation.Config;
 import com.ea.orbit.concurrent.Task;
+import com.ea.orbit.metrics.annotations.ExportMetric;
+import com.ea.orbit.metrics.annotations.MetricScope;
 
 import java.util.ArrayList;
 import java.util.Date;
@@ -122,4 +124,10 @@ public Task<?> deactivateAsync()
     {
         return writeState().thenCompose(() -> super.deactivateAsync());
     }
+
+    @ExportMetric(name="historySize", scope= MetricScope.PROTOTYPE)
+    public long historySize()
+    {
+        return state().history.size();
+    }
 }

samples/chat/chat-actors/src/main/resources/conf/orbit.yaml

@@ -34,8 +34,16 @@ orbit.actors.extensions:
     host: localhost
     port: 27017
     database: chat
+  - !!com.ea.orbit.actors.extensions.metrics.MetricsLifetimeExtension {}
 
 orbit.chat.maxMessages: 500
 
 orbit.components:
   - com.ea.orbit.actors.server.ServerModule
+
+orbit.metrics.reporters:
+  - !!com.ea.orbit.metrics.config.Slf4jReporterConfig
+    period: 1
+    periodUnit: 'MINUTES'
+    prefix: 'chat.chat-backend'
+  - !!com.ea.orbit.metrics.config.JmxReporterConfig {}