feat: added validators balances metrics

Author: Tarens2

src/common/prometheus/prometheus.service.ts

@@ -35,6 +35,12 @@ export class PrometheusService {
     labelNames: ENV_KEYS,
   });
 
+  public validatorsState = this.getOrCreateMetric('Gauge', {
+    name: METRICS_PREFIX + 'validators_state',
+    help: 'balances of Lido validators with withdrawable_epoch by frames',
+    labelNames: ['frame', 'balance'],
+  });
+
   public clApiRequestDuration = this.getOrCreateMetric('Histogram', {
     name: METRICS_PREFIX + 'cl_api_requests_duration_seconds',
     help: 'CL API request duration',

src/common/validators/strigify-frame-balances.ts

@@ -0,0 +1,9 @@
+import { BigNumber } from '@ethersproject/bignumber';
+
+export function stringifyFrameBalances(frameBalances: Record<string, BigNumber>) {
+  return JSON.stringify(
+    Object.keys(frameBalances).reduce((acc, key) => {
+      return { ...acc, [key]: frameBalances[key].toString() };
+    }, {}),
+  );
+}

src/jobs/validators/validators.service.ts

@@ -16,13 +16,16 @@ import { ResponseValidatorsData, Validator } from './validators.types';
 import { parseGweiToWei } from '../../common/utils/parse-gwei-to-big-number';
 import { ValidatorsCacheService } from 'storage/validators/validators-cache.service';
 import { CronExpression } from '@nestjs/schedule';
+import { PrometheusService } from '../../common/prometheus';
+import { stringifyFrameBalances } from '../../common/validators/strigify-frame-balances';
 
 export class ValidatorsService {
   static SERVICE_LOG_NAME = 'validators';
 
   constructor(
     @Inject(LOGGER_PROVIDER) protected readonly logger: LoggerService,
 
+    protected readonly prometheusService: PrometheusService,
     protected readonly consensusProviderService: ConsensusProviderService,
     protected readonly configService: ConfigService,
     protected readonly jobService: JobService,
@@ -78,23 +81,34 @@ export class ValidatorsService {
 
           await unblock();
         }
-        await this.setLidoValidatorsWithdrawableBalances(data);
         this.validatorsStorageService.setTotal(totalValidators);
         this.validatorsStorageService.setMaxExitEpoch(latestEpoch);
         this.validatorsStorageService.setLastUpdate(Math.floor(Date.now() / 1000));
 
+        const frameBalances = await this.getLidoValidatorsWithdrawableBalances(data);
+        this.validatorsStorageService.setFrameBalances(frameBalances);
         await this.validatorsCacheService.saveDataToCache();
 
         this.logger.log('End update validators', {
           service: ValidatorsService.SERVICE_LOG_NAME,
           totalValidators,
           latestEpoch,
+          frameBalances: stringifyFrameBalances(frameBalances),
+        });
+
+        Object.keys(frameBalances).forEach((frame) => {
+          this.prometheusService.validatorsState
+            .labels({
+              frame,
+              balance: frameBalances[frame],
+            })
+            .inc();
         });
       },
     );
   }
 
-  protected async setLidoValidatorsWithdrawableBalances(validators: Validator[]) {
+  protected async getLidoValidatorsWithdrawableBalances(validators: Validator[]) {
     const keysData = await this.lidoKeys.fetchLidoKeysData();
     const lidoValidators = await this.lidoKeys.getLidoValidatorsByKeys(keysData.data, validators);
 
@@ -111,6 +125,6 @@ export class ValidatorsService {
       await unblock();
     }
 
-    this.validatorsStorageService.setFrameBalances(frameBalances);
+    return frameBalances;
   }
 }

src/storage/validators/validators-cache.service.ts

@@ -4,6 +4,7 @@ import * as path from 'path';
 import { LOGGER_PROVIDER, LoggerService } from '../../common/logger';
 import { ValidatorsStorageService } from './validators.service';
 import { BigNumber } from '@ethersproject/bignumber';
+import { stringifyFrameBalances } from '../../common/validators/strigify-frame-balances';
 
 @Injectable()
 export class ValidatorsCacheService {
@@ -75,7 +76,7 @@ export class ValidatorsCacheService {
       this.validatorsStorage.getTotal(),
       this.validatorsStorage.getMaxExitEpoch(),
       this.validatorsStorage.getLastUpdate(),
-      this.stringifyFrameBalances(this.validatorsStorage.getFrameBalances()),
+      stringifyFrameBalances(this.validatorsStorage.getFrameBalances()),
     ].join(ValidatorsCacheService.CACHE_DATA_DIVIDER);
     await writeFile(cacheFileName, data);
     this.logger.log(`success save to file ${cacheFileName}`, { service: ValidatorsCacheService.SERVICE_LOG_NAME });
@@ -85,14 +86,6 @@ export class ValidatorsCacheService {
     return path.join(ValidatorsCacheService.CACHE_DIR, ValidatorsCacheService.CACHE_FILE_NAME);
   };
 
-  protected stringifyFrameBalances(frameBalances: Record<string, BigNumber>) {
-    return JSON.stringify(
-      Object.keys(frameBalances).reduce((acc, key) => {
-        return { ...acc, [key]: frameBalances[key].toString() };
-      }, {}),
-    );
-  }
-
   protected parseFrameBalances(frameBalancesStr: string) {
     const frameBalances = JSON.parse(frameBalancesStr);
     return Object.keys(frameBalances).reduce((acc, key) => {