Basic support for the PromQL dialect by vitlibar · Pull Request #75036 · ClickHouse/ClickHouse

vitlibar · 2025-01-26T16:38:34Z

Changelog category (leave one):

New Feature

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Basic support for the PromQL dialect is added. To use it, set dialect='promql' in clickhouse-client, point it to the TimeSeries table using the setting promql_table_name='X' and execute queries like rate(ClickHouseProfileEvents_ReadCompressedBytes[1m])[5m:1m].
In addition you can wrap the PromQL query with SQL: SELECT * FROM prometheusQuery('up', ...);.
So far only functions rate, delta and increase are supported. No unary/binary operators. No HTTP API.

robot-ch-test-poll4 · 2025-01-26T20:49:21Z

This is an automated comment for commit d0715d6 with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Check name	Description	Status
Builds	There's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS	❌ failure
Integration tests	The integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests	❌ failure

Successful checks

Check name	Description	Status
AST fuzzer	Runs randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help	✅ success
BuzzHouse (asan)	There's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS	✅ success
BuzzHouse (debug)	There's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS	✅ success
BuzzHouse (msan)	There's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS	✅ success
BuzzHouse (tsan)	There's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS	✅ success
BuzzHouse (ubsan)	There's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS	✅ success
ClickBench	Runs ClickBench with instant-attach table	✅ success
Compatibility check	Checks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help	✅ success
Docker keeper image	The check to build and optionally push the mentioned image to docker hub	✅ success
Docker server image	The check to build and optionally push the mentioned image to docker hub	✅ success
Docs check	Builds and tests the documentation	✅ success
Fast test	Normally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here	✅ success
Flaky tests	Checks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integration tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc	✅ success
Install packages	Checks that the built packages are installable in a clear environment	✅ success
Performance Comparison	Measure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests	✅ success
Stateless tests	Runs stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc	✅ success
Stress test	Runs stateless functional tests concurrently from several clients to detect concurrency-related errors	✅ success
Style check	Runs a set of checks to keep the code style clean. If some of tests failed, see the related log from the report	✅ success
Unit tests	Runs the unit tests for different release types	✅ success
Upgrade check	Runs stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts	✅ success

UnamedRus · 2025-01-27T12:05:42Z

This does feel somewhat unusual, as ClickHouse have 2 additional dialects (with others in mind), and they act as first level citizen(Kusto/PRQL). Any other reasons to wrap it in function?

vitlibar · 2025-01-27T21:22:55Z

This does feel somewhat unusual, as ClickHouse have 2 additional dialects (with others in mind), and they act as first level citizen(Kusto/PRQL). Any other reasons to wrap it in function?

Yes, PromQL support in ClickHouse can be implemented as a dialect too. Though it requires specifying a TimeSeries table to use but that can be implemented via another setting.

srikanthccv · 2025-01-28T07:59:50Z

contrib/antlr4-grammars/promql/PromQLLexer.g4

+METRIC_NAME : [a-z_:] [a-z0-9_:]*;
+LABEL_NAME  : [a-z_] [a-z0-9_]*;
+


Since v3, all valid utf-8 chars are allowed https://prometheus.io/blog/2024/11/14/prometheus-3-0/#utf-8-support

srikanthccv · 2025-01-28T08:11:46Z

@vitlibar curious if/how range vectors and resets will be handled.

UnamedRus · 2025-01-28T19:11:52Z

Hm, PromQL doesn't have concept of table, right.

In that case, can it be just one more "endpoint", and PromQL will act like postgresql/mysql interfaces of ClickHouse. (with difference that it's not only protocol but also language)

May be, it even make sense to have "default" prometheus query endpoint, which will point to data from metrics/async_metrics/events _log tables. (but this req some adoption of them under TimeSeries schema, so it's like separate feature for now)

clickhouse-gh · 2025-04-01T13:16:00Z

Dear @vitlibar, this PR hasn't been updated for a while. Will you continue working on it? If not, please close it. Otherwise, ignore this message.

clickhouse-gh · 2025-06-03T13:21:57Z

Dear @vitlibar, this PR hasn't been updated for a while. Will you continue working on it? If not, please close it. Otherwise, ignore this message.

clickhouse-gh · 2025-07-01T10:02:50Z

Workflow [PR], commit [fafb184]

Summary: ❌

job_name	test_name	status	info	comment
Stateless tests (amd_debug, distributed plan, s3 storage, parallel)		failure
	02443_detach_attach_partition	FAIL

…IdToTagsGroup(), timeSeriesTagsGroupToTags().

…e_series_table == true.

vitlibar · 2025-08-13T18:39:42Z

This PR is ready for review, @GrigoryPervakov please take a look.

…aky tests).

docs/en/sql-reference/table-functions/prometheusQuery.md

src/Parsers/Prometheus/PrometheusQueryParsingUtil.cpp

src/AggregateFunctions/TimeSeries/AggregateFunctionTimeseriesHelpers.cpp

GrigoryPervakov · 2025-08-13T16:46:37Z

src/Functions/TimeSeries/timeSeriesStoreTags.cpp

+        }
+
+        /// The argument can be nullable.
+        if (const auto * nullable_column = checkAndGetColumn<ColumnNullable>(&column_tags_array))


Can you add an example here?
Map/Array cannot be Nullable, and I can't find an example when this code works

I corrected this code in my new PR #93234. Map/Array can't be nullable, but instead of Map or Array just literal NULL can be passed to this argument.

GrigoryPervakov · 2025-08-13T19:40:45Z

src/Functions/TimeSeries/timeSeriesTagsGroupToTags.cpp

Let's add some tests for these functions, maybe smth like this could be useful to ensure it is consistent

SELECT timeSeriesIdToTags(stored_id) = timeSeriesTagsGroupToTags(timeSeriesIdToTagsGroup(stored_id)) FROM ( SELECT timeSeriesStoreTags(id , tags, '__name__', metric_name) as stored_id FROM <some timeseries tags table> ) ORDER BY group

I added a test named 03779_time_series_tags_functions.sql in my new PR #93234 to test such functions.

…omql-parser

nikitamikhaylov · 2025-08-23T14:56:08Z

Flaky test 02443_detach_attach_partition: #54748

robot-ch-test-poll2 added the submodule changed At least one submodule changed in this PR. label Jan 26, 2025

alexey-milovidov mentioned this pull request Jan 26, 2025

Roadmap 2025 #74046

Closed

76 tasks

vitlibar force-pushed the add-promql-parser branch from 852673f to 89026e0 Compare January 26, 2025 20:39

robot-ch-test-poll1 added the pr-feature Pull request with new product feature label Jan 26, 2025

vitlibar force-pushed the add-promql-parser branch 4 times, most recently from 1261a10 to d0715d6 Compare January 26, 2025 23:31

UnamedRus mentioned this pull request Jan 28, 2025

Support for PromQL #57545

Open

srikanthccv reviewed Jan 28, 2025

View reviewed changes

vitlibar force-pushed the add-promql-parser branch from d0715d6 to eed38fc Compare June 20, 2025 13:10

vitlibar force-pushed the add-promql-parser branch from eed38fc to 0c74981 Compare July 1, 2025 10:02

vitlibar force-pushed the add-promql-parser branch from 0c74981 to 3ec3134 Compare July 8, 2025 09:15

vitlibar marked this pull request as ready for review July 8, 2025 09:15

vitlibar changed the title ~~[WIP] Add promql parser~~ Add promql parser Jul 8, 2025

vitlibar force-pushed the add-promql-parser branch 2 times, most recently from 4f033ed to 838954f Compare July 10, 2025 01:41

vitlibar force-pushed the add-promql-parser branch 5 times, most recently from 9967d57 to 6da7128 Compare July 17, 2025 15:03

vitlibar mentioned this pull request Aug 12, 2025

Rework tests for prometheus protocols #85485

Merged

vitlibar force-pushed the add-promql-parser branch 3 times, most recently from ed23964 to 296aba1 Compare August 13, 2025 18:38

vitlibar added 11 commits August 13, 2025 20:38

Allow constructing ASTFunction from std::string_view.

5e2631a

Allow function DecimalUtils::convertTo() to change decimal's scale.

2b6784d

Add error code CANNOT_PARSE_PROMQL_QUERY.

68fff57

Implement parsing a prometheus query and conversion it to a tree.

2c13ed2

Add functions timeSeriesStoreTags(), timeSeriesIdToTags(), timeSeries…

cdf82fe

…IdToTagsGroup(), timeSeriesTagsGroupToTags().

Add table function timeSeriesSelector().

30a610c

Add table functions prometheusQuery() and prometheusQueryRange().

2be982c

Enable time series aggregate functions also if allow_experimental_tim…

a881a47

…e_series_table == true.

Add tests for evaluation of promQL queries.

592c802

Add dialect "promql".

4e5d51f

Fix style.

a697a2c

vitlibar force-pushed the add-promql-parser branch from 296aba1 to 93ca6d5 Compare August 13, 2025 18:39

Fix removing duplicates while processing RemoteRead (this will fix fl…

18d019b

…aky tests).

vitlibar force-pushed the add-promql-parser branch from 93ca6d5 to 18d019b Compare August 13, 2025 18:41

GrigoryPervakov reviewed Aug 14, 2025

View reviewed changes

nikitamikhaylov and others added 2 commits August 22, 2025 18:48

Merge branch 'master' of github.com:ClickHouse/ClickHouse into add-pr…

febf95b

…omql-parser

Remove unknown setting

fafb184

nikitamikhaylov changed the title ~~Add promql parser~~ Basic support for the PromQL dialect Aug 23, 2025

nikitamikhaylov added this pull request to the merge queue Aug 23, 2025

Merged via the queue into ClickHouse:master with commit e59fe89 Aug 23, 2025
121 of 122 checks passed

robot-ch-test-poll1 added the pr-synced-to-cloud The PR is synced to the cloud repo label Aug 23, 2025

vitlibar mentioned this pull request Jan 5, 2026

PromQL support: Add functions for working with tags #93234

Merged

JTCunning added the comp-promql Issues related to the PromQL support and TimeSeries table engine. label Jan 12, 2026

		METRIC_NAME : [a-z_:] [a-z0-9_:]*;
		LABEL_NAME : [a-z_] [a-z0-9_]*;

Conversation

vitlibar commented Jan 26, 2025 • edited by nikitamikhaylov Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog category (leave one):

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Uh oh!

robot-ch-test-poll4 commented Jan 26, 2025 • edited by robot-clickhouse Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

UnamedRus commented Jan 27, 2025

Uh oh!

vitlibar commented Jan 27, 2025

Uh oh!

srikanthccv Jan 28, 2025

Choose a reason for hiding this comment

Uh oh!

srikanthccv commented Jan 28, 2025

Uh oh!

UnamedRus commented Jan 28, 2025

Uh oh!

clickhouse-gh bot commented Apr 1, 2025

Uh oh!

clickhouse-gh bot commented Jun 3, 2025

Uh oh!

clickhouse-gh bot commented Jul 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vitlibar commented Aug 13, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GrigoryPervakov Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

vitlibar Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

GrigoryPervakov Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

vitlibar Jan 5, 2026

Choose a reason for hiding this comment

Uh oh!

nikitamikhaylov commented Aug 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

vitlibar commented Jan 26, 2025 •

edited by nikitamikhaylov

Loading

robot-ch-test-poll4 commented Jan 26, 2025 •

edited by robot-clickhouse

Loading

clickhouse-gh bot commented Jul 1, 2025 •

edited

Loading