feat: Add delta() function for gauge metrics

pulpdrew · pulpdrew · commit 29ac4c2f40c7 · 2025-09-08T11:47:56.000-04:00
diff --git a/.changeset/honest-pens-bathe.md b/.changeset/honest-pens-bathe.md
@@ -0,0 +1,6 @@
+---
+"@hyperdx/common-utils": minor
+"@hyperdx/app": minor
+---
+
+Add delta() function for gauge metrics
diff --git a/packages/app/src/components/DBEditTimeChartForm.tsx b/packages/app/src/components/DBEditTimeChartForm.tsx
@@ -75,7 +75,11 @@ import HDXMarkdownChart from '../HDXMarkdownChart';
 
 import { AggFnSelectControlled } from './AggFnSelect';
 import DBNumberChart from './DBNumberChart';
-import { InputControlled, TextInputControlled } from './InputControlled';
+import {
+  CheckBoxControlled,
+  InputControlled,
+  TextInputControlled,
+} from './InputControlled';
 import { MetricNameSelect } from './MetricNameSelect';
 import { NumberFormatInput } from './NumberFormat';
 import { SourceSelectControlled } from './SourceSelect';
@@ -202,7 +206,7 @@ function ChartSeriesEditorComponent({
         mb={8}
         mt="sm"
       />
-      <Flex gap="sm" mt="xs" align="center">
+      <Flex gap="sm" mt="xs" align="start">
         <div
           style={{
             minWidth: 200,
@@ -216,17 +220,32 @@ function ChartSeriesEditorComponent({
           />
         </div>
         {tableSource?.kind === SourceKind.Metric && (
-          <MetricNameSelect
-            metricName={metricName}
-            dateRange={dateRange}
-            metricType={metricType}
-            setMetricName={value => {
-              setValue(`${namePrefix}metricName`, value);
-              setValue(`${namePrefix}valueExpression`, 'Value');
-            }}
-            setMetricType={value => setValue(`${namePrefix}metricType`, value)}
-            metricSource={tableSource}
-          />
+          <div style={{ minWidth: 220 }}>
+            <MetricNameSelect
+              metricName={metricName}
+              dateRange={dateRange}
+              metricType={metricType}
+              setMetricName={value => {
+                setValue(`${namePrefix}metricName`, value);
+                setValue(`${namePrefix}valueExpression`, 'Value');
+              }}
+              setMetricType={value =>
+                setValue(`${namePrefix}metricType`, value)
+              }
+              metricSource={tableSource}
+            />
+            {metricType === 'gauge' && (
+              <Flex justify="end">
+                <CheckBoxControlled
+                  control={control}
+                  name={`${namePrefix}isDelta`}
+                  label="Delta"
+                  size="xs"
+                  className="mt-2"
+                />
+              </Flex>
+            )}
+          </div>
         )}
         {tableSource?.kind !== SourceKind.Metric && aggFn !== 'count' && (
           <div style={{ minWidth: 220 }}>
@@ -243,44 +262,46 @@ function ChartSeriesEditorComponent({
             />
           </div>
         )}
-        <Text size="sm">Where</Text>
-        {aggConditionLanguage === 'sql' ? (
-          <SQLInlineEditorControlled
-            tableConnections={{
-              databaseName,
-              tableName: tableName ?? '',
-              connectionId: connectionId ?? '',
-            }}
-            control={control}
-            name={`${namePrefix}aggCondition`}
-            placeholder="SQL WHERE clause (ex. column = 'foo')"
-            onLanguageChange={lang =>
-              setValue(`${namePrefix}aggConditionLanguage`, lang)
-            }
-            additionalSuggestions={attributeKeys}
-            language="sql"
-            onSubmit={onSubmit}
-          />
-        ) : (
-          <SearchInputV2
-            tableConnections={{
-              connectionId: connectionId ?? '',
-              databaseName: databaseName ?? '',
-              tableName: tableName ?? '',
-            }}
-            control={control}
-            name={`${namePrefix}aggCondition`}
-            onLanguageChange={lang =>
-              setValue(`${namePrefix}aggConditionLanguage`, lang)
-            }
-            language="lucene"
-            placeholder="Search your events w/ Lucene ex. column:foo"
-            onSubmit={onSubmit}
-            additionalSuggestions={attributeKeys}
-          />
-        )}
+        <Flex align={'center'} gap={'xs'} className="flex-grow-1">
+          <Text size="sm">Where</Text>
+          {aggConditionLanguage === 'sql' ? (
+            <SQLInlineEditorControlled
+              tableConnections={{
+                databaseName,
+                tableName: tableName ?? '',
+                connectionId: connectionId ?? '',
+              }}
+              control={control}
+              name={`${namePrefix}aggCondition`}
+              placeholder="SQL WHERE clause (ex. column = 'foo')"
+              onLanguageChange={lang =>
+                setValue(`${namePrefix}aggConditionLanguage`, lang)
+              }
+              additionalSuggestions={attributeKeys}
+              language="sql"
+              onSubmit={onSubmit}
+            />
+          ) : (
+            <SearchInputV2
+              tableConnections={{
+                connectionId: connectionId ?? '',
+                databaseName: databaseName ?? '',
+                tableName: tableName ?? '',
+              }}
+              control={control}
+              name={`${namePrefix}aggCondition`}
+              onLanguageChange={lang =>
+                setValue(`${namePrefix}aggConditionLanguage`, lang)
+              }
+              language="lucene"
+              placeholder="Search your events w/ Lucene ex. column:foo"
+              onSubmit={onSubmit}
+              additionalSuggestions={attributeKeys}
+            />
+          )}
+        </Flex>
         {showGroupBy && (
-          <>
+          <Flex align={'center'} gap={'xs'}>
             <Text size="sm" style={{ whiteSpace: 'nowrap' }}>
               Group By
             </Text>
@@ -303,7 +324,7 @@ function ChartSeriesEditorComponent({
                 onSubmit={onSubmit}
               />
             </div>
-          </>
+          </Flex>
         )}
       </Flex>
     </>
diff --git a/packages/app/src/components/InputControlled.tsx b/packages/app/src/components/InputControlled.tsx
@@ -1,6 +1,8 @@
 import React from 'react';
 import { Control, Controller, FieldValues, Path } from 'react-hook-form';
 import {
+  Checkbox,
+  CheckboxProps,
   Input,
   InputProps,
   PasswordInput,
@@ -33,6 +35,17 @@ interface TextInputControlledProps<T extends FieldValues>
   rules?: Parameters<Control<T>['register']>[1];
 }
 
+interface CheckboxControlledProps<T extends FieldValues>
+  extends Omit<CheckboxProps, 'name' | 'style'>,
+    Omit<
+      React.InputHTMLAttributes<HTMLInputElement>,
+      'name' | 'size' | 'color'
+    > {
+  name: Path<T>;
+  control: Control<T>;
+  rules?: Parameters<Control<T>['register']>[1];
+}
+
 export function TextInputControlled<T extends FieldValues>({
   name,
   control,
@@ -86,3 +99,26 @@ export function PasswordInputControlled<T extends FieldValues>({
     />
   );
 }
+
+export function CheckBoxControlled<T extends FieldValues>({
+  name,
+  control,
+  rules,
+  ...props
+}: CheckboxControlledProps<T>) {
+  return (
+    <Controller
+      name={name}
+      control={control}
+      rules={rules}
+      render={({ field: { value, ...field }, fieldState: { error } }) => (
+        <Checkbox
+          {...props}
+          {...field}
+          checked={value}
+          error={error?.message}
+        />
+      )}
+    />
+  );
+}
diff --git a/packages/common-utils/src/__tests__/__snapshots__/renderChartConfig.test.ts.snap b/packages/common-utils/src/__tests__/__snapshots__/renderChartConfig.test.ts.snap
@@ -284,7 +284,40 @@ exports[`renderChartConfig should generate sql for a single gauge metric 1`] = `
             FROM Source
             GROUP BY AttributesHash, __hdx_time_bucket2
             ORDER BY AttributesHash, __hdx_time_bucket2
-          ) SELECT quantile(0.95)(toFloat64OrDefault(toString(LastValue))),toStartOfInterval(toDateTime(__hdx_time_bucket2), INTERVAL 1 minute) AS \`__hdx_time_bucket\` FROM Bucketed WHERE (__hdx_time_bucket2 >= fromUnixTimestamp64Milli(1739318400000) AND __hdx_time_bucket2 <= fromUnixTimestamp64Milli(1765670400000)) GROUP BY toStartOfInterval(toDateTime(__hdx_time_bucket2), INTERVAL 1 minute) AS \`__hdx_time_bucket\` ORDER BY toStartOfInterval(toDateTime(__hdx_time_bucket2), INTERVAL 1 minute) AS \`__hdx_time_bucket\` LIMIT 10"
+          ) SELECT quantile(0.95)(toFloat64OrDefault(toString(LastValue))),toStartOfInterval(toDateTime(__hdx_time_bucket2), INTERVAL 1 minute) AS \`__hdx_time_bucket\` FROM Bucketed WHERE (__hdx_time_bucket2 >= fromUnixTimestamp64Milli(1739318400000) AND __hdx_time_bucket2 <= fromUnixTimestamp64Milli(1765670400000)) GROUP BY toStartOfInterval(toDateTime(__hdx_time_bucket2), INTERVAL 1 minute) AS \`__hdx_time_bucket\` ORDER BY toStartOfInterval(toDateTime(__hdx_time_bucket2), INTERVAL 1 minute) AS \`__hdx_time_bucket\` LIMIT 10 SETTINGS short_circuit_function_evaluation = 'force_enable'"
+`;
+
+exports[`renderChartConfig should generate sql for a single gauge metric with a delta() function applied 1`] = `
+"WITH Source AS (
+            SELECT
+              *,
+              cityHash64(mapConcat(ScopeAttributes, ResourceAttributes, Attributes)) AS AttributesHash
+            FROM default.otel_metrics_gauge
+            WHERE (TimeUnix >= fromUnixTimestamp64Milli(1739318400000) AND TimeUnix <= fromUnixTimestamp64Milli(1765670400000)) AND ((MetricName = 'nodejs.event_loop.utilization'))
+          ),Bucketed AS (
+            SELECT
+              toStartOfInterval(toDateTime(TimeUnix), INTERVAL 1 minute) AS \`__hdx_time_bucket2\`,
+              AttributesHash,
+              IF(date_diff('second', min(toDateTime(TimeUnix)), max(toDateTime(TimeUnix))) > 0, (argMax(Value, TimeUnix) - argMin(Value, TimeUnix)) * 60 / date_diff('second', min(toDateTime(TimeUnix)), max(toDateTime(TimeUnix))), 0) AS LastValue,
+              any(ScopeAttributes) AS ScopeAttributes,
+              any(ResourceAttributes) AS ResourceAttributes,
+              any(Attributes) AS Attributes,
+              any(ResourceSchemaUrl) AS ResourceSchemaUrl,
+              any(ScopeName) AS ScopeName,
+              any(ScopeVersion) AS ScopeVersion,
+              any(ScopeDroppedAttrCount) AS ScopeDroppedAttrCount,
+              any(ScopeSchemaUrl) AS ScopeSchemaUrl,
+              any(ServiceName) AS ServiceName,
+              any(MetricDescription) AS MetricDescription,
+              any(MetricUnit) AS MetricUnit,
+              any(StartTimeUnix) AS StartTimeUnix,
+              any(Flags) AS Flags
+            FROM Source
+            GROUP BY AttributesHash, __hdx_time_bucket2
+            ORDER BY AttributesHash, __hdx_time_bucket2
+          ) SELECT max(
+      toFloat64OrDefault(toString(LastValue))
+    ),toStartOfInterval(toDateTime(__hdx_time_bucket2), INTERVAL 1 minute) AS \`__hdx_time_bucket\` FROM Bucketed WHERE (__hdx_time_bucket2 >= fromUnixTimestamp64Milli(1739318400000) AND __hdx_time_bucket2 <= fromUnixTimestamp64Milli(1765670400000)) GROUP BY toStartOfInterval(toDateTime(__hdx_time_bucket2), INTERVAL 1 minute) AS \`__hdx_time_bucket\` ORDER BY toStartOfInterval(toDateTime(__hdx_time_bucket2), INTERVAL 1 minute) AS \`__hdx_time_bucket\` LIMIT 10 SETTINGS short_circuit_function_evaluation = 'force_enable'"
 `;
 
 exports[`renderChartConfig should generate sql for a single sum metric 1`] = `
diff --git a/packages/common-utils/src/__tests__/renderChartConfig.test.ts b/packages/common-utils/src/__tests__/renderChartConfig.test.ts
@@ -22,42 +22,65 @@ describe('renderChartConfig', () => {
     } as unknown as Metadata;
   });
 
-  it('should generate sql for a single gauge metric', async () => {
-    const config: ChartConfigWithOptDateRange = {
-      displayType: DisplayType.Line,
-      connection: 'test-connection',
-      // metricTables is added from the Source object via spread operator
-      metricTables: {
-        gauge: 'otel_metrics_gauge',
-        histogram: 'otel_metrics_histogram',
-        sum: 'otel_metrics_sum',
-        summary: 'otel_metrics_summary',
-        'exponential histogram': 'otel_metrics_exponential_histogram',
+  const gaugeConfiguration: ChartConfigWithOptDateRange = {
+    displayType: DisplayType.Line,
+    connection: 'test-connection',
+    // metricTables is added from the Source object via spread operator
+    metricTables: {
+      gauge: 'otel_metrics_gauge',
+      histogram: 'otel_metrics_histogram',
+      sum: 'otel_metrics_sum',
+      summary: 'otel_metrics_summary',
+      'exponential histogram': 'otel_metrics_exponential_histogram',
+    },
+    from: {
+      databaseName: 'default',
+      tableName: '',
+    },
+    select: [
+      {
+        aggFn: 'quantile',
+        aggCondition: '',
+        aggConditionLanguage: 'lucene',
+        valueExpression: 'Value',
+        level: 0.95,
+        metricName: 'nodejs.event_loop.utilization',
+        metricType: MetricsDataType.Gauge,
       },
-      from: {
-        databaseName: 'default',
-        tableName: '',
-      },
-      select: [
-        {
-          aggFn: 'quantile',
-          aggCondition: '',
-          aggConditionLanguage: 'lucene',
-          valueExpression: 'Value',
-          level: 0.95,
-          metricName: 'nodejs.event_loop.utilization',
-          metricType: MetricsDataType.Gauge,
-        },
-      ],
-      where: '',
-      whereLanguage: 'lucene',
-      timestampValueExpression: 'TimeUnix',
-      dateRange: [new Date('2025-02-12'), new Date('2025-12-14')],
-      granularity: '1 minute',
-      limit: { limit: 10 },
-    };
+    ],
+    where: '',
+    whereLanguage: 'lucene',
+    timestampValueExpression: 'TimeUnix',
+    dateRange: [new Date('2025-02-12'), new Date('2025-12-14')],
+    granularity: '1 minute',
+    limit: { limit: 10 },
+  };
 
-    const generatedSql = await renderChartConfig(config, mockMetadata);
+  it('should generate sql for a single gauge metric', async () => {
+    const generatedSql = await renderChartConfig(
+      gaugeConfiguration,
+      mockMetadata,
+    );
+    const actual = parameterizedQueryToSql(generatedSql);
+    expect(actual).toMatchSnapshot();
+  });
+
+  it('should generate sql for a single gauge metric with a delta() function applied', async () => {
+    const generatedSql = await renderChartConfig(
+      {
+        ...gaugeConfiguration,
+        select: [
+          {
+            aggFn: 'max',
+            valueExpression: 'Value',
+            metricName: 'nodejs.event_loop.utilization',
+            metricType: MetricsDataType.Gauge,
+            isDelta: true,
+          },
+        ],
+      },
+      mockMetadata,
+    );
     const actual = parameterizedQueryToSql(generatedSql);
     expect(actual).toMatchSnapshot();
   });
diff --git a/packages/common-utils/src/renderChartConfig.ts b/packages/common-utils/src/renderChartConfig.ts
diff --git a/packages/common-utils/src/types.ts b/packages/common-utils/src/types.ts
