Add Metrics via Prometheus support

Source/ACE.Common/MasterConfiguration.cs

@@ -9,5 +9,7 @@ public class MasterConfiguration
         public OfflineConfiguration Offline { get; set; } = new OfflineConfiguration();
 
         public DDDConfiguration DDD { get; set; } = new DDDConfiguration();
+
+        public MetricsConfiguration Metrics { get; set; } = new MetricsConfiguration();
     }
 }

Source/ACE.Common/MetricsConfiguration.cs

@@ -0,0 +1,19 @@
+
+namespace ACE.Common
+{
+    public class MetricsConfiguration
+    {
+        /// <summary>
+        /// Allow server to publish Prometheus metrics
+        /// </summary>
+        public bool EnableMetricsServer { get; set; } = false;
+
+        public string Host { get; set; } = "127.0.0.1";
+
+        public int Port { get; set; } = 9200;
+
+        public string Url { get; set; } = "metrics/";
+
+        public bool UseHTTPs { get; set; } = false;
+    }
+}

Source/ACE.Server/ACE.Server.csproj

@@ -239,6 +239,8 @@
     <PackageReference Include="Log4Net.Async.Standard" Version="3.1.0" />
     <PackageReference Include="McMaster.NETCore.Plugins" Version="1.4.0" />
     <PackageReference Include="MySqlConnector" Version="2.3.7" />
+    <PackageReference Include="prometheus-net" Version="8.2.1" />
+    <PackageReference Include="prometheus-net.DotNetRuntime" Version="4.4.1" />
     <PackageReference Include="System.Text.Encoding.CodePages" Version="8.0.0" />
   </ItemGroup>
 

Source/ACE.Server/Config.js.docker

@@ -221,5 +221,36 @@
      // When retrieving a file list of .sql files in the AutoApplyWorldCustomizations process
      // this will cause the file search to retrieve all files recursively from each directory
      "RecurseWorldCustomizationPaths": true
+  },
+  // This section configures handling of client DAT patching from server's DAT files
+  "DDD": {
+    // Allow server to patch client DAT files using server's DAT files via DDDManager
+    "EnableDATPatching": false,
+
+    // Upon server startup, precache all DAT files that would be sent as compressed data
+    "PrecacheCompressedDATFiles": false
+  },
+  // This section configures Prometheus metrics server
+  "Metrics": {
+    // Allow server to publish Prometheus metrics
+    "EnableMetricsServer": false,
+
+    // Host, default: 127.0.0.1
+    // Probably best to leave this as is, and use reverse proxy which can be secured better.
+    "Host": "127.0.0.1",
+
+    // Port, default: 9200
+    // Probably best to leave this as is, and use reverse proxy which can be secured better.
+    "Port": 9200,
+
+    // Url, default: metrics/
+    // Probably best to leave this as is, and use reverse proxy which can be secured better.
+    // If above is default, the full url becomes http://127.0.0.1:9200/metrics/ to access
+    "Url": "metrics/",
+
+    // UseHTTPs, default: false
+    // Probably best to leave this as is, and use reverse proxy which can be secured better.
+    // If above is default, the full url becomes https://127.0.0.1:9200/metrics to access
+    "UseHTTPs": false
   }
 }

Source/ACE.Server/Config.js.example

@@ -230,5 +230,28 @@
 
     // Upon server startup, precache all DAT files that would be sent as compressed data
     "PrecacheCompressedDATFiles": false
+  },
+  // This section configures Prometheus metrics server
+  "Metrics": {
+    // Allow server to publish Prometheus metrics
+    "EnableMetricsServer": false,
+
+    // Host, default: 127.0.0.1
+    // Probably best to leave this as is, and use reverse proxy which can be secured better.
+    "Host": "127.0.0.1",
+
+    // Port, default: 9200
+    // Probably best to leave this as is, and use reverse proxy which can be secured better.
+    "Port": 9200,
+
+    // Url, default: metrics/
+    // Probably best to leave this as is, and use reverse proxy which can be secured better.
+    // If above is default, the full url becomes http://127.0.0.1:9200/metrics/ to access
+    "Url": "metrics/",
+
+    // UseHTTPs, default: false
+    // Probably best to leave this as is, and use reverse proxy which can be secured better.
+    // If above is default, the full url becomes https://127.0.0.1:9200/metrics to access
+    "UseHTTPs": false
   }
 }

Source/ACE.Server/Managers/GuidManager.cs

@@ -31,12 +31,14 @@ public static class GuidManager
 
         private class PlayerGuidAllocator
         {
+            private readonly uint min;
             private readonly uint max;
             private uint current;
             private readonly string name;
 
             public PlayerGuidAllocator(uint min, uint max, string name)
             {
+                this.min = min;
                 this.max = max;
 
                 // Read current value out of ShardDatabase
@@ -99,13 +101,24 @@ public uint Current()
             {
                 return current;
             }
+
+            public uint Min()
+            {
+                return min;
+            }
+
+            public uint Max()
+            {
+                return max;
+            }
         }
 
         /// <summary>
         /// On a server with ~500 players, about 10,000,000 dynamic GUID's will be requested every 24hr period.
         /// </summary>
         private class DynamicGuidAllocator
         {
+            private readonly uint min;
             private readonly uint max;
             private uint current;
             private readonly string name;
@@ -129,6 +142,7 @@ private class DynamicGuidAllocator
 
             public DynamicGuidAllocator(uint min, uint max, string name, bool unlimitedGaps)
             {
+                this.min = min;
                 this.max = max;
 
                 // Read current value out of ShardDatabase
@@ -249,6 +263,32 @@ public uint Current()
                 return current;
             }
 
+            public uint Min()
+            {
+                return min;
+            }
+
+            public uint Max()
+            {
+                return max;
+            }
+
+            public int SequenceGapPairsTotal => availableIDs.Count;
+
+            public uint SequenceGapTotalAvailable()
+            {
+                lock (this)
+                {
+                    uint total = 0;
+                    foreach (var (start, end) in availableIDs)
+                        total += end - start + 1;
+
+                    return total;
+                }
+            }
+
+            public int RecycledGuidsTotal => recycledGuids.Count;
+
             public void Recycle(uint guid)
             {
                 lock (this)
@@ -352,5 +392,14 @@ public static string GetIdListCommandOutput()
 
             return message;
         }
+
+        public static uint PlayerMin => playerAlloc?.Min() ?? 0;
+        public static uint PlayerCurrent => playerAlloc?.Current() ?? 0;
+        public static uint PlayerMax => playerAlloc?.Max() ?? 0;
+        public static uint DynamicMin => dynamicAlloc?.Min() ?? 0;
+        public static uint DynamicCurrent => dynamicAlloc?.Current() ?? 0;
+        public static uint DynamicMax => dynamicAlloc?.Max() ?? 0;
+        public static int SequenceGapPairsTotal => dynamicAlloc?.SequenceGapPairsTotal ?? 0;
+        public static int RecycledGuidsTotal => dynamicAlloc?.RecycledGuidsTotal ?? 0;
     }
 }

Source/ACE.Server/Managers/HouseManager.cs

@@ -48,6 +48,11 @@ public static class HouseManager
 
         public static void Initialize()
         {
+            TotalOwnedHousingByType[HouseType.Apartment] = 0;
+            TotalOwnedHousingByType[HouseType.Cottage] = 0;
+            TotalOwnedHousingByType[HouseType.Villa] = 0;
+            TotalOwnedHousingByType[HouseType.Mansion] = 0;
+
             BuildHouseIdToGuid();
 
             BuildRentQueue();
@@ -198,6 +203,8 @@ private static void AddRentQueue(IPlayer player, House house)
             var playerHouse = new PlayerHouse(player, house);
 
             RentQueue.Add(playerHouse);
+
+            TotalOwnedHousingByType[playerHouse.House.HouseType]++;
         }
 
         /// <summary>
@@ -336,6 +343,7 @@ public static void Tick()
             while (currentTime > nextEntry.RentDue)
             {
                 RentQueue.Remove(nextEntry);
+                DecrementTotalOwnedHousingByType(nextEntry.House.HouseType);
 
                 ProcessRent(nextEntry);
 
@@ -507,6 +515,7 @@ public static void HandleEviction(House house, uint playerGuid, bool multihouse
             if (multihouse)
             {
                 RemoveRentQueue(house.Guid.Full);
+                DecrementTotalOwnedHousingByType(house.HouseType);
 
                 player.SaveBiotaToDatabase();
 
@@ -621,7 +630,7 @@ private static HouseData GetHouseData(House house)
         }
 
         // This function is called from a database callback.
-        // We must add thread safety to prevent AllegianceManager corruption
+        // We must add thread safety to prevent HouseManager corruption
         public static void HandlePlayerDelete(uint playerGuid)
         {
             WorldManager.EnqueueAction(new ActionEventDelegate(() => DoHandlePlayerDelete(playerGuid)));
@@ -654,6 +663,7 @@ private static void DoHandlePlayerDelete(uint playerGuid)
                 HandleEviction(playerHouse, true);
 
                 RemoveRentQueue(house.Guid.Full);
+                DecrementTotalOwnedHousingByType(house.HouseType);
             });
         }
 
@@ -921,5 +931,13 @@ public static void PayAllRent()
                 PayRent(house);
             }
         }
+
+        public static int TotalOwnedHousing => RentQueue?.Count ?? 0;
+
+        public static Dictionary<HouseType, int> TotalOwnedHousingByType = new Dictionary<HouseType, int>();
+
+        public static void IncrementTotalOwnedHousingByType(HouseType houseType) => TotalOwnedHousingByType[houseType]++;
+
+        public static void DecrementTotalOwnedHousingByType(HouseType houseType) => TotalOwnedHousingByType[houseType]--;
     }
 }

Source/ACE.Server/Program.cs

@@ -232,6 +232,14 @@ public static void Main(string[] args)
                 Environment.Exit(0);
             }
 
+            if (ConfigManager.Config.Metrics.EnableMetricsServer)
+            {
+                log.Info("Initializing Metrics Server...");
+                InitMetrics();
+            }
+            else
+                log.Info("Metrics Server Disabled...");
+
             log.Info("Initializing ServerManager...");
             ServerManager.Initialize();
 
@@ -350,6 +358,8 @@ private static void CurrentDomain_UnhandledException(object sender, UnhandledExc
 
         private static void OnProcessExit(object sender, EventArgs e)
         {
+            ShutdownMetrics();
+
             if (!IsRunningInContainer)
             {
                 if (!ServerManager.ShutdownInitiated)