You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by yi...@apache.org on 2022/06/24 07:30:12 UTC
[doris] branch master updated: [chore] Rename Doris binary output format
This is an automated email from the ASF dual-hosted git repository.
yiguolei pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris.git
The following commit(s) were added to refs/heads/master by this push:
new 8a49c7ef04 [chore] Rename Doris binary output format
8a49c7ef04 is described below
commit 8a49c7ef047293ce9a515d2d3bff563b7ca18cdf
Author: Mingyu Chen <mo...@gmail.com>
AuthorDate: Fri Jun 24 15:30:05 2022 +0800
[chore] Rename Doris binary output format
---
be/src/exprs/bitmap_function.h | 2 +-
be/src/http/default_path_handlers.cpp | 4 ++--
be/src/service/CMakeLists.txt | 18 +++++++++---------
be/src/util/pprof_utils.h | 2 +-
bin/start_be.sh | 6 +++---
bin/stop_be.sh | 2 +-
build.sh | 11 ++++++-----
docs/.vuepress/sidebar/en/developer.js | 3 +--
docs/.vuepress/sidebar/zh-CN/developer.js | 3 +--
docs/en/developer/developer-guide/be-vscode-dev.md | 16 +++++++++-------
docs/en/developer/developer-guide/debug-tool.md | 12 +++++++-----
docs/en/developer/developer-guide/minidump.md | 22 +++++++++++-----------
.../admin-manual/cluster-management/upgrade.md | 10 ++++++----
docs/en/docs/faq/install-faq.md | 4 +++-
.../developer/developer-guide/be-vscode-dev.md | 16 +++++++++-------
docs/zh-CN/developer/developer-guide/debug-tool.md | 12 +++++++-----
docs/zh-CN/developer/developer-guide/minidump.md | 20 ++++++++++----------
.../admin-manual/cluster-management/upgrade.md | 8 +++++---
docs/zh-CN/docs/faq/install-faq.md | 8 +++-----
fe/fe-core/pom.xml | 2 +-
20 files changed, 96 insertions(+), 85 deletions(-)
diff --git a/be/src/exprs/bitmap_function.h b/be/src/exprs/bitmap_function.h
index 5c7ba4dff0..8b3db6b33e 100644
--- a/be/src/exprs/bitmap_function.h
+++ b/be/src/exprs/bitmap_function.h
@@ -30,7 +30,7 @@ namespace doris {
* 2. Add a UT in BitmapFunctionsTest
* 3. Add the function signature in gensrc/script/doris_builtins_functions.py
* Note: if the result is bitmap serialize data, the function return type should be BITMAP
- * you could use `nm $DORIS_HOME/output/be/lib/palo_be | grep bitmap` to get the function signature
+ * you could use `nm $DORIS_HOME/output/be/lib/doris_be | grep bitmap` to get the function signature
* 4. Update the doc docs/documentation/cn/sql-reference/sql-functions/aggregate-functions/bitmap.md
* and docs/documentation/en/sql-reference/sql-functions/aggregate-functions/bitmap_EN.md
*/
diff --git a/be/src/http/default_path_handlers.cpp b/be/src/http/default_path_handlers.cpp
index 57c988c68c..4a6efbb1b5 100644
--- a/be/src/http/default_path_handlers.cpp
+++ b/be/src/http/default_path_handlers.cpp
@@ -190,7 +190,7 @@ void heap_handler(const WebPageHandler::ArgumentMap& args, std::stringstream* ou
(*output) << std::endl;
(*output) << " curl http://localhost:" << config::webserver_port
<< "/pprof/heap?seconds=30 > perf.data" << std::endl;
- (*output) << " pprof --text be/lib/palo_be perf.data" << std::endl;
+ (*output) << " pprof --text be/lib/doris_be perf.data" << std::endl;
(*output) << std::endl;
(*output) << "</pre>" << std::endl;
(*output) << "<div id=\"heap\">" << std::endl;
@@ -256,7 +256,7 @@ void cpu_handler(const WebPageHandler::ArgumentMap& args, std::stringstream* out
(*output) << std::endl;
(*output) << " curl http://localhost:" << config::webserver_port
<< "/pprof/profile?seconds=30 > perf.data" << std::endl;
- (*output) << " pprof --text be/lib/palo_be perf.data" << std::endl;
+ (*output) << " pprof --text be/lib/doris_be perf.data" << std::endl;
(*output) << std::endl;
(*output) << "If you want to get the flame graph, you must first make sure that there is a "
"'perf' command on the host machine."
diff --git a/be/src/service/CMakeLists.txt b/be/src/service/CMakeLists.txt
index fb07d2cca7..31588b62ab 100644
--- a/be/src/service/CMakeLists.txt
+++ b/be/src/service/CMakeLists.txt
@@ -30,28 +30,28 @@ add_library(Service
)
if (${MAKE_TEST} STREQUAL "OFF")
- add_executable(palo_be
+ add_executable(doris_be
doris_main.cpp
)
# This permits libraries loaded by dlopen to link to the symbols in the program.
- set_target_properties(palo_be PROPERTIES ENABLE_EXPORTS 1)
+ set_target_properties(doris_be PROPERTIES ENABLE_EXPORTS 1)
- target_link_libraries(palo_be
+ target_link_libraries(doris_be
${DORIS_LINK_LIBS}
)
install(DIRECTORY DESTINATION ${OUTPUT_DIR}/lib/)
- install(TARGETS palo_be DESTINATION ${OUTPUT_DIR}/lib/)
+ install(TARGETS doris_be DESTINATION ${OUTPUT_DIR}/lib/)
if ("${STRIP_DEBUG_INFO}" STREQUAL "ON")
- add_custom_command(TARGET palo_be POST_BUILD
- COMMAND ${CMAKE_OBJCOPY} --only-keep-debug $<TARGET_FILE:palo_be> $<TARGET_FILE:palo_be>.dbg
- COMMAND ${CMAKE_STRIP} --strip-debug --strip-unneeded $<TARGET_FILE:palo_be>
- COMMAND ${CMAKE_OBJCOPY} --add-gnu-debuglink=$<TARGET_FILE:palo_be>.dbg $<TARGET_FILE:palo_be>
+ add_custom_command(TARGET doris_be POST_BUILD
+ COMMAND ${CMAKE_OBJCOPY} --only-keep-debug $<TARGET_FILE:doris_be> $<TARGET_FILE:doris_be>.dbg
+ COMMAND ${CMAKE_STRIP} --strip-debug --strip-unneeded $<TARGET_FILE:doris_be>
+ COMMAND ${CMAKE_OBJCOPY} --add-gnu-debuglink=$<TARGET_FILE:doris_be>.dbg $<TARGET_FILE:doris_be>
)
install(DIRECTORY DESTINATION ${OUTPUT_DIR}/lib/debug_info/)
- install(FILES $<TARGET_FILE:palo_be>.dbg DESTINATION ${OUTPUT_DIR}/lib/debug_info/)
+ install(FILES $<TARGET_FILE:doris_be>.dbg DESTINATION ${OUTPUT_DIR}/lib/debug_info/)
endif()
endif()
diff --git a/be/src/util/pprof_utils.h b/be/src/util/pprof_utils.h
index c2842acc90..bef4c64dcb 100644
--- a/be/src/util/pprof_utils.h
+++ b/be/src/util/pprof_utils.h
@@ -35,7 +35,7 @@ public:
/// check and get "pprof" command, return the cmd abs path via "cmd".
static Status get_pprof_cmd(std::string* cmd);
- /// get readable profile by `pprof --text palo_be perf.data`
+ /// get readable profile by `pprof --text doris_be perf.data`
/// if is_file is true, the file_or_content is an abs path of perf file.
/// if is_file is false, the file_or_content is the perf file content.
/// the readable content is returned via "output"
diff --git a/bin/start_be.sh b/bin/start_be.sh
index 8bb8a6ff30..a121b47f75 100755
--- a/bin/start_be.sh
+++ b/bin/start_be.sh
@@ -158,7 +158,7 @@ if [ -f $pidfile ]; then
fi
fi
-chmod 755 ${DORIS_HOME}/lib/palo_be
+chmod 755 ${DORIS_HOME}/lib/doris_be
echo "start time: "$(date) >> $LOG_DIR/be.out
if [ ! -f /bin/limit3 ]; then
@@ -168,8 +168,8 @@ else
fi
if [ ${RUN_DAEMON} -eq 1 ]; then
- nohup $LIMIT ${DORIS_HOME}/lib/palo_be "$@" >> $LOG_DIR/be.out 2>&1 < /dev/null &
+ nohup $LIMIT ${DORIS_HOME}/lib/doris_be "$@" >> $LOG_DIR/be.out 2>&1 < /dev/null &
else
export DORIS_LOG_TO_STDERR=1
- $LIMIT ${DORIS_HOME}/lib/palo_be "$@" 2>&1 < /dev/null
+ $LIMIT ${DORIS_HOME}/lib/doris_be "$@" 2>&1 < /dev/null
fi
diff --git a/bin/stop_be.sh b/bin/stop_be.sh
index 03c6b7abe5..2ca1b47124 100755
--- a/bin/stop_be.sh
+++ b/bin/stop_be.sh
@@ -35,7 +35,7 @@ pidfile=$PID_DIR/be.pid
if [ -f $pidfile ]; then
pid=`cat $pidfile`
pidcomm=`ps -p $pid -o comm=`
- if [ "palo_be"x != "$pidcomm"x ]; then
+ if [ "doris_be"x != "$pidcomm"x ]; then
echo "ERROR: pid process may not be be. "
exit 1
fi
diff --git a/build.sh b/build.sh
index 7b038d6896..a365bbb7d5 100755
--- a/build.sh
+++ b/build.sh
@@ -135,7 +135,7 @@ if [ $# == 1 ] ; then
BUILD_FE=1
BUILD_BE=1
BUILD_BROKER=1
- BUILD_META_TOOL=ON
+ BUILD_META_TOOL=OFF
BUILD_SPARK_DPP=1
BUILD_JAVA_UDF=0 # TODO: open it when ready
BUILD_HIVE_UDF=1
@@ -371,7 +371,8 @@ if [ ${BUILD_FE} -eq 1 ]; then
cp -r -p ${DORIS_HOME}/conf/fe.conf ${DORIS_OUTPUT}/fe/conf/
rm -rf ${DORIS_OUTPUT}/fe/lib/*
cp -r -p ${DORIS_HOME}/fe/fe-core/target/lib/* ${DORIS_OUTPUT}/fe/lib/
- cp -r -p ${DORIS_HOME}/fe/fe-core/target/palo-fe.jar ${DORIS_OUTPUT}/fe/lib/
+ rm -f ${DORIS_OUTPUT}/fe/lib/palo-fe.jar
+ cp -r -p ${DORIS_HOME}/fe/fe-core/target/doris-fe.jar ${DORIS_OUTPUT}/fe/lib/
cp -r -p ${DORIS_HOME}/docs/build/help-resource.zip ${DORIS_OUTPUT}/fe/lib/
cp -r -p ${DORIS_HOME}/webroot/static ${DORIS_OUTPUT}/fe/webroot/
@@ -396,7 +397,9 @@ if [ ${BUILD_BE} -eq 1 ]; then
cp -r -p ${DORIS_HOME}/be/output/bin/* ${DORIS_OUTPUT}/be/bin/
cp -r -p ${DORIS_HOME}/be/output/conf/* ${DORIS_OUTPUT}/be/conf/
- cp -r -p ${DORIS_HOME}/be/output/lib/palo_be ${DORIS_OUTPUT}/be/lib/
+ cp -r -p ${DORIS_HOME}/be/output/lib/doris_be ${DORIS_OUTPUT}/be/lib/
+ # make a soft link palo_be point to doris_be, for forward compatibility
+ cd ${DORIS_OUTPUT}/be/lib && rm palo_be && ln -s doris_be palo_be && cd -
if [ "${BUILD_META_TOOL}" = "ON" ]; then
cp -r -p ${DORIS_HOME}/be/output/lib/meta_tool ${DORIS_OUTPUT}/be/lib/
@@ -417,8 +420,6 @@ if [ ${BUILD_BE} -eq 1 ]; then
cp -r -p ${DORIS_THIRDPARTY}/installed/webroot/* ${DORIS_OUTPUT}/be/www/
mkdir -p ${DORIS_OUTPUT}/be/log
mkdir -p ${DORIS_OUTPUT}/be/storage
-
-
fi
if [ ${BUILD_BROKER} -eq 1 ]; then
diff --git a/docs/.vuepress/sidebar/en/developer.js b/docs/.vuepress/sidebar/en/developer.js
index 3751036569..59318b64ce 100644
--- a/docs/.vuepress/sidebar/en/developer.js
+++ b/docs/.vuepress/sidebar/en/developer.js
@@ -42,9 +42,8 @@ module.exports = [
"cpp-format-code",
"cpp-diagnostic-code",
"how-to-share-blogs",
- "minidump",
"bitmap-hll-file-format",
"github-checks"
],
},
-]
\ No newline at end of file
+]
diff --git a/docs/.vuepress/sidebar/zh-CN/developer.js b/docs/.vuepress/sidebar/zh-CN/developer.js
index 26f40cd398..d9d94c1126 100644
--- a/docs/.vuepress/sidebar/zh-CN/developer.js
+++ b/docs/.vuepress/sidebar/zh-CN/developer.js
@@ -43,10 +43,9 @@ module.exports = [
"cpp-format-code",
"cpp-diagnostic-code",
"how-to-share-blogs",
- "minidump",
"bitmap-hll-file-format",
"regression-testing",
"github-checks"
],
},
-]
\ No newline at end of file
+]
diff --git a/docs/en/developer/developer-guide/be-vscode-dev.md b/docs/en/developer/developer-guide/be-vscode-dev.md
index 89cb3b5189..f6875c6b99 100644
--- a/docs/en/developer/developer-guide/be-vscode-dev.md
+++ b/docs/en/developer/developer-guide/be-vscode-dev.md
@@ -30,6 +30,8 @@ under the License.
**This tutorial was conducted under Ubuntu 20.04**
+**The name of the BE binary that appears in this doc is `doris_be`, which was `palo_be` in previous versions.**
+
1. Download the doris source code
URL：[apache/doris: Apache Doris (github.com)](https://github.com/apache/doris)
@@ -94,10 +96,10 @@ If nothing happens, the compilation should be successful, and the final deployme
1. Authorize be compilation result files
```
-chmod /home/workspace/doris/output/be/lib/palo_be
+chmod /home/workspace/doris/output/be/lib/doris_be
```
-Note: /home/workspace/doris/output/be/lib/palo_be is the executable file of be.
+Note: /home/workspace/doris/output/be/lib/doris_be is the executable file of be.
2. Create a data storage directory
@@ -148,7 +150,7 @@ mkdir -p /soft/be/storage
"name": "(gdb) Launch",
"type": "cppdbg",
"request": "launch",
- "program": "/home/workspace/doris/output/be/lib/palo_be",
+ "program": "/home/workspace/doris/output/be/lib/doris_be",
"args": [],
"stopAtEntry": false,
"cwd": "/home/workspace/doris/",
@@ -171,7 +173,7 @@ mkdir -p /soft/be/storage
}
```
-Among them, environment defines several environment variables DORIS_HOME UDF_RUNTIME_DIR LOG_DIR PID_DIR, which are the environment variables needed when palo_be is running. If it is not set, the startup will fail
+Among them, environment defines several environment variables DORIS_HOME UDF_RUNTIME_DIR LOG_DIR PID_DIR, which are the environment variables needed when doris_be is running. If it is not set, the startup will fail
**Note: If you want attach (additional process) debugging, the configuration code is as follows:**
@@ -183,7 +185,7 @@ Among them, environment defines several environment variables DORIS_HOME UDF_RUN
"name": "(gdb) Launch",
"type": "cppdbg",
"request": "attach",
- "program": "/home/workspace/doris/output/lib/palo_be",
+ "program": "/home/workspace/doris/output/lib/doris_be",
"processId":,
"MIMode": "gdb",
"internalConsoleOptions":"openOnSessionStart",
@@ -221,7 +223,7 @@ An example of a complete launch.json is as follows:
"name": "(gdb) Attach",
"type": "cppdbg",
"request": "attach",
- "program": "/home/workspace/doris/output/be/lib/palo_be",
+ "program": "/home/workspace/doris/output/be/lib/doris_be",
"processId": 17016,
"MIMode": "gdb",
"setupCommands": [
@@ -236,7 +238,7 @@ An example of a complete launch.json is as follows:
"name": "(gdb) Launch",
"type": "cppdbg",
"request": "launch",
- "program": "/home/workspace/doris/output/be/lib/palo_be",
+ "program": "/home/workspace/doris/output/be/lib/doris_be",
"args": [],
"stopAtEntry": false,
"cwd": "/home/workspace/doris/output/be",
diff --git a/docs/en/developer/developer-guide/debug-tool.md b/docs/en/developer/developer-guide/debug-tool.md
index f5f55a39a1..4e7f50e9ba 100644
--- a/docs/en/developer/developer-guide/debug-tool.md
+++ b/docs/en/developer/developer-guide/debug-tool.md
@@ -28,6 +28,8 @@ under the License.
In the process of using and developing Doris, we often encounter scenarios that need to debug Doris. Here are some common debugging tools.
+**The name of the BE binary that appears in this doc is `doris_be`, which was `palo_be` in previous versions.**
+
## FE debugging
Fe is a java process. Here are just a few simple and commonly used java debugging commands.
@@ -111,7 +113,7 @@ tcmalloc: large alloc 1396277248 bytes == 0x3f3488000 @ 0x2af6f63 0x2c4095b 0x1
This indicates that Doris be is trying to apply memory of '1396277248 bytes' on this stack. We can use the 'addr2line' command to restore the stack to a letter that we can understand. The specific example is shown below.
```
-$ addr2line -e lib/palo_be 0x2af6f63 0x2c4095b 0x134d278 0x134bdcb 0x133d105 0x133d1d0 0x19930ed
+$ addr2line -e lib/doris_be 0x2af6f63 0x2c4095b 0x134d278 0x134bdcb 0x133d105 0x133d1d0 0x19930ed
/home/ssd0/zc/palo/doris/core/thirdparty/src/gperftools-gperftools-2.7/src/tcmalloc.cc:1335
/home/ssd0/zc/palo/doris/core/thirdparty/src/gperftools-gperftools-2.7/src/tcmalloc.cc:1357
@@ -136,9 +138,9 @@ export HEAPPROFILE=/tmp/doris_be.hprof
In this way, when the dump condition of the heapprofile is met, the overall memory usage will be written to the file in the specified path. Later, we can use the 'pprof' tool to analyze the output content.
```
-$ pprof --text lib/palo_be /tmp/doris_be.hprof.0012.heap | head -30
+$ pprof --text lib/doris_be /tmp/doris_be.hprof.0012.heap | head -30
-Using local file lib/palo_be.
+Using local file lib/doris_be.
Using local file /tmp/doris_be.hprof.0012.heap.
Total: 668.6 MB
610.6 91.3% 91.3% 610.6 91.3% doris::SystemAllocator::allocate_via_malloc (inline)
@@ -164,7 +166,7 @@ Contents of each column of the above documents:
Of course, it can also generate call relation pictures, which is more convenient for analysis. For example, the following command can generate a call graph in SVG format.
```
-pprof --svg lib/palo_be /tmp/doris_be.hprof.0012.heap > heap.svg
+pprof --svg lib/doris_be /tmp/doris_be.hprof.0012.heap > heap.svg
```
**NOTE: turning on this option will affect the execution performance of the program. Please be careful to turn on the online instance.**
@@ -260,7 +262,7 @@ WRITE of size 1 at 0x61900008bf80 thread T0
#0 0x129f569 in doris::StorageEngine::open(doris::EngineOptions const&, doris::StorageEngine**) /home/ssd0/zc/palo/doris/core/be/src/olap/storage_engine.cpp:106
#1 0xe2c1e3 in main /home/ssd0/zc/palo/doris/core/be/src/service/doris_main.cpp:159
#2 0x7fa5580fbbd4 in __libc_start_main (/opt/compiler/gcc-4.8.2/lib64/libc.so.6+0x21bd4)
- #3 0xd30794 (/home/ssd0/zc/palo/doris/core/output3/be/lib/palo_be+0xd30794)
+ #3 0xd30794 (/home/ssd0/zc/palo/doris/core/output3/be/lib/doris_be+0xd30794)
0x61900008bf80 is located 0 bytes to the right of 1024-byte region [0x61900008bb80,0x61900008bf80)
allocated by thread T0 here:
diff --git a/docs/en/developer/developer-guide/minidump.md b/docs/en/developer/developer-guide/minidump.md
index 47468ebd99..1203b753a2 100644
--- a/docs/en/developer/developer-guide/minidump.md
+++ b/docs/en/developer/developer-guide/minidump.md
@@ -123,39 +123,39 @@ We can use the following two methods to analyze Minidump files.
Then we can use the gdb tool to analyze the coredump file:
```
- gdb lib/palo_be -c 1.coredump
+ gdb lib/doris_be -c 1.coredump
```
2. Generate a readable call stack
- The Minidump file only contains the address of the call stack, and we need to map these addresses to the actual function file location. Therefore, we first need to generate the symbol table `palo_be.sym` of the BE binary file through `dump_syms`:
+ The Minidump file only contains the address of the call stack, and we need to map these addresses to the actual function file location. Therefore, we first need to generate the symbol table `doris_be.sym` of the BE binary file through `dump_syms`:
```
- ./dump_syms ./lib/palo_be> palo_be.sym
+ ./dump_syms ./lib/doris_be> doris_be.sym
```
Next, we need the information in the first row of the symbol table to build a corresponding symbol table directory.
```
- head -n1 palo_be.sym
+ head -n1 doris_be.sym
```
- The above command will print the first line of palo_be.sym as follows:
+ The above command will print the first line of doris_be.sym as follows:
```
- MODULE Linux x86_64 137706CC745F5EC3EABBF730D4B229370 palo_be
+ MODULE Linux x86_64 137706CC745F5EC3EABBF730D4B229370 doris_be
```
Then we create a directory structure:
```
- mkdir -p ./symbols/palo_be/137706CC745F5EC3EABBF730D4B229370
+ mkdir -p ./symbols/doris_be/137706CC745F5EC3EABBF730D4B229370
```
- The `palo_be` and `137706CC745F5EC3EABBF730D4B229370` in the directory path must be consistent with the first line of the palo_be.sym file. Then we move the palo_be.sym file to this directory:
+ The `doris_be` and `137706CC745F5EC3EABBF730D4B229370` in the directory path must be consistent with the first line of the doris_be.sym file. Then we move the doris_be.sym file to this directory:
```
- cp palo_be.sym ./symbols/palo_be/137706CC745F5EC3EABBF730D4B229370
+ cp doris_be.sym ./symbols/doris_be/137706CC745F5EC3EABBF730D4B229370
```
Finally, we can use `minidump_stackwalk` to produce readable call stack information:
@@ -164,7 +164,7 @@ We can use the following two methods to analyze Minidump files.
minidump_stackwalk 4f8d4fe5-15f8-40a3-843109b3-d49993f3.dmp ./symbols/> readable.stack
```
- Among them, `4f8d4fe5-15f8-40a3-843109b3-d49993f3.dmp` is a minidump file. `./symbols/` is the previously created directory containing palo_be.sym. `readable.stack` redirects the generated results to this file. At the same time, when this command is executed, some program running logs will be flashed on the screen, so you can ignore it.
+ Among them, `4f8d4fe5-15f8-40a3-843109b3-d49993f3.dmp` is a minidump file. `./symbols/` is the previously created directory containing doris_be.sym. `readable.stack` redirects the generated results to this file. At the same time, when this command is executed, some program running logs will be flashed on the screen, so you can ignore it.
At this point, we have obtained a readable thread call stack file: readable.stack. It contains the call stack information of all threads when the BE program is writing the Minidump file, and the corresponding register information. Among them, `Crash reason` explains why the program crashed. If it is `DUMP_REQUESTED`, it means that this is a Minidump triggered by the user.
@@ -174,4 +174,4 @@ We can use the following two methods to analyze Minidump files.
grep -v = readable.stack |grep -v "Found by" |vi-
```
- The result is similar to the thread call stack information obtained through the pstack command.
\ No newline at end of file
+ The result is similar to the thread call stack information obtained through the pstack command.
diff --git a/docs/en/docs/admin-manual/cluster-management/upgrade.md b/docs/en/docs/admin-manual/cluster-management/upgrade.md
index b479a2a150..a521bbdfd0 100644
--- a/docs/en/docs/admin-manual/cluster-management/upgrade.md
+++ b/docs/en/docs/admin-manual/cluster-management/upgrade.md
@@ -29,9 +29,11 @@ under the License.
Doris can upgrade smoothly by rolling upgrades. The following steps are recommended for security upgrade.
+**The name of the BE binary that appears in this doc is `doris_be`, which was `palo_be` in previous versions.**
+
> **Note:**
> 1. Doris does not support upgrading across two-digit version numbers, for example: you cannot upgrade directly from 0.13 to 0.15, only through 0.13.x -> 0.14.x -> 0.15.x, and the three-digit version number can be upgraded across versions, such as from 0.13 .15 can be directly upgraded to 0.14.13.1, it is not necessary to upgrade 0.14.7 or 0.14.12.1
-> 1. The following approaches are based on highly available deployments. That is, data 3 replicas, FE high availability.
+> 2. The following approaches are based on highly available deployments. That is, data 3 replicas, FE high availability.
## Preparen
@@ -56,9 +58,9 @@ Doris can upgrade smoothly by rolling upgrades. The following steps are recommen
## Test the correctness of BE upgrade
-1. Arbitrarily select a BE node and deploy the latest palo_be binary file.
+1. Arbitrarily select a BE node and deploy the latest doris_be binary file.
2. Restart the BE node and check the BE log be.INFO to see if the boot was successful.
-3. If the startup fails, you can check the reason first. If the error is not recoverable, you can delete the BE directly through DROP BACKEND, clean up the data, and restart the BE using the previous version of palo_be. Then re-ADD BACKEND. (**This method will result in the loss of a copy of the data, please make sure that three copies are complete, and perform this operation!!!**
+3. If the startup fails, you can check the reason first. If the error is not recoverable, you can delete the BE directly through DROP BACKEND, clean up the data, and restart the BE using the previous version of doris_be. Then re-ADD BACKEND. (**This method will result in the loss of a copy of the data, please make sure that three copies are complete, and perform this operation!!!**
## Testing FE Metadata Compatibility
@@ -77,7 +79,7 @@ Doris can upgrade smoothly by rolling upgrades. The following steps are recommen
## Upgrade preparation
1. After data validation, the new version of BE and FE binary files are distributed to their respective directories.
-2. Usually small version upgrade, BE only needs to upgrade palo_be; FE only needs to upgrade palo-fe.jar. If it is a large version upgrade, you may need to upgrade other files (including but not limited to bin / lib / etc.) If you are not sure whether you need to replace other files, it is recommended to replace all of them.
+2. Usually small version upgrade, BE only needs to upgrade doris_be; FE only needs to upgrade palo-fe.jar. If it is a large version upgrade, you may need to upgrade other files (including but not limited to bin / lib / etc.) If you are not sure whether you need to replace other files, it is recommended to replace all of them.
## rolling upgrade
diff --git a/docs/en/docs/faq/install-faq.md b/docs/en/docs/faq/install-faq.md
index 0c291f40a7..fcc98aa567 100644
--- a/docs/en/docs/faq/install-faq.md
+++ b/docs/en/docs/faq/install-faq.md
@@ -28,6 +28,8 @@ under the License.
This document is mainly used to record the common problems of operation and maintenance during the use of Doris. It will be updated from time to time.
+**The name of the BE binary that appears in this doc is `doris_be`, which was `palo_be` in previous versions.**
+
### Q1. Why is there always some tablet left when I log off the BE node through DECOMMISSION?
During the offline process, use show backends to view the tabletNum of the offline node, and you will observe that the number of tabletNum is decreasing, indicating that data shards are being migrated from this node. When the number is reduced to 0, the system will automatically delete the node. But in some cases, tabletNum will not change after it drops to a certain value. This is usually possible for two reasons:
@@ -145,7 +147,7 @@ In many cases, we need to troubleshoot problems through logs. The format and vie
2. dmesg
- If there is no stack information in be.out, the probability is that OOM was forcibly killed by the system. At this time, you can use the dmesg -T command to view the Linux system log. If a log similar to Memory cgroup out of memory: Kill process 7187 (palo_be) score 1007 or sacrifice child appears at the end, it means that it is caused by OOM.
+ If there is no stack information in be.out, the probability is that OOM was forcibly killed by the system. At this time, you can use the dmesg -T command to view the Linux system log. If a log similar to Memory cgroup out of memory: Kill process 7187 (doris_be) score 1007 or sacrifice child appears at the end, it means that it is caused by OOM.
Memory problems can have many reasons, such as large queries, imports, compactions, etc. Doris is also constantly optimizing memory usage. Welcome to the WeChat group, github discussion or dev mail group for help.
diff --git a/docs/zh-CN/developer/developer-guide/be-vscode-dev.md b/docs/zh-CN/developer/developer-guide/be-vscode-dev.md
index 5a6430dc7f..763c64a3f6 100644
--- a/docs/zh-CN/developer/developer-guide/be-vscode-dev.md
+++ b/docs/zh-CN/developer/developer-guide/be-vscode-dev.md
@@ -31,6 +31,8 @@ under the License.
**本教程是在 Ubuntu 20.04 下进行的**
+**文中的出现的BE二进制文件名称 `doris_be`，在之前的版本中为 `palo_be`。**
+
1. 下载 doris 源代码
下载地址为：[apache/doris: Apache Doris (github.com)](https://github.com/apache/doris)
@@ -97,10 +99,10 @@ cd /home/workspace/doris
1. 给be编译结果文件授权
```
-chmod /home/workspace/doris/output/be/lib/palo_be
+chmod /home/workspace/doris/output/be/lib/doris_be
```
-注意： /home/workspace/doris/output/be/lib/palo_be为be的执行文件。
+注意： /home/workspace/doris/output/be/lib/doris_be为be的执行文件。
2. 创建数据存放目录
@@ -151,7 +153,7 @@ mkdir -p /soft/be/storage
"name": "(gdb) Launch",
"type": "cppdbg",
"request": "launch",
- "program": "/home/workspace/doris/output/be/lib/palo_be",
+ "program": "/home/workspace/doris/output/be/lib/doris_be",
"args": [],
"stopAtEntry": false,
"cwd": "/home/workspace/doris/",
@@ -174,7 +176,7 @@ mkdir -p /soft/be/storage
}
```
-其中，environment 定义了几个环境变量 DORIS_HOME UDF_RUNTIME_DIR LOG_DIR PID_DIR，这是 palo_be 运行时需要的环境变量，如果没有设置，启动会失败。
+其中，environment 定义了几个环境变量 DORIS_HOME UDF_RUNTIME_DIR LOG_DIR PID_DIR，这是 doris_be 运行时需要的环境变量，如果没有设置，启动会失败。
**注意：如果希望是attach(附加进程）调试，配置代码如下：**
@@ -186,7 +188,7 @@ mkdir -p /soft/be/storage
"name": "(gdb) Launch",
"type": "cppdbg",
"request": "attach",
- "program": "/home/workspace/doris/output/lib/palo_be",
+ "program": "/home/workspace/doris/output/lib/doris_be",
"processId":,
"MIMode": "gdb",
"internalConsoleOptions":"openOnSessionStart",
@@ -224,7 +226,7 @@ ps -ef | grep palo*
"name": "(gdb) Attach",
"type": "cppdbg",
"request": "attach",
- "program": "/home/workspace/doris/output/be/lib/palo_be",
+ "program": "/home/workspace/doris/output/be/lib/doris_be",
"processId": 17016,
"MIMode": "gdb",
"setupCommands": [
@@ -239,7 +241,7 @@ ps -ef | grep palo*
"name": "(gdb) Launch",
"type": "cppdbg",
"request": "launch",
- "program": "/home/workspace/doris/output/be/lib/palo_be",
+ "program": "/home/workspace/doris/output/be/lib/doris_be",
"args": [],
"stopAtEntry": false,
"cwd": "/home/workspace/doris/output/be",
diff --git a/docs/zh-CN/developer/developer-guide/debug-tool.md b/docs/zh-CN/developer/developer-guide/debug-tool.md
index 921b6b27a6..bf56879c28 100644
--- a/docs/zh-CN/developer/developer-guide/debug-tool.md
+++ b/docs/zh-CN/developer/developer-guide/debug-tool.md
@@ -28,6 +28,8 @@ under the License.
在Doris的使用、开发过程中，经常会遇到需要对Doris进行调试的场景，这里介绍一些常用的调试工具。
+**文中的出现的BE二进制文件名称 `doris_be`，在之前的版本中为 `palo_be`。**
+
## FE 调试
FE 是 Java 进程。这里只列举一下简单常用的 java 调试命令。
@@ -112,7 +114,7 @@ tcmalloc: large alloc 1396277248 bytes == 0x3f3488000 @ 0x2af6f63 0x2c4095b 0x1
这个表示在Doris BE在这个堆栈上尝试申请`1396277248 bytes`的内存。我们可以通过`addr2line`命令去把堆栈还原成我们能够看懂的信，具体的例子如下所示。
```
-$ addr2line -e lib/palo_be 0x2af6f63 0x2c4095b 0x134d278 0x134bdcb 0x133d105 0x133d1d0 0x19930ed
+$ addr2line -e lib/doris_be 0x2af6f63 0x2c4095b 0x134d278 0x134bdcb 0x133d105 0x133d1d0 0x19930ed
/home/ssd0/zc/palo/doris/core/thirdparty/src/gperftools-gperftools-2.7/src/tcmalloc.cc:1335
/home/ssd0/zc/palo/doris/core/thirdparty/src/gperftools-gperftools-2.7/src/tcmalloc.cc:1357
@@ -137,9 +139,9 @@ export HEAPPROFILE=/tmp/doris_be.hprof
这样，当满足HEAPPROFILE的dump条件时，就会将内存的整体使用情况写到指定路径的文件中。后续我们就可以通过使用`pprof`工具来对输出的内容进行分析。
```
-$ pprof --text lib/palo_be /tmp/doris_be.hprof.0012.heap | head -30
+$ pprof --text lib/doris_be /tmp/doris_be.hprof.0012.heap | head -30
-Using local file lib/palo_be.
+Using local file lib/doris_be.
Using local file /tmp/doris_be.hprof.0012.heap.
Total: 668.6 MB
610.6 91.3% 91.3% 610.6 91.3% doris::SystemAllocator::allocate_via_malloc (inline)
@@ -165,7 +167,7 @@ Total: 668.6 MB
当然也可以生成调用关系图片，更加方便分析。比如下面的命令就能够生成SVG格式的调用关系图。
```
-pprof --svg lib/palo_be /tmp/doris_be.hprof.0012.heap > heap.svg
+pprof --svg lib/doris_be /tmp/doris_be.hprof.0012.heap > heap.svg
```
**注意：开启这个选项是要影响程序的执行性能的，请慎重对线上的实例开启**
@@ -261,7 +263,7 @@ WRITE of size 1 at 0x61900008bf80 thread T0
#0 0x129f569 in doris::StorageEngine::open(doris::EngineOptions const&, doris::StorageEngine**) /home/ssd0/zc/palo/doris/core/be/src/olap/storage_engine.cpp:106
#1 0xe2c1e3 in main /home/ssd0/zc/palo/doris/core/be/src/service/doris_main.cpp:159
#2 0x7fa5580fbbd4 in __libc_start_main (/opt/compiler/gcc-4.8.2/lib64/libc.so.6+0x21bd4)
- #3 0xd30794 (/home/ssd0/zc/palo/doris/core/output3/be/lib/palo_be+0xd30794)
+ #3 0xd30794 (/home/ssd0/zc/palo/doris/core/output3/be/lib/doris_be+0xd30794)
0x61900008bf80 is located 0 bytes to the right of 1024-byte region [0x61900008bb80,0x61900008bf80)
allocated by thread T0 here:
diff --git a/docs/zh-CN/developer/developer-guide/minidump.md b/docs/zh-CN/developer/developer-guide/minidump.md
index ca71bc45b5..dd15d8d7e9 100644
--- a/docs/zh-CN/developer/developer-guide/minidump.md
+++ b/docs/zh-CN/developer/developer-guide/minidump.md
@@ -123,39 +123,39 @@ Minidump 的生成有两种方式：
之后我们可以使用 gdb 工具来分析这个 coredump 文件了：
```
- gdb lib/palo_be -c 1.coredump
+ gdb lib/doris_be -c 1.coredump
```
2. 生成可读调用栈
- Minidump 文件中只包含调用栈的地址，我们需要把这些地址对应到实际的函数文件位置。因此，我们首先需要通过 `dump_syms ` 生成 BE 二进制文件的符号表 `palo_be.sym`：
+ Minidump 文件中只包含调用栈的地址，我们需要把这些地址对应到实际的函数文件位置。因此，我们首先需要通过 `dump_syms ` 生成 BE 二进制文件的符号表 `doris_be.sym`：
```
- ./dump_syms ./lib/palo_be > palo_be.sym
+ ./dump_syms ./lib/doris_be > doris_be.sym
```
接下来，我们需要符号表第一行的信息，构建一个对应的符号表目录。
```
- head -n1 palo_be.sym
+ head -n1 doris_be.sym
```
- 以上命令会打印 palo_be.sym 的第一行内容如下：
+ 以上命令会打印 doris_be.sym 的第一行内容如下：
```
- MODULE Linux x86_64 137706CC745F5EC3EABBF730D4B229370 palo_be
+ MODULE Linux x86_64 137706CC745F5EC3EABBF730D4B229370 doris_be
```
之后我们创建一个目录结构：
```
- mkdir -p ./symbols/palo_be/137706CC745F5EC3EABBF730D4B229370
+ mkdir -p ./symbols/doris_be/137706CC745F5EC3EABBF730D4B229370
```
- 目录路径中的 `palo_be` 和 `137706CC745F5EC3EABBF730D4B229370` 需和 palo_be.sym 文件的第一行内容一致。然后我们将 palo_be.sym 文件移动到该目录中：
+ 目录路径中的 `doris_be` 和 `137706CC745F5EC3EABBF730D4B229370` 需和 doris_be.sym 文件的第一行内容一致。然后我们将 doris_be.sym 文件移动到该目录中：
```
- cp palo_be.sym ./symbols/palo_be/137706CC745F5EC3EABBF730D4B229370
+ cp doris_be.sym ./symbols/doris_be/137706CC745F5EC3EABBF730D4B229370
```
最后，我们可以使用 `minidump_stackwalk` 来产出可读的调用栈信息：
@@ -164,7 +164,7 @@ Minidump 的生成有两种方式：
minidump_stackwalk 4f8d4fe5-15f8-40a3-843109b3-d49993f3.dmp ./symbols/ > readable.stack
```
- 其中 `4f8d4fe5-15f8-40a3-843109b3-d49993f3.dmp` 为 minidump 文件。`./symbols/` 为之前创建的包含 palo_be.sym 的目录。`readable.stack` 是将生成的结果重定向到这个文件中。同时，在执行这个命令时，屏幕上也会刷一些程序运行日志，可以不用理会。
+ 其中 `4f8d4fe5-15f8-40a3-843109b3-d49993f3.dmp` 为 minidump 文件。`./symbols/` 为之前创建的包含 doris_be.sym 的目录。`readable.stack` 是将生成的结果重定向到这个文件中。同时，在执行这个命令时，屏幕上也会刷一些程序运行日志，可以不用理会。
至此，我们就获取了一个可读的线程调用栈文件：readable.stack。其中包含了 BE 程序在写 Minidump 文件时的所有线程的调用栈信息，以及对应的寄存器信息。
diff --git a/docs/zh-CN/docs/admin-manual/cluster-management/upgrade.md b/docs/zh-CN/docs/admin-manual/cluster-management/upgrade.md
index ae10f1062e..c586622d78 100644
--- a/docs/zh-CN/docs/admin-manual/cluster-management/upgrade.md
+++ b/docs/zh-CN/docs/admin-manual/cluster-management/upgrade.md
@@ -28,6 +28,8 @@ under the License.
Doris 可以通过滚动升级的方式，平滑进行升级。建议按照以下步骤进行安全升级。
+**文中的出现的BE二进制文件名称 `doris_be`，在之前的版本中为 `palo_be`。**
+
> **注：**
>
> 1. Doris不支持跨两位版本号进行升级，例如：不能从0.13直接升级到0.15，只能通过0.13.x -> 0.14.x -> 0.15.x，三位版本号可以跨版本升级，比如从0.13.15可以直接升级到0.14.13.1，不必一定要升级0.14.7 或者 0.14.12.1这种版本
@@ -56,9 +58,9 @@ Doris 可以通过滚动升级的方式，平滑进行升级。建议按照以
## 测试 BE 升级正确性
-1. 任意选择一个 BE 节点，部署最新的 palo_be 二进制文件。
+1. 任意选择一个 BE 节点，部署最新的 doris_be 二进制文件。
2. 重启 BE 节点，通过 BE 日志 be.INFO，查看是否启动成功。
-3. 如果启动失败，可以先排查原因。如果错误不可恢复，可以直接通过 DROP BACKEND 删除该 BE、清理数据后，使用上一个版本的 palo_be 重新启动 BE。然后重新 ADD BACKEND。（**该方法会导致丢失一个数据副本，请务必确保3副本完整的情况下，执行这个操作！！！**）
+3. 如果启动失败，可以先排查原因。如果错误不可恢复，可以直接通过 DROP BACKEND 删除该 BE、清理数据后，使用上一个版本的 doris_be 重新启动 BE。然后重新 ADD BACKEND。（**该方法会导致丢失一个数据副本，请务必确保3副本完整的情况下，执行这个操作！！！**）
## 测试 FE 元数据兼容性
@@ -77,7 +79,7 @@ Doris 可以通过滚动升级的方式，平滑进行升级。建议按照以
## 升级准备
1. 在完成数据正确性验证后，将 BE 和 FE 新版本的二进制文件分发到各自目录下。
-2. 通常小版本升级，BE 只需升级 palo_be；而 FE 只需升级 palo-fe.jar。如果是大版本升级，则可能需要升级其他文件（包括但不限于 bin/ lib/ 等等）如果你不清楚是否需要替换其他文件，建议全部替换。
+2. 通常小版本升级，BE 只需升级 doris_be；而 FE 只需升级 palo-fe.jar。如果是大版本升级，则可能需要升级其他文件（包括但不限于 bin/ lib/ 等等）如果你不清楚是否需要替换其他文件，建议全部替换。
## 滚动升级
diff --git a/docs/zh-CN/docs/faq/install-faq.md b/docs/zh-CN/docs/faq/install-faq.md
index 27d848937a..f1e688ddf6 100644
--- a/docs/zh-CN/docs/faq/install-faq.md
+++ b/docs/zh-CN/docs/faq/install-faq.md
@@ -28,6 +28,8 @@ under the License.
本文档主要用于记录 Doris 使用过程中的运维常见问题。会不定期更新。
+**文中的出现的BE二进制文件名称 `doris_be`，在之前的版本中为 `palo_be`。**
+
### Q1. 通过 DECOMMISSION 下线BE节点时，为什么总会有部分tablet残留？
在下线过程中，通过 show backends 查看下线节点的 tabletNum ，会观察到 tabletNum 数量在减少，说明数据分片正在从这个节点迁移走。当数量减到0时，系统会自动删除这个节点。但某些情况下，tabletNum 下降到一定数值后就不变化。这通常可能有以下两种原因：
@@ -145,7 +147,7 @@ Observer 角色和这个单词的含义一样，仅仅作为观察者来同步
2. dmesg
- 如果be.out没有堆栈信息，则大概率是因为OOM被系统强制kill掉了。此时可以通过dmesg -T 这个命令查看linux系统日志，如果最后出现 Memory cgroup out of memory: Kill process 7187 (palo_be) score 1007 or sacrifice child 类似的日志，则说明是OOM导致的。
+ 如果be.out没有堆栈信息，则大概率是因为OOM被系统强制kill掉了。此时可以通过dmesg -T 这个命令查看linux系统日志，如果最后出现 Memory cgroup out of memory: Kill process 7187 (doris_be) score 1007 or sacrifice child 类似的日志，则说明是OOM导致的。
内存问题可能有多方面原因，如大查询、导入、compaction等。Doris也在不断优化内存使用。欢迎前往微信群、github discussion 或dev邮件组寻求帮助。
@@ -153,10 +155,6 @@ Observer 角色和这个单词的含义一样，仅仅作为观察者来同步
F开头的日志是 Fatal 日志。如 F0916 ，表示9月16号的Fatal日志。Fatal日志通常表示程序断言错误，断言错误会直接导致进程退出（说明程序出现了Bug）。欢迎前往微信群、github discussion 或dev邮件组寻求帮助。
- 4. Minidump(removed)
-
- Mindump 是 Doris 0.15 版本之后加入的功能，具体可参阅[文档](https://doris.apache.org/zh-CN/developer-guide/minidump.html)。
-
2. FE
FE 是 java 进程，健壮程度要由于 C/C++ 程序。通常FE 挂掉的原因可能是 OOM（Out-of-Memory）或者是元数据写入失败。这些错误通常在 fe.log 或者 fe.out 中有错误堆栈。需要根据错误堆栈信息进一步排查。
diff --git a/fe/fe-core/pom.xml b/fe/fe-core/pom.xml
index 98eb139d05..0fd782241f 100644
--- a/fe/fe-core/pom.xml
+++ b/fe/fe-core/pom.xml
@@ -651,7 +651,7 @@ under the License.
</dependencies>
<build>
- <finalName>palo-fe</finalName>
+ <finalName>doris-fe</finalName>
<plugins>
<!--jcup-->
<plugin>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org