refactor client logic

Author: AbhiPrasad

packages/core/src/baseclient.ts

@@ -49,6 +49,7 @@ import { createEventEnvelope, createSessionEnvelope } from './envelope';
 import { getCurrentHub } from './hub';
 import type { IntegrationIndex } from './integration';
 import { setupIntegration, setupIntegrations } from './integration';
+import { createMetricEnvelope } from './metrics/envelope';
 import type { MetricsAggregator } from './metrics/types';
 import type { Scope } from './scope';
 import { updateSession } from './session';
@@ -289,6 +290,9 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
   public close(timeout?: number): PromiseLike<boolean> {
     return this.flush(timeout).then(result => {
       this.getOptions().enabled = false;
+      if (this.metricsAggregator) {
+        this.metricsAggregator.close();
+      }
       return result;
     });
   }
@@ -394,6 +398,19 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
     }
   }
 
+  /**
+   * @inheritDoc
+   */
+  public captureSerializedMetrics(serializedMetrics: string): void {
+    const metricsEnvelope = createMetricEnvelope(
+      serializedMetrics,
+      this._dsn,
+      this._options._metadata,
+      this._options.tunnel,
+    );
+    void this._sendEnvelope(metricsEnvelope);
+  }
+
   // Keep on() & emit() signatures in sync with types' client.ts interface
   /* eslint-disable @typescript-eslint/unified-signatures */
 

packages/core/src/metrics/constants.ts

@@ -5,3 +5,5 @@ export const DISTRIBUTION_METRIC_TYPE = 'd';
 
 export const NAME_AND_TAG_KEY_REGEX = /[^a-zA-Z0-9_/.-]+"/g;
 export const TAG_VALUE_REGEX = /[^\w\d_:/@.{}[\]$-]+/g;
+
+export const DEFAULT_FLUSH_INTERVAL = 5000;

packages/core/src/metrics/envelope.ts

@@ -6,9 +6,9 @@ import { createEnvelope, dsnToString } from '@sentry/utils';
  */
 export function createMetricEnvelope(
   metricAggregate: string,
+  dsn?: DsnComponents,
   metadata?: SdkMetadata,
   tunnel?: string,
-  dsn?: DsnComponents,
 ): StatsdEnvelope {
   const headers: StatsdEnvelope[0] = {
     sent_at: new Date().toISOString(),

packages/core/src/metrics/simpleaggregator.ts

@@ -1,8 +1,6 @@
-import type { ClientOptions, MeasurementUnit, Primitive } from '@sentry/types';
+import type { Client, ClientOptions, MeasurementUnit, Primitive } from '@sentry/types';
 import { timestampInSeconds } from '@sentry/utils';
-import type { BaseClient } from '../baseclient';
-import { NAME_AND_TAG_KEY_REGEX, TAG_VALUE_REGEX } from './constants';
-import { createMetricEnvelope } from './envelope';
+import { DEFAULT_FLUSH_INTERVAL, NAME_AND_TAG_KEY_REGEX, TAG_VALUE_REGEX } from './constants';
 import type { Metric } from './instance';
 import { METRIC_MAP } from './instance';
 import type { MetricType, MetricsAggregator } from './types';
@@ -22,14 +20,17 @@ type SimpleMetricBucket = Map<
 
 /**
  * A simple metrics aggregator that aggregates metrics in memory and flushes them periodically.
+ * Default flush interval is 5 seconds.
  *
  * @experimental This API is experimental and might change in the future.
  */
 export class SimpleMetricsAggregator implements MetricsAggregator {
   private _buckets: SimpleMetricBucket;
+  private readonly _interval: ReturnType<typeof setInterval>;
 
-  public constructor(private readonly _client: BaseClient<ClientOptions>) {
+  public constructor(private readonly _client: Client<ClientOptions>) {
     this._buckets = new Map();
+    this._interval = setInterval(() => this.flush(), DEFAULT_FLUSH_INTERVAL);
   }
 
   /**
@@ -71,18 +72,18 @@ export class SimpleMetricsAggregator implements MetricsAggregator {
       return;
     }
 
-    // Allow of this logic should be in the client, but we want to
-    const metrics = serializeBuckets(this._buckets);
-    const sdkMetadata = this._client.getSdkMetadata && this._client.getSdkMetadata();
-    const metricsEnvelope = createMetricEnvelope(
-      metrics,
-      sdkMetadata,
-      this._client.getOptions().tunnel,
-      this._client.getDsn(),
-    );
+    if (this._client.captureSerializedMetrics) {
+      this._client.captureSerializedMetrics(serializeBuckets(this._buckets));
+    }
+    this._buckets.clear();
+  }
 
-    // TODO(abhi): Remove this hack - only here until we decide on final API for metrics on client
-    void this._client['_sendEnvelope'](metricsEnvelope);
+  /**
+   * @inheritDoc
+   */
+  public close(): void {
+    clearInterval(this._interval);
+    this.flush();
     this._buckets.clear();
   }
 }

packages/core/src/metrics/types.ts

@@ -28,4 +28,9 @@ export interface MetricsAggregator {
    * Flushes the current metrics to the transport via the transport.
    */
   flush(): void;
+
+  /**
+   * Shuts down metrics aggregator and clears all metrics.
+   */
+  close(): void;
 }

packages/types/src/client.ts

@@ -179,6 +179,13 @@ export interface Client<O extends ClientOptions = ClientOptions> {
    */
   recordDroppedEvent(reason: EventDropReason, dataCategory: DataCategory, event?: Event): void;
 
+  /**
+   * Captures serialized metrics and sends them to Sentry.
+   *
+   * @experimental This API is experimental and might experience breaking changes
+   */
+  captureSerializedMetrics?(serializedMetrics: string): void;
+
   // HOOKS
   // TODO(v8): Make the hooks non-optional.
   /* eslint-disable @typescript-eslint/unified-signatures */