Skip to content

Commit 439fdba

Browse files
authored
feat: provision a PromQL source in the dev default sources
1 parent e61461b commit 439fdba

4 files changed

Lines changed: 112 additions & 2 deletions

File tree

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
'@hyperdx/api': patch
3+
---
4+
5+
feat: only provision a default PromQL source when PromQL is enabled
6+
7+
`DEFAULT_SOURCES` entries of kind `promql` are now skipped unless
8+
`ENABLE_PROMQL=true`, so a single sources list can include a PromQL source
9+
without creating it on deployments that have PromQL turned off.

‎packages/api/.env.development‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ USAGE_STATS_ENABLED=false
2222
NODE_OPTIONS="--max-http-header-size=131072"
2323
ENABLE_SWAGGER=true
2424
DEFAULT_CONNECTIONS=[{"name":"Local ClickHouse","host":"http://localhost:${HDX_DEV_CH_HTTP_PORT}","username":"default","password":""}]
25-
DEFAULT_SOURCES=[{"from":{"databaseName":"default","tableName":"otel_logs"},"kind":"log","timestampValueExpression":"Timestamp","name":"Logs","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"Body","serviceNameExpression":"ServiceName","bodyExpression":"Body","eventAttributesExpression":"LogAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,SeverityText,Body","severityTextExpression":"SeverityText","traceIdExpression":"TraceId","spanIdExpression":"SpanId","metadataMaterializedViews":{"keyRollupTable":"otel_logs_key_rollup_15m","kvRollupTable":"otel_logs_kv_rollup_15m","granularity":"15 minute"},"connection":"Local ClickHouse","traceSourceId":"Traces","sessionSourceId":"Sessions","metricSourceId":"Metrics"},{"from":{"databaseName":"default","tableName":"otel_traces"},"kind":"trace","timestampValueExpression":"Timestamp","name":"Traces","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"SpanName","serviceNameExpression":"ServiceName","eventAttributesExpression":"SpanAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,StatusCode,round(Duration/1e6),SpanName","traceIdExpression":"TraceId","spanIdExpression":"SpanId","durationExpression":"Duration","durationPrecision":9,"parentSpanIdExpression":"ParentSpanId","spanNameExpression":"SpanName","spanKindExpression":"SpanKind","statusCodeExpression":"StatusCode","statusMessageExpression":"StatusMessage","metadataMaterializedViews":{"keyRollupTable":"otel_traces_key_rollup_15m","kvRollupTable":"otel_traces_kv_rollup_15m","granularity":"15 minute"},"connection":"Local ClickHouse","logSourceId":"Logs","sessionSourceId":"Sessions","metricSourceId":"Metrics"},{"from":{"databaseName":"default","tableName":""},"kind":"metric","timestampValueExpression":"TimeUnix","name":"Metrics","resourceAttributesExpression":"ResourceAttributes","metricTables":{"gauge":"otel_metrics_gauge","histogram":"otel_metrics_histogram","sum":"otel_metrics_sum","_id":"682586a8b1f81924e628e808","id":"682586a8b1f81924e628e808"},"connection":"Local ClickHouse","logSourceId":"Logs","traceSourceId":"Traces","sessionSourceId":"Sessions"},{"from":{"databaseName":"default","tableName":"hyperdx_sessions"},"kind":"session","timestampValueExpression":"TimestampTime","name":"Sessions","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"Body","serviceNameExpression":"ServiceName","bodyExpression":"Body","eventAttributesExpression":"LogAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,SeverityText,Body","severityTextExpression":"SeverityText","traceIdExpression":"TraceId","spanIdExpression":"SpanId","connection":"Local ClickHouse","logSourceId":"Logs","traceSourceId":"Traces","metricSourceId":"Metrics"},{"from":{"databaseName":"otel_json","tableName":"otel_logs"},"kind":"log","timestampValueExpression":"Timestamp","name":"JSON Logs","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"Body","serviceNameExpression":"ServiceName","bodyExpression":"Body","eventAttributesExpression":"LogAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,SeverityText,Body","severityTextExpression":"SeverityText","traceIdExpression":"TraceId","spanIdExpression":"SpanId","connection":"Local ClickHouse","traceSourceId":"JSON Traces","metricSourceId":"JSON Metrics"},{"from":{"databaseName":"otel_json","tableName":"otel_traces"},"kind":"trace","timestampValueExpression":"Timestamp","name":"JSON Traces","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"SpanName","serviceNameExpression":"ServiceName","eventAttributesExpression":"SpanAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,StatusCode,round(Duration/1e6),SpanName","traceIdExpression":"TraceId","spanIdExpression":"SpanId","durationExpression":"Duration","durationPrecision":9,"parentSpanIdExpression":"ParentSpanId","spanNameExpression":"SpanName","spanKindExpression":"SpanKind","statusCodeExpression":"StatusCode","statusMessageExpression":"StatusMessage","connection":"Local ClickHouse","logSourceId":"JSON Logs","metricSourceId":"JSON Metrics"},{"from":{"databaseName":"otel_json","tableName":""},"kind":"metric","timestampValueExpression":"TimeUnix","name":"JSON Metrics","resourceAttributesExpression":"ResourceAttributes","metricTables":{"gauge":"otel_metrics_gauge","histogram":"otel_metrics_histogram","sum":"otel_metrics_sum"},"connection":"Local ClickHouse","logSourceId":"JSON Logs","traceSourceId":"JSON Traces"}]
25+
DEFAULT_SOURCES=[{"from":{"databaseName":"default","tableName":"otel_logs"},"kind":"log","timestampValueExpression":"Timestamp","name":"Logs","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"Body","serviceNameExpression":"ServiceName","bodyExpression":"Body","eventAttributesExpression":"LogAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,SeverityText,Body","severityTextExpression":"SeverityText","traceIdExpression":"TraceId","spanIdExpression":"SpanId","metadataMaterializedViews":{"keyRollupTable":"otel_logs_key_rollup_15m","kvRollupTable":"otel_logs_kv_rollup_15m","granularity":"15 minute"},"connection":"Local ClickHouse","traceSourceId":"Traces","sessionSourceId":"Sessions","metricSourceId":"Metrics"},{"from":{"databaseName":"default","tableName":"otel_traces"},"kind":"trace","timestampValueExpression":"Timestamp","name":"Traces","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"SpanName","serviceNameExpression":"ServiceName","eventAttributesExpression":"SpanAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,StatusCode,round(Duration/1e6),SpanName","traceIdExpression":"TraceId","spanIdExpression":"SpanId","durationExpression":"Duration","durationPrecision":9,"parentSpanIdExpression":"ParentSpanId","spanNameExpression":"SpanName","spanKindExpression":"SpanKind","statusCodeExpression":"StatusCode","statusMessageExpression":"StatusMessage","metadataMaterializedViews":{"keyRollupTable":"otel_traces_key_rollup_15m","kvRollupTable":"otel_traces_kv_rollup_15m","granularity":"15 minute"},"connection":"Local ClickHouse","logSourceId":"Logs","sessionSourceId":"Sessions","metricSourceId":"Metrics"},{"from":{"databaseName":"default","tableName":""},"kind":"metric","timestampValueExpression":"TimeUnix","name":"Metrics","resourceAttributesExpression":"ResourceAttributes","metricTables":{"gauge":"otel_metrics_gauge","histogram":"otel_metrics_histogram","sum":"otel_metrics_sum","_id":"682586a8b1f81924e628e808","id":"682586a8b1f81924e628e808"},"connection":"Local ClickHouse","logSourceId":"Logs","traceSourceId":"Traces","sessionSourceId":"Sessions"},{"from":{"databaseName":"default","tableName":"hyperdx_sessions"},"kind":"session","timestampValueExpression":"TimestampTime","name":"Sessions","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"Body","serviceNameExpression":"ServiceName","bodyExpression":"Body","eventAttributesExpression":"LogAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,SeverityText,Body","severityTextExpression":"SeverityText","traceIdExpression":"TraceId","spanIdExpression":"SpanId","connection":"Local ClickHouse","logSourceId":"Logs","traceSourceId":"Traces","metricSourceId":"Metrics"},{"from":{"databaseName":"otel_json","tableName":"otel_logs"},"kind":"log","timestampValueExpression":"Timestamp","name":"JSON Logs","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"Body","serviceNameExpression":"ServiceName","bodyExpression":"Body","eventAttributesExpression":"LogAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,SeverityText,Body","severityTextExpression":"SeverityText","traceIdExpression":"TraceId","spanIdExpression":"SpanId","connection":"Local ClickHouse","traceSourceId":"JSON Traces","metricSourceId":"JSON Metrics"},{"from":{"databaseName":"otel_json","tableName":"otel_traces"},"kind":"trace","timestampValueExpression":"Timestamp","name":"JSON Traces","displayedTimestampValueExpression":"Timestamp","implicitColumnExpression":"SpanName","serviceNameExpression":"ServiceName","eventAttributesExpression":"SpanAttributes","resourceAttributesExpression":"ResourceAttributes","defaultTableSelectExpression":"Timestamp,ServiceName,StatusCode,round(Duration/1e6),SpanName","traceIdExpression":"TraceId","spanIdExpression":"SpanId","durationExpression":"Duration","durationPrecision":9,"parentSpanIdExpression":"ParentSpanId","spanNameExpression":"SpanName","spanKindExpression":"SpanKind","statusCodeExpression":"StatusCode","statusMessageExpression":"StatusMessage","connection":"Local ClickHouse","logSourceId":"JSON Logs","metricSourceId":"JSON Metrics"},{"from":{"databaseName":"otel_json","tableName":""},"kind":"metric","timestampValueExpression":"TimeUnix","name":"JSON Metrics","resourceAttributesExpression":"ResourceAttributes","metricTables":{"gauge":"otel_metrics_gauge","histogram":"otel_metrics_histogram","sum":"otel_metrics_sum"},"connection":"Local ClickHouse","logSourceId":"JSON Logs","traceSourceId":"JSON Traces"},{"kind":"promql","name":"PromQL","connection":"Local ClickHouse","from":{"databaseName":"default","tableName":"metrics_ts"},"timestampValueExpression":"timestamp"}]
26+
2627
INGESTION_API_KEY="super-secure-ingestion-api-key"
2728
HYPERDX_API_KEY=$INGESTION_API_KEY
2829
ANTHROPIC_API_KEY="your-anthropic-api-key-here"
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
import { SourceKind } from '@hyperdx/common-utils/dist/types';
2+
3+
const configState = { IS_PROMQL_ENABLED: false };
4+
5+
jest.mock('@/config', () => ({
6+
DEFAULT_CONNECTIONS: undefined,
7+
DEFAULT_SOURCES: JSON.stringify([
8+
{
9+
kind: 'log',
10+
name: 'Logs',
11+
connection: 'Local ClickHouse',
12+
from: { databaseName: 'default', tableName: 'otel_logs' },
13+
timestampValueExpression: 'Timestamp',
14+
defaultTableSelectExpression: 'Timestamp, Body',
15+
},
16+
{
17+
kind: 'promql',
18+
name: 'PromQL',
19+
connection: 'Local ClickHouse',
20+
from: { databaseName: 'default', tableName: 'metrics_ts' },
21+
timestampValueExpression: 'timestamp',
22+
},
23+
]),
24+
get IS_PROMQL_ENABLED() {
25+
return configState.IS_PROMQL_ENABLED;
26+
},
27+
}));
28+
29+
jest.mock('@/controllers/team', () => ({
30+
getTeam: jest.fn().mockResolvedValue({ _id: 'team-1' }),
31+
}));
32+
jest.mock('@/controllers/connection', () => ({
33+
createConnection: jest.fn(),
34+
getConnections: jest
35+
.fn()
36+
.mockResolvedValue([
37+
{ _id: 'conn-1', team: 'team-1', name: 'Local ClickHouse' },
38+
]),
39+
}));
40+
jest.mock('@/controllers/sources', () => ({
41+
getSources: jest.fn().mockResolvedValue([]),
42+
createSource: jest.fn(async (_teamId: string, source: { name: string }) => ({
43+
_id: `${source.name}-id`,
44+
toObject: () => source,
45+
})),
46+
updateSource: jest.fn(),
47+
}));
48+
jest.mock('@/utils/logger', () => ({
49+
__esModule: true,
50+
default: { info: jest.fn(), warn: jest.fn(), error: jest.fn() },
51+
}));
52+
53+
import { createSource } from '@/controllers/sources';
54+
import { setupTeamDefaults } from '@/setupDefaults';
55+
56+
const createdKinds = () =>
57+
jest.mocked(createSource).mock.calls.map(([, source]) => source.kind);
58+
59+
describe('setupTeamDefaults', () => {
60+
beforeEach(() => {
61+
jest.mocked(createSource).mockClear();
62+
});
63+
64+
it('creates a default PromQL source when PromQL is enabled', async () => {
65+
configState.IS_PROMQL_ENABLED = true;
66+
67+
await setupTeamDefaults('team-1');
68+
69+
expect(createdKinds()).toEqual([SourceKind.Log, SourceKind.Promql]);
70+
expect(createSource).toHaveBeenLastCalledWith(
71+
'team-1',
72+
expect.objectContaining({
73+
kind: SourceKind.Promql,
74+
connection: 'conn-1',
75+
from: { databaseName: 'default', tableName: 'metrics_ts' },
76+
}),
77+
);
78+
});
79+
80+
it('skips a default PromQL source when PromQL is disabled', async () => {
81+
configState.IS_PROMQL_ENABLED = false;
82+
83+
await setupTeamDefaults('team-1');
84+
85+
expect(createdKinds()).toEqual([SourceKind.Log]);
86+
});
87+
});

‎packages/api/src/setupDefaults.ts‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
import { DEFAULT_CONNECTIONS, DEFAULT_SOURCES } from '@/config';
1+
import { SourceKind } from '@hyperdx/common-utils/dist/types';
2+
3+
import {
4+
DEFAULT_CONNECTIONS,
5+
DEFAULT_SOURCES,
6+
IS_PROMQL_ENABLED,
7+
} from '@/config';
28
import { createConnection, getConnections } from '@/controllers/connection';
39
import { createSource, getSources, updateSource } from '@/controllers/sources';
410
import { getTeam } from '@/controllers/team';
@@ -122,6 +128,13 @@ export async function setupTeamDefaults(teamId: string) {
122128
continue;
123129
}
124130

131+
if (sourceConfig.kind === SourceKind.Promql && !IS_PROMQL_ENABLED) {
132+
logger.info(
133+
`Skipping default source ${sourceConfig.name}: PromQL is disabled`,
134+
);
135+
continue;
136+
}
137+
125138
// Store the config by name for later reference
126139
sourceConfigsByName[sourceConfig.name] = sourceConfig;
127140

0 commit comments

Comments
 (0)