Skip to content

ref(dashboards): Simplify TimeSeries field meta #86834

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.

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

Merged
merged 5 commits into from
Mar 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions static/app/utils/discover/fields.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,8 @@ export const RATE_UNIT_TITLE: Record<RateUnit, string> = {
[RateUnit.PER_HOUR]: 'Per Hour',
};

export type DataUnit = DurationUnit | SizeUnit | RateUnit | null;

const getDocsAndOutputType = (key: AggregationKey) => {
return {
documentation: AGGREGATION_FIELDS[key].desc,
Expand Down
48 changes: 12 additions & 36 deletions static/app/utils/timeSeries/scaleTimeSeriesData.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,8 @@ describe('scaleTimeSeriesData', () => {
},
],
meta: {
fields: {
user: 'string',
},
units: {
user: null,
},
type: 'string',
unit: null,
},
};

Expand All @@ -40,12 +36,8 @@ describe('scaleTimeSeriesData', () => {
},
],
meta: {
fields: {
'transaction.duration': 'duration',
},
units: {
'transaction.duration': 'second',
},
type: 'duration',
unit: DurationUnit.SECOND,
},
};

Expand All @@ -62,12 +54,8 @@ describe('scaleTimeSeriesData', () => {
},
],
meta: {
fields: {
'transaction.duration': 'duration',
},
units: {
'transaction.duration': 'second',
},
type: 'duration',
unit: DurationUnit.SECOND,
},
};

Expand All @@ -80,12 +68,8 @@ describe('scaleTimeSeriesData', () => {
},
],
meta: {
fields: {
'transaction.duration': 'duration',
},
units: {
'transaction.duration': 'millisecond',
},
type: 'duration',
unit: DurationUnit.MILLISECOND,
},
});
});
Expand All @@ -100,12 +84,8 @@ describe('scaleTimeSeriesData', () => {
},
],
meta: {
fields: {
'file.size': 'size',
},
units: {
'file.size': 'mebibyte',
},
type: 'size',
unit: SizeUnit.MEBIBYTE,
},
};

Expand All @@ -118,12 +98,8 @@ describe('scaleTimeSeriesData', () => {
},
],
meta: {
fields: {
'file.size': 'size',
},
units: {
'file.size': 'byte',
},
type: 'size',
unit: SizeUnit.BYTE,
},
});
});
Expand Down
21 changes: 6 additions & 15 deletions static/app/utils/timeSeries/scaleTimeSeriesData.tsx
Original file line number Diff line number Diff line change
@@ -1,12 +1,7 @@
import * as Sentry from '@sentry/react';
import partialRight from 'lodash/partialRight';

import type {
AggregationOutputType,
DurationUnit,
RateUnit,
SizeUnit,
} from 'sentry/utils/discover/fields';
import type {AggregationOutputType, DataUnit} from 'sentry/utils/discover/fields';
import {convertDuration} from 'sentry/utils/unitConversion/convertDuration';
import {convertRate} from 'sentry/utils/unitConversion/convertRate';
import {convertSize} from 'sentry/utils/unitConversion/convertSize';
Expand All @@ -24,19 +19,19 @@ import {

export function scaleTimeSeriesData(
timeSeries: Readonly<TimeSeries>,
destinationUnit: DurationUnit | SizeUnit | RateUnit | null
destinationUnit: DataUnit
): TimeSeries {
// TODO: Instead of a fallback, allow this to be `null`, which might happen
const sourceType =
(timeSeries.meta?.fields[timeSeries.field] as AggregationOutputType) ??
(timeSeries.meta?.type as AggregationOutputType) ??
(FALLBACK_TYPE as AggregationOutputType);

// Don't bother trying to convert numbers, dates, etc.
if (!isAUnitConvertibleFieldType(sourceType)) {
return timeSeries;
}

const sourceUnit = timeSeries.meta?.units?.[timeSeries.field] ?? null;
const sourceUnit = timeSeries.meta?.unit;

if (!destinationUnit || sourceUnit === destinationUnit) {
return timeSeries;
Expand Down Expand Up @@ -87,12 +82,8 @@ export function scaleTimeSeriesData(
}),
meta: {
...timeSeries.meta,
fields: {
[timeSeries.field]: sourceType,
},
units: {
[timeSeries.field]: destinationUnit,
},
type: sourceType,
unit: destinationUnit,
},
};
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import {resetMockDate, setMockDate} from 'sentry-test/utils';

import {DurationUnit} from '../discover/fields';

import {splitSeriesIntoCompleteAndIncomplete} from './splitSeriesIntoCompleteAndIncomplete';

describe('splitSeriesIntoCompleteAndIncomplete', () => {
Expand Down Expand Up @@ -29,12 +31,8 @@ describe('splitSeriesIntoCompleteAndIncomplete', () => {
},
],
meta: {
fields: {
'p99(span.duration)': 'duration',
},
units: {
'p99(span.duration)': 'millisecond',
},
type: 'duration',
unit: DurationUnit.MILLISECOND,
},
};

Expand Down Expand Up @@ -83,12 +81,8 @@ describe('splitSeriesIntoCompleteAndIncomplete', () => {
},
],
meta: {
fields: {
'p99(span.duration)': 'duration',
},
units: {
'p99(span.duration)': 'millisecond',
},
type: 'duration',
unit: DurationUnit.MILLISECOND,
},
};

Expand Down Expand Up @@ -145,12 +139,8 @@ describe('splitSeriesIntoCompleteAndIncomplete', () => {
},
],
meta: {
fields: {
'p99(span.duration)': 'duration',
},
units: {
'p99(span.duration)': 'millisecond',
},
type: 'duration',
unit: DurationUnit.MILLISECOND,
},
};

Expand Down Expand Up @@ -214,12 +204,8 @@ describe('splitSeriesIntoCompleteAndIncomplete', () => {
},
],
meta: {
fields: {
'p99(span.duration)': 'duration',
},
units: {
'p99(span.duration)': 'millisecond',
},
type: 'duration',
unit: DurationUnit.MILLISECOND,
},
};

Expand Down
7 changes: 5 additions & 2 deletions static/app/views/dashboards/widgetCard/chart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ import {
tooltipFormatter,
} from 'sentry/utils/discover/charts';
import type {EventsMetaType, MetaType} from 'sentry/utils/discover/eventView';
import type {AggregationOutputType} from 'sentry/utils/discover/fields';
import type {AggregationOutputType, DataUnit} from 'sentry/utils/discover/fields';
import {
aggregateOutputType,
getAggregateArg,
Expand Down Expand Up @@ -225,7 +225,10 @@ class WidgetCardChart extends Component<WidgetCardChartProps> {
key={i}
field={field}
value={value}
meta={meta}
meta={{
type: meta.fields?.[field] ?? null,
unit: (meta.units?.[field] as DataUnit) ?? null,
}}
thresholds={widget.thresholds ?? undefined}
preferredPolarity="-"
/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {render, screen, userEvent} from 'sentry-test/reactTestingLibrary';
import {textWithMarkupMatcher} from 'sentry-test/utils';

import {DurationUnit, RateUnit} from 'sentry/utils/discover/fields';
import {BigNumberWidgetVisualization} from 'sentry/views/dashboards/widgets/bigNumberWidget/bigNumberWidgetVisualization';

import {Widget} from '../widget/widget';
Expand All @@ -23,10 +24,8 @@ describe('BigNumberWidgetVisualization', () => {
value={Infinity}
field="count()"
meta={{
fields: {
'count()': 'number',
},
units: {},
type: 'number',
unit: null,
}}
/>
}
Expand All @@ -42,12 +41,8 @@ describe('BigNumberWidgetVisualization', () => {
value={'2024-10-17T16:08:07+00:00'}
field="max(timestamp)"
meta={{
fields: {
'max(timestamp)': 'date',
},
units: {
'max(timestamp)': null,
},
type: 'date',
unit: null,
}}
/>
);
Expand All @@ -61,10 +56,8 @@ describe('BigNumberWidgetVisualization', () => {
value={'/api/0/fetch'}
field="any(transaction)"
meta={{
fields: {
'max(timestamp)': 'string',
},
units: {},
type: 'string',
unit: null,
}}
/>
);
Expand All @@ -78,12 +71,8 @@ describe('BigNumberWidgetVisualization', () => {
value={17.28}
field="p95(span.duration)"
meta={{
fields: {
'p95(span.duration)': 'duration',
},
units: {
'p95(span.duration)': 'milliseconds',
},
type: 'duration',
unit: DurationUnit.MILLISECOND,
}}
/>
);
Expand All @@ -97,12 +86,8 @@ describe('BigNumberWidgetVisualization', () => {
value={178451214}
field="count()"
meta={{
fields: {
'count()': 'integer',
},
units: {
'count()': null,
},
type: 'integer',
unit: null,
}}
/>
);
Expand All @@ -119,10 +104,8 @@ describe('BigNumberWidgetVisualization', () => {
field="count()"
maximumValue={100000000}
meta={{
fields: {
'count()': 'integer',
},
units: {},
type: 'integer',
unit: null,
}}
/>
);
Expand All @@ -139,12 +122,8 @@ describe('BigNumberWidgetVisualization', () => {
previousPeriodValue={0.1728139}
field="http_response_code_rate(500)"
meta={{
fields: {
'http_response_code_rate(500)': 'percentage',
},
units: {
'http_response_code_rate(500)': null,
},
type: 'percentage',
unit: null,
}}
/>
);
Expand All @@ -161,12 +140,8 @@ describe('BigNumberWidgetVisualization', () => {
value={14.227123}
field="eps()"
meta={{
fields: {
'eps()': 'rate',
},
units: {
'eps()': '1/second',
},
type: 'rate',
unit: RateUnit.PER_SECOND,
}}
thresholds={{
max_values: {
Expand All @@ -190,12 +165,8 @@ describe('BigNumberWidgetVisualization', () => {
value={135} // 2.25/s
field="mystery_error_rate()"
meta={{
fields: {
'mystery_error_rate()': 'rate',
},
units: {
'mystery_error_rate()': '1/minute',
},
type: 'rate',
unit: RateUnit.PER_MINUTE,
}}
thresholds={{
max_values: {
Expand All @@ -216,12 +187,8 @@ describe('BigNumberWidgetVisualization', () => {
value={135}
field="mystery_error_rate()"
meta={{
fields: {
'mystery_error_rate()': 'rate',
},
units: {
'mystery_error_rate()': '1/second',
},
type: 'rate',
unit: RateUnit.PER_SECOND,
}}
thresholds={{
max_values: {
Expand Down
Loading
Loading