Telemetry: fix health checks, node info, and docs

Author: Neo Bot

src/Plugins/Telemetry/Collectors/PluginMetricsCollector.cs

@@ -11,7 +11,6 @@
 
 using Neo.Network.P2P;
 using Neo.Plugins.Telemetry.Metrics;
-using System.Reflection;
 
 namespace Neo.Plugins.Telemetry.Collectors
 {
@@ -32,7 +31,7 @@ public PluginMetricsCollector(NeoSystem system, string nodeId, string network)
             _network = network ?? throw new ArgumentNullException(nameof(network));
 
             // Set node info metric
-            var version = Assembly.GetExecutingAssembly().GetName().Version?.ToString() ?? "unknown";
+            var version = _system.GetType().Assembly.GetName().Version?.ToString() ?? "unknown";
             var protocolVersion = LocalNode.ProtocolVersion.ToString();
             MetricsDefinitions.NodeInfo.WithLabels(_nodeId, _network, version, protocolVersion).Set(1);
         }

src/Plugins/Telemetry/Health/HealthCheckEndpoint.cs

@@ -9,7 +9,9 @@
 // Redistribution and use in source and binary forms with or without
 // modifications are permitted.
 
+using Akka.Actor;
 using Neo.Json;
+using Neo.Network.P2P;
 using Neo.SmartContract.Native;
 using System.Net;
 using System.Text;
@@ -27,6 +29,7 @@ public sealed class HealthCheckEndpoint : IDisposable
         private readonly Task _listenerTask;
         private readonly string _nodeId;
         private readonly string _network;
+        private LocalNode? _localNode;
         private bool _disposed;
 
         public HealthCheckEndpoint(NeoSystem system, string host, int port, string nodeId, string network)
@@ -41,6 +44,8 @@ public HealthCheckEndpoint(NeoSystem system, string host, int port, string nodeI
             _listener.Prefixes.Add($"http://{host}:{port}/ready/");
             _listener.Prefixes.Add($"http://{host}:{port}/live/");
 
+            InitializeLocalNode();
+
             try
             {
                 _listener.Start();
@@ -57,6 +62,19 @@ public HealthCheckEndpoint(NeoSystem system, string host, int port, string nodeI
             }
         }
 
+        private async void InitializeLocalNode()
+        {
+            try
+            {
+                _localNode = await _system.LocalNode.Ask<LocalNode>(new LocalNode.GetInstance());
+            }
+            catch (Exception ex)
+            {
+                Utility.Log(nameof(HealthCheckEndpoint), LogLevel.Debug,
+                    $"Failed to get LocalNode instance for health checks: {ex.Message}");
+            }
+        }
+
         private async Task ListenAsync()
         {
             while (!_cts.Token.IsCancellationRequested && _listener?.IsListening == true)
@@ -121,15 +139,16 @@ private JObject GetHealthStatus()
             {
                 var currentHeight = NativeContract.Ledger.CurrentIndex(_system.StoreView);
                 var headerHeight = _system.HeaderCache.Last?.Index ?? currentHeight;
-                var blocksBehind = headerHeight - currentHeight;
+                var blocksBehind = headerHeight >= currentHeight ? headerHeight - currentHeight : 0;
                 var isSynced = blocksBehind <= 2;
-                var peerCount = 0;
+                int? peerCount = _localNode?.ConnectedCount;
+                var hasPeers = peerCount is null || peerCount > 0;
 
                 var memPool = _system.MemPool;
                 var mempoolCount = memPool.Count;
                 var mempoolCapacity = memPool.Capacity;
 
-                var status = isSynced && peerCount >= 0 ? "healthy" : "degraded";
+                var status = isSynced && hasPeers ? "healthy" : "degraded";
 
                 return new JObject
                 {
@@ -147,6 +166,11 @@ private JObject GetHealthStatus()
                             ["blocks_behind"] = blocksBehind,
                             ["synced"] = isSynced
                         },
+                        ["network"] = new JObject
+                        {
+                            ["status"] = hasPeers ? "healthy" : "degraded",
+                            ["connected_peers"] = peerCount ?? 0
+                        },
                         ["mempool"] = new JObject
                         {
                             ["status"] = "healthy",
@@ -174,13 +198,19 @@ private JObject GetReadinessStatus()
             {
                 var currentHeight = NativeContract.Ledger.CurrentIndex(_system.StoreView);
                 var headerHeight = _system.HeaderCache.Last?.Index ?? currentHeight;
-                var isSynced = (headerHeight - currentHeight) <= 2;
+                var blocksBehind = headerHeight >= currentHeight ? headerHeight - currentHeight : 0;
+                var isSynced = blocksBehind <= 2;
+                int? peerCount = _localNode?.ConnectedCount;
+                var hasPeers = peerCount is null || peerCount > 0;
+                var ready = isSynced && hasPeers;
 
                 return new JObject
                 {
-                    ["status"] = isSynced ? "healthy" : "not_ready",
+                    ["status"] = ready ? "healthy" : "not_ready",
                     ["timestamp"] = DateTime.UtcNow.ToString("O"),
                     ["synced"] = isSynced,
+                    ["blocks_behind"] = blocksBehind,
+                    ["connected_peers"] = peerCount ?? 0,
                     ["block_height"] = currentHeight
                 };
             }

src/Plugins/Telemetry/README.md

@@ -15,19 +15,19 @@ A comprehensive telemetry and metrics collection plugin for Neo N3 full nodes, p
 
 1. Build the plugin:
 ```bash
-dotnet build src/Plugins/TelemetryPlugin/TelemetryPlugin.csproj
+dotnet build src/Plugins/Telemetry/Telemetry.csproj
 ```
 
-2. Copy the output to your Neo node's `Plugins/TelemetryPlugin/` directory:
+2. Copy the output to your Neo node's `Plugins/Telemetry/` directory:
 ```bash
-cp -r bin/Debug/net10.0/* /path/to/neo-node/Plugins/TelemetryPlugin/
+cp -r bin/Debug/net10.0/* /path/to/neo-node/Plugins/Telemetry/
 ```
 
 3. Configure the plugin by editing `config.json` in the plugin directory.
 
 ## Configuration
 
-Create or edit `config.json` in the `Plugins/TelemetryPlugin/` directory:
+Create or edit `config.json` in the `Plugins/Telemetry/` directory:
 
 ```json
 {
@@ -170,7 +170,7 @@ Import the provided Grafana dashboard JSON for a pre-configured monitoring view:
 
 1. Open Grafana
 2. Go to Dashboards → Import
-3. Upload `grafana-dashboard.json` or paste the JSON content
+3. Upload `dashboards/neo-node-dashboard.json` or paste the JSON content
 4. Select your Prometheus data source
 5. Click Import
 

src/Plugins/Telemetry/Telemetry.cs

@@ -50,7 +50,8 @@ protected override void Configure()
         {
             TelemetrySettings.Load(GetConfiguration());
             Log($"Configuration loaded - Enabled: {TelemetrySettings.Default.Enabled}, " +
-                $"Port: {TelemetrySettings.Default.PrometheusPort}", LogLevel.Info);
+                $"Port: {TelemetrySettings.Default.PrometheusPort}, " +
+                $"ExceptionPolicy: {TelemetrySettings.Default.ExceptionPolicy}", LogLevel.Info);
         }
 
         protected internal override void OnSystemLoaded(NeoSystem system)