From 23a9484677b3f006e1f16ec2b24c38d1e413d2a0 Mon Sep 17 00:00:00 2001 From: Karl Power Date: Tue, 17 Nov 2026 16:29:58 +0100 Subject: [PATCH 1/2] feat: add PromQL support behind hyperdx.promql.enabled (HDX-5759) --- .changeset/promql-support.md | 5 + charts/clickstack/README.md | 5 +- charts/clickstack/templates/_helpers.tpl | 62 +++++ .../templates/clickhouse/cluster.yaml | 11 +- .../clickstack/tests/app-configmap_test.yaml | 22 ++ .../tests/clickhouse-promql_test.yaml | 231 ++++++++++++++++++ .../tests/default-env-vars_test.yaml | 11 + .../tests/hyperdx-rollout-checksums_test.yaml | 10 +- charts/clickstack/values.yaml | 21 ++ docs/UPGRADE.md | 4 + 10 files changed, 374 insertions(+), 8 deletions(-) create mode 100644 .changeset/promql-support.md create mode 100644 charts/clickstack/tests/clickhouse-promql_test.yaml diff --git a/.changeset/promql-support.md b/.changeset/promql-support.md new file mode 100644 index 00000000..50f2b675 --- /dev/null +++ b/.changeset/promql-support.md @@ -0,0 +1,5 @@ +--- +"helm-charts": minor +--- + +feat: add PromQL support behind `hyperdx.promql.enabled` (on by default). Sets `ENABLE_PROMQL` and `NEXT_PUBLIC_ENABLE_PROMQL`, adds a PromQL default source on the `metrics_ts` TimeSeries table, and configures ClickHouse with Prometheus remote write/read handlers, the `prometheus_api_v1` HTTP handler and `allow_experimental_time_series_table` on the default profile. The ClickHouse settings need ClickHouse 26.6 or newer and are skipped automatically on older image tags. diff --git a/charts/clickstack/README.md b/charts/clickstack/README.md index 1f63ddab..30e0091e 100644 --- a/charts/clickstack/README.md +++ b/charts/clickstack/README.md @@ -55,9 +55,9 @@ Documented values below. Undocumented keys (operator CRD passthrough fields, sub | global.imagePullSecrets | list | `[]` | Image pull secrets for private registries. Helps avoid Docker Hub rate limits. | | global.imageRegistry | string | `""` | Optional prefix for container images (e.g. registry.example.com/). | | hyperdx.autoscaling | object | `{"enabled":false,"spec":{}}` | HorizontalPodAutoscaler for HyperDX. spec is passed through verbatim (autoscaling/v2). Do not include scaleTargetRef — the chart auto-wires it. When enabled, omit deployment.replicas; disabling autoscaling reverts to deployment.replicas (default 1). | -| hyperdx.config | object | `{"API_PORT":"8000","APP_PORT":"3000","CLICKHOUSE_ENDPOINT":"tcp://{{ include \"clickstack.clickhouse.svc\" . }}:{{ .Values.clickhouse.nativePort }}?dial_timeout=10s","CLICKHOUSE_PROMETHEUS_METRICS_ENDPOINT":"{{ include \"clickstack.clickhouse.svc\" . }}:{{ .Values.clickhouse.prometheus.port }}","CLICKHOUSE_SERVER_ENDPOINT":"{{ include \"clickstack.clickhouse.svc\" . }}:{{ .Values.clickhouse.nativePort }}","CLICKHOUSE_USER":"otelcollector","FRONTEND_URL":"http://localhost:3000","HDX_EXPORTER_ENABLED":"{{ if .Values.hyperdx.config.NEXT_PUBLIC_OTEL_EXPORTER_OTLP_ENDPOINT }}true{{ else }}false{{ end }}","HYPERDX_API_PORT":"8000","HYPERDX_APP_PORT":"3000","HYPERDX_LOG_LEVEL":"info","HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE":"default","HYPERDX_OTEL_EXPORTER_TABLES_TTL":"720h","MONGO_URI":"mongodb://hyperdx:{{ .Values.hyperdx.secrets.MONGODB_PASSWORD }}@{{ include \"clickstack.mongodb.svc\" . }}:27017/hyperdx?authSource=hyperdx","OPAMP_PORT":"4320","OPAMP_SERVER_URL":"http://{{ include \"clickstack.hyperdx.fullname\" . }}:{{ .Values.hyperdx.ports.opamp }}","OTEL_EXPORTER_OTLP_ENDPOINT":"http://{{ include \"clickstack.otel.fullname\" . }}:4318","OTEL_SERVICE_NAME":"hdx-oss-api","RUN_SCHEDULED_TASKS_EXTERNALLY":"false","USAGE_STATS_ENABLED":"true"}` | Shared non-sensitive environment variables (clickstack-config ConfigMap). Used by HyperDX and OTEL collector via envFrom. Values support tpl expressions. Override entries with plain strings to point at external services. Changes to the rendered ConfigMap roll the HyperDX Deployment; the otel-collector rolls on every helm upgrade. | +| hyperdx.config | object | `{"API_PORT":"8000","APP_PORT":"3000","CLICKHOUSE_ENDPOINT":"tcp://{{ include \"clickstack.clickhouse.svc\" . }}:{{ .Values.clickhouse.nativePort }}?dial_timeout=10s","CLICKHOUSE_PROMETHEUS_METRICS_ENDPOINT":"{{ include \"clickstack.clickhouse.svc\" . }}:{{ .Values.clickhouse.prometheus.port }}","CLICKHOUSE_SERVER_ENDPOINT":"{{ include \"clickstack.clickhouse.svc\" . }}:{{ .Values.clickhouse.nativePort }}","CLICKHOUSE_USER":"otelcollector","ENABLE_PROMQL":"{{ if .Values.hyperdx.promql.enabled }}true{{ else }}false{{ end }}","FRONTEND_URL":"http://localhost:3000","HDX_EXPORTER_ENABLED":"{{ if .Values.hyperdx.config.NEXT_PUBLIC_OTEL_EXPORTER_OTLP_ENDPOINT }}true{{ else }}false{{ end }}","HYPERDX_API_PORT":"8000","HYPERDX_APP_PORT":"3000","HYPERDX_LOG_LEVEL":"info","HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE":"default","HYPERDX_OTEL_EXPORTER_TABLES_TTL":"720h","MONGO_URI":"mongodb://hyperdx:{{ .Values.hyperdx.secrets.MONGODB_PASSWORD }}@{{ include \"clickstack.mongodb.svc\" . }}:27017/hyperdx?authSource=hyperdx","NEXT_PUBLIC_ENABLE_PROMQL":"{{ if .Values.hyperdx.promql.enabled }}true{{ else }}false{{ end }}","OPAMP_PORT":"4320","OPAMP_SERVER_URL":"http://{{ include \"clickstack.hyperdx.fullname\" . }}:{{ .Values.hyperdx.ports.opamp }}","OTEL_EXPORTER_OTLP_ENDPOINT":"http://{{ include \"clickstack.otel.fullname\" . }}:4318","OTEL_SERVICE_NAME":"hdx-oss-api","RUN_SCHEDULED_TASKS_EXTERNALLY":"false","USAGE_STATS_ENABLED":"true"}` | Shared non-sensitive environment variables (clickstack-config ConfigMap). Used by HyperDX and OTEL collector via envFrom. Values support tpl expressions. Override entries with plain strings to point at external services. Changes to the rendered ConfigMap roll the HyperDX Deployment; the otel-collector rolls on every helm upgrade. | | hyperdx.dashboards | object | `{"configMaps":{},"enabled":false,"namespaces":[],"rbac":{"create":true},"resources":{"limits":{"cpu":"50m","memory":"64Mi"},"requests":{"cpu":"10m","memory":"32Mi"}},"sidecarImage":"kiwigrid/k8s-sidecar:2.10.1","sidecarPullPolicy":"IfNotPresent"}` | Dashboard provisioning: upserts dashboard JSON into MongoDB (matched by name, never deletes). Provide dashboards inline via configMaps, or label ConfigMaps hyperdx.io/dashboard: "true" for a k8s-sidecar watcher to discover. | -| hyperdx.deployment | object | `{"annotations":{},"containerSecurityContext":{},"defaultConnections":"[\n {\n \"name\": \"Local ClickHouse\",\n \"host\": \"http://{{ include \"clickstack.clickhouse.svc\" . }}:8123\",\n \"port\": 8123,\n \"username\": \"app\",\n \"password\": \"{{ .Values.hyperdx.secrets.CLICKHOUSE_APP_PASSWORD }}\"\n }\n]\n","defaultSources":"[\n {\n \"from\": {\n \"databaseName\": \"default\",\n \"tableName\": \"otel_logs\"\n },\n \"kind\": \"log\",\n \"timestampValueExpression\": \"Timestamp\",\n \"name\": \"Logs\",\n \"displayedTimestampValueExpression\": \"Timestamp\",\n \"implicitColumnExpression\": \"Body\",\n \"serviceNameExpression\": \"ServiceName\",\n \"bodyExpression\": \"Body\",\n \"eventAttributesExpression\": \"LogAttributes\",\n \"resourceAttributesExpression\": \"ResourceAttributes\",\n \"defaultTableSelectExpression\": \"Timestamp,ServiceName,SeverityText,Body\",\n \"severityTextExpression\": \"SeverityText\",\n \"traceIdExpression\": \"TraceId\",\n \"spanIdExpression\": \"SpanId\",\n \"connection\": \"Local ClickHouse\",\n \"traceSourceId\": \"Traces\",\n \"metricSourceId\": \"Metrics\"\n },\n {\n \"from\": {\n \"databaseName\": \"default\",\n \"tableName\": \"otel_traces\"\n },\n \"kind\": \"trace\",\n \"timestampValueExpression\": \"Timestamp\",\n \"name\": \"Traces\",\n \"displayedTimestampValueExpression\": \"Timestamp\",\n \"implicitColumnExpression\": \"SpanName\",\n \"serviceNameExpression\": \"ServiceName\",\n \"eventAttributesExpression\": \"SpanAttributes\",\n \"resourceAttributesExpression\": \"ResourceAttributes\",\n \"defaultTableSelectExpression\": \"Timestamp,ServiceName,StatusCode,round(Duration/1e6),SpanName\",\n \"traceIdExpression\": \"TraceId\",\n \"spanIdExpression\": \"SpanId\",\n \"durationExpression\": \"Duration\",\n \"durationPrecision\": 9,\n \"parentSpanIdExpression\": \"ParentSpanId\",\n \"spanNameExpression\": \"SpanName\",\n \"spanKindExpression\": \"SpanKind\",\n \"statusCodeExpression\": \"StatusCode\",\n \"statusMessageExpression\": \"StatusMessage\",\n \"spanEventsValueExpression\": \"Events\",\n \"spanLinksValueExpression\": \"Links\",\n \"connection\": \"Local ClickHouse\",\n \"logSourceId\": \"Logs\",\n \"sessionSourceId\": \"Sessions\",\n \"metricSourceId\": \"Metrics\"\n },\n {\n \"from\": {\n \"databaseName\": \"default\",\n \"tableName\": \"\"\n },\n \"kind\": \"metric\",\n \"timestampValueExpression\": \"TimeUnix\",\n \"name\": \"Metrics\",\n \"resourceAttributesExpression\": \"ResourceAttributes\",\n \"metricTables\": {\n \"gauge\": \"otel_metrics_gauge\",\n \"histogram\": \"otel_metrics_histogram\",\n \"sum\": \"otel_metrics_sum\",\n \"summary\": \"otel_metrics_summary\",\n \"exponential histogram\": \"otel_metrics_exponential_histogram\"\n },\n \"connection\": \"Local ClickHouse\",\n \"logSourceId\": \"Logs\"\n },\n {\n \"from\": {\n \"databaseName\": \"default\",\n \"tableName\": \"hyperdx_sessions\"\n },\n \"kind\": \"session\",\n \"timestampValueExpression\": \"TimestampTime\",\n \"name\": \"Sessions\",\n \"resourceAttributesExpression\": \"ResourceAttributes\",\n \"connection\": \"Local ClickHouse\",\n \"traceSourceId\": \"Traces\"\n }\n]\n","deploymentAnnotations":{},"env":[],"existingConfigConnectionsKey":"connections.json","existingConfigSecret":"","existingConfigSourcesKey":"sources.json","image":{"pullPolicy":"IfNotPresent","repository":"docker.hyperdx.io/hyperdx/hyperdx","tag":null},"initContainers":[],"labels":{},"livenessProbe":{"enabled":true,"failureThreshold":3,"initialDelaySeconds":10,"path":"/health","periodSeconds":30,"timeoutSeconds":5},"nodeSelector":{},"podAnnotations":{},"podLabels":{},"podSecurityContext":{},"priorityClassName":"","readinessProbe":{"enabled":true,"failureThreshold":3,"initialDelaySeconds":1,"path":"/ready","periodSeconds":10,"timeoutSeconds":5},"replicas":1,"resources":{},"tolerations":[],"topologySpreadConstraints":[],"useExistingConfigSecret":false,"volumeMounts":[],"volumes":[],"waitForMongodb":{"image":"busybox@sha256:1fcf5df59121b92d61e066df1788e8df0cc35623f5d62d9679a41e163b6a0cdb","pullPolicy":"IfNotPresent"}}` | HyperDX Deployment spec (image, probes, scheduling, init containers, volumes). defaultConnections/defaultSources JSON: set to "" to disable; use useExistingConfigSecret for external secrets. | +| hyperdx.deployment | object | `{"annotations":{},"containerSecurityContext":{},"defaultConnections":"[\n {\n \"name\": \"Local ClickHouse\",\n \"host\": \"http://{{ include \"clickstack.clickhouse.svc\" . }}:8123\",\n \"port\": 8123,\n \"username\": \"app\",\n \"password\": \"{{ .Values.hyperdx.secrets.CLICKHOUSE_APP_PASSWORD }}\"\n }\n]\n","defaultSources":"[\n {\n \"from\": {\n \"databaseName\": \"default\",\n \"tableName\": \"otel_logs\"\n },\n \"kind\": \"log\",\n \"timestampValueExpression\": \"Timestamp\",\n \"name\": \"Logs\",\n \"displayedTimestampValueExpression\": \"Timestamp\",\n \"implicitColumnExpression\": \"Body\",\n \"serviceNameExpression\": \"ServiceName\",\n \"bodyExpression\": \"Body\",\n \"eventAttributesExpression\": \"LogAttributes\",\n \"resourceAttributesExpression\": \"ResourceAttributes\",\n \"defaultTableSelectExpression\": \"Timestamp,ServiceName,SeverityText,Body\",\n \"severityTextExpression\": \"SeverityText\",\n \"traceIdExpression\": \"TraceId\",\n \"spanIdExpression\": \"SpanId\",\n \"connection\": \"Local ClickHouse\",\n \"traceSourceId\": \"Traces\",\n \"metricSourceId\": \"Metrics\"\n },\n {\n \"from\": {\n \"databaseName\": \"default\",\n \"tableName\": \"otel_traces\"\n },\n \"kind\": \"trace\",\n \"timestampValueExpression\": \"Timestamp\",\n \"name\": \"Traces\",\n \"displayedTimestampValueExpression\": \"Timestamp\",\n \"implicitColumnExpression\": \"SpanName\",\n \"serviceNameExpression\": \"ServiceName\",\n \"eventAttributesExpression\": \"SpanAttributes\",\n \"resourceAttributesExpression\": \"ResourceAttributes\",\n \"defaultTableSelectExpression\": \"Timestamp,ServiceName,StatusCode,round(Duration/1e6),SpanName\",\n \"traceIdExpression\": \"TraceId\",\n \"spanIdExpression\": \"SpanId\",\n \"durationExpression\": \"Duration\",\n \"durationPrecision\": 9,\n \"parentSpanIdExpression\": \"ParentSpanId\",\n \"spanNameExpression\": \"SpanName\",\n \"spanKindExpression\": \"SpanKind\",\n \"statusCodeExpression\": \"StatusCode\",\n \"statusMessageExpression\": \"StatusMessage\",\n \"spanEventsValueExpression\": \"Events\",\n \"spanLinksValueExpression\": \"Links\",\n \"connection\": \"Local ClickHouse\",\n \"logSourceId\": \"Logs\",\n \"sessionSourceId\": \"Sessions\",\n \"metricSourceId\": \"Metrics\"\n },\n {\n \"from\": {\n \"databaseName\": \"default\",\n \"tableName\": \"\"\n },\n \"kind\": \"metric\",\n \"timestampValueExpression\": \"TimeUnix\",\n \"name\": \"Metrics\",\n \"resourceAttributesExpression\": \"ResourceAttributes\",\n \"metricTables\": {\n \"gauge\": \"otel_metrics_gauge\",\n \"histogram\": \"otel_metrics_histogram\",\n \"sum\": \"otel_metrics_sum\",\n \"summary\": \"otel_metrics_summary\",\n \"exponential histogram\": \"otel_metrics_exponential_histogram\"\n },\n \"connection\": \"Local ClickHouse\",\n \"logSourceId\": \"Logs\"\n },\n {\n \"from\": {\n \"databaseName\": \"default\",\n \"tableName\": \"hyperdx_sessions\"\n },\n \"kind\": \"session\",\n \"timestampValueExpression\": \"TimestampTime\",\n \"name\": \"Sessions\",\n \"resourceAttributesExpression\": \"ResourceAttributes\",\n \"connection\": \"Local ClickHouse\",\n \"traceSourceId\": \"Traces\"\n },\n {\n \"from\": {\n \"databaseName\": \"default\",\n \"tableName\": \"metrics_ts\"\n },\n \"kind\": \"promql\",\n \"timestampValueExpression\": \"timestamp\",\n \"name\": \"PromQL\",\n \"connection\": \"Local ClickHouse\"\n }\n]\n","deploymentAnnotations":{},"env":[],"existingConfigConnectionsKey":"connections.json","existingConfigSecret":"","existingConfigSourcesKey":"sources.json","image":{"pullPolicy":"IfNotPresent","repository":"docker.hyperdx.io/hyperdx/hyperdx","tag":null},"initContainers":[],"labels":{},"livenessProbe":{"enabled":true,"failureThreshold":3,"initialDelaySeconds":10,"path":"/health","periodSeconds":30,"timeoutSeconds":5},"nodeSelector":{},"podAnnotations":{},"podLabels":{},"podSecurityContext":{},"priorityClassName":"","readinessProbe":{"enabled":true,"failureThreshold":3,"initialDelaySeconds":1,"path":"/ready","periodSeconds":10,"timeoutSeconds":5},"replicas":1,"resources":{},"tolerations":[],"topologySpreadConstraints":[],"useExistingConfigSecret":false,"volumeMounts":[],"volumes":[],"waitForMongodb":{"image":"busybox@sha256:1fcf5df59121b92d61e066df1788e8df0cc35623f5d62d9679a41e163b6a0cdb","pullPolicy":"IfNotPresent"}}` | HyperDX Deployment spec (image, probes, scheduling, init containers, volumes). defaultConnections/defaultSources JSON: set to "" to disable; use useExistingConfigSecret for external secrets. | | hyperdx.deployment.env | list | `[]` | Extra environment variables for the HyperDX container, rendered verbatim (supports `valueFrom`, e.g. `secretKeyRef`). | | hyperdx.deployment.existingConfigSecret | string | `""` | Secret containing connections and sources JSON when useExistingConfigSecret is true. | | hyperdx.deployment.image.repository | string | `"docker.hyperdx.io/hyperdx/hyperdx"` | HyperDX container image repository. | @@ -71,6 +71,7 @@ Documented values below. Undocumented keys (operator CRD passthrough fields, sub | hyperdx.networkPolicy | object | `{"enabled":false,"spec":{}}` | NetworkPolicy for HyperDX. spec is passed through verbatim. | | hyperdx.podDisruptionBudget | object | `{"enabled":false}` | PodDisruptionBudget for the HyperDX Deployment. Defaults to maxUnavailable: 1, which never blocks a node drain; set minAvailable or maxUnavailable to override. | | hyperdx.ports | object | `{"api":8000,"app":3000,"opamp":4320}` | Ports shared across Deployment, Service, ConfigMap, and Ingress. | +| hyperdx.promql | object | `{"enabled":true}` | PromQL support. Turns on the HyperDX PromQL UI and API, adds the PromQL default source, and configures ClickHouse with Prometheus remote write/read handlers, the `prometheus_api_v1` HTTP handler and `allow_experimental_time_series_table` (an experimental ClickHouse setting). The ClickHouse part needs ClickHouse 26.6 or newer and is skipped when `clickhouse.cluster.spec.containerTemplate.image.tag` is an older version. | | hyperdx.secrets | object | `{"CLICKHOUSE_APP_PASSWORD":"hyperdx","CLICKHOUSE_PASSWORD":"otelcollectorpass","HYPERDX_API_KEY":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","MONGODB_PASSWORD":"hyperdx"}` | Shared sensitive environment variables (clickstack-secret). Set to null to skip Secret creation (requires mongodb, clickhouse, and otel-collector disabled). Changes to this Secret roll the HyperDX Deployment; the otel-collector rolls on every helm upgrade. External Secrets need a manual rollout. | | hyperdx.service | object | `{"annotations":{},"apiPort":{"enabled":false},"type":"ClusterIP"}` | HyperDX Service (ClusterIP by default). | | hyperdx.service.apiPort | object | `{"enabled":false}` | Expose the API port (8000) on the Service for API-only or direct API access. | diff --git a/charts/clickstack/templates/_helpers.tpl b/charts/clickstack/templates/_helpers.tpl index 541d2ccd..2cee14f1 100644 --- a/charts/clickstack/templates/_helpers.tpl +++ b/charts/clickstack/templates/_helpers.tpl @@ -312,6 +312,68 @@ ClickHouse headless service name. The operator creates a headless service named {{- printf "%s-clickhouse-headless" (include "clickstack.clickhouse.fullname" .) -}} {{- end }} +{{/* +Whether the ClickHouse PromQL config is injected into the ClickHouseCluster CR. +Needs hyperdx.promql.enabled and a ClickHouse server image of 26.6 or newer, the +first release with the prometheus_api_v1 handler. The tag is read from +clickhouse.cluster.spec.containerTemplate.image.tag; a four-part ClickHouse version +and an image-variant suffix such as "-alpine" are reduced to semver first. A tag +that carries no version (e.g. "latest") is assumed new enough. Renders "true" or "". +*/}} +{{- define "clickstack.clickhouse.promqlEnabled" -}} +{{- if .Values.hyperdx.promql.enabled -}} +{{- $tag := toString (dig "containerTemplate" "image" "tag" "" .Values.clickhouse.cluster.spec) -}} +{{- $version := regexFind "^[0-9]+\\.[0-9]+(\\.[0-9]+)?" $tag -}} +{{- if or (not $version) (semverCompare ">= 26.6" $version) }}true{{- end -}} +{{- end -}} +{{- end }} + +{{/* +ClickHouse settings that back PromQL, merged under the user's +clickhouse.cluster.spec.settings by clickhouse/cluster.yaml. Mirrors the upstream +ClickStack config.xml/users.xml: Prometheus remote write/read into the TimeSeries +table the otel-collector creates, the Prometheus HTTP API on the main HTTP port, and +the experimental setting the TimeSeries engine needs. The metrics handler is +repeated because ClickHouse ignores its legacy prometheus.endpoint settings once a +handlers block exists. +*/}} +{{- define "clickstack.clickhouse.promqlSettings" -}} +{{- $database := .Values.hyperdx.config.HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE | default "default" }} +extraConfig: + prometheus: + handlers: + metrics_handler: + url: /metrics + handler: + type: expose_metrics + metrics: true + asynchronous_metrics: true + events: true + errors: true + remote_write_handler: + url: /write + handler: + type: remote_write + database: {{ $database | quote }} + table: metrics_ts + remote_read_handler: + url: /read + handler: + type: remote_read + database: {{ $database | quote }} + table: metrics_ts + http_handlers: + rule: + url_prefix: /prometheus/api/v1 + handler: + type: prometheus_api_v1 + defaults: "" +extraUsersConfig: + profiles: + default: + allow_experimental_time_series_table: 1 +{{- end }} + {{/* Render the chart-managed HyperDX ConfigMap from one canonical template so the manifest and the Deployment rollout checksum cannot drift. diff --git a/charts/clickstack/templates/clickhouse/cluster.yaml b/charts/clickstack/templates/clickhouse/cluster.yaml index 185da73e..5cc6db72 100644 --- a/charts/clickstack/templates/clickhouse/cluster.yaml +++ b/charts/clickstack/templates/clickhouse/cluster.yaml @@ -1,4 +1,13 @@ {{- if .Values.clickhouse.enabled }} +{{- $spec := deepCopy .Values.clickhouse.cluster.spec }} +{{- if include "clickstack.clickhouse.promqlEnabled" . }} +{{- /* Chart defaults go first so anything the user sets under settings wins. */}} +{{- $promql := include "clickstack.clickhouse.promqlSettings" . | fromYaml }} +{{- $settings := default (dict) $spec.settings }} +{{- $_ := set $settings "extraConfig" (mergeOverwrite (dict) $promql.extraConfig (default (dict) $settings.extraConfig)) }} +{{- $_ := set $settings "extraUsersConfig" (mergeOverwrite (dict) $promql.extraUsersConfig (default (dict) $settings.extraUsersConfig)) }} +{{- $_ := set $spec "settings" $settings }} +{{- end }} apiVersion: clickhouse.com/v1alpha1 kind: ClickHouseCluster metadata: @@ -6,5 +15,5 @@ metadata: labels: {{- include "clickstack.labels" . | nindent 4 }} spec: - {{- tpl (toYaml .Values.clickhouse.cluster.spec) . | nindent 2 }} + {{- tpl (toYaml $spec) . | nindent 2 }} {{- end }} diff --git a/charts/clickstack/tests/app-configmap_test.yaml b/charts/clickstack/tests/app-configmap_test.yaml index 97ccbadb..d5dd6347 100644 --- a/charts/clickstack/tests/app-configmap_test.yaml +++ b/charts/clickstack/tests/app-configmap_test.yaml @@ -57,6 +57,28 @@ tests: path: data.HDX_EXPORTER_ENABLED value: "true" + - it: should enable the PromQL feature flags by default + asserts: + - equal: + path: data.ENABLE_PROMQL + value: "true" + - equal: + path: data.NEXT_PUBLIC_ENABLE_PROMQL + value: "true" + + - it: should disable the PromQL feature flags when hyperdx.promql.enabled is false + set: + hyperdx: + promql: + enabled: false + asserts: + - equal: + path: data.ENABLE_PROMQL + value: "false" + - equal: + path: data.NEXT_PUBLIC_ENABLE_PROMQL + value: "false" + - it: should fail when the removed 1.x usageStatsEnabled key is set set: hyperdx: diff --git a/charts/clickstack/tests/clickhouse-promql_test.yaml b/charts/clickstack/tests/clickhouse-promql_test.yaml new file mode 100644 index 00000000..70d32d75 --- /dev/null +++ b/charts/clickstack/tests/clickhouse-promql_test.yaml @@ -0,0 +1,231 @@ +suite: Test ClickHouse PromQL Settings +templates: + - clickhouse/cluster.yaml + +tests: + - it: should inject Prometheus remote write and read handlers by default + asserts: + - equal: + path: spec.settings.extraConfig.prometheus.handlers.remote_write_handler.url + value: /write + - equal: + path: spec.settings.extraConfig.prometheus.handlers.remote_write_handler.handler + value: + type: remote_write + database: default + table: metrics_ts + - equal: + path: spec.settings.extraConfig.prometheus.handlers.remote_read_handler.url + value: /read + - equal: + path: spec.settings.extraConfig.prometheus.handlers.remote_read_handler.handler.type + value: remote_read + + - it: should keep the metrics handler once a handlers block exists + asserts: + - equal: + path: spec.settings.extraConfig.prometheus.handlers.metrics_handler.url + value: /metrics + - equal: + path: spec.settings.extraConfig.prometheus.handlers.metrics_handler.handler.type + value: expose_metrics + + - it: should expose the Prometheus HTTP API on the main HTTP port + asserts: + - equal: + path: spec.settings.extraConfig.http_handlers.rule.url_prefix + value: /prometheus/api/v1 + - equal: + path: spec.settings.extraConfig.http_handlers.rule.handler.type + value: prometheus_api_v1 + - equal: + path: spec.settings.extraConfig.http_handlers.defaults + value: "" + + - it: should enable the TimeSeries table engine on the default profile + asserts: + - equal: + path: spec.settings.extraUsersConfig.profiles.default.allow_experimental_time_series_table + value: 1 + + - it: should keep the existing extraConfig and users next to the injected settings + asserts: + - equal: + path: spec.settings.extraConfig.max_connections + value: 4096 + - equal: + path: spec.settings.extraConfig.query_log.ttl + value: event_date + INTERVAL 30 DAY DELETE + - isNotNull: + path: spec.settings.extraUsersConfig.users.app + - isNotNull: + path: spec.settings.extraUsersConfig.users.otelcollector + + - it: should point remote write at the configured collector database + set: + hyperdx: + config: + HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE: otel + asserts: + - equal: + path: spec.settings.extraConfig.prometheus.handlers.remote_write_handler.handler.database + value: otel + - equal: + path: spec.settings.extraConfig.prometheus.handlers.remote_read_handler.handler.database + value: otel + + - it: should fall back to the default database when the collector database is empty + set: + hyperdx: + config: + HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE: "" + asserts: + - equal: + path: spec.settings.extraConfig.prometheus.handlers.remote_write_handler.handler.database + value: default + + - it: should let user settings win over the injected ones + set: + clickhouse: + cluster: + spec: + settings: + extraConfig: + prometheus: + handlers: + remote_write_handler: + handler: + table: custom_ts + extraUsersConfig: + profiles: + default: + allow_experimental_time_series_table: 0 + max_memory_usage: 1000000 + asserts: + - equal: + path: spec.settings.extraConfig.prometheus.handlers.remote_write_handler.handler.table + value: custom_ts + - equal: + path: spec.settings.extraConfig.prometheus.handlers.remote_write_handler.handler.type + value: remote_write + - equal: + path: spec.settings.extraUsersConfig.profiles.default.allow_experimental_time_series_table + value: 0 + - equal: + path: spec.settings.extraUsersConfig.profiles.default.max_memory_usage + value: 1000000 + + - it: should inject settings when the spec has no settings block + set: + clickhouse: + cluster: + spec: + settings: null + asserts: + - isNull: + path: spec.settings.extraUsersConfig.users + - equal: + path: spec.settings.extraConfig.http_handlers.rule.handler.type + value: prometheus_api_v1 + - equal: + path: spec.settings.extraUsersConfig.profiles.default.allow_experimental_time_series_table + value: 1 + + - it: should inject settings when settings has no extraConfig or extraUsersConfig + set: + clickhouse: + cluster: + spec: + settings: + extraConfig: null + extraUsersConfig: null + asserts: + - equal: + path: spec.settings.logger.level + value: information + - equal: + path: spec.settings.extraConfig.http_handlers.rule.handler.type + value: prometheus_api_v1 + - equal: + path: spec.settings.extraUsersConfig.profiles.default.allow_experimental_time_series_table + value: 1 + + - it: should not inject settings when PromQL is disabled + set: + hyperdx: + promql: + enabled: false + asserts: + - isNull: + path: spec.settings.extraConfig.prometheus + - isNull: + path: spec.settings.extraConfig.http_handlers + - isNull: + path: spec.settings.extraUsersConfig.profiles + - equal: + path: spec.settings.extraConfig.max_connections + value: 4096 + + - it: should not inject settings on a ClickHouse image older than 26.6 + set: + clickhouse: + cluster: + spec: + containerTemplate: + image: + tag: "25.7-alpine" + asserts: + - isNull: + path: spec.settings.extraConfig.prometheus + - isNull: + path: spec.settings.extraConfig.http_handlers + - isNull: + path: spec.settings.extraUsersConfig.profiles + + - it: should not inject settings on a four-part tag just below 26.6 + set: + clickhouse: + cluster: + spec: + containerTemplate: + image: + tag: "26.5.9.2" + asserts: + - isNull: + path: spec.settings.extraConfig.prometheus + + - it: should inject settings on a two-part tag at 26.6 + set: + clickhouse: + cluster: + spec: + containerTemplate: + image: + tag: "26.6" + asserts: + - isNotNull: + path: spec.settings.extraConfig.prometheus + + - it: should inject settings on a tag without a version number + set: + clickhouse: + cluster: + spec: + containerTemplate: + image: + tag: latest + asserts: + - isNotNull: + path: spec.settings.extraConfig.prometheus + + - it: should inject settings when no image tag is set + set: + clickhouse: + cluster: + spec: + containerTemplate: + image: + tag: null + asserts: + - isNotNull: + path: spec.settings.extraConfig.prometheus diff --git a/charts/clickstack/tests/default-env-vars_test.yaml b/charts/clickstack/tests/default-env-vars_test.yaml index 5a617a45..a1bc4ec6 100644 --- a/charts/clickstack/tests/default-env-vars_test.yaml +++ b/charts/clickstack/tests/default-env-vars_test.yaml @@ -127,6 +127,17 @@ tests: path: spec.template.spec.containers[0].env[?(@.name == "DEFAULT_SOURCES")].value pattern: '"exponential histogram": "otel_metrics_exponential_histogram"' + # HyperDX only creates promql-kind default sources when ENABLE_PROMQL is true, + # so the entry is safe to ship regardless of hyperdx.promql.enabled. + - it: should include a PromQL source backed by the TimeSeries table + asserts: + - matchRegex: + path: spec.template.spec.containers[0].env[?(@.name == "DEFAULT_SOURCES")].value + pattern: '"tableName": "metrics_ts"[^}]*}[^}]*"kind": "promql"' + - matchRegex: + path: spec.template.spec.containers[0].env[?(@.name == "DEFAULT_SOURCES")].value + pattern: '"kind": "promql",[^}]*"timestampValueExpression": "timestamp"' + - it: should not include DEFAULT_SOURCES when set to empty string set: hyperdx: diff --git a/charts/clickstack/tests/hyperdx-rollout-checksums_test.yaml b/charts/clickstack/tests/hyperdx-rollout-checksums_test.yaml index c6597d30..d7bdd52a 100644 --- a/charts/clickstack/tests/hyperdx-rollout-checksums_test.yaml +++ b/charts/clickstack/tests/hyperdx-rollout-checksums_test.yaml @@ -20,7 +20,7 @@ tests: asserts: - equal: path: spec.template.metadata.annotations["checksum/clickstack-config"] - value: feeb4f67ae2d01415d2fdb317f6bf6da573c0df8b80526ea61c8055c2d7fe05b + value: ab3037603573ead5d1c9f9878c4437fa49a4d615b4229dc9633b3c26c150a500 - equal: path: spec.template.metadata.annotations["checksum/clickstack-secret"] value: 93200c574b88c22d434ac7d53d4f1105effa8d491a41f9102e131b7f5b919218 @@ -34,7 +34,7 @@ tests: asserts: - equal: path: spec.template.metadata.annotations["checksum/clickstack-config"] - value: ea0e67552953545def4dcf843ecbb2718d14295179f7da3f24087b3fba534be1 + value: bd473aedda4bbc33639c2e46f3948f8ad391c86204020d7e28dc42d511286afb - equal: path: spec.template.metadata.annotations["checksum/clickstack-secret"] value: 93200c574b88c22d434ac7d53d4f1105effa8d491a41f9102e131b7f5b919218 @@ -48,7 +48,7 @@ tests: asserts: - equal: path: spec.template.metadata.annotations["checksum/clickstack-config"] - value: feeb4f67ae2d01415d2fdb317f6bf6da573c0df8b80526ea61c8055c2d7fe05b + value: ab3037603573ead5d1c9f9878c4437fa49a4d615b4229dc9633b3c26c150a500 - equal: path: spec.template.metadata.annotations["checksum/clickstack-secret"] value: 1adcdfb26c7114f9990031b28eb1ae1d7097dcf27c16487d16c8666da062a507 @@ -110,7 +110,7 @@ tests: value: preserved - equal: path: spec.template.metadata.annotations["checksum/clickstack-config"] - value: feeb4f67ae2d01415d2fdb317f6bf6da573c0df8b80526ea61c8055c2d7fe05b + value: ab3037603573ead5d1c9f9878c4437fa49a4d615b4229dc9633b3c26c150a500 - equal: path: spec.template.metadata.annotations["checksum/clickstack-secret"] value: 93200c574b88c22d434ac7d53d4f1105effa8d491a41f9102e131b7f5b919218 @@ -130,7 +130,7 @@ tests: asserts: - equal: path: spec.template.metadata.annotations["checksum/clickstack-config"] - value: feeb4f67ae2d01415d2fdb317f6bf6da573c0df8b80526ea61c8055c2d7fe05b + value: ab3037603573ead5d1c9f9878c4437fa49a4d615b4229dc9633b3c26c150a500 - equal: path: spec.template.metadata.annotations["checksum/clickstack-secret"] value: 93200c574b88c22d434ac7d53d4f1105effa8d491a41f9102e131b7f5b919218 diff --git a/charts/clickstack/values.yaml b/charts/clickstack/values.yaml index 8a2da047..8837b163 100644 --- a/charts/clickstack/values.yaml +++ b/charts/clickstack/values.yaml @@ -42,6 +42,14 @@ hyperdx: app: 3000 opamp: 4320 + # -- PromQL support. Turns on the HyperDX PromQL UI and API, adds the PromQL default source, + # and configures ClickHouse with Prometheus remote write/read handlers, the `prometheus_api_v1` + # HTTP handler and `allow_experimental_time_series_table` (an experimental ClickHouse setting). + # The ClickHouse part needs ClickHouse 26.6 or newer and is skipped when + # `clickhouse.cluster.spec.containerTemplate.image.tag` is an older version. + promql: + enabled: true + # -- Dashboard provisioning: upserts dashboard JSON into MongoDB (matched by name, never deletes). # Provide dashboards inline via configMaps, or label ConfigMaps hyperdx.io/dashboard: "true" # for a k8s-sidecar watcher to discover. @@ -129,6 +137,9 @@ hyperdx: CLICKHOUSE_SERVER_ENDPOINT: '{{ include "clickstack.clickhouse.svc" . }}:{{ .Values.clickhouse.nativePort }}' CLICKHOUSE_PROMETHEUS_METRICS_ENDPOINT: '{{ include "clickstack.clickhouse.svc" . }}:{{ .Values.clickhouse.prometheus.port }}' OPAMP_SERVER_URL: 'http://{{ include "clickstack.hyperdx.fullname" . }}:{{ .Values.hyperdx.ports.opamp }}' + # PromQL feature flags, driven by hyperdx.promql.enabled. + ENABLE_PROMQL: '{{ if .Values.hyperdx.promql.enabled }}true{{ else }}false{{ end }}' + NEXT_PUBLIC_ENABLE_PROMQL: '{{ if .Values.hyperdx.promql.enabled }}true{{ else }}false{{ end }}' # -- Shared sensitive environment variables (clickstack-secret). # Set to null to skip Secret creation (requires mongodb, clickhouse, and otel-collector disabled). @@ -297,6 +308,16 @@ hyperdx: "resourceAttributesExpression": "ResourceAttributes", "connection": "Local ClickHouse", "traceSourceId": "Traces" + }, + { + "from": { + "databaseName": "default", + "tableName": "metrics_ts" + }, + "kind": "promql", + "timestampValueExpression": "timestamp", + "name": "PromQL", + "connection": "Local ClickHouse" } ] diff --git a/docs/UPGRADE.md b/docs/UPGRADE.md index 3432aed6..9345d94c 100644 --- a/docs/UPGRADE.md +++ b/docs/UPGRADE.md @@ -2,6 +2,10 @@ Each section lists what changes when you upgrade to that chart version and anything you have to do first, newest first. A version that isn't listed needs nothing beyond `helm upgrade`. The full list of changes is in [CHANGELOG.md](../CHANGELOG.md). +## Unreleased + +- PromQL is on by default via `hyperdx.promql.enabled`. The chart adds Prometheus remote write/read handlers, the `prometheus_api_v1` HTTP handler and the experimental `allow_experimental_time_series_table` setting to the ClickHouse config, so the ClickHouse pods restart once. If you pin `clickhouse.cluster.spec.containerTemplate.image.tag` to a version older than 26.6, the ClickHouse settings are skipped but the HyperDX PromQL UI still shows; set `hyperdx.promql.enabled: false` there. New installs also get a `PromQL` default source; existing sources are not modified. + ## 3.6.0 - `helm upgrade` fails while your values still set the 1.x key `hyperdx.usageStatsEnabled`, which the chart has ignored since 2.0. Remove it, and set `hyperdx.config.USAGE_STATS_ENABLED: "false"` to opt out of usage stats. From 3e4a394f179425384c02d15d3ff8ca75a2b08963 Mon Sep 17 00:00:00 2001 From: Karl Power Date: Wed, 18 Nov 2026 10:50:06 +0100 Subject: [PATCH 2/2] fix: grant app user CREATE TEMPORARY TABLE for prometheus_api_v1 (HDX-5759) --- .changeset/promql-support.md | 2 +- charts/clickstack/README.md | 4 ++-- charts/clickstack/tests/clickhouse-users_test.yaml | 8 ++++++++ charts/clickstack/values.yaml | 4 +++- 4 files changed, 14 insertions(+), 4 deletions(-) diff --git a/.changeset/promql-support.md b/.changeset/promql-support.md index 50f2b675..8916270c 100644 --- a/.changeset/promql-support.md +++ b/.changeset/promql-support.md @@ -2,4 +2,4 @@ "helm-charts": minor --- -feat: add PromQL support behind `hyperdx.promql.enabled` (on by default). Sets `ENABLE_PROMQL` and `NEXT_PUBLIC_ENABLE_PROMQL`, adds a PromQL default source on the `metrics_ts` TimeSeries table, and configures ClickHouse with Prometheus remote write/read handlers, the `prometheus_api_v1` HTTP handler and `allow_experimental_time_series_table` on the default profile. The ClickHouse settings need ClickHouse 26.6 or newer and are skipped automatically on older image tags. +feat: add PromQL support behind `hyperdx.promql.enabled` (on by default). Sets `ENABLE_PROMQL` and `NEXT_PUBLIC_ENABLE_PROMQL`, adds a PromQL default source on the `metrics_ts` TimeSeries table, and configures ClickHouse with Prometheus remote write/read handlers, the `prometheus_api_v1` HTTP handler and `allow_experimental_time_series_table` on the default profile, and grants the `app` user `CREATE TEMPORARY TABLE` so the handler can evaluate queries. The ClickHouse settings need ClickHouse 26.6 or newer and are skipped automatically on older image tags. diff --git a/charts/clickstack/README.md b/charts/clickstack/README.md index 30e0091e..ef95ede8 100644 --- a/charts/clickstack/README.md +++ b/charts/clickstack/README.md @@ -45,8 +45,8 @@ Documented values below. Undocumented keys (operator CRD passthrough fields, sub | Key | Type | Default | Description | |-----|------|---------|-------------| | additionalManifests | list | `[]` | Additional Kubernetes manifests deployed alongside the chart (supports tpl). See docs/ADDITIONAL-MANIFESTS.md for examples. | -| clickhouse | object | `{"cluster":{"spec":{"containerTemplate":{"image":{"repository":"clickhouse/clickhouse-server","tag":"26.8.37.168-alpine"},"resources":{"limits":{"memory":"2Gi"},"requests":{"cpu":"500m","memory":"2Gi"}}},"dataVolumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"10Gi"}}},"keeperClusterRef":{"name":"{{ include \"clickstack.clickhouse.keeper\" . }}"},"replicas":1,"settings":{"extraConfig":{"asynchronous_metric_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"keep_alive_timeout":64,"max_concurrent_queries":100,"max_connections":4096,"metric_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"part_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"query_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"text_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"}},"extraUsersConfig":{"users":{"app":{"grants":[{"query":"GRANT SHOW ON *.*, SELECT ON system.*, SELECT ON default.*"}],"password":"{{ .Values.hyperdx.secrets.CLICKHOUSE_APP_PASSWORD }}","profile":"default"},"otelcollector":{"grants":[{"query":"GRANT SELECT,INSERT,CREATE,SHOW ON default.*"}],"password":"{{ .Values.hyperdx.secrets.CLICKHOUSE_PASSWORD }}","profile":"default"}}},"logger":{"count":10,"level":"information","size":"100M"}},"shards":1}},"enabled":true,"keeper":{"spec":{"containerTemplate":{"image":{"repository":"clickhouse/clickhouse-keeper","tag":"26.8.37.168-alpine"}},"dataVolumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"5Gi"}}},"replicas":1}},"nativePort":9000,"port":8123,"prometheus":{"enabled":true,"port":9363}}` | In-cluster ClickHouse via ClickHouseCluster CR. Set enabled: false for external ClickHouse. | -| clickhouse.cluster | object | `{"spec":{"containerTemplate":{"image":{"repository":"clickhouse/clickhouse-server","tag":"26.8.37.168-alpine"},"resources":{"limits":{"memory":"2Gi"},"requests":{"cpu":"500m","memory":"2Gi"}}},"dataVolumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"10Gi"}}},"keeperClusterRef":{"name":"{{ include \"clickstack.clickhouse.keeper\" . }}"},"replicas":1,"settings":{"extraConfig":{"asynchronous_metric_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"keep_alive_timeout":64,"max_concurrent_queries":100,"max_connections":4096,"metric_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"part_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"query_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"text_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"}},"extraUsersConfig":{"users":{"app":{"grants":[{"query":"GRANT SHOW ON *.*, SELECT ON system.*, SELECT ON default.*"}],"password":"{{ .Values.hyperdx.secrets.CLICKHOUSE_APP_PASSWORD }}","profile":"default"},"otelcollector":{"grants":[{"query":"GRANT SELECT,INSERT,CREATE,SHOW ON default.*"}],"password":"{{ .Values.hyperdx.secrets.CLICKHOUSE_PASSWORD }}","profile":"default"}}},"logger":{"count":10,"level":"information","size":"100M"}},"shards":1}}` | ClickHouseCluster CRD spec (rendered verbatim). See ClickHouse Operator docs. | +| clickhouse | object | `{"cluster":{"spec":{"containerTemplate":{"image":{"repository":"clickhouse/clickhouse-server","tag":"26.8.37.168-alpine"},"resources":{"limits":{"memory":"2Gi"},"requests":{"cpu":"500m","memory":"2Gi"}}},"dataVolumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"10Gi"}}},"keeperClusterRef":{"name":"{{ include \"clickstack.clickhouse.keeper\" . }}"},"replicas":1,"settings":{"extraConfig":{"asynchronous_metric_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"keep_alive_timeout":64,"max_concurrent_queries":100,"max_connections":4096,"metric_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"part_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"query_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"text_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"}},"extraUsersConfig":{"users":{"app":{"grants":[{"query":"GRANT SHOW ON *.*, SELECT ON system.*, SELECT ON default.*, CREATE TEMPORARY TABLE ON *.*"}],"password":"{{ .Values.hyperdx.secrets.CLICKHOUSE_APP_PASSWORD }}","profile":"default"},"otelcollector":{"grants":[{"query":"GRANT SELECT,INSERT,CREATE,SHOW ON default.*"}],"password":"{{ .Values.hyperdx.secrets.CLICKHOUSE_PASSWORD }}","profile":"default"}}},"logger":{"count":10,"level":"information","size":"100M"}},"shards":1}},"enabled":true,"keeper":{"spec":{"containerTemplate":{"image":{"repository":"clickhouse/clickhouse-keeper","tag":"26.8.37.168-alpine"}},"dataVolumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"5Gi"}}},"replicas":1}},"nativePort":9000,"port":8123,"prometheus":{"enabled":true,"port":9363}}` | In-cluster ClickHouse via ClickHouseCluster CR. Set enabled: false for external ClickHouse. | +| clickhouse.cluster | object | `{"spec":{"containerTemplate":{"image":{"repository":"clickhouse/clickhouse-server","tag":"26.8.37.168-alpine"},"resources":{"limits":{"memory":"2Gi"},"requests":{"cpu":"500m","memory":"2Gi"}}},"dataVolumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"10Gi"}}},"keeperClusterRef":{"name":"{{ include \"clickstack.clickhouse.keeper\" . }}"},"replicas":1,"settings":{"extraConfig":{"asynchronous_metric_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"keep_alive_timeout":64,"max_concurrent_queries":100,"max_connections":4096,"metric_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"part_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"query_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"},"text_log":{"ttl":"event_date + INTERVAL 30 DAY DELETE"}},"extraUsersConfig":{"users":{"app":{"grants":[{"query":"GRANT SHOW ON *.*, SELECT ON system.*, SELECT ON default.*, CREATE TEMPORARY TABLE ON *.*"}],"password":"{{ .Values.hyperdx.secrets.CLICKHOUSE_APP_PASSWORD }}","profile":"default"},"otelcollector":{"grants":[{"query":"GRANT SELECT,INSERT,CREATE,SHOW ON default.*"}],"password":"{{ .Values.hyperdx.secrets.CLICKHOUSE_PASSWORD }}","profile":"default"}}},"logger":{"count":10,"level":"information","size":"100M"}},"shards":1}}` | ClickHouseCluster CRD spec (rendered verbatim). See ClickHouse Operator docs. | | clickhouse.keeper | object | `{"spec":{"containerTemplate":{"image":{"repository":"clickhouse/clickhouse-keeper","tag":"26.8.37.168-alpine"}},"dataVolumeClaimSpec":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"5Gi"}}},"replicas":1}}` | KeeperCluster CRD spec (rendered verbatim). See ClickHouse Operator docs. | | clickhouse.nativePort | int | `9000` | Native TCP port used in connection strings. | | clickhouse.port | int | `8123` | HTTP interface port for in-cluster connections. | diff --git a/charts/clickstack/tests/clickhouse-users_test.yaml b/charts/clickstack/tests/clickhouse-users_test.yaml index 3955fb40..e81d2604 100644 --- a/charts/clickstack/tests/clickhouse-users_test.yaml +++ b/charts/clickstack/tests/clickhouse-users_test.yaml @@ -11,6 +11,14 @@ tests: path: spec.settings.extraUsersConfig.users.app.profile value: default + # The prometheus_api_v1 handler reads through the timeSeriesSelector() table function, + # and ClickHouse requires CREATE TEMPORARY TABLE to use any table function. + - it: should grant the app user CREATE TEMPORARY TABLE for PromQL queries + asserts: + - matchRegex: + path: spec.settings.extraUsersConfig.users.app.grants[0].query + pattern: CREATE TEMPORARY TABLE ON \*\.\* + - it: should include otelcollector user in extraUsersConfig asserts: - isNotNull: diff --git a/charts/clickstack/values.yaml b/charts/clickstack/values.yaml index 8837b163..c66c25fa 100644 --- a/charts/clickstack/values.yaml +++ b/charts/clickstack/values.yaml @@ -453,7 +453,9 @@ clickhouse: password: '{{ .Values.hyperdx.secrets.CLICKHOUSE_APP_PASSWORD }}' profile: default grants: - - query: "GRANT SHOW ON *.*, SELECT ON system.*, SELECT ON default.*" + # The prometheus_api_v1 handler reads via the timeSeriesSelector() table function, + # and ClickHouse gates every table function behind CREATE TEMPORARY TABLE. + - query: "GRANT SHOW ON *.*, SELECT ON system.*, SELECT ON default.*, CREATE TEMPORARY TABLE ON *.*" otelcollector: password: '{{ .Values.hyperdx.secrets.CLICKHOUSE_PASSWORD }}' profile: default