diff --git a/.changeset/rename-promql-source-type-label.md b/.changeset/rename-promql-source-type-label.md new file mode 100644 index 0000000000..a74957f104 --- /dev/null +++ b/.changeset/rename-promql-source-type-label.md @@ -0,0 +1,15 @@ +--- +'@hyperdx/app': patch +'@hyperdx/api': patch +--- + +feat: Name PromQL sources "Time Series" or "Prometheus" by their connection + +The source type for a PromQL source now reads "Time Series" when it queries a +ClickHouse TimeSeries table and "Prometheus" when it queries an external +Prometheus API. Where no connection is known yet, such as the source form before +a connection is picked or a data source variable's kinds, it reads "Time Series +/ Prometheus". The stored kind is still `promql`. + +The PromQL source created by onboarding auto-detection and the local dev default +sources is now named "Time Series" instead of "PromQL". diff --git a/packages/api/.env.development b/packages/api/.env.development index c937acea83..390dd2feeb 100644 --- a/packages/api/.env.development +++ b/packages/api/.env.development @@ -23,7 +23,7 @@ USAGE_STATS_ENABLED=false NODE_OPTIONS="--max-http-header-size=131072" ENABLE_SWAGGER=true DEFAULT_CONNECTIONS=[{"name":"Local ClickHouse","host":"http://localhost:${HDX_DEV_CH_HTTP_PORT}","username":"default","password":""}] -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","severityNumberExpression":"SeverityNumber","eventNameExpression":"EventName","traceIdExpression":"TraceId","spanIdExpression":"SpanId","metadataMaterializedViews":{"kvRollupTable":"otel_logs_kv_rollup_15m","granularity":"15 minute"},"connection":"Local ClickHouse","traceSourceId":"Traces","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","spanEventsValueExpression":"Events","spanLinksValueExpression":"Links","metadataMaterializedViews":{"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","summary":"otel_metrics_summary","exponential histogram":"otel_metrics_exponential_histogram"},"connection":"Local ClickHouse","logSourceId":"Logs"},{"from":{"databaseName":"default","tableName":"hyperdx_sessions"},"kind":"session","timestampValueExpression":"TimestampTime","name":"Sessions","resourceAttributesExpression":"ResourceAttributes","connection":"Local ClickHouse","traceSourceId":"Traces"},{"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","severityNumberExpression":"SeverityNumber","eventNameExpression":"EventName","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","spanEventsValueExpression":"Events","spanLinksValueExpression":"Links","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","summary":"otel_metrics_summary","exponential histogram":"otel_metrics_exponential_histogram"},"connection":"Local ClickHouse","logSourceId":"JSON Logs"},{"kind":"promql","name":"PromQL","connection":"Local ClickHouse","from":{"databaseName":"default","tableName":"metrics_ts"},"timestampValueExpression":"timestamp"}] +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","severityNumberExpression":"SeverityNumber","eventNameExpression":"EventName","traceIdExpression":"TraceId","spanIdExpression":"SpanId","metadataMaterializedViews":{"kvRollupTable":"otel_logs_kv_rollup_15m","granularity":"15 minute"},"connection":"Local ClickHouse","traceSourceId":"Traces","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","spanEventsValueExpression":"Events","spanLinksValueExpression":"Links","metadataMaterializedViews":{"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","summary":"otel_metrics_summary","exponential histogram":"otel_metrics_exponential_histogram"},"connection":"Local ClickHouse","logSourceId":"Logs"},{"from":{"databaseName":"default","tableName":"hyperdx_sessions"},"kind":"session","timestampValueExpression":"TimestampTime","name":"Sessions","resourceAttributesExpression":"ResourceAttributes","connection":"Local ClickHouse","traceSourceId":"Traces"},{"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","severityNumberExpression":"SeverityNumber","eventNameExpression":"EventName","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","spanEventsValueExpression":"Events","spanLinksValueExpression":"Links","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","summary":"otel_metrics_summary","exponential histogram":"otel_metrics_exponential_histogram"},"connection":"Local ClickHouse","logSourceId":"JSON Logs"},{"kind":"promql","name":"Time Series","connection":"Local ClickHouse","from":{"databaseName":"default","tableName":"metrics_ts"},"timestampValueExpression":"timestamp"}] INGESTION_API_KEY="super-secure-ingestion-api-key" HYPERDX_API_KEY=$INGESTION_API_KEY diff --git a/packages/api/src/__tests__/setupDefaults.test.ts b/packages/api/src/__tests__/setupDefaults.test.ts index a94af81b38..84bf86452f 100644 --- a/packages/api/src/__tests__/setupDefaults.test.ts +++ b/packages/api/src/__tests__/setupDefaults.test.ts @@ -15,7 +15,7 @@ jest.mock('@/config', () => ({ }, { kind: 'promql', - name: 'PromQL', + name: 'Time Series', connection: 'Local ClickHouse', from: { databaseName: 'default', tableName: 'metrics_ts' }, timestampValueExpression: 'timestamp', diff --git a/packages/app/src/components/OnboardingModal.tsx b/packages/app/src/components/OnboardingModal.tsx index ab2e3cbf05..22aef9e069 100644 --- a/packages/app/src/components/OnboardingModal.tsx +++ b/packages/app/src/components/OnboardingModal.tsx @@ -544,7 +544,7 @@ function OnboardingModalComponent({ const promqlSource = await createSourceMutation.mutateAsync({ source: { kind: SourceKind.Promql, - name: 'PromQL', + name: 'Time Series', connection: connectionId, from: timeSeriesTable, timestampValueExpression: PROMQL_TIMESTAMP_EXPRESSION, diff --git a/packages/app/src/components/Sources/SourceForm/SourceForm.tsx b/packages/app/src/components/Sources/SourceForm/SourceForm.tsx index 329a8d54e5..cfcd2542c5 100644 --- a/packages/app/src/components/Sources/SourceForm/SourceForm.tsx +++ b/packages/app/src/components/Sources/SourceForm/SourceForm.tsx @@ -62,6 +62,7 @@ import { import { DEFAULT_DATABASE, + getSourceKindLabel, PROMETHEUS_PLACEHOLDER, SOURCE_KIND_LABELS, } from './constants'; @@ -653,7 +654,10 @@ export function TableSourceForm({ {IS_PROMQL_ENABLED && ( )} diff --git a/packages/app/src/components/Sources/SourceForm/constants.ts b/packages/app/src/components/Sources/SourceForm/constants.ts index 575e953275..dd7ea9dbc1 100644 --- a/packages/app/src/components/Sources/SourceForm/constants.ts +++ b/packages/app/src/components/Sources/SourceForm/constants.ts @@ -16,9 +16,24 @@ export const SOURCE_KIND_LABELS: Record = { [SourceKind.Trace]: 'Traces', [SourceKind.Metric]: 'OTel metrics', [SourceKind.Session]: 'Sessions', - [SourceKind.Promql]: 'PromQL', + [SourceKind.Promql]: 'Time Series / Prometheus', }; +/** + * The kind label for a source on a known connection. A PromQL source reads a + * ClickHouse TimeSeries table or an external Prometheus API, depending on the + * connection, so it is named after which one it uses. + */ +export function getSourceKindLabel( + kind: SourceKind, + connection?: { isPrometheusEndpoint?: boolean }, +): string { + if (kind !== SourceKind.Promql || connection == null) { + return SOURCE_KIND_LABELS[kind]; + } + return connection.isPrometheusEndpoint ? 'Prometheus' : 'Time Series'; +} + export const KNOWN_COLUMNS_EXPRESSION_HELP_TEXT = 'For Distributed table sources whose target tables have non-matching column sets. Provide a list of columns supported across all target tables; it is used instead of SELECT * when fetching full row data (e.g. the row side panel). Leave blank to select all columns. This should be a comma-separated list of column names - do not include non-column expressions or aliases.'; diff --git a/packages/app/src/components/Sources/SourcesList.tsx b/packages/app/src/components/Sources/SourcesList.tsx index 89fe1a635e..743bce7813 100644 --- a/packages/app/src/components/Sources/SourcesList.tsx +++ b/packages/app/src/components/Sources/SourcesList.tsx @@ -30,7 +30,7 @@ import { IS_LOCAL_MODE } from '@/config'; import { useConnections } from '@/connection'; import { useSources } from '@/source'; -import { SOURCE_KIND_LABELS } from './SourceForm/constants'; +import { getSourceKindLabel } from './SourceForm/constants'; import { TableSourceForm } from './SourceForm'; import styles from './Sources.module.scss'; @@ -210,7 +210,10 @@ export function SourcesList({ - {SOURCE_KIND_LABELS[s.kind]} + {getSourceKindLabel( + s.kind, + connections?.find(c => c.id === s.connection), + )} {s.section && ( diff --git a/packages/app/src/components/__tests__/OnboardingModal.test.tsx b/packages/app/src/components/__tests__/OnboardingModal.test.tsx index 8bb64b1995..b6a2655458 100644 --- a/packages/app/src/components/__tests__/OnboardingModal.test.tsx +++ b/packages/app/src/components/__tests__/OnboardingModal.test.tsx @@ -114,7 +114,7 @@ describe('OnboardingModal auto-detection', () => { expect(mockCreateSource).toHaveBeenLastCalledWith({ source: { kind: SourceKind.Promql, - name: 'PromQL', + name: 'Time Series', connection: 'conn-1', from: { databaseName: 'default', tableName: 'metrics_ts' }, timestampValueExpression: 'timestamp', diff --git a/packages/app/src/components/__tests__/SourcesList.test.tsx b/packages/app/src/components/__tests__/SourcesList.test.tsx index 138a69d450..7685511def 100644 --- a/packages/app/src/components/__tests__/SourcesList.test.tsx +++ b/packages/app/src/components/__tests__/SourcesList.test.tsx @@ -87,9 +87,40 @@ describe('SourcesList section display', () => { 'Traces', 'OTel metrics', 'Sessions', - 'PromQL', + 'Time Series', ]) { expect(screen.getByText(label)).toBeInTheDocument(); } }); + + it('names a PromQL source after the connection it reads from', () => { + asMock(useConnections).mockReturnValue({ + data: [ + { id: 'conn-a', name: 'Default' }, + { id: 'conn-prom', name: 'Thanos', isPrometheusEndpoint: true }, + ], + isLoading: false, + refetch: jest.fn(), + }); + asMock(useSources).mockReturnValue({ + data: [ + makeSource('a', 'A', { kind: SourceKind.Promql }), + makeSource('b', 'B', { + kind: SourceKind.Promql, + connection: 'conn-prom', + }), + makeSource('c', 'C', { + kind: SourceKind.Promql, + connection: 'conn-missing', + }), + ], + isLoading: false, + refetch: jest.fn(), + }); + renderWithMantine(); + + expect(screen.getByText('Time Series')).toBeInTheDocument(); + expect(screen.getByText('Prometheus')).toBeInTheDocument(); + expect(screen.getByText('Time Series / Prometheus')).toBeInTheDocument(); + }); });