Enhance OpenTelemetry span logging to include query settings by sharathks118 · Pull Request #70011 · ClickHouse/ClickHouse

sharathks118 · 2024-09-26T11:53:50Z

Changelog category (leave one):

Improvement

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

Enhance OpenTelemetry span logging to include query settings

Documentation entry for user-facing changes

Documentation is written (mandatory for new features)

Information about CI checks: https://clickhouse.com/docs/en/development/continuous-integration/

CI Settings (Only check the boxes if you know what you are doing):

Allow: All Required Checks
Allow: Stateless tests
Allow: Stateful tests
Allow: Integration Tests
Allow: Performance tests
Allow: All Builds
Allow: batch 1, 2 for multi-batch jobs
Allow: batch 3, 4, 5, 6 for multi-batch jobs

Exclude: Style check
Exclude: Fast test
Exclude: All with ASAN
Exclude: All with TSAN, MSAN, UBSAN, Coverage
Exclude: All with aarch64, release, debug

Run only fuzzers related jobs (libFuzzer fuzzers, AST fuzzers, etc.)
Exclude: AST fuzzers

CLAassistant · 2024-09-26T11:57:00Z

All committers have signed the CLA.

kssenii · 2024-09-26T19:06:12Z

tests/queries/0_stateless/02421_simple_queries_for_opentelemetry.sh

 query_id=$(${CLICKHOUSE_CLIENT} -q "select generateUUIDv4()");
 execute_query $query_id 'select * from opentelemetry_test format Null'
 check_query_span $query_id
+check_query_settings


need to also update according tests/queries/0_stateless/02421_simple_queries_for_opentelemetry.reference file

Update test script and reference file as per review comments

kssenii · 2024-09-26T19:06:49Z

programs/server/config.xml

    <interserver_http_port>9009</interserver_http_port>

+    <settings>
+        <log_query_settings>1</log_query_settings>


This is not the correct place to modify settings for the tests, please modify ClickHouse/tests/configs/ instead

Addressed the review comments

kssenii · 2024-09-26T19:08:53Z

programs/server/users.xml

    <profiles>
        <!-- Default settings. -->
        <default>
+            <allow_introspection_functions>1</allow_introspection_functions>


This does not look required for the test. Anyway same comment as above that this is not the correct place to modify settings for tests.

kssenii · 2024-09-26T19:09:45Z

tests/queries/0_stateless/02421_simple_queries_for_opentelemetry.sh

+{
+    ${CLICKHOUSE_CLIENT} -q "
+        SYSTEM FLUSH LOGS;
+        SELECT attribute


This test will give too big output, better to search for specific query settings.

Update test script and reference file as per review comments

robot-ch-test-poll4 · 2024-09-26T19:11:03Z

This is an automated comment for commit ef9b9a2 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
Stateful tests	Runs stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc	❌ failure
Stateless tests	Runs stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc	❌ 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
Builds	There's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS	✅ success
ClickBench	Runs [ClickBench](https://github.com/ClickHouse/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
Integration tests	The integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests	✅ 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
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

Removed config files changes

kssenii · 2024-10-02T09:17:17Z

@sharathks118 Hi, there is an issue with checks.
For example, Fast test — Cannot build ClickHouse .

2024-10-01 14:02:09 /repo/src/Interpreters/executeQuery.cpp:573:22: error: no member named 'log_query_settings' in 'DB::Settings'
2024-10-01 14:02:09   573 |         if (settings.log_query_settings)
2024-10-01 14:02:09       |             ~~~~~~~~ ^
2024-10-01 14:02:09 /repo/src/Interpreters/executeQuery.cpp:575:50: error: no member named 'allChanged' in 'DB::Settings'
2024-10-01 14:02:09   575 |             for (const auto & setting : settings.allChanged())
2024-10-01 14:02:09       |                                         ~~~~~~~~ ^
2024-10-01 14:02:09 2 errors generated.

FrankChen021 · 2024-10-07T01:47:58Z

src/Interpreters/executeQuery.cpp

+                        break;
+                }
+
+                query_span->addAttribute(name, value_str);


I would like to suggest adding a prefix(like clickhouse.setting.) to the name so that all these query setting names in the span log can be easily distinguished from other attributes.

Addressed review comments by adding a "clickhouse.setting." prefix to query setting names

FrankChen021 · 2024-10-07T01:51:42Z

src/Interpreters/executeQuery.cpp

+            query_span->addAttribute("clickhouse.user", user_name);
+        }
+
+        if (settings[Setting::log_query_settings])


If this feature is controlled by this setting, it's better to update docs and the setting description in the code to reflect this change.

Updated documentation and setting descriptions

Updated relevant documentation and setting descriptions to reflect this change.

sharathks118 · 2024-10-10T07:00:21Z

The test failure in the pipeline is not related to my changes.

docs/en/operations/settings/settings.md

docs/en/operations/opentelemetry.md

kssenii · 2024-10-14T08:48:16Z

src/Interpreters/executeQuery.cpp

+                Field value = settings.get(name);
+                String value_str;
+
+                switch (value.getType())


Let's use here convertFieldToString from Common/FieldVisitorToString.h

updated the code to use convertFieldToString from Common/FieldVisitorToString.h

sharathks118 · 2024-10-15T05:13:30Z

The failure in the pipeline is unrelated to my changes.

Algunenano · 2024-10-17T20:40:15Z

src/Interpreters/executeQuery.cpp

+
+        if (settings[Setting::log_query_settings])
+        {
+            auto changed_settings_names = settings.getChangedNames();


You already have this in settings.changes(). No need to add a new function and call .get() every time

rschu1ze · 2024-10-22T15:26:36Z

docs/en/operations/opentelemetry.md


 The tags or attributes are saved as two parallel arrays, containing the keys and values. Use [ARRAY JOIN](../sql-reference/statements/select/array-join.md) to work with them.

+## Log-query-settings


@sharathks118 Without a link to the corresponding setting in "settings.md", readers will be confused by "Log-query-settings" and below description.

Minor fixups of #70011 and #69918

Enhance OpenTelemetry span logging to include query settings

9f8964a

kssenii self-assigned this Sep 26, 2024

kssenii reviewed Sep 26, 2024

View reviewed changes

kssenii added the can be tested Allows running workflows for external contributors label Sep 26, 2024

robot-ch-test-poll2 added the pr-improvement Pull request with some product improvements label Sep 26, 2024

sharathks118 added 2 commits October 1, 2024 03:27

Fixed review comments

e524469

Removed config files changes

Fix indentation in shell script

4eddbe6

Handle fast test failure

6358a14

FrankChen021 reviewed Oct 7, 2024

View reviewed changes

sharathks118 and others added 3 commits October 8, 2024 07:33

Add prefix "clickhouse.setting." to query setting names in span log

15a86ae

Updated relevant documentation and setting descriptions to reflect this change.

Merge branch 'master' into setting-opentelemetry

88671d8

Updated log_query_settings description in Settings.cpp

6d308b3

kssenii approved these changes Oct 11, 2024

View reviewed changes

docs/en/operations/settings/settings.md Show resolved Hide resolved

docs/en/operations/opentelemetry.md Show resolved Hide resolved

kssenii added 2 commits October 11, 2024 14:36

Update docs/en/operations/settings/settings.md

a0e2e6a

Update docs/en/operations/opentelemetry.md

36e29e4

kssenii requested changes Oct 14, 2024

View reviewed changes

Refactor executeQuery.cpp to use convertFieldToString

ef9b9a2

sharathks118 requested a review from kssenii October 15, 2024 09:08

kssenii approved these changes Oct 15, 2024

View reviewed changes

kssenii added this pull request to the merge queue Oct 15, 2024

Merged via the queue into ClickHouse:master with commit ba0b7f5 Oct 15, 2024

robot-clickhouse added the pr-synced-to-cloud The PR is synced to the cloud repo label Oct 15, 2024

Algunenano reviewed Oct 17, 2024

View reviewed changes

Algunenano mentioned this pull request Oct 17, 2024

Remove inneficient code #70816

Merged

21 tasks

rschu1ze reviewed Oct 22, 2024

View reviewed changes

rschu1ze added a commit to rschu1ze/ClickHouse that referenced this pull request Oct 23, 2024

Minor fixups of ClickHouse#70011 and ClickHouse#69918

6a374cb

github-merge-queue bot pushed a commit that referenced this pull request Oct 23, 2024

Merge pull request #70959 from rschu1ze/minor-fixups

85056de

Minor fixups of #70011 and #69918


		The tags or attributes are saved as two parallel arrays, containing the keys and values. Use [ARRAY JOIN](../sql-reference/statements/select/array-join.md) to work with them.

		## Log-query-settings

Conversation

sharathks118 commented Sep 26, 2024 • edited by kssenii 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):

Documentation entry for user-facing changes

CI Settings (Only check the boxes if you know what you are doing):

Uh oh!

CLAassistant commented Sep 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

kssenii commented Oct 2, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sharathks118 commented Oct 10, 2024

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sharathks118 commented Oct 15, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

sharathks118 commented Sep 26, 2024 •

edited by kssenii

Loading

CLAassistant commented Sep 26, 2024 •

edited

Loading

robot-ch-test-poll4 commented Sep 26, 2024 •

edited by robot-ch-test-poll

Loading