Skip to content
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
7 changes: 7 additions & 0 deletions .changeset/nice-cows-hug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@hyperdx/common-utils": patch
"@hyperdx/api": patch
"@hyperdx/app": patch
---

feat: Support distribution heatmaps calculated from promql data
37 changes: 26 additions & 11 deletions packages/app/src/components/ChartDisplaySettingsDrawer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ export type ChartConfigDisplaySettings = Pick<
// PromQL-only: Handlebars template over each series' Prometheus label set
// that renders the legend/tooltip name.
legendTemplate?: string;
// Distribution heatmaps only; stored on the heatmap's select[0].
// Distribution heatmaps only; stored on a builder heatmap's select[0] and
// on a PromQL heatmap's `heatmap.scaleType`.
heatmapScaleType?: HeatmapScaleType;
};

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

function applyDefaultSettings(
settings: ChartConfigDisplaySettings,
fallbackNumberFormat?: NumberFormat,
fallbackNumberFormat: NumberFormat | undefined,
defaultHeatmapScaleType: HeatmapScaleType,
): DrawerFormValues {
return {
numberFormat:
Expand All @@ -121,7 +125,7 @@ function applyDefaultSettings(
? attachLocalIds(settings.colorRules)
: undefined,
backgroundChart: settings.backgroundChart,
heatmapScaleType: settings.heatmapScaleType ?? 'log',
heatmapScaleType: settings.heatmapScaleType ?? defaultHeatmapScaleType,
};
}

Expand All @@ -132,15 +136,21 @@ export default function ChartDisplaySettingsDrawer({
configType,
promqlUsesRange = false,
heatmapMode,
defaultHeatmapScaleType = 'log',
defaultNumberFormat,
onChange,
onClose,
previousDateRange,
isPerSeriesNumberFormatAllowed = false,
}: ChartDisplaySettingsDrawerProps) {
const appliedDefaults = useMemo(
() => applyDefaultSettings(settings, defaultNumberFormat),
[settings, defaultNumberFormat],
() =>
applyDefaultSettings(
settings,
defaultNumberFormat,
defaultHeatmapScaleType,
),
[settings, defaultNumberFormat, defaultHeatmapScaleType],
);

const {
Expand Down Expand Up @@ -197,9 +207,10 @@ export default function ChartDisplaySettingsDrawer({
applyDefaultSettings(
{} as ChartConfigDisplaySettings,
defaultNumberFormat,
defaultHeatmapScaleType,
),
);
}, [reset, defaultNumberFormat]);
}, [reset, defaultNumberFormat, defaultHeatmapScaleType]);

const isTimeChart = isTimeSeriesDisplayType(displayType);

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

const isDistributionHeatmap =
displayType === DisplayType.Heatmap && heatmapMode === 'distribution';

// Every PromQL display that surfaces a series name. A number tile shows one
// value and a table gives each label its own column, so neither has a legend.
// value, a table gives each label its own column, and a distribution heatmap
// merges every series into one, so none has a legend.
const showLegendTemplate =
configType === 'promql' &&
displayType !== DisplayType.Number &&
displayType !== DisplayType.Table;
displayType !== DisplayType.Table &&
!isDistributionHeatmap;

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

// Log scale only means something on a numeric (distribution mode) y axis
const showHeatmapScale =
displayType === DisplayType.Heatmap && heatmapMode === 'distribution';
const showHeatmapScale = isDistributionHeatmap;

return (
<Drawer
Expand Down Expand Up @@ -343,7 +358,7 @@ export default function ChartDisplaySettingsDrawer({
name="heatmapScaleType"
render={({ field: { onChange, value } }) => (
<HeatmapScaleControl
value={value ?? 'log'}
value={value ?? defaultHeatmapScaleType}
onChange={onChange}
/>
)}
Expand Down
17 changes: 16 additions & 1 deletion packages/app/src/components/ChartEditor/PromqlChartEditor.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,15 @@ import {
} from '@hyperdx/common-utils/dist/core/promql';
import { isTimeSeriesDisplayType } from '@hyperdx/common-utils/dist/core/utils';
import {
DisplayType,
HeatmapMode,
MAX_PROMQL_EXPRESSIONS,
SourceKind,
} from '@hyperdx/common-utils/dist/types';
import { Button, Divider, Flex, Group, Text } from '@mantine/core';
import { Box, Button, Divider, Flex, Group, Text } from '@mantine/core';
import { IconCirclePlus } from '@tabler/icons-react';

import { HeatmapModeControl } from '@/components/DBEditTimeChartForm/HeatmapModeControl';
import { SourceSelectControlled } from '@/components/SourceSelect';
import { usePromqlMetricNames } from '@/hooks/usePromqlMetadata';
import { useSource } from '@/source';
Expand All @@ -30,12 +33,16 @@ export default function PromqlChartEditor({
allowedSourceKinds,
onSubmit,
onOpenDisplaySettings,
heatmapMode,
onHeatmapModeChange,
}: {
control: Control<ChartEditorFormState>;
getValues: UseFormGetValues<ChartEditorFormState>;
allowedSourceKinds: SourceKind[];
onSubmit: (suppressErrorNotification?: boolean) => void;
onOpenDisplaySettings: () => void;
heatmapMode: HeatmapMode;
onHeatmapModeChange: (mode: HeatmapMode) => void;
}) {
const {
fields: expressions,
Expand Down Expand Up @@ -106,6 +113,14 @@ export default function PromqlChartEditor({
allowedSourceKinds={allowedSourceKinds}
/>
</Group>
{displayType === DisplayType.Heatmap && (
<Box mt="md">
<HeatmapModeControl
mode={heatmapMode}
onModeChange={onHeatmapModeChange}
/>
</Box>
)}
{expressions.map((field, index) => (
<PromqlExpressionEditor
key={field.id}
Expand Down
35 changes: 32 additions & 3 deletions packages/app/src/components/ChartEditor/__tests__/utils.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -668,12 +668,12 @@ describe('PromQL expressions', () => {
series: [],
});

it('saves a heatmap with only its first expression queried and no heatmap mode', () => {
it('saves a heatmap with only its first expression queried and its heatmap settings', () => {
const result = convertFormStateToSavedChartConfig(
{
...promqlForm([{ expression: 'up' }], DisplayType.Heatmap),
legendTemplate: '{{pod}}',
heatmap: { mode: 'distribution' },
heatmap: { mode: 'distribution', scaleType: 'log' },
granularity: '5 minute',
},
undefined,
Expand All @@ -684,8 +684,37 @@ describe('PromQL expressions', () => {
promqlExpression: [{ expression: 'up' }],
legendTemplate: '{{pod}}',
granularity: '5 minute',
heatmap: { mode: 'distribution', scaleType: 'log' },
});
expect(result).not.toHaveProperty('heatmap');
});

it('queries a heatmap with its heatmap settings', () => {
const result = convertFormStateToChartConfig(
{
...promqlForm([{ expression: 'up' }], DisplayType.Heatmap),
heatmap: { mode: 'series' },
},
[new Date(0), new Date(1000)],
undefined,
);
expect(result).toMatchObject({ heatmap: { mode: 'series' } });
});

it('drops heatmap settings from PromQL tiles that are not heatmaps', () => {
const form = {
...promqlForm([{ expression: 'up' }], DisplayType.Line),
heatmap: { mode: 'series' as const },
};
expect(
convertFormStateToSavedChartConfig(form, undefined),
).not.toHaveProperty('heatmap', expect.anything());
expect(
convertFormStateToChartConfig(
form,
[new Date(0), new Date(1000)],
undefined,
),
).not.toHaveProperty('heatmap', expect.anything());
});

it('saves the form rows as the expression list', () => {
Expand Down
9 changes: 9 additions & 0 deletions packages/app/src/components/ChartEditor/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ export function convertFormStateToSavedChartConfig(
connection: form.connection ?? '',
source: form.source || undefined,
legendTemplate: form.legendTemplate?.trim() || undefined,
heatmap: formPromqlHeatmap(form),
};

return promqlConfig;
Expand Down Expand Up @@ -380,6 +381,7 @@ export function convertFormStateToChartConfig(
source: form.source || undefined,
from: source?.from,
legendTemplate: form.legendTemplate?.trim() || undefined,
heatmap: formPromqlHeatmap(form),
};

return { ...promqlConfig, dateRange };
Expand Down Expand Up @@ -552,6 +554,13 @@ function formPromqlExpressions(form: ChartEditorFormState): PromqlSeries[] {
}));
}

/** Heatmap settings are dropped from PromQL tiles that are not heatmaps. */
function formPromqlHeatmap(
form: ChartEditorFormState,
): PromqlSavedChartConfig['heatmap'] {
return form.displayType === DisplayType.Heatmap ? form.heatmap : undefined;
}

export const validateChartForm = (
form: ChartEditorFormState,
source: TSource | undefined,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,11 @@ function HeatmapSQLPreview({
};
const query = toHeatmapQuery(configWithTimestamp);

// Only PromQL heatmaps are calculated, and they have no SQL to preview
if (query.mode === 'calculated') {
Comment thread
pulpdrew marked this conversation as resolved.
Resolved
Comment thread
pulpdrew marked this conversation as resolved.
Resolved
Comment thread
pulpdrew marked this conversation as resolved.
Resolved
return null;
}

if (query.mode === 'series') {
const seriesConfig = { ...query.config, dateRange };
return (
Expand Down
Loading
Loading