Skip to content

Add protobufs for Prometheus remote-write/remote-read protocols#66069

Merged
vitlibar merged 2 commits intoClickHouse:masterfrom
vitlibar:add-prometheus-protocols-protobufs
Jul 5, 2024
Merged

Add protobufs for Prometheus remote-write/remote-read protocols#66069
vitlibar merged 2 commits intoClickHouse:masterfrom
vitlibar:add-prometheus-protocols-protobufs

Conversation

@vitlibar
Copy link
Copy Markdown
Member

@vitlibar vitlibar commented Jul 3, 2024

Changelog category:

  • Not for changelog

Changelog entry:

Add protobufs for Prometheus remote-write / remote-read protocols to our repository.
Fix cmake script for compiling protobufs.

This PR is required for #64183

@robot-ch-test-poll robot-ch-test-poll added pr-not-for-changelog This PR should not be mentioned in the changelog submodule changed At least one submodule changed in this PR. labels Jul 3, 2024
@robot-ch-test-poll2
Copy link
Copy Markdown
Contributor

robot-ch-test-poll2 commented Jul 3, 2024

This is an automated comment for commit 1ef5bca 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 nameDescriptionStatus
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors❌ failure
Upgrade checkRuns 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❌ failure
Successful checks
Check nameDescriptionStatus
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help✅ success
BuildsThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS✅ success
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help✅ success
Docker keeper imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docker server imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docs checkBuilds and tests the documentation✅ success
Fast testNormally 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 testsChecks 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 packagesChecks that the built packages are installable in a clear environment✅ success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests✅ success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests✅ success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc✅ success
Style checkRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report✅ success
Unit testsRuns the unit tests for different release types✅ success

@nikitamikhaylov nikitamikhaylov self-assigned this Jul 3, 2024
@vitlibar vitlibar force-pushed the add-prometheus-protocols-protobufs branch from f8316ea to 5b4a3f7 Compare July 4, 2024 21:05
@vitlibar vitlibar force-pushed the add-prometheus-protocols-protobufs branch from 5b4a3f7 to 0559621 Compare July 4, 2024 21:06
…ths in SRCS and HDRS

even if input ".proto" files are located in sibling directories.
@vitlibar vitlibar force-pushed the add-prometheus-protocols-protobufs branch from 0559621 to 1ef5bca Compare July 4, 2024 21:07
@@ -0,0 +1,2 @@
Files "prompb/remote.proto" and "prompb/types.proto" were downloaded from the Prometheus repository:
https://github.com/prometheus/prometheus/tree/main/prompb
Copy link
Copy Markdown
Member Author

@vitlibar vitlibar Jul 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whole repository https://github.com/prometheus/prometheus is quite big, and I need only two small files remote.proto and types.proto from it, so I decided not to add the prometheus repository as a submodule and just download these two files into our contrib/prometheus-protobufs/ folder instead.

option go_package = "prompb";

import "prompb/types.proto";
import "gogoproto/gogo.proto";
Copy link
Copy Markdown
Member Author

@vitlibar vitlibar Jul 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here remote.proto from the Prometheus repository depends on gogo.proto from the Protocol Buffers for Go with Gadgets repository. And again, that repository is quite big and I need only one file from it, so I just downloaded it into our contrib/prometheus-protobufs-gogo/ folder instead of making a new submodule.

# _basename - filename of the .proto file (without path and without extenstion).
get_proto_absolute_path(_abs_file "${_proto}" ${_protobuf_include_path})
get_proto_relative_path(_possible_rel_dir "${_abs_file}" ${_protobuf_include_path})
get_filename_component(_basename "${_abs_file}" NAME_WE)
Copy link
Copy Markdown
Member Author

@vitlibar vitlibar Jul 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without my changes here this cmake script returned incorrect paths for generated source files after compiling .proto files. As a result variables prometheus_protobufs_sources and prometheus_protobufs_headers here were incorrect and the build failed.

@vitlibar
Copy link
Copy Markdown
Member Author

vitlibar commented Jul 5, 2024

@vitlibar vitlibar added this pull request to the merge queue Jul 5, 2024
Merged via the queue into ClickHouse:master with commit f315b36 Jul 5, 2024
@vitlibar vitlibar deleted the add-prometheus-protocols-protobufs branch July 5, 2024 11:12
@robot-ch-test-poll1 robot-ch-test-poll1 added the pr-synced-to-cloud The PR is synced to the cloud repo label Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr-not-for-changelog This PR should not be mentioned in the changelog pr-synced-to-cloud The PR is synced to the cloud repo submodule changed At least one submodule changed in this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants