Skip to content

Commit fc73f3a

Browse files
committed
feat: Add distribution heatmaps calculated from PromQL values
1 parent eeabaeb commit fc73f3a

26 files changed

Lines changed: 1168 additions & 126 deletions

‎.changeset/nice-cows-hug.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
"@hyperdx/common-utils": patch
3+
"@hyperdx/api": patch
4+
"@hyperdx/app": patch
5+
---
6+
7+
feat: Support distribution heatmaps calculated from promql data

‎packages/app/src/components/ChartDisplaySettingsDrawer.tsx‎

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,8 @@ export type ChartConfigDisplaySettings = Pick<
6565
// PromQL-only: Handlebars template over each series' Prometheus label set
6666
// that renders the legend/tooltip name.
6767
legendTemplate?: string;
68-
// Distribution heatmaps only; stored on the heatmap's select[0].
68+
// Distribution heatmaps only; stored on a builder heatmap's select[0] and
69+
// on a PromQL heatmap's `heatmap.scaleType`.
6970
heatmapScaleType?: HeatmapScaleType;
7071
};
7172

@@ -90,6 +91,8 @@ interface ChartDisplaySettingsDrawerProps {
9091
promqlUsesRange?: boolean;
9192
/** A builder heatmap's mode; only distribution heatmaps have a numeric y axis to scale. */
9293
heatmapMode?: HeatmapMode;
94+
/** The heatmap scale used when the tile has none set. */
95+
defaultHeatmapScaleType?: HeatmapScaleType;
9396
previousDateRange?: [Date, Date];
9497
onChange: (settings: ChartConfigDisplaySettings, isDirty: boolean) => void;
9598
onClose: () => void;
@@ -98,7 +101,8 @@ interface ChartDisplaySettingsDrawerProps {
98101

99102
function applyDefaultSettings(
100103
settings: ChartConfigDisplaySettings,
101-
fallbackNumberFormat?: NumberFormat,
104+
fallbackNumberFormat: NumberFormat | undefined,
105+
defaultHeatmapScaleType: HeatmapScaleType,
102106
): DrawerFormValues {
103107
return {
104108
numberFormat:
@@ -121,7 +125,7 @@ function applyDefaultSettings(
121125
? attachLocalIds(settings.colorRules)
122126
: undefined,
123127
backgroundChart: settings.backgroundChart,
124-
heatmapScaleType: settings.heatmapScaleType ?? 'log',
128+
heatmapScaleType: settings.heatmapScaleType ?? defaultHeatmapScaleType,
125129
};
126130
}
127131

@@ -132,15 +136,21 @@ export default function ChartDisplaySettingsDrawer({
132136
configType,
133137
promqlUsesRange = false,
134138
heatmapMode,
139+
defaultHeatmapScaleType = 'log',
135140
defaultNumberFormat,
136141
onChange,
137142
onClose,
138143
previousDateRange,
139144
isPerSeriesNumberFormatAllowed = false,
140145
}: ChartDisplaySettingsDrawerProps) {
141146
const appliedDefaults = useMemo(
142-
() => applyDefaultSettings(settings, defaultNumberFormat),
143-
[settings, defaultNumberFormat],
147+
() =>
148+
applyDefaultSettings(
149+
settings,
150+
defaultNumberFormat,
151+
defaultHeatmapScaleType,
152+
),
153+
[settings, defaultNumberFormat, defaultHeatmapScaleType],
144154
);
145155

146156
const {
@@ -197,9 +207,10 @@ export default function ChartDisplaySettingsDrawer({
197207
applyDefaultSettings(
198208
{} as ChartConfigDisplaySettings,
199209
defaultNumberFormat,
210+
defaultHeatmapScaleType,
200211
),
201212
);
202-
}, [reset, defaultNumberFormat]);
213+
}, [reset, defaultNumberFormat, defaultHeatmapScaleType]);
203214

204215
const isTimeChart = isTimeSeriesDisplayType(displayType);
205216

@@ -212,12 +223,17 @@ export default function ChartDisplaySettingsDrawer({
212223
const isClientSideSeriesLimit =
213224
showSeriesLimit && (configType === 'sql' || configType === 'promql');
214225

226+
const isDistributionHeatmap =
227+
displayType === DisplayType.Heatmap && heatmapMode === 'distribution';
228+
215229
// Every PromQL display that surfaces a series name. A number tile shows one
216-
// value and a table gives each label its own column, so neither has a legend.
230+
// value, a table gives each label its own column, and a distribution heatmap
231+
// merges every series into one, so none has a legend.
217232
const showLegendTemplate =
218233
configType === 'promql' &&
219234
displayType !== DisplayType.Number &&
220-
displayType !== DisplayType.Table;
235+
displayType !== DisplayType.Table &&
236+
!isDistributionHeatmap;
221237

222238
// On pie/bar builder charts, seriesLimit becomes a plain SQL LIMIT on the
223239
// number of slices/bars; on PromQL it trims the reduced series client-side
@@ -254,8 +270,7 @@ export default function ChartDisplaySettingsDrawer({
254270
: 'Available on query-builder number tiles.';
255271

256272
// Log scale only means something on a numeric (distribution mode) y axis
257-
const showHeatmapScale =
258-
displayType === DisplayType.Heatmap && heatmapMode === 'distribution';
273+
const showHeatmapScale = isDistributionHeatmap;
259274

260275
return (
261276
<Drawer
@@ -343,7 +358,7 @@ export default function ChartDisplaySettingsDrawer({
343358
name="heatmapScaleType"
344359
render={({ field: { onChange, value } }) => (
345360
<HeatmapScaleControl
346-
value={value ?? 'log'}
361+
value={value ?? defaultHeatmapScaleType}
347362
onChange={onChange}
348363
/>
349364
)}

‎packages/app/src/components/ChartEditor/PromqlChartEditor.tsx‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ import {
1111
} from '@hyperdx/common-utils/dist/core/promql';
1212
import { isTimeSeriesDisplayType } from '@hyperdx/common-utils/dist/core/utils';
1313
import {
14+
DisplayType,
15+
HeatmapMode,
1416
MAX_PROMQL_EXPRESSIONS,
1517
SourceKind,
1618
} from '@hyperdx/common-utils/dist/types';
17-
import { Button, Divider, Flex, Group, Text } from '@mantine/core';
19+
import { Box, Button, Divider, Flex, Group, Text } from '@mantine/core';
1820
import { IconCirclePlus } from '@tabler/icons-react';
1921

22+
import { HeatmapModeControl } from '@/components/DBEditTimeChartForm/HeatmapModeControl';
2023
import { SourceSelectControlled } from '@/components/SourceSelect';
2124
import { usePromqlMetricNames } from '@/hooks/usePromqlMetadata';
2225
import { useSource } from '@/source';
@@ -30,12 +33,16 @@ export default function PromqlChartEditor({
3033
allowedSourceKinds,
3134
onSubmit,
3235
onOpenDisplaySettings,
36+
heatmapMode,
37+
onHeatmapModeChange,
3338
}: {
3439
control: Control<ChartEditorFormState>;
3540
getValues: UseFormGetValues<ChartEditorFormState>;
3641
allowedSourceKinds: SourceKind[];
3742
onSubmit: (suppressErrorNotification?: boolean) => void;
3843
onOpenDisplaySettings: () => void;
44+
heatmapMode: HeatmapMode;
45+
onHeatmapModeChange: (mode: HeatmapMode) => void;
3946
}) {
4047
const {
4148
fields: expressions,
@@ -106,6 +113,14 @@ export default function PromqlChartEditor({
106113
allowedSourceKinds={allowedSourceKinds}
107114
/>
108115
</Group>
116+
{displayType === DisplayType.Heatmap && (
117+
<Box mt="md">
118+
<HeatmapModeControl
119+
mode={heatmapMode}
120+
onModeChange={onHeatmapModeChange}
121+
/>
122+
</Box>
123+
)}
109124
{expressions.map((field, index) => (
110125
<PromqlExpressionEditor
111126
key={field.id}

‎packages/app/src/components/ChartEditor/__tests__/utils.test.ts‎

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -668,12 +668,12 @@ describe('PromQL expressions', () => {
668668
series: [],
669669
});
670670

671-
it('saves a heatmap with only its first expression queried and no heatmap mode', () => {
671+
it('saves a heatmap with only its first expression queried and its heatmap settings', () => {
672672
const result = convertFormStateToSavedChartConfig(
673673
{
674674
...promqlForm([{ expression: 'up' }], DisplayType.Heatmap),
675675
legendTemplate: '{{pod}}',
676-
heatmap: { mode: 'distribution' },
676+
heatmap: { mode: 'distribution', scaleType: 'log' },
677677
granularity: '5 minute',
678678
},
679679
undefined,
@@ -684,8 +684,37 @@ describe('PromQL expressions', () => {
684684
promqlExpression: [{ expression: 'up' }],
685685
legendTemplate: '{{pod}}',
686686
granularity: '5 minute',
687+
heatmap: { mode: 'distribution', scaleType: 'log' },
687688
});
688-
expect(result).not.toHaveProperty('heatmap');
689+
});
690+
691+
it('queries a heatmap with its heatmap settings', () => {
692+
const result = convertFormStateToChartConfig(
693+
{
694+
...promqlForm([{ expression: 'up' }], DisplayType.Heatmap),
695+
heatmap: { mode: 'series' },
696+
},
697+
[new Date(0), new Date(1000)],
698+
undefined,
699+
);
700+
expect(result).toMatchObject({ heatmap: { mode: 'series' } });
701+
});
702+
703+
it('drops heatmap settings from PromQL tiles that are not heatmaps', () => {
704+
const form = {
705+
...promqlForm([{ expression: 'up' }], DisplayType.Line),
706+
heatmap: { mode: 'series' as const },
707+
};
708+
expect(
709+
convertFormStateToSavedChartConfig(form, undefined),
710+
).not.toHaveProperty('heatmap', expect.anything());
711+
expect(
712+
convertFormStateToChartConfig(
713+
form,
714+
[new Date(0), new Date(1000)],
715+
undefined,
716+
),
717+
).not.toHaveProperty('heatmap', expect.anything());
689718
});
690719

691720
it('saves the form rows as the expression list', () => {

‎packages/app/src/components/ChartEditor/utils.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,7 @@ export function convertFormStateToSavedChartConfig(
280280
connection: form.connection ?? '',
281281
source: form.source || undefined,
282282
legendTemplate: form.legendTemplate?.trim() || undefined,
283+
heatmap: formPromqlHeatmap(form),
283284
};
284285

285286
return promqlConfig;
@@ -380,6 +381,7 @@ export function convertFormStateToChartConfig(
380381
source: form.source || undefined,
381382
from: source?.from,
382383
legendTemplate: form.legendTemplate?.trim() || undefined,
384+
heatmap: formPromqlHeatmap(form),
383385
};
384386

385387
return { ...promqlConfig, dateRange };
@@ -552,6 +554,13 @@ function formPromqlExpressions(form: ChartEditorFormState): PromqlSeries[] {
552554
}));
553555
}
554556

557+
/** Heatmap settings are dropped from PromQL tiles that are not heatmaps. */
558+
function formPromqlHeatmap(
559+
form: ChartEditorFormState,
560+
): PromqlSavedChartConfig['heatmap'] {
561+
return form.displayType === DisplayType.Heatmap ? form.heatmap : undefined;
562+
}
563+
555564
export const validateChartForm = (
556565
form: ChartEditorFormState,
557566
source: TSource | undefined,

‎packages/app/src/components/DBEditTimeChartForm/ChartPreviewPanel.tsx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,11 @@ function HeatmapSQLPreview({
106106
};
107107
const query = toHeatmapQuery(configWithTimestamp);
108108

109+
// Only PromQL heatmaps are calculated, and they have no SQL to preview
110+
if (query.mode === 'calculated') {
111+
return null;
112+
}
113+
109114
if (query.mode === 'series') {
110115
const seriesConfig = { ...query.config, dateRange };
111116
return (

0 commit comments

Comments
 (0)