add details about regex and improve name

Author: AbhiPrasad

packages/core/src/metrics/constants.ts

@@ -3,7 +3,24 @@ export const GAUGE_METRIC_TYPE = 'g';
 export const SET_METRIC_TYPE = 's';
 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;
+/**
+ * Normalization regex for metric names and metric tag names.
+ *
+ * This enforces that names and tag keys only contain alphanumeric characters,
+ * underscores, forward slashes, periods, and dashes.
+ *
+ * See: https://develop.sentry.dev/sdk/metrics/#normalization
+ */
+export const NAME_AND_TAG_KEY_NORMALIZATION_REGEX = /[^a-zA-Z0-9_/.-]+/g;
+
+/**
+ * Normalization regex for metric tag balues.
+ *
+ * This enforces that values only contain words, digits, or the following
+ * special characters: _:/@.{}[\]$-
+ *
+ * See: https://develop.sentry.dev/sdk/metrics/#normalization
+ */
+export const TAG_VALUE_NORMALIZATION_REGEX = /[^\w\d_:/@.{}[\]$-]+/g;
 
 export const DEFAULT_FLUSH_INTERVAL = 5000;

packages/core/src/metrics/simpleaggregator.ts

@@ -1,6 +1,10 @@
 import type { Client, ClientOptions, MeasurementUnit, Primitive } from '@sentry/types';
 import { timestampInSeconds } from '@sentry/utils';
-import { DEFAULT_FLUSH_INTERVAL, NAME_AND_TAG_KEY_REGEX, TAG_VALUE_REGEX } from './constants';
+import {
+  DEFAULT_FLUSH_INTERVAL,
+  NAME_AND_TAG_KEY_NORMALIZATION_REGEX,
+  TAG_VALUE_NORMALIZATION_REGEX,
+} from './constants';
 import type { Metric } from './instance';
 import { METRIC_MAP } from './instance';
 import type { MetricType, MetricsAggregator } from './types';
@@ -45,7 +49,7 @@ export class SimpleMetricsAggregator implements MetricsAggregator {
     maybeFloatTimestamp = timestampInSeconds(),
   ): void {
     const timestamp = Math.floor(maybeFloatTimestamp);
-    const name = unsanitizedName.replace(NAME_AND_TAG_KEY_REGEX, '_');
+    const name = unsanitizedName.replace(NAME_AND_TAG_KEY_NORMALIZATION_REGEX, '_');
     const tags = sanitizeTags(unsanitizedTags);
 
     const bucketKey = getBucketKey(metricType, name, unit, tags);
@@ -112,8 +116,8 @@ function sanitizeTags(unsanitizedTags: { [key: string]: Primitive }): { [key: st
   const tags: { [key: string]: string } = {};
   for (const key in unsanitizedTags) {
     if (Object.prototype.hasOwnProperty.call(unsanitizedTags, key)) {
-      const sanitizedKey = key.replace(NAME_AND_TAG_KEY_REGEX, '_');
-      tags[sanitizedKey] = String(unsanitizedTags[key]).replace(TAG_VALUE_REGEX, '_');
+      const sanitizedKey = key.replace(NAME_AND_TAG_KEY_NORMALIZATION_REGEX, '_');
+      tags[sanitizedKey] = String(unsanitizedTags[key]).replace(TAG_VALUE_NORMALIZATION_REGEX, '_');
     }
   }
   return tags;