Add version of Teku to VC metrics (#9298)

Author: StefanBratanov

CHANGELOG.md

@@ -13,6 +13,7 @@
 - updated graffiti watermarking to put the EL first and shrink the max size.
 - Increased the minimum thread count for batch signature verification to 4. If you are on less than a 4 cpu instance, you can override this back to default by using `--Xp2p-batch-verify-signatures-max-threads=2`
 - Increased the queue size limit for batch signature verification to 30000.
+- Introduced new metric `validator_teku_version_total` which tracks the Teku version in use when running a standalone VC
 - Added bootnode-only mode
 
 ### Bug Fixes

infrastructure/metrics/src/main/java/tech/pegasys/teku/infrastructure/metrics/TekuMetricCategory.java

@@ -59,7 +59,6 @@ public static Set<TekuMetricCategory> defaultCategories() {
         STORAGE,
         STORAGE_HOT_DB,
         STORAGE_FINALIZED_DB,
-        REMOTE_VALIDATOR,
         VALIDATOR,
         VALIDATOR_PERFORMANCE,
         VALIDATOR_DUTY);

infrastructure/metrics/src/test/java/tech/pegasys/teku/infrastructure/metrics/TekuMetricCategoryTest.java

@@ -20,7 +20,6 @@
 import static tech.pegasys.teku.infrastructure.metrics.TekuMetricCategory.EXECUTOR;
 import static tech.pegasys.teku.infrastructure.metrics.TekuMetricCategory.LIBP2P;
 import static tech.pegasys.teku.infrastructure.metrics.TekuMetricCategory.NETWORK;
-import static tech.pegasys.teku.infrastructure.metrics.TekuMetricCategory.REMOTE_VALIDATOR;
 import static tech.pegasys.teku.infrastructure.metrics.TekuMetricCategory.STORAGE;
 import static tech.pegasys.teku.infrastructure.metrics.TekuMetricCategory.STORAGE_FINALIZED_DB;
 import static tech.pegasys.teku.infrastructure.metrics.TekuMetricCategory.STORAGE_HOT_DB;
@@ -46,7 +45,6 @@ public void shouldProvideExpectedDefaultCategories() {
             STORAGE,
             STORAGE_HOT_DB,
             STORAGE_FINALIZED_DB,
-            REMOTE_VALIDATOR,
             VALIDATOR,
             VALIDATOR_PERFORMANCE,
             VALIDATOR_DUTY);

validator/client/src/main/java/tech/pegasys/teku/validator/client/ValidatorClientService.java

@@ -29,6 +29,8 @@
 import org.apache.logging.log4j.Logger;
 import org.apache.tuweni.bytes.Bytes32;
 import org.hyperledger.besu.plugin.services.MetricsSystem;
+import org.hyperledger.besu.plugin.services.metrics.Counter;
+import org.hyperledger.besu.plugin.services.metrics.LabelledMetric;
 import tech.pegasys.teku.bls.BLSPublicKey;
 import tech.pegasys.teku.infrastructure.async.AsyncRunner;
 import tech.pegasys.teku.infrastructure.async.SafeFuture;
@@ -41,6 +43,7 @@
 import tech.pegasys.teku.infrastructure.metrics.TekuMetricCategory;
 import tech.pegasys.teku.infrastructure.restapi.RestApi;
 import tech.pegasys.teku.infrastructure.time.TimeProvider;
+import tech.pegasys.teku.infrastructure.version.VersionProvider;
 import tech.pegasys.teku.service.serviceutils.Service;
 import tech.pegasys.teku.service.serviceutils.ServiceConfig;
 import tech.pegasys.teku.service.serviceutils.layout.DataDirLayout;
@@ -169,9 +172,18 @@ public static ValidatorClientService create(
 
     final ValidatorLoader validatorLoader =
         createValidatorLoader(services, config, asyncRunner, updatableGraffitiProvider);
+
+    final MetricsSystem metricsSystem = services.getMetricsSystem();
+
+    /* Only available when running a standalone VC client */
+    if (validatorConfig.getSentryNodeConfigurationFile().isPresent()
+        || validatorConfig.getBeaconNodeApiEndpoints().isPresent()) {
+      addVersionMetric(metricsSystem);
+    }
+
     final ValidatorStatusProvider validatorStatusProvider =
         new OwnedValidatorStatusProvider(
-            services.getMetricsSystem(),
+            metricsSystem,
             validatorLoader.getOwnedValidators(),
             validatorApiChannel,
             config.getSpec(),
@@ -234,7 +246,7 @@ public static ValidatorClientService create(
             beaconProposerPreparer,
             validatorRegistrator,
             config.getSpec(),
-            services.getMetricsSystem(),
+            metricsSystem,
             doppelgangerDetectionAction,
             maybeValidatorSlashedAction,
             services.getTimeProvider());
@@ -394,7 +406,6 @@ private static BeaconNodeApi createBeaconNodeApi(
       final SentryNodesConfig sentryNodesConfig =
           new SentryNodesConfigLoader()
               .load(validatorConfig.getSentryNodeConfigurationFile().get());
-
       beaconNodeApi =
           SentryBeaconNodeApi.create(
               services,
@@ -566,6 +577,17 @@ private static void addValidatorCountMetric(
         validators::getValidatorCount);
   }
 
+  private static void addVersionMetric(final MetricsSystem metricsSystem) {
+    final String version = VersionProvider.IMPLEMENTATION_VERSION.replaceAll("^v", "");
+    final LabelledMetric<Counter> versionCounter =
+        metricsSystem.createLabelledCounter(
+            TekuMetricCategory.VALIDATOR,
+            VersionProvider.CLIENT_IDENTITY + "_version_total",
+            "Teku version in use",
+            "version");
+    versionCounter.labels(version).inc();
+  }
+
   @Override
   protected SafeFuture<?> doStart() {
     return initializationComplete