Skip to content

ref(core): Type metric units with MetricUnit #23304

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
logaretm wants to merge 1 commit into
base: develop
Choose a base branch
from
+10 −3
Draft

ref(core): Type metric units with MetricUnit #23304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/core/src/metrics/public-api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { Scope } from '../scope';
import type { MetricUnit } from '../types/measurement';
import type { Metric, MetricType } from '../types/metric';
import { _INTERNAL_captureMetric } from './internal';

Expand All @@ -9,7 +10,7 @@ export interface MetricOptions {
/**
* The unit of the metric value.
*/
unit?: string;
unit?: MetricUnit;

/**
* Arbitrary structured data that stores information about the metric.
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/shared-exports.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,7 @@ export type {
InformationUnit,
FractionUnit,
MeasurementUnit,
MetricUnit,
NoneUnit,
Measurements,
} from './types/measurement';
Expand Down
4 changes: 4 additions & 0 deletions packages/core/src/types/measurement.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,7 @@ type LiteralUnion<T extends string> = T | Omit<T, T>;
export type MeasurementUnit = LiteralUnion<DurationUnit | InformationUnit | FractionUnit | NoneUnit>;

export type Measurements = Record<string, { value: number; unit: MeasurementUnit }>;

// Unlike MeasurementUnit, metric units have no NoneUnit: a unitless metric omits the unit field
// rather than sending 'none'. See https://develop.sentry.dev/sdk/telemetry/attributes/#units
export type MetricUnit = LiteralUnion<DurationUnit | InformationUnit | FractionUnit>;
5 changes: 3 additions & 2 deletions packages/core/src/types/metric.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import type { Attributes, TypedAttributeValue } from '../attributes';
import type { MetricUnit } from './measurement';

export type MetricType = 'counter' | 'gauge' | 'distribution';

Expand All @@ -21,7 +22,7 @@ export interface Metric {
/**
* The unit of the metric value.
*/
unit?: string;
unit?: MetricUnit;

/**
* Arbitrary structured data that stores information about the metric.
Expand Down Expand Up @@ -63,7 +64,7 @@ export interface SerializedMetric {
/**
* The unit of the metric value.
*/
unit?: string;
unit?: MetricUnit;

/**
* The value of the metric.
Expand Down
Loading