Skip to content

feat(dashboards): Pass AreaChart series meta alongside the data #82653

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

Merged
merged 1 commit into from
Dec 30, 2024
Merged

feat(dashboards): Pass AreaChart series meta alongside the data #82653

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
8 changes: 0 additions & 8 deletions static/app/views/dashboards/widgets/areaChartWidget/areaChartWidget.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,6 @@ describe('AreaChartWidget', () => {
title="eps()"
description="Number of events per second"
timeseries={[sampleLatencyTimeSeries, sampleSpanDurationTimeSeries]}
meta={{
fields: {
'eps()': 'rate',
},
units: {
'eps()': '1/second',
},
}}
/>
);
});
Expand Down
30 changes: 0 additions & 30 deletions static/app/views/dashboards/widgets/areaChartWidget/areaChartWidget.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,16 +66,6 @@ export default storyBook(AreaChartWidget, story => {
title="Duration Breakdown"
description="Explains what proportion of total duration is taken up by latency vs. span duration"
timeseries={[latencyTimeSeries, spanDurationTimeSeries]}
meta={{
fields: {
'avg(latency)': 'duration',
'avg(span.duration)': 'duration',
},
units: {
'avg(latency)': 'millisecond',
'avg(span.duration)': 'millisecond',
},
}}
/>
</SmallSizingWindow>
</Fragment>
Expand Down Expand Up @@ -135,16 +125,6 @@ export default storyBook(AreaChartWidget, story => {

{...sampleSpanDurationTimeSeries, color: theme.warning},
]}
meta={{
fields: {
'avg(latency)': 'duration',
'avg(span.duration)': 'duration',
},
units: {
'avg(latency)': 'millisecond',
'avg(span.duration)': 'millisecond',
},
}}
/>
</MediumWidget>
</Fragment>
Expand Down Expand Up @@ -175,16 +155,6 @@ export default storyBook(AreaChartWidget, story => {
<AreaChartWidget
title="error_rate()"
timeseries={[sampleLatencyTimeSeries, sampleSpanDurationTimeSeries]}
meta={{
fields: {
'avg(latency)': 'duration',
'avg(span.duration)': 'duration',
},
units: {
'avg(latency)': 'millisecond',
'avg(span.duration)': 'millisecond',
},
}}
releases={releases}
/>
</MediumWidget>
Expand Down
1 change: 0 additions & 1 deletion static/app/views/dashboards/widgets/areaChartWidget/areaChartWidget.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ export function AreaChartWidget(props: AreaChartWidgetProps) {
<AreaChartWidgetVisualization
timeseries={timeseries}
releases={props.releases}
meta={props.meta}
/>
</AreaChartWrapper>
)}
Expand Down
8 changes: 3 additions & 5 deletions static/app/views/dashboards/widgets/areaChartWidget/areaChartWidgetVisualization.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,10 @@ import {useWidgetSyncContext} from '../../contexts/widgetSyncContext';
import {formatTooltipValue} from '../common/formatTooltipValue';
import {formatYAxisValue} from '../common/formatYAxisValue';
import {ReleaseSeries} from '../common/releaseSeries';
import type {Meta, Release, TimeseriesData} from '../common/types';
import type {Release, TimeseriesData} from '../common/types';

export interface AreaChartWidgetVisualizationProps {
timeseries: TimeseriesData[];
meta?: Meta;
releases?: Release[];
}

Expand All @@ -37,7 +36,6 @@ export function AreaChartWidgetVisualization(props: AreaChartWidgetVisualization

const pageFilters = usePageFilters();
const {start, end, period, utc} = pageFilters.selection.datetime;
const {meta} = props;

const theme = useTheme();
const organization = useOrganization();
Expand Down Expand Up @@ -69,8 +67,8 @@ export function AreaChartWidgetVisualization(props: AreaChartWidgetVisualization

// TODO: Raise error if attempting to plot series of different types or units
const firstSeriesField = firstSeries?.field;
const type = meta?.fields?.[firstSeriesField] ?? 'number';
const unit = meta?.units?.[firstSeriesField] ?? undefined;
const type = firstSeries?.meta?.fields?.[firstSeriesField] ?? 'number';
const unit = firstSeries?.meta?.units?.[firstSeriesField] ?? undefined;

const formatter: TooltipFormatterCallback<TopLevelFormatterParams> = (
params,
Expand Down
8 changes: 8 additions & 0 deletions static/app/views/dashboards/widgets/areaChartWidget/sampleLatencyTimeSeries.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"field": "avg(latency)",
"meta": {
"fields": {
"avg(latency)": "duration"
},
"units": {
"avg(latency)": "millisecond"
}
},
"data": [
{
"timestamp": "2024-12-09T22:00:00Z",
Expand Down
8 changes: 8 additions & 0 deletions static/app/views/dashboards/widgets/areaChartWidget/sampleSpanDurationTimeSeries.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
{
"field": "avg(span.duration)",
"meta": {
"fields": {
"avg(span.duration)": "duration"
},
"units": {
"avg(span.duration)": "millisecond"
}
},
"data": [
{
"timestamp": "2024-12-09T22:00:00Z",
Expand Down
Loading