diff --git a/.changeset/line-interpolation.md b/.changeset/line-interpolation.md new file mode 100644 index 0000000000..6af6565bff --- /dev/null +++ b/.changeset/line-interpolation.md @@ -0,0 +1,7 @@ +--- +'@hyperdx/common-utils': patch +'@hyperdx/api': patch +'@hyperdx/app': patch +--- + +feat: Add a line interpolation display setting (smooth, linear, step) diff --git a/packages/api/openapi.json b/packages/api/openapi.json index 4ef3abf69a..b6263b7423 100644 --- a/packages/api/openapi.json +++ b/packages/api/openapi.json @@ -1847,6 +1847,16 @@ "description": "Set the y-axis lower bound to the minimum of the displayed data instead of zero, making small fluctuations between series easier to see.\n", "default": false }, + "lineInterpolation": { + "type": "string", + "enum": [ + "smooth", + "linear", + "step" + ], + "example": "step", + "description": "How points are connected. Defaults to \"smooth\" when omitted.\n" + }, "numberFormat": { "$ref": "#/components/schemas/NumberFormat", "description": "Number formatting options for displayed values." @@ -2006,6 +2016,16 @@ "description": "Fill missing time buckets with zero instead of leaving gaps.", "default": true }, + "lineInterpolation": { + "type": "string", + "enum": [ + "smooth", + "linear", + "step" + ], + "example": "step", + "description": "How points are connected. Defaults to \"linear\" when omitted.\n" + }, "numberFormat": { "$ref": "#/components/schemas/NumberFormat", "description": "Number formatting options for displayed values." @@ -2620,6 +2640,16 @@ "type": "boolean", "description": "Set the y-axis lower bound to the minimum of the displayed data instead of zero, making small fluctuations between series easier to see.\n", "default": false + }, + "lineInterpolation": { + "type": "string", + "enum": [ + "smooth", + "linear", + "step" + ], + "example": "step", + "description": "How points are connected. Defaults to \"smooth\" when omitted.\n" } } } @@ -2688,6 +2718,16 @@ "type": "boolean", "description": "Expand date range boundaries to the query granularity interval.", "default": true + }, + "lineInterpolation": { + "type": "string", + "enum": [ + "smooth", + "linear", + "step" + ], + "example": "step", + "description": "How points are connected. Defaults to \"linear\" when omitted.\n" } } } diff --git a/packages/api/src/mcp/__tests__/dashboards/saveDashboard.int.test.ts b/packages/api/src/mcp/__tests__/dashboards/saveDashboard.int.test.ts index c4a82f7460..73141b1f28 100644 --- a/packages/api/src/mcp/__tests__/dashboards/saveDashboard.int.test.ts +++ b/packages/api/src/mcp/__tests__/dashboards/saveDashboard.int.test.ts @@ -399,6 +399,7 @@ describe('MCP Dashboard Tools - clickstack_save_dashboard', () => { }, compareToPreviousPeriod: true, fitYAxisToData: true, + lineInterpolation: 'step' as const, }; const sqlNumberConfig = { configType: 'sql' as const, @@ -996,6 +997,7 @@ describe('MCP Dashboard Tools - clickstack_save_dashboard', () => { numberFormat, compareToPreviousPeriod: true, fitYAxisToData: true, + lineInterpolation: 'linear' as const, seriesLimit: 5, }; const barConfig = { @@ -1009,6 +1011,7 @@ describe('MCP Dashboard Tools - clickstack_save_dashboard', () => { const stackedLineConfig = { ...barConfig, displayType: 'stacked_line' as const, + lineInterpolation: 'step' as const, }; const tableConfig = { displayType: 'table' as const, diff --git a/packages/api/src/mcp/tools/dashboards/schemas.ts b/packages/api/src/mcp/tools/dashboards/schemas.ts index 9701313801..bd678a768e 100644 --- a/packages/api/src/mcp/tools/dashboards/schemas.ts +++ b/packages/api/src/mcp/tools/dashboards/schemas.ts @@ -12,6 +12,7 @@ import { DASHBOARD_VARIABLE_NAME_PATTERN_ANCHORED, DashboardContainerSchema, DashboardFilterType, + LineInterpolationSchema, MetricsDataType, NumberTileColorConditionSchema, SearchConditionTrimmedLanguageSchema, @@ -749,6 +750,9 @@ export const mcpLineTileSchema = mcpTileLayoutSchema.extend({ seriesLimit: seriesLimitSchema.describe(timeChartSeriesLimitDescription), formulas: mcpTileFormulasSchema, showOperandSeries: mcpShowOperandSeriesSchema, + lineInterpolation: LineInterpolationSchema.optional().describe( + 'How points are connected: "smooth" (default), "linear", or "step".', + ), }) .describe('Line chart query and display settings.'), }); @@ -794,6 +798,9 @@ export const mcpStackedLineTileSchema = mcpTileLayoutSchema.extend({ .literal('stacked_line') .describe('Stacked line (area) chart over time'), ...mcpStackedTimeChartConfigFields, + lineInterpolation: LineInterpolationSchema.optional().describe( + 'How points are connected: "linear" (default), "smooth", or "step".', + ), }) .describe('Stacked line chart query and display settings.'), }); @@ -1256,6 +1263,11 @@ GROUP BY ServiceName, ts .optional() .describe(rawSqlNumberTileColorRulesDescription), onClick: mcpOnClickSchema.optional(), + lineInterpolation: LineInterpolationSchema.optional().describe( + 'How points are connected: "smooth", "linear", or "step". Defaults to ' + + '"smooth" for "line" and "linear" for "stacked_line". ' + + 'Valid only when displayType is "line" or "stacked_line", ignored otherwise.', + ), }) .describe('Raw SQL tile query and display settings.'), }); diff --git a/packages/api/src/routers/external-api/__tests__/dashboards.int.test.ts b/packages/api/src/routers/external-api/__tests__/dashboards.int.test.ts index 67b841dae5..5e4e55d087 100644 --- a/packages/api/src/routers/external-api/__tests__/dashboards.int.test.ts +++ b/packages/api/src/routers/external-api/__tests__/dashboards.int.test.ts @@ -3645,6 +3645,78 @@ describe('External API v2 Dashboards - new format', () => { expect(tiles[2].config).not.toHaveProperty('fitYAxisToData'); }); + it('persists lineInterpolation on line and stacked line tiles only', async () => { + const sourceId = traceSource._id.toString(); + const connectionId = connection._id.toString(); + const sqlTemplate = 'SELECT count() FROM otel_logs WHERE {timeFilter}'; + const select = [ + { aggFn: 'count' as const, where: '', whereLanguage: 'sql' as const }, + ]; + const configs = [ + { displayType: 'line', sourceId, select, lineInterpolation: 'step' }, + { + displayType: 'stacked_line', + sourceId, + select, + lineInterpolation: 'smooth', + }, + { + configType: 'sql', + displayType: 'line', + connectionId, + sqlTemplate, + lineInterpolation: 'linear', + }, + { + configType: 'sql', + displayType: 'stacked_line', + connectionId, + sqlTemplate, + lineInterpolation: 'step', + }, + { + displayType: 'stacked_bar', + sourceId, + select, + lineInterpolation: 'step', + }, + { displayType: 'line', sourceId, select }, + ]; + + const createResponse = await authRequest('post', BASE_URL) + .send({ + name: 'lineInterpolation dashboard', + tiles: configs.map((config, i) => ({ + name: `Tile ${i}`, + x: 0, + y: i * 3, + w: 6, + h: 3, + config, + })), + tags: [], + }) + .expect(200); + + const getResponse = await authRequest( + 'get', + `${BASE_URL}/${createResponse.body.data.id}`, + ).expect(200); + const tiles: { config: Record }[] = + getResponse.body.data.tiles; + + expect(tiles.map(t => t.config.lineInterpolation)).toEqual([ + 'step', + 'smooth', + 'linear', + 'step', + undefined, + undefined, + ]); + expect(tiles[4].config).not.toHaveProperty('lineInterpolation'); + expect(tiles[5].config).not.toHaveProperty('lineInterpolation'); + }); + it('should return 400 when source IDs do not exist', async () => { const nonExistentSourceId = new ObjectId().toString(); const mockDashboard = createMockDashboard(nonExistentSourceId); diff --git a/packages/api/src/routers/external-api/v2/dashboards.ts b/packages/api/src/routers/external-api/v2/dashboards.ts index 2efb020ef7..276c28c59e 100644 --- a/packages/api/src/routers/external-api/v2/dashboards.ts +++ b/packages/api/src/routers/external-api/v2/dashboards.ts @@ -690,6 +690,12 @@ const EXTERNAL_DASHBOARD_PROJECTION = { * instead of zero, making small fluctuations between series easier * to see. * default: false + * lineInterpolation: + * type: string + * enum: [smooth, linear, step] + * example: "step" + * description: > + * How points are connected. Defaults to "smooth" when omitted. * numberFormat: * $ref: '#/components/schemas/NumberFormat' * description: Number formatting options for displayed values. @@ -834,6 +840,12 @@ const EXTERNAL_DASHBOARD_PROJECTION = { * type: boolean * description: Fill missing time buckets with zero instead of leaving gaps. * default: true + * lineInterpolation: + * type: string + * enum: [smooth, linear, step] + * example: "step" + * description: > + * How points are connected. Defaults to "linear" when omitted. * numberFormat: * $ref: '#/components/schemas/NumberFormat' * description: Number formatting options for displayed values. @@ -1374,6 +1386,12 @@ const EXTERNAL_DASHBOARD_PROJECTION = { * data instead of zero, making small fluctuations between * series easier to see. * default: false + * lineInterpolation: + * type: string + * enum: [smooth, linear, step] + * example: "step" + * description: > + * How points are connected. Defaults to "smooth" when omitted. * * BarRawSqlChartConfig: * description: Raw SQL configuration for a stacked-bar time-series chart. @@ -1418,6 +1436,12 @@ const EXTERNAL_DASHBOARD_PROJECTION = { * type: boolean * description: Expand date range boundaries to the query granularity interval. * default: true + * lineInterpolation: + * type: string + * enum: [smooth, linear, step] + * example: "step" + * description: > + * How points are connected. Defaults to "linear" when omitted. * * TableRawSqlChartConfig: * description: Raw SQL configuration for a table chart. diff --git a/packages/api/src/routers/external-api/v2/utils/alertChartConfig.ts b/packages/api/src/routers/external-api/v2/utils/alertChartConfig.ts index a0975d3e90..73d94f21bc 100644 --- a/packages/api/src/routers/external-api/v2/utils/alertChartConfig.ts +++ b/packages/api/src/routers/external-api/v2/utils/alertChartConfig.ts @@ -108,6 +108,7 @@ export const EVALUATION_INERT_CONFIG_KEYS: ReadonlySet = new Set([ 'backgroundChart', 'compareToPreviousPeriod', 'fitYAxisToData', + 'lineInterpolation', 'onClick', 'alternateRowBackground', // Heatmap tiles carry no alerts; alert display types ignore it. diff --git a/packages/api/src/routers/external-api/v2/utils/dashboards.ts b/packages/api/src/routers/external-api/v2/utils/dashboards.ts index 7c43f3e6c1..47bf79d4f6 100644 --- a/packages/api/src/routers/external-api/v2/utils/dashboards.ts +++ b/packages/api/src/routers/external-api/v2/utils/dashboards.ts @@ -240,6 +240,7 @@ export const convertToExternalTileChartConfig = ( alignDateRangeToGranularity: config.alignDateRangeToGranularity, fillNulls: config.fillNulls !== false, fitYAxisToData: config.fitYAxisToData, + lineInterpolation: config.lineInterpolation, numberFormat: config.numberFormat, compareToPreviousPeriod: config.compareToPreviousPeriod, // Three-state passthrough: 0 (unlimited) and positive N round-trip; @@ -262,7 +263,11 @@ export const convertToExternalTileChartConfig = ( }; // A union-typed displayType doesn't narrow to one union member. return config.displayType === DisplayType.StackedLine - ? { displayType: DisplayType.StackedLine, ...stacked } + ? { + displayType: DisplayType.StackedLine, + lineInterpolation: config.lineInterpolation, + ...stacked, + } : { displayType: DisplayType.StackedBar, ...stacked }; } case DisplayType.Table: @@ -357,6 +362,7 @@ export const convertToExternalTileChartConfig = ( alignDateRangeToGranularity: config.alignDateRangeToGranularity, fillNulls: config.fillNulls !== false, fitYAxisToData: config.fitYAxisToData, + lineInterpolation: config.lineInterpolation, groupBy: stringValueOrDefault(config.groupBy, undefined), select: Array.isArray(config.select) ? config.select.map(convertToExternalSelectItem) @@ -391,7 +397,11 @@ export const convertToExternalTileChartConfig = ( ...externalShowOperandSeriesField, }; return config.displayType === DisplayType.StackedLine - ? { displayType: DisplayType.StackedLine, ...stacked } + ? { + displayType: DisplayType.StackedLine, + lineInterpolation: config.lineInterpolation, + ...stacked, + } : { displayType: DisplayType.StackedBar, ...stacked }; } case DisplayType.Number: @@ -751,6 +761,7 @@ export function convertToInternalTileConfig( 'alignDateRangeToGranularity', 'compareToPreviousPeriod', 'fitYAxisToData', + 'lineInterpolation', // Round-trip the render cap so a GET→PUT does not silently wipe it. 'seriesLimit', ]), @@ -818,6 +829,7 @@ export function convertToInternalTileConfig( 'alignDateRangeToGranularity', 'compareToPreviousPeriod', 'fitYAxisToData', + 'lineInterpolation', // Formulas round-trip as-is; the input schema has already // validated the expressions against `select`. 'formulas', diff --git a/packages/api/src/utils/zod.ts b/packages/api/src/utils/zod.ts index 7deb2e9d15..8c80e11489 100644 --- a/packages/api/src/utils/zod.ts +++ b/packages/api/src/utils/zod.ts @@ -11,6 +11,7 @@ import { ChartPaletteTokenSchema, DASHBOARD_CONTAINER_ID_MAX, DASHBOARD_MAX_TILES, + LineInterpolationSchema, MetricFormulaSchema, MetricsDataType, NumberFormatSchema, @@ -354,6 +355,7 @@ const externalDashboardLineChartConfigSchema = displayType: z.literal('line'), compareToPreviousPeriod: z.boolean().optional(), fitYAxisToData: z.boolean().optional(), + lineInterpolation: LineInterpolationSchema.optional(), // Three-state, matching the internal SharedChartSettingsSchema.seriesLimit: // omitted = default render cap, 0 = unlimited, positive N = top-N by peak. seriesLimit: z.number().int().nonnegative().optional(), @@ -366,6 +368,7 @@ const externalDashboardLineRawSqlChartConfigSchema = fillNulls: z.boolean().optional(), alignDateRangeToGranularity: z.boolean().optional(), fitYAxisToData: z.boolean().optional(), + lineInterpolation: LineInterpolationSchema.optional(), // Three-state, matching the internal SharedChartSettingsSchema.seriesLimit: // omitted = default render cap, 0 = unlimited, positive N = top-N by peak. // Raw SQL Line tiles carry the client-side render cap too, so it must @@ -396,11 +399,13 @@ const externalDashboardBarRawSqlChartConfigSchema = const externalDashboardStackedLineChartConfigSchema = externalDashboardBarChartConfigSchema.extend({ displayType: z.literal('stacked_line'), + lineInterpolation: LineInterpolationSchema.optional(), }); const externalDashboardStackedLineRawSqlChartConfigSchema = externalDashboardBarRawSqlChartConfigSchema.extend({ displayType: z.literal('stacked_line'), + lineInterpolation: LineInterpolationSchema.optional(), }); const externalDashboardTableChartConfigSchema = z.object({ diff --git a/packages/app/src/HDXMultiSeriesTimeChart.tsx b/packages/app/src/HDXMultiSeriesTimeChart.tsx index 7aa1dd0f6e..3de997cf70 100644 --- a/packages/app/src/HDXMultiSeriesTimeChart.tsx +++ b/packages/app/src/HDXMultiSeriesTimeChart.tsx @@ -27,9 +27,14 @@ import { YAxis, } from 'recharts'; import { getTickValuesFixedDomain } from 'recharts/lib/util/scale/getNiceTickValues'; +import { CurveType } from 'recharts/types/shape/Curve'; import { AxisDomain } from 'recharts/types/util/types'; import { convertGranularityToSeconds } from '@hyperdx/common-utils/dist/core/utils'; -import { DisplayType } from '@hyperdx/common-utils/dist/types'; +import { + DisplayType, + getDefaultLineInterpolation, + LineInterpolation, +} from '@hyperdx/common-utils/dist/types'; import { Popover } from '@mantine/core'; import type { NumberFormat } from '@/types'; @@ -1148,6 +1153,21 @@ const FIT_Y_AXIS_BOUNDS: YAxisBounds = { ticks: undefined, }; +const CURVE_TYPE_BY_INTERPOLATION: Record = { + smooth: 'monotone', + linear: 'linear', + step: 'stepAfter', +}; + +export function getLineCurveType( + displayType: DisplayType, + lineInterpolation: LineInterpolation | undefined, +): CurveType { + return CURVE_TYPE_BY_INTERPOLATION[ + lineInterpolation ?? getDefaultLineInterpolation(displayType) + ]; +} + // A stacked bar's rendered height sums its series at each timestamp - leave // that entirely to Recharts, regardless of selection/fit-to-data state. export function computeYAxisBounds( @@ -1309,6 +1329,7 @@ export const MemoChart = memo(function MemoChart({ granularity, dateRangeEndInclusive = true, fitYAxisToData = false, + lineInterpolation, }: { graphResults: any[]; setIsClickActive: (v: ActiveClickPayload | undefined) => void; @@ -1353,6 +1374,8 @@ export const MemoChart = memo(function MemoChart({ * (with padding) instead of zero. **/ fitYAxisToData?: boolean; + /** Unset follows the display type's default (see getLineCurveType). */ + lineInterpolation?: LineInterpolation; }) { const _id = useId(); const id = _id.replace(/:/g, ''); @@ -1412,6 +1435,7 @@ export const MemoChart = memo(function MemoChart({ const lines = useMemo(() => { const isStackedLine = displayType === DisplayType.StackedLine; + const curveType = getLineCurveType(displayType, lineInterpolation); return visibleLineData.map(ld => { const key = ld.dataKey; const color = ld.color; @@ -1434,10 +1458,7 @@ export const MemoChart = memo(function MemoChart({ ); }); - }, [visibleLineData, displayType, id, captureActivePointY]); + }, [ + visibleLineData, + displayType, + lineInterpolation, + id, + captureActivePointY, + ]); // Nearest-cursor emphasis (thicken the nearest line, fade the rest) applied // via a tiny scoped