Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement support of date/time format specifiers in log and error log file names #51945

Merged
merged 12 commits into from Jul 14, 2023

Conversation

sirvickr
Copy link
Contributor

@sirvickr sirvickr commented Jul 7, 2023

Changelog category (leave one):

  • New Feature

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

Added the possibility to use date and time format specifiers in log and error log file names, either in config files (log and errorlog tags) or command line arguments (--log-file and --errorlog-file)

Documentation entry for user-facing changes

  • Documentation is written (mandatory for new features)

@nikitamikhaylov nikitamikhaylov added the can be tested Allows running workflows for external contributors label Jul 7, 2023
@robot-ch-test-poll2 robot-ch-test-poll2 added the pr-feature Pull request with new product feature label Jul 7, 2023
@robot-ch-test-poll2
Copy link
Contributor

robot-ch-test-poll2 commented Jul 7, 2023

This is an automated comment for commit e592c7c with description of existing statuses. It's updated for the latest CI running
The full report is available here
The overall status of the commit is 🟢 success

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
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR🟢 success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process🟢 success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help🟢 success
Docker image for serversThe 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. Integrational 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
Mergeable CheckChecks if all other necessary checks are successful🟢 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
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub🟢 success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool🟢 success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed🟢 success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc🟢 success
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc🟢 success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors🟢 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
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🟢 success

@rvasin
Copy link
Contributor

rvasin commented Jul 12, 2023

Hi, could anyone be assigned to this PR? So Victor could start working on reviewers suggestions.

@alexey-milovidov alexey-milovidov self-assigned this Jul 14, 2023
@robot-ch-test-poll robot-ch-test-poll merged commit 93b40c4 into ClickHouse:master Jul 14, 2023
268 checks passed
@alexey-milovidov
Copy link
Member

alexey-milovidov commented Jul 14, 2023

LGTM.

The localtime_r and stringstream usage was suspicious to me while reviewing, but it looks like we cannot support all these format substitutions easier, and the method will be called very rarely, and it is static (buried deep enough).

@sirvickr sirvickr deleted the ADQM-950-B branch July 21, 2023 04:37
localtime_r(&now, &buf);
std::ostringstream ss; // STYLE_CHECK_ALLOW_STD_STRING_STREAM
ss << std::put_time(&buf, file_path.c_str());
return path.replace_filename(ss.str());
Copy link
Collaborator

@amosbird amosbird Aug 31, 2023

Choose a reason for hiding this comment

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

This breaks relative path configuration for non-daemon servers. Consider the following example:

    <logger>
        <level>trace</level>
        <log>logs/clickhouse-server.log</log>
        <errorlog>logs/clickhouse-server.err.log</errorlog>
        <size>1000M</size>
        <count>10</count>
    </logger>

The log path will be modified as logs/logs/clickhouse-server.log.

cc @sirvickr

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's the exact reason why those format specifiers currently do not apply to the "path" part - only to the file name.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@amosbird, path.replace_filename() does the trick.
If someone decides another day to apply the specifiers to the full path, they will have to take into consideration this issue about non-daemon servers.

Copy link
Collaborator

@amosbird amosbird Aug 31, 2023

Choose a reason for hiding this comment

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

That's the exact reason why those format specifiers currently do not apply to the "path" part - only to the file name.

@sirvickr I'm confused. If that's the expected behavior, why not do the following:

    ss << std::put_time(&buf, path.filename().c_str());

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@amosbird, you are right, my code looks like an ugly typo, to say the least. This one is more concise, clear and correct:

ss << std::put_time(&buf, path.filename().c_str());

It looks like it should be amended.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess, replace_filename() extracts the file name from its argument, otherwise it wouldn't work properly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

And thank you for noticing.
I'm thinking of creating a "follow-up" PR to clean up this line of code. Or may be you'd rather amend this code by yourself?

Copy link
Collaborator

Choose a reason for hiding this comment

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

And thank you for noticing.

No problem!

I'm thinking of creating a "follow-up" PR to clean up this line of code.

Perfect. Please go ahead for amending it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
can be tested Allows running workflows for external contributors pr-feature Pull request with new product feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants