packages/metrics/lib/Metric.ts

   1 import type IMetricsRequestService from './types/IMetricsRequestService';
   2 import type MetricSchema from './types/MetricSchema';
   3 import type MetricVersions from './types/MetricVersions';
   4
   5 /**
   6  * Custom regex based on the following
   7  * - https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels
   8  * - https://gitlab.protontech.ch/proton/be/json-schema-registry
   9  */
  10 const metricRegexp = /^[a-zA-Z]+(?:_[a-zA-Z0-9]+)*$/;
  11
  12 function validateMetricName(name: string) {
  13     return metricRegexp.test(name);
  14 }
  15
  16 abstract class Metric<D extends MetricSchema> {
  17     private name: string;
  18
  19     private version: MetricVersions;
  20
  21     private requestService: IMetricsRequestService;
  22
  23     constructor(config: { name: string; version: MetricVersions }, requestService: IMetricsRequestService) {
  24         this.name = config.name;
  25         this.version = config.version;
  26         this.requestService = requestService;
  27
  28         if (!validateMetricName(this.name)) {
  29             throw new Error(`Invalid metric name ${this.name}`);
  30         }
  31     }
  32
  33     protected addToRequestQueue(data: D) {
  34         this.requestService.report({
  35             Name: this.name,
  36             Version: this.version,
  37             Timestamp: Math.round(Date.now() / 1000),
  38             Data: data,
  39         });
  40     }
  41 }
  42
  43 export default Metric;