Elgato_dark/hyperdx
1
0
Fork 0
mirror of https://github.com/hyperdxio/hyperdx synced 2026-04-21 13:37:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

test: histogram metric query integration tests (#692)

Browse source 
Pulls a set of test cases from the v1 code base that checks histogram metric queries against different quantile and queries for edge bounds as well.

Ref: HDX-1425
This commit is contained in:
Dan Hable 2025-03-25 13:59:15 -05:00 committed by GitHub
parent 2e350e22ba
commit 50ce38f1a9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 506 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.changeset/breezy-humans-crash.md Normal file
View file

@ -0,0 +1,6 @@
---
"@hyperdx/common-utils": patch
"@hyperdx/api": patch
---
Histogram metric query test cases

82
packages/api/src/clickhouse/__tests__/__snapshots__/renderChartConfig.test.ts.snap
View file

@ -157,3 +157,85 @@ Array [
},
]
`;
exports[`renderChartConfig Query Metrics three_timestamps_bounded histogram with reset (p50) 1`] = `
Array [
Object {
"__hdx_time_bucket": "2022-01-05T00:00:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 10,
},
Object {
"__hdx_time_bucket": "2022-01-05T00:01:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 10,
},
Object {
"__hdx_time_bucket": "2022-01-05T00:02:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 30,
},
]
`;
exports[`renderChartConfig Query Metrics two_timestamps_bounded histogram (p25) 1`] = `
Array [
Object {
"__hdx_time_bucket": "2022-01-05T00:00:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 0,
},
Object {
"__hdx_time_bucket": "2022-01-05T00:01:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 10,
},
]
`;
exports[`renderChartConfig Query Metrics two_timestamps_bounded histogram (p50) 1`] = `
Array [
Object {
"__hdx_time_bucket": "2022-01-05T00:00:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 0,
},
Object {
"__hdx_time_bucket": "2022-01-05T00:01:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 20,
},
]
`;
exports[`renderChartConfig Query Metrics two_timestamps_bounded histogram (p90) 1`] = `
Array [
Object {
"__hdx_time_bucket": "2022-01-05T00:00:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 0,
},
Object {
"__hdx_time_bucket": "2022-01-05T00:01:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 30,
},
]
`;
exports[`renderChartConfig Query Metrics two_timestamps_lower_bound_inf histogram (p50) 1`] = `
Array [
Object {
"__hdx_time_bucket": "2022-01-05T00:00:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 0,
},
Object {
"__hdx_time_bucket": "2022-01-05T00:01:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 1,
},
]
`;
exports[`renderChartConfig Query Metrics two_timestamps_upper_bound_inf histogram (p50) 1`] = `
Array [
Object {
"__hdx_time_bucket": "2022-01-05T00:00:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 0,
},
Object {
"__hdx_time_bucket": "2022-01-05T00:01:00Z",
"sum(toFloat64OrNull(toString(Rate)))": 30,
},
]
`;

442
packages/api/src/clickhouse/__tests__/renderChartConfig.test.ts
View file

@ -12,6 +12,7 @@ import { createTeam } from '@/controllers/team';
import {
bulkInsertLogs,
bulkInsertMetricsGauge,
bulkInsertMetricsHistogram,
bulkInsertMetricsSum,
DEFAULT_DATABASE,
DEFAULT_LOGS_TABLE,
@ -20,6 +21,13 @@ import {
} from '@/fixtures';
import Connection from '@/models/connection';
import { Source } from '@/models/source';
import { AggregationTemporality } from '@/utils/logParser';
const TEST_METRIC_TABLES = {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
};
describe('renderChartConfig', () => {
const server = getServer();
@ -334,6 +342,91 @@ describe('renderChartConfig', () => {
IsMonotonic: true,
AggregationTemporality: 2, // Cumulative
}));
const histPointsA = [
{
BucketCounts: [0, 0, 0],
ExplicitBounds: [10, 30],
TimeUnix: new Date(now),
},
{
BucketCounts: [10, 10, 10],
ExplicitBounds: [10, 30],
TimeUnix: new Date(now + ms('1m')),
},
].map(point => ({
MetricName: 'test.two_timestamps_lower_bound',
ResourceAttributes: {
host: 'test2',
ip: '127.0.0.1',
},
AggregationTemporality: 2, // Cumulative
...point,
}));
const histPointsB = [
{
BucketCounts: [0, 0, 0],
ExplicitBounds: [1, 30],
TimeUnix: new Date(now),
},
{
BucketCounts: [10, 0, 0],
ExplicitBounds: [1, 30],
TimeUnix: new Date(now + ms('1m')),
},
].map(point => ({
MetricName: 'test.two_timestamps_lower_bound_inf',
ResourceAttributes: {
host: 'test2',
ip: '127.0.0.1',
},
AggregationTemporality: 2, // Cumulative
...point,
}));
const histPointsC = [
{
BucketCounts: [0, 0, 0],
ExplicitBounds: [0, 30],
TimeUnix: new Date(now),
},
{
BucketCounts: [0, 0, 10],
ExplicitBounds: [0, 30],
TimeUnix: new Date(now + ms('1m')),
},
].map(point => ({
MetricName: 'test.two_timestamps_upper_bound_inf',
ResourceAttributes: {
host: 'test2',
ip: '127.0.0.1',
},
AggregationTemporality: 2, // Cumulative
...point,
}));
const histPointsD = [
{
BucketCounts: [5, 5, 5],
ExplicitBounds: [10, 30],
TimeUnix: new Date(now),
},
{
BucketCounts: [0, 0, 0],
ExplicitBounds: [10, 30],
TimeUnix: new Date(now + ms('1m')),
},
{
BucketCounts: [10, 10, 10],
ExplicitBounds: [10, 30],
TimeUnix: new Date(now + ms('2m')),
},
].map(point => ({
MetricName: 'test.three_timestamps_bounded',
ResourceAttributes: {
host: 'test3',
ip: '127.0.0.1',
},
AggregationTemporality: 2, // Cumulative
...point,
}));
await Promise.all([
bulkInsertMetricsGauge([...gaugePointsA, ...gaugePointsB]),
@ -344,6 +437,12 @@ describe('renderChartConfig', () => {
...sumPointsD,
...sumPointsE,
]),
bulkInsertMetricsHistogram([
...histPointsA,
...histPointsB,
...histPointsC,
...histPointsD,
]),
]);
});
@ -360,11 +459,7 @@ describe('renderChartConfig', () => {
],
from: metricSource.from,
where: '',
metricTables: {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
},
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('10m'))],
granularity: '5 minute',
timestampValueExpression: metricSource.timestampValueExpression,
@ -385,11 +480,7 @@ describe('renderChartConfig', () => {
],
from: metricSource.from,
where: '',
metricTables: {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
},
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('10m'))],
granularity: '5 minute',
timestampValueExpression: metricSource.timestampValueExpression,
@ -410,11 +501,7 @@ describe('renderChartConfig', () => {
],
from: metricSource.from,
where: '',
metricTables: {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
},
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('10m'))],
granularity: '5 minute',
timestampValueExpression: metricSource.timestampValueExpression,
@ -439,11 +526,7 @@ describe('renderChartConfig', () => {
from: metricSource.from,
where: 'ServiceName:"db" AND ResourceAttributes.host:"host1"',
whereLanguage: 'lucene',
metricTables: {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
},
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('10m'))],
granularity: '5 minute',
timestampValueExpression: metricSource.timestampValueExpression,
@ -467,11 +550,7 @@ describe('renderChartConfig', () => {
],
from: metricSource.from,
where: '',
metricTables: {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
},
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('10m'))],
granularity: '5 minute',
groupBy: `ResourceAttributes['host']`,
@ -496,11 +575,7 @@ describe('renderChartConfig', () => {
],
from: metricSource.from,
where: '',
metricTables: {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
},
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('20m'))],
granularity: '5 minute',
timestampValueExpression: metricSource.timestampValueExpression,
@ -524,11 +599,7 @@ describe('renderChartConfig', () => {
],
from: metricSource.from,
where: '',
metricTables: {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
},
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('20m'))],
granularity: '10 minute',
timestampValueExpression: metricSource.timestampValueExpression,
@ -568,11 +639,7 @@ describe('renderChartConfig', () => {
],
from: metricSource.from,
where: '',
metricTables: {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
},
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('20m'))],
granularity: '10 minute',
timestampValueExpression: metricSource.timestampValueExpression,
@ -594,11 +661,7 @@ describe('renderChartConfig', () => {
],
from: metricSource.from,
where: '',
metricTables: {
sum: DEFAULT_METRICS_TABLE.SUM,
gauge: DEFAULT_METRICS_TABLE.GAUGE,
histogram: DEFAULT_METRICS_TABLE.HISTOGRAM,
},
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('20m'))],
granularity: '10 minute',
timestampValueExpression: metricSource.timestampValueExpression,
@ -608,5 +671,294 @@ describe('renderChartConfig', () => {
);
expect(await queryData(maxQuery)).toMatchSnapshot('maxSum');
});
it('two_timestamps_bounded histogram (p50)', async () => {
/*
This test starts with 2 data points with bounds of [10, 30]:
t0: [0, 0, 0]
t1: [10, 10, 10]
Since the AggregationTemporality is 2(cumulative), we need to calculate the delta between the two points:
delta: [10, 10, 10] - [0, 0, 0] = [10, 10, 10]
Total observations: 10 + 10 + 10 = 30
Cumulative counts: [10, 20, 30]
p50 point:
Rank = 0.5 * 30 = 15
This falls in the second bucket (since 10 < 15 ≤ 20)
We need to interpolate between the lower and upper bounds of the second bucket:
Lower bound: 10
Upper bound: 30
Position in bucket: (15 - 10) / (20 - 10) = 0.5
Interpolated value: 10 + (30 - 10) * 0.5 = 10 + 10 = 20
Thus the first point value would be 0 since it's at the start of the bounds.
The second point value would be 20 since that is the median point value delta from the first point.
*/
const query = await renderChartConfig(
{
select: [
{
aggFn: 'quantile',
level: 0.5,
metricName: 'test.two_timestamps_lower_bound',
metricType: MetricsDataType.Histogram,
valueExpression: 'Value',
},
],
from: metricSource.from,
where: '',
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('2m'))],
granularity: '1 minute',
timestampValueExpression: metricSource.timestampValueExpression,
connection: connection.id,
},
metadata,
);
const res = await queryData(query);
expect(res).toMatchSnapshot();
});
it('two_timestamps_bounded histogram (p90)', async () => {
/*
This test starts with 2 data points with bounds of [10, 30]:
t0: [0, 0, 0]
t1: [10, 10, 10]
Since the AggregationTemporality is 2(cumulative), we need to calculate the delta between the two points:
delta: [10, 10, 10] - [0, 0, 0] = [10, 10, 10]
Total observations: 10 + 10 + 10 = 30
Cumulative counts: [10, 20, 30]
p90 point:
Rank = 0.9 * 30 = 27
This falls in the third bucket (since 20 < 27 ≤ 30)
We need to interpolate between the lower and upper bounds of the third bucket:
Lower bound: 30
Upper bound: Infinity (but we use the upper bound of the previous bucket for the last bucket)
Position in bucket: (27 - 20) / (30 - 20) = 0.7
Interpolated value: 30 (since it's in the last bucket, we return the upper bound of the previous bucket)
Thus the first point value would be 0 since it's at the start of the bounds.
The second point value would be 30 since that is the 90th percentile point value delta from the first point.
*/
const query = await renderChartConfig(
{
select: [
{
aggFn: 'quantile',
level: 0.9,
metricName: 'test.two_timestamps_lower_bound',
metricType: MetricsDataType.Histogram,
valueExpression: 'Value',
},
],
from: metricSource.from,
where: '',
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('2m'))],
granularity: '1 minute',
timestampValueExpression: metricSource.timestampValueExpression,
connection: connection.id,
},
metadata,
);
const res = await queryData(query);
expect(res).toMatchSnapshot();
});
it('two_timestamps_bounded histogram (p25)', async () => {
/*
This test starts with 2 data points with bounds of [10, 30]:
t0: [0, 0, 0]
t1: [10, 10, 10]
Since the AggregationTemporality is 2(cumulative), we need to calculate the delta between the two points:
delta: [10, 10, 10] - [0, 0, 0] = [10, 10, 10]
Total observations: 10 + 10 + 10 = 30
Cumulative counts: [10, 20, 30]
p25 point:
Rank = 0.25 * 30 = 7.5
This falls in the first bucket (since 0 < 7.5 ≤ 10)
We need to interpolate between the lower and upper bounds of the first bucket:
Lower bound: 0 (implicit lower bound for first bucket)
Upper bound: 10 (first explicit bound)
Position in bucket: 7.5 / 10 = 0.75
Interpolated value: 0 + 0.75 * (10 - 0) = 7.5
Since all observations are in the first bucket which has an upper bound of 1:
For the first bucket (≤ 0), the algorithm would interpolate, but since all values are in this bucket and it's the lowest bucket, it would return 10
Thus the value columns in res should be [0, 10]
*/
const query = await renderChartConfig(
{
select: [
{
aggFn: 'quantile',
level: 0.25,
metricName: 'test.two_timestamps_lower_bound',
metricType: MetricsDataType.Histogram,
valueExpression: 'Value',
},
],
from: metricSource.from,
where: '',
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('2m'))],
granularity: '1 minute',
timestampValueExpression: metricSource.timestampValueExpression,
connection: connection.id,
},
metadata,
);
const res = await queryData(query);
expect(res).toMatchSnapshot();
});
it('two_timestamps_lower_bound_inf histogram (p50)', async () => {
/*
This test starts with 2 data points with bounds of [1, 30]:
t0: [0, 0, 0]
t1: [10, 0, 0]
Since the AggregationTemporality is 2(cumulative), we need to calculate the delta between the two points:
delta: [10, 0, 0] - [0, 0, 0] = [10, 0, 0]
Total observations: 10 + 0 + 0 = 10
Cumulative counts: [10, 10, 10]
p50 point:
Rank = 0.5 * 10 = 5
This falls in the first bucket (since 5 < 10)
Since all observations are in the first bucket which has an upper bound of 1:
For the first bucket (≤ 0), the algorithm would interpolate, but since all values are in this bucket and it's the lowest bucket, it would return 1
Thus the value columns in res should be [0, 1]
*/
const query = await renderChartConfig(
{
select: [
{
aggFn: 'quantile',
level: 0.5,
metricName: 'test.two_timestamps_lower_bound_inf',
metricType: MetricsDataType.Histogram,
valueExpression: 'Value',
},
],
from: metricSource.from,
where: '',
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('2m'))],
granularity: '1 minute',
timestampValueExpression: metricSource.timestampValueExpression,
connection: connection.id,
},
metadata,
);
const res = await queryData(query);
expect(res).toMatchSnapshot();
});
it('two_timestamps_upper_bound_inf histogram (p50)', async () => {
/*
This test starts with 2 data points with bounds of [0, 30]:
t0: [0, 0, 0]
t1: [0, 0, 10]
Since the AggregationTemporality is 2(cumulative), we need to calculate the delta between the two points:
delta: [0, 0, 10] - [0, 0, 0] = [0, 0, 10]
Total observations: 0 + 0 + 10 = 10
Cumulative counts: [0, 0, 10]
p50 point:
Rank = 0.5 * 10 = 5
This falls in the third bucket
Since all observations are in the third bucket which has no upper bound (infinity):
For the third bucket (> 30), the algorithm would return the upper bound of the previous bucket, which is 30
Thus the value columns in res should be [0, 30]
*/
const query = await renderChartConfig(
{
select: [
{
aggFn: 'quantile',
level: 0.5,
metricName: 'test.two_timestamps_upper_bound_inf',
metricType: MetricsDataType.Histogram,
valueExpression: 'Value',
},
],
from: metricSource.from,
where: '',
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('2m'))],
granularity: '1 minute',
timestampValueExpression: metricSource.timestampValueExpression,
connection: connection.id,
},
metadata,
);
const res = await queryData(query);
expect(res).toMatchSnapshot();
});
// HDX-1515: Handle counter reset in histogram metric in the same way that the counter reset
// is handled for sum metrics.
it.skip('three_timestamps_bounded histogram with reset (p50)', async () => {
/*
For the following histogram values:
b = [10, 30]
t0 = [5, 5, 5]
t1 = [0, 0, 0]
t2 = [10, 10, 10]
The computed value at each point would be:
t0 = 10
cum values = [5, 10, 15]
rank = 0.5 * 15 = 7.5
t1 = 0
cum values = [0, 0, 0]
rank = 0.5 * 0 = 0
t2 = 20
cum values = [10, 20, 30]
rank = 0.5 * 30 = 15
Position in bucket: (15 - 10) / (20 - 10) = 0.5
Interpolated value: 10 + (30 - 10) * 0.5 = 10 + 10 = 20
Ignoring the counter reset of zeros:
[10, 0, 20] is interpolated as [10, 10, 30]
*/
const query = await renderChartConfig(
{
select: [
{
aggFn: 'quantile',
level: 0.5,
metricName: 'test.three_timestamps_bounded',
metricType: MetricsDataType.Histogram,
valueExpression: 'Value',
},
],
from: metricSource.from,
where: '',
metricTables: TEST_METRIC_TABLES,
dateRange: [new Date(now), new Date(now + ms('2m'))],
granularity: '1 minute',
timestampValueExpression: metricSource.timestampValueExpression,
connection: connection.id,
},
metadata,
);
const res = await queryData(query);
expect(res).toMatchSnapshot();
});
});
});

19
packages/api/src/fixtures.ts
View file

@ -446,6 +446,25 @@ export const bulkInsertMetricsSum = async (
);
};
export const bulkInsertMetricsHistogram = async (
metrics: {
MetricName: string;
ResourceAttributes: Record<string, string>;
TimeUnix: Date;
BucketCounts: number[];
ExplicitBounds: number[];
AggregationTemporality: number;
}[],
) => {
if (!config.IS_CI) {
throw new Error('ONLY execute this in CI env 😈 !!!');
}
await _bulkInsertData(
`${DEFAULT_DATABASE}.${DEFAULT_METRICS_TABLE.HISTOGRAM}`,
metrics,
);
};
// TODO: DEPRECATED
export function buildMetricSeries({
tags,

2
packages/common-utils/src/__tests__/__snapshots__/renderChartConfig.test.ts.snap
View file

@ -64,7 +64,7 @@ exports[`renderChartConfig should generate sql for a single histogram metric 1`]
arrayElement(ExplicitBounds, BucketLowIdx - 1) + (arrayElement(ExplicitBounds, BucketLowIdx) - arrayElement(ExplicitBounds, BucketLowIdx - 1)) *
IF(arrayElement(CumRates, BucketLowIdx) > arrayElement(CumRates, BucketLowIdx - 1),
(Rank - arrayElement(CumRates, BucketLowIdx - 1)) / (arrayElement(CumRates, BucketLowIdx) - arrayElement(CumRates, BucketLowIdx - 1)), 0),
IF(arrayElement(CumRates, 1) > 0, arrayElement(ExplicitBounds, BucketLowIdx + 1) * (Rank / arrayElement(CumRates, BucketLowIdx)), 0)
arrayElement(ExplicitBounds, BucketLowIdx)
)) as Rate
FROM HistRate) SELECT sum(
toFloat64OrNull(toString(Rate))

2
packages/common-utils/src/renderChartConfig.ts
View file

@ -1111,7 +1111,7 @@ async function translateMetricChartConfig(
arrayElement(ExplicitBounds, BucketLowIdx - 1) + (arrayElement(ExplicitBounds, BucketLowIdx) - arrayElement(ExplicitBounds, BucketLowIdx - 1)) *
IF(arrayElement(CumRates, BucketLowIdx) > arrayElement(CumRates, BucketLowIdx - 1),
(Rank - arrayElement(CumRates, BucketLowIdx - 1)) / (arrayElement(CumRates, BucketLowIdx) - arrayElement(CumRates, BucketLowIdx - 1)), 0),
IF(arrayElement(CumRates, 1) > 0, arrayElement(ExplicitBounds, BucketLowIdx + 1) * (Rank / arrayElement(CumRates, BucketLowIdx)), 0)
arrayElement(ExplicitBounds, BucketLowIdx)
)) as Rate
FROM HistRate`,
},