@sentio/sdk 1.12.6 → 1.13.0

package/src/meter.ts

@@ -1,4 +1,4 @@
-import { RecordMetaData } from './gen/processor/protos/processor'
+import { MetricDescriptor, RecordMetaData } from './gen/processor/protos/processor'
 import { BaseContext, Context, SolanaContext, SuiContext } from './context'
 import { toMetricValue, Numberish } from './numberish'
 import Long from 'long'
@@ -27,8 +27,14 @@ export function normalizeLabels(labels: Labels): Labels {
   return normLabels
 }
 
-function GetRecordMetaData(ctx: BaseContext, name: string, labels: Labels): RecordMetaData {
-  name = normalizeName(name)
+function GetRecordMetaData(ctx: BaseContext, metric: Metric, labels: Labels): RecordMetaData {
+  let descriptor = metric.descriptor
+  if (metric.usage > 0) {
+    // Other setting don't need to be write multiple times
+    descriptor = MetricDescriptor.fromPartial({ name: descriptor.name })
+  }
+
+  descriptor.name = normalizeName(descriptor.name)
 
   if (ctx instanceof Context) {
     if (ctx.log) {
@@ -38,7 +44,8 @@ function GetRecordMetaData(ctx: BaseContext, name: string, labels: Labels): Reco
         transactionIndex: ctx.log.transactionIndex,
         logIndex: ctx.log.logIndex,
         chainId: ctx.chainId.toString(),
-        name: name,
+        name: descriptor.name,
+        descriptor: descriptor,
         labels: normalizeLabels(labels),
       }
     }
@@ -49,7 +56,8 @@ function GetRecordMetaData(ctx: BaseContext, name: string, labels: Labels): Reco
         transactionIndex: -1,
         logIndex: -1,
         chainId: ctx.chainId.toString(),
-        name: name,
+        name: descriptor.name,
+        descriptor: descriptor,
         labels: normalizeLabels(labels),
       }
     }
@@ -60,7 +68,8 @@ function GetRecordMetaData(ctx: BaseContext, name: string, labels: Labels): Reco
         transactionIndex: ctx.trace.transactionPosition, // TODO make sure if this is the right value to set
         logIndex: -1,
         chainId: ctx.chainId.toString(),
-        name: name,
+        name: descriptor.name,
+        descriptor: descriptor,
         labels: normalizeLabels(labels),
       }
     }
@@ -71,7 +80,8 @@ function GetRecordMetaData(ctx: BaseContext, name: string, labels: Labels): Reco
       transactionIndex: 0,
       logIndex: 0,
       chainId: 'SOL_mainnet', // TODO set in context
-      name: name,
+      name: descriptor.name,
+      descriptor: descriptor,
       labels: normalizeLabels(labels),
     }
   } else if (ctx instanceof SuiContext) {
@@ -81,7 +91,8 @@ function GetRecordMetaData(ctx: BaseContext, name: string, labels: Labels): Reco
       transactionIndex: 0,
       logIndex: 0,
       chainId: 'SUI_devnet', // TODO set in context
-      name: name,
+      name: descriptor.name,
+      descriptor: descriptor,
       labels: normalizeLabels(labels),
     }
   }
@@ -90,80 +101,107 @@ function GetRecordMetaData(ctx: BaseContext, name: string, labels: Labels): Reco
 
 export type Labels = { [key: string]: string }
 
-export class Counter {
+export class MetricDescriptorOption {
+  unit?: string
+  description?: string
+  sparse?: boolean
+}
+
+export class Metric {
+  descriptor: MetricDescriptor = MetricDescriptor.fromPartial({})
+  usage = 0
+
+  constructor(name: string, option?: MetricDescriptorOption) {
+    this.descriptor.name = name
+    if (option) {
+      if (option.unit) {
+        this.descriptor.unit = option.unit
+      }
+      if (option.description) {
+        this.descriptor.description = option.description
+      }
+      if (option.sparse) {
+        this.descriptor.sparse = option.sparse
+      }
+    }
+  }
+}
+
+export class Counter extends Metric {
+  add(ctx: BaseContext, value: Numberish, labels: Labels = {}) {
+    this.record(ctx, value, labels, true)
+  }
+
+  sub(ctx: BaseContext, value: Numberish, labels: Labels = {}) {
+    this.record(ctx, value, labels, false)
+  }
+
+  private record(ctx: BaseContext, value: Numberish, labels: Labels, add: boolean) {
+    ctx.counters.push({
+      metadata: GetRecordMetaData(ctx, this, labels),
+      metricValue: toMetricValue(value),
+      add: add,
+      runtimeInfo: undefined,
+    })
+    this.usage++
+  }
+}
+
+export class CounterBinding {
   private readonly ctx: BaseContext
-  private readonly name: string
+  private readonly counter: Counter
 
   constructor(name: string, ctx: BaseContext) {
-    this.name = name
+    this.counter = new Counter(name)
     this.ctx = ctx
   }
 
   add(value: Numberish, labels: Labels = {}) {
-    this.record(value, labels, true)
+    this.counter.add(this.ctx, value, labels)
   }
 
   sub(value: Numberish, labels: Labels = {}) {
-    this.record(value, labels, false)
+    this.counter.sub(this.ctx, value, labels)
   }
+}
 
-  private record(value: Numberish, labels: Labels, add: boolean) {
-    this.ctx.counters.push({
-      metadata: GetRecordMetaData(this.ctx, this.name, labels),
+export class Gauge extends Metric {
+  record(ctx: BaseContext, value: Numberish, labels: Labels = {}) {
+    ctx.gauges.push({
+      metadata: GetRecordMetaData(ctx, this, labels),
       metricValue: toMetricValue(value),
-      add: add,
       runtimeInfo: undefined,
     })
+    this.usage++
   }
 }
 
-export class Gauge {
-  private readonly name: string
+export class GaugeBinding {
+  private readonly gauge: Gauge
   private readonly ctx: BaseContext
 
   constructor(name: string, ctx: BaseContext) {
-    this.name = name
+    this.gauge = new Gauge(name)
     this.ctx = ctx
   }
 
   record(value: Numberish, labels: Labels = {}) {
-    this.ctx.gauges.push({
-      metadata: GetRecordMetaData(this.ctx, this.name, labels),
-      metricValue: toMetricValue(value),
-      runtimeInfo: undefined,
-    })
+    this.gauge.record(this.ctx, value, labels)
   }
 }
 
 export class Meter {
   private readonly ctx: BaseContext
 
-  // TODO is map necessary since we are sending request remotely?
-  // counterMap = new Map<string, Counter>()
-  // gaugeMap = new Map<string, Gauge>()
-
   constructor(ctx: BaseContext) {
     this.ctx = ctx
   }
 
-  Counter(name: string): Counter {
-    // let counter = this.counterMap.get(name)
-
-    // if (!counter) {
-    //     counter =  new Counter(name, this.ctx)
-    // }
-    // return counter
-
-    return new Counter(name, this.ctx)
+  Counter(name: string): CounterBinding {
+    return new CounterBinding(name, this.ctx)
   }
 
-  Gauge(name: string): Gauge {
-    // let gauge = this.gaugeMap.get(name)
-    //
-    // if (!gauge) {
-    //     gauge = new Gauge(name, this.ctx)
-    // }
-    // return gauge
-    return new Gauge(name, this.ctx)
+  Gauge(name: string): GaugeBinding {
+    return new GaugeBinding(name, this.ctx)
   }
 }