This is an automated email from the ASF dual-hosted git repository.
yiguolei pushed a commit to branch branch-4.2
in repository https://gitbox.apache.org/repos/asf/doris.git
The following commit(s) were added to refs/heads/branch-4.2 by this push:
new 48b17e2b3eb [fix](be) Remove heartbeat tokens from logs and errors
(#69532) (#70692)
48b17e2b3eb is described below
commit 48b17e2b3eba88a28e4540d734bb51d95f795e80
Author: deardeng <[email protected]>
AuthorDate: Thu Nov 19 15:30:17 2026 +0800
[fix](be) Remove heartbeat tokens from logs and errors (#69532) (#70692)
pick from https://github.com/apache/doris/pull/69532
Problem Summary: When a BE receives its cluster token or a new
authentication token, heartbeat INFO logs include the credential values.
A cluster-token mismatch also includes both tokens in the error
response, which can propagate to FE logs. Keep the heartbeat event
messages and invalid-token error while removing credential values. Add a
unit test covering initialization, repeated heartbeats, successive
authentication-token updates, and token mismatch, including checks that
logs and error responses do not contain the credentials.
(cherry picked from commit c3c7af57fa4e018a2f4319bf60ce5f83ef503ad7)
### Background
<!-- How the feature or module this PR touches works today, in two to
four plain sentences, for a reviewer who doesn't know it. Link the user
doc if there is one. Leave the problem and the fix to Problem Summary.
-->
### What problem does this PR solve?
<!-- Issue Number: "close #N" if this PR resolves the issue, "#N" if it
only relates to it, "None" if there is none. A Feature needs an issue.
-->
<!-- Related PR: "#N (relation)" for each PR a reviewer should know
about, such as "#123 (introduced the bug)", separated by commas. Write
"None" if no related PR is known. -->
<!-- PR Type: Bugfix, Performance, Feature, Enhancement, Refactor, Test,
Build/CI/Chore, Revert, Release/Dependency, or Other. -->
Issue Number:
Related PR:
PR Type:
Problem Summary:
<!-- Two to five sentences: the problem or need and who is affected; the
approach in one sentence; when the diff is larger than that suggests,
what else it had to handle, or that most of it is tests; and what
existing users see after an upgrade. -->
### Details
<!--
For a diff of more than about 300 changed lines, start with "- **Change
map:**": how many lines are production code, tests, generated files, and
docs, then the code in parts, each with the problem it handles and its
size.
Then answer each field of your PR type on its own line, as "- **Field:**
answer", in this order:
Bugfix: Frequency, Root cause, Why existing tests missed it, Fix, Other
paths and branches
Performance: Why it was slow, Optimization, Results, Applicability and
cost
Feature: Scope, Design, Usage, Default behavior, Compatibility
Enhancement: Before and after, Configs and defaults, Impact on existing
users
Refactor: Moves vs. logic changes, Behavior change, Compatibility,
Performance impact, Rollback
Test, adding tests: Scenarios, What existing tests miss, Fails when
broken
Test, fixing a test: Failure, Cause, Stability evidence
Build/CI/Chore: Affected, Developer and release impact, License and
third-party, Rollback
Revert: Why not fix forward, Original author notified, Follow-up
Release/Dependency: Versions, Upstream changes, Compatibility, Rollback
Other: Why Other
"None" is a valid answer when it is true. Don't restate the diff.
-->
### Testing
<!-- The tests, suites, or commands that ran, what each shows, and where
it ran (locally or in CI). For a fix, the test that fails before it and
passes after. -->
### Notes for Reviewers
<!-- Optional; delete this section if there is nothing to say. Why each
non-obvious edit was made, what you are unsure about, and where to start
reading if Details has no Change map. -->
### Release note
<!-- One paragraph on what users will notice, or None. -->
### Check List (For Author)
<!-- Behavior changed: "No", or "Yes (see Details)" with a Behavior
change field in Details. -->
<!-- Does this need documentation: "No", or "Yes" with the
apache/doris-website PR or the plan. -->
<!-- Pre-submission status: "Ready"; "Partially verified: " and what is
not verified; or "Not ready: " and why, for a Draft PR. -->
- Behavior changed:
- Does this need documentation:
- Pre-submission status:
### AI Disclosure
<!-- Tool: the agent and model, or None. Generated: the parts it wrote
(code, tests, this description), or None. Human review: what you
reviewed of the generated parts, or "Not applicable" without AI tools.
You may add "- Prompts:" to summarize how you directed the agent. -->
- Tool:
- Generated:
- Human review:
---
be/src/agent/heartbeat_server.cpp | 10 ++-
be/test/agent/heartbeat_server_token_test.cpp | 90 +++++++++++++++++++++++++++
2 files changed, 94 insertions(+), 6 deletions(-)
diff --git a/be/src/agent/heartbeat_server.cpp
b/be/src/agent/heartbeat_server.cpp
index 5cf8c7df01d..d66ec68f629 100644
--- a/be/src/agent/heartbeat_server.cpp
+++ b/be/src/agent/heartbeat_server.cpp
@@ -219,10 +219,9 @@ Status HeartbeatServer::_heartbeat(const TMasterInfo&
master_info) {
if (master_info.__isset.token) {
if (_cluster_info->token == "") {
_cluster_info->token = master_info.token;
- LOG(INFO) << "get token. token: " << _cluster_info->token;
+ LOG(INFO) << "get token";
} else if (_cluster_info->token != master_info.token) {
- return Status::InternalError("invalid token. local: {}, master:
{}",
- _cluster_info->token,
master_info.token);
+ return Status::InternalError("invalid token");
}
}
@@ -322,10 +321,9 @@ Status HeartbeatServer::_heartbeat(const TMasterInfo&
master_info) {
if (master_info.__isset.auth_token) {
if (_cluster_info->curr_auth_token == "") {
_cluster_info->curr_auth_token = master_info.auth_token;
- LOG(INFO) << "set new auth token: " << master_info.auth_token;
+ LOG(INFO) << "set new auth token";
} else if (_cluster_info->curr_auth_token != master_info.auth_token) {
- LOG(INFO) << "last auth token: " << _cluster_info->last_auth_token
- << "set new auth token: " << master_info.auth_token;
+ LOG(INFO) << "update auth token";
_cluster_info->last_auth_token = _cluster_info->curr_auth_token;
_cluster_info->curr_auth_token = master_info.auth_token;
}
diff --git a/be/test/agent/heartbeat_server_token_test.cpp
b/be/test/agent/heartbeat_server_token_test.cpp
new file mode 100644
index 00000000000..33c242d0015
--- /dev/null
+++ b/be/test/agent/heartbeat_server_token_test.cpp
@@ -0,0 +1,90 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements. See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership. The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#include <glog/logging.h>
+#include <gtest/gtest.h>
+
+#include <memory>
+#include <string>
+
+#include "agent/heartbeat_server.h"
+#include "runtime/cluster_info.h"
+#include "runtime/exec_env.h"
+#include "storage/storage_engine.h"
+#include "util/defer_op.h"
+
+namespace doris {
+
+class HeartbeatLogSink : public google::LogSink {
+public:
+ void send(google::LogSeverity /*severity*/, const char* /*full_filename*/,
+ const char* /*base_filename*/, int /*line*/, const
google::LogMessageTime& /*time*/,
+ const char* message, std::size_t message_len) override {
+ messages.append(message, message_len);
+ }
+
+ std::string messages;
+};
+
+TEST(HeartbeatServerTest, DoesNotExposeTokens) {
+
ExecEnv::GetInstance()->set_storage_engine(std::make_unique<StorageEngine>(EngineOptions
{}));
+ Defer reset_engine([] {
ExecEnv::GetInstance()->set_storage_engine(nullptr); });
+ ClusterInfo cluster;
+ cluster.cluster_id = 7;
+ HeartbeatServer server(&cluster);
+ TMasterInfo master;
+ master.__set_cluster_id(7);
+ master.__set_epoch(10);
+ TNetworkAddress address;
+ address.__set_hostname("master-a");
+ address.__set_port(9020);
+ master.__set_network_address(address);
+ master.__set_token("heartbeat_cluster_secret");
+
+ HeartbeatLogSink log_sink;
+ google::AddLogSink(&log_sink);
+ Defer remove_log_sink([&] { google::RemoveLogSink(&log_sink); });
+
+ THeartbeatResult result;
+ for (const auto* token :
+ {"heartbeat_auth_secret_a", "heartbeat_auth_secret_b",
"heartbeat_auth_secret_c"}) {
+ master.__set_auth_token(token);
+ server.heartbeat(result, master);
+ ASSERT_EQ(TStatusCode::OK, result.status.status_code);
+ }
+
+ server.heartbeat(result, master);
+ ASSERT_EQ(TStatusCode::OK, result.status.status_code);
+ EXPECT_EQ("heartbeat_auth_secret_c", cluster.curr_auth_token);
+ EXPECT_EQ("heartbeat_auth_secret_b", cluster.last_auth_token);
+
+ master.__set_token("heartbeat_mismatched_secret");
+ server.heartbeat(result, master);
+ ASSERT_EQ(TStatusCode::INTERNAL_ERROR, result.status.status_code);
+ ASSERT_EQ(1, result.status.error_msgs.size());
+ EXPECT_NE(std::string::npos,
result.status.error_msgs.front().find("invalid token"));
+ EXPECT_EQ("heartbeat_cluster_secret", cluster.token);
+
+ for (const auto* secret :
+ {"heartbeat_cluster_secret", "heartbeat_mismatched_secret",
"heartbeat_auth_secret_a",
+ "heartbeat_auth_secret_b", "heartbeat_auth_secret_c"}) {
+ EXPECT_EQ(std::string::npos, log_sink.messages.find(secret));
+ EXPECT_EQ(std::string::npos,
result.status.error_msgs.front().find(secret));
+ }
+}
+
+} // namespace doris
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]