Merge pull request #27 from beverly-hills-money-gangster/micro-meter-…

…metrics

Add micrometer + up version 2.4.0

README.md

@@ -54,6 +54,8 @@ A sample [docker-compose file](/docker-compose.yaml) can be found in the root fo
 
 ### Server monitoring
 
+#### JVM metrics
+
 Server JVM metrics can be monitored through JMX remotely. See [docker-compose file](/docker-compose.yaml). 
 In the sample, JMX agent is running on port 9999 listening to incoming connections initiated by 127.0.0.1. 
 If server is running in the cloud, then it's possible to port-forward JMX using the following command:
@@ -62,8 +64,15 @@ If server is running in the cloud, then it's possible to port-forward JMX using
 ssh -L 9999:127.0.0.1:9999 <user>@<remote_host>
 ```
 
+#### Heap dumps
+
 Apart from JMX metrics, the server is configured to drop a heap dump file on out-of-memory.
 
+
+#### Micrometer
+
+All command handlers publish Micrometer timer metrics through JMX. See "metrics" in Jconsole "MBeans" tab.
+
 ### Client monitoring
 
 `GameConnection.java` has `networkStats` field that gathers basic network stats including:

net-client/pom.xml

@@ -7,11 +7,11 @@
     <parent>
         <groupId>com.beverly.hills.money.gang</groupId>
         <artifactId>daikombat-server</artifactId>
-        <version>2.3.0</version>
+        <version>2.4.0</version>
     </parent>
 
     <artifactId>net-client</artifactId>
-    <version>2.3.0</version>
+    <version>2.4.0</version>
 
     <properties>
         <maven.compiler.source>14</maven.compiler.source>
@@ -65,12 +65,12 @@
         <dependency>
             <groupId>com.beverly.hills.money.gang</groupId>
             <artifactId>schema</artifactId>
-            <version>2.3.0</version>
+            <version>2.4.0</version>
         </dependency>
         <dependency>
             <groupId>com.beverly.hills.money.gang</groupId>
             <artifactId>security</artifactId>
-            <version>2.3.0</version>
+            <version>2.4.0</version>
         </dependency>
 
         <!-- https://mvnrepository.com/artifact/org.apache.maven/maven-model -->

pom.xml

@@ -12,7 +12,7 @@
 
     <groupId>com.beverly.hills.money.gang</groupId>
     <artifactId>daikombat-server</artifactId>
-    <version>2.3.0</version>
+    <version>2.4.0</version>
     <packaging>pom</packaging>
 
     <modules>

schema/pom.xml

@@ -7,11 +7,11 @@
     <parent>
         <groupId>com.beverly.hills.money.gang</groupId>
         <artifactId>daikombat-server</artifactId>
-        <version>2.3.0</version>
+        <version>2.4.0</version>
     </parent>
 
     <artifactId>schema</artifactId>
-    <version>2.3.0</version>
+    <version>2.4.0</version>
 
     <properties>
         <maven.compiler.source>14</maven.compiler.source>

security/pom.xml

@@ -7,11 +7,11 @@
     <parent>
         <groupId>com.beverly.hills.money.gang</groupId>
         <artifactId>daikombat-server</artifactId>
-        <version>2.3.0</version>
+        <version>2.4.0</version>
     </parent>
 
     <artifactId>security</artifactId>
-    <version>2.3.0</version>
+    <version>2.4.0</version>
 
     <properties>
         <maven.compiler.source>14</maven.compiler.source>

server/pom.xml

@@ -7,11 +7,11 @@
     <parent>
         <groupId>com.beverly.hills.money.gang</groupId>
         <artifactId>daikombat-server</artifactId>
-        <version>2.3.0</version>
+        <version>2.4.0</version>
     </parent>
 
     <artifactId>server</artifactId>
-    <version>2.3.0</version>
+    <version>2.4.0</version>
 
     <properties>
         <maven.compiler.source>14</maven.compiler.source>
@@ -71,12 +71,12 @@
         <dependency>
             <groupId>com.beverly.hills.money.gang</groupId>
             <artifactId>schema</artifactId>
-            <version>2.3.0</version>
+            <version>2.4.0</version>
         </dependency>
         <dependency>
             <groupId>com.beverly.hills.money.gang</groupId>
             <artifactId>security</artifactId>
-            <version>2.3.0</version>
+            <version>2.4.0</version>
         </dependency>
         <dependency>
             <groupId>eu.rekawek.toxiproxy</groupId>
@@ -88,6 +88,13 @@
             <artifactId>spring-context</artifactId>
             <version>5.3.31</version>
         </dependency>
+
+        <!-- https://mvnrepository.com/artifact/io.micrometer/micrometer-registry-jmx -->
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-registry-jmx</artifactId>
+            <version>1.10.13</version>
+        </dependency>
         <!-- https://mvnrepository.com/artifact/org.springframework/spring-test -->
         <dependency>
             <groupId>org.springframework</groupId>
@@ -98,7 +105,7 @@
         <dependency>
             <groupId>com.beverly.hills.money.gang</groupId>
             <artifactId>net-client</artifactId>
-            <version>2.3.0</version>
+            <version>2.4.0</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

server/src/main/java/com/beverly/hills/money/gang/handler/command/ServerCommandHandler.java

@@ -1,6 +1,7 @@
 package com.beverly.hills.money.gang.handler.command;
 
 import com.beverly.hills.money.gang.exception.GameLogicError;
+import com.beverly.hills.money.gang.meter.RequestsMeter;
 import com.beverly.hills.money.gang.proto.ServerCommand;
 import io.netty.channel.Channel;
 import org.slf4j.Logger;
@@ -11,18 +12,21 @@
 
 public abstract class ServerCommandHandler {
 
+    private final RequestsMeter requestsMeter = new RequestsMeter(this.getClass().getSimpleName());
     private static final Logger LOG = LoggerFactory.getLogger(ServerCommandHandler.class);
 
     protected abstract boolean isValidCommand(ServerCommand msg, Channel currentChannel);
 
     protected abstract void handleInternal(ServerCommand msg, Channel currentChannel) throws GameLogicError;
 
     public final void handle(ServerCommand msg, Channel currentChannel) throws GameLogicError {
-        if (isValidCommand(msg, currentChannel)) {
-            handleInternal(msg, currentChannel);
-        } else {
-            LOG.error("Invalid command {}", msg);
-            throw new GameLogicError("Invalid command", COMMAND_NOT_RECOGNIZED);
-        }
+        requestsMeter.runAndMeasure(() -> {
+            if (isValidCommand(msg, currentChannel)) {
+                handleInternal(msg, currentChannel);
+            } else {
+                LOG.error("Invalid command {}", msg);
+                throw new GameLogicError("Invalid command", COMMAND_NOT_RECOGNIZED);
+            }
+        });
     }
 }

server/src/main/java/com/beverly/hills/money/gang/meter/RequestsMeter.java

@@ -0,0 +1,37 @@
+package com.beverly.hills.money.gang.meter;
+
+import com.beverly.hills.money.gang.exception.GameLogicError;
+import io.micrometer.core.instrument.Clock;
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.Timer;
+import io.micrometer.jmx.JmxConfig;
+import io.micrometer.jmx.JmxMeterRegistry;
+
+import java.util.Locale;
+
+public class RequestsMeter {
+
+    private final Timer requestTimer;
+
+    private final MeterRegistry meterRegistry = new JmxMeterRegistry(JmxConfig.DEFAULT, Clock.SYSTEM);
+
+    public RequestsMeter(final String name) {
+        this.requestTimer = Timer.builder("app.timer." + name.toLowerCase(Locale.ENGLISH))
+                .description("Request processing time")
+                .register(meterRegistry);
+    }
+
+    public void runAndMeasure(MeasureRunnable r) throws GameLogicError {
+        Timer.Sample sample = Timer.start(meterRegistry);
+        try {
+            r.run();
+        } finally {
+            sample.stop(requestTimer);
+        }
+    }
+
+    @FunctionalInterface
+    public interface MeasureRunnable {
+        void run() throws GameLogicError;
+    }
+}