283 lines
8.6 KiB
Markdown
283 lines
8.6 KiB
Markdown
---
|
|
{
|
|
"title": "BE development and debugging environment under Linux",
|
|
"language": "en"
|
|
}
|
|
---
|
|
|
|
<!--
|
|
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.
|
|
-->
|
|
|
|
# Apache Doris Be development and debugging
|
|
|
|
## initial preparation work
|
|
|
|
**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)
|
|
|
|
2. Install GCC 8.3.1+, Oracle JDK 1.8+, Python 2.7+, confirm that the gcc, java, python commands point to the correct version, and set the JAVA_HOME environment variable
|
|
|
|
3. Install other dependent packages
|
|
|
|
```
|
|
sudo apt install build-essential openjdk-8-jdk maven cmake byacc flex automake libtool-bin bison binutils-dev libiberty-dev zip unzip libncurses5-dev curl git ninja-build python brotli
|
|
sudo add-apt-repository ppa:ubuntu-toolchain-r/ppa
|
|
sudo apt update
|
|
sudo apt install gcc-10 g++-10
|
|
sudo apt-get install autoconf automake libtool autopoint
|
|
```
|
|
|
|
4. install : libssl-dev
|
|
```
|
|
sudo apt install -y libssl-dev
|
|
```
|
|
|
|
## Compile
|
|
|
|
The following steps are carried out in the /home/workspace directory
|
|
|
|
1. dowload source
|
|
|
|
```
|
|
git clone https://github.com/apache/doris.git
|
|
```
|
|
|
|
2. Compile third-party dependency packages
|
|
|
|
```
|
|
cd /home/workspace/doris/thirdparty
|
|
./build-thirdparty.sh
|
|
```
|
|
|
|
3. Compile doris product code
|
|
|
|
```
|
|
cd /home/workspace/doris
|
|
./build.sh
|
|
```
|
|
|
|
Note: This compilation has the following instructions:
|
|
|
|
```shell
|
|
./build.sh #Compile be and fe at the same time
|
|
./build.sh --be #Only compile be
|
|
./build.sh --fe #Only compilefe
|
|
./build.sh --fe --be --clean#Delete and compile be fe at the same time
|
|
./build.sh --fe --clean#Delete and compile fe
|
|
./build.sh --be --clean#Delete and compile be
|
|
./build.sh --be --fe --clean#Delete and compile be fe at the same time
|
|
```
|
|
|
|
If nothing happens, the compilation should be successful, and the final deployment file will be output to the /home/workspace/doris/output/ directory. If you still encounter other problems, you can refer to the doris installation document http://doris.apache.org.
|
|
|
|
## Deployment and debugging
|
|
|
|
1. Authorize be compilation result files
|
|
|
|
```
|
|
chmod /home/workspace/doris/output/be/lib/doris_be
|
|
```
|
|
|
|
Note: /home/workspace/doris/output/be/lib/doris_be is the executable file of be.
|
|
|
|
2. Create a data storage directory
|
|
|
|
By viewing /home/workspace/doris/output/be/conf/be.conf
|
|
|
|
```
|
|
# INFO, WARNING, ERROR, FATAL
|
|
sys_log_level = INFO
|
|
be_port = 9060
|
|
be_rpc_port = 9070
|
|
webserver_port = 8040
|
|
heartbeat_service_port = 9050
|
|
brpc_port = 8060
|
|
|
|
# Note that there should at most one ip match this list.
|
|
# If no ip match this rule, will choose one randomly.
|
|
# use CIDR format, e.g. 10.10.10.0/
|
|
# Default value is empty.
|
|
priority_networks = 192.168.59.0/24 # data root path, separate by ';'
|
|
storage_root_path = /soft/be/storage
|
|
# sys_log_dir = ${PALO_HOME}/log
|
|
# sys_log_roll_mode = SIZE-MB-
|
|
# sys_log_roll_num =
|
|
# sys_log_verbose_modules =
|
|
# log_buffer_level = -
|
|
# palo_cgroups
|
|
```
|
|
|
|
Need to create this folder, this is where the be data is stored
|
|
|
|
```
|
|
mkdir -p /soft/be/storage
|
|
```
|
|
|
|
3. Open vscode, and open the directory where the be source code is located. In this case, open the directory as **/home/workspace/doris/**，For details on how to vscode, refer to the online tutorial
|
|
|
|
4. Install the vscode ms c++ debugging plug-in, the plug-in identified by the red box in the figure below
|
|
|
|
|
|
|
|
5. Create a launch.json file, the content of the file is as follows:
|
|
|
|
```
|
|
{
|
|
"version": "0.2.0",
|
|
"configurations": [
|
|
{
|
|
"name": "(gdb) Launch",
|
|
"type": "cppdbg",
|
|
"request": "launch",
|
|
"program": "/home/workspace/doris/output/be/lib/doris_be",
|
|
"args": [],
|
|
"stopAtEntry": false,
|
|
"cwd": "/home/workspace/doris/",
|
|
"environment": [{"name":"PALO_HOME","value":"/home/workspace/doris/output/be/"},
|
|
{"name":"UDF_RUNTIME_DIR","value":"/home/workspace/doris/output/be/lib/udf-runtime"},
|
|
{"name":"LOG_DIR","value":"/home/workspace/doris/output/be/log"},
|
|
{"name":"PID_DIR","value":"/home/workspace/doris/output/be/bin"}
|
|
],
|
|
"externalConsole": true,
|
|
"MIMode": "gdb",
|
|
"setupCommands": [
|
|
{
|
|
"description": "Enable pretty-printing for gdb",
|
|
"text": "-enable-pretty-printing",
|
|
"ignoreFailures": true
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
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:**
|
|
|
|
```
|
|
{
|
|
"version": "0.2.0",
|
|
"configurations": [
|
|
{
|
|
"name": "(gdb) Launch",
|
|
"type": "cppdbg",
|
|
"request": "attach",
|
|
"program": "/home/workspace/doris/output/lib/doris_be",
|
|
"processId":,
|
|
"MIMode": "gdb",
|
|
"internalConsoleOptions":"openOnSessionStart",
|
|
"setupCommands": [
|
|
{
|
|
"description": "Enable pretty-printing for gdb",
|
|
"text": "-enable-pretty-printing",
|
|
"ignoreFailures": true
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
In the configuration **"request": "attach", "processId": PID**, these two configurations are the key points: set the debug mode of gdb to attach and attach the processId of the process, otherwise it will fail. To find the process id, you can enter the following command in the command line:
|
|
|
|
```
|
|
ps -ef | grep palo*
|
|
```
|
|
|
|
As shown in the figure:
|
|
|
|
|
|
|
|
Among them, 15200 is the process id of the currently running be.
|
|
|
|
An example of a complete launch.json is as follows:
|
|
|
|
```
|
|
{
|
|
"version": "0.2.0",
|
|
"configurations": [
|
|
{
|
|
"name": "(gdb) Attach",
|
|
"type": "cppdbg",
|
|
"request": "attach",
|
|
"program": "/home/workspace/doris/output/be/lib/doris_be",
|
|
"processId": 17016,
|
|
"MIMode": "gdb",
|
|
"setupCommands": [
|
|
{
|
|
"description": "Enable pretty-printing for gdb",
|
|
"text": "-enable-pretty-printing",
|
|
"ignoreFailures": true
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"name": "(gdb) Launch",
|
|
"type": "cppdbg",
|
|
"request": "launch",
|
|
"program": "/home/workspace/doris/output/be/lib/doris_be",
|
|
"args": [],
|
|
"stopAtEntry": false,
|
|
"cwd": "/home/workspace/doris/output/be",
|
|
"environment": [
|
|
{
|
|
"name": "DORIS_HOME",
|
|
"value": "/home/workspace/doris/output/be"
|
|
},
|
|
{
|
|
"name": "UDF_RUNTIME_DIR",
|
|
"value": "/home/workspace/doris/output/be/lib/udf-runtime"
|
|
},
|
|
{
|
|
"name": "LOG_DIR",
|
|
"value": "/home/workspace/doris/output/be/log"
|
|
},
|
|
{
|
|
"name": "PID_DIR",
|
|
"value": "/home/workspace/doris/output/be/bin"
|
|
}
|
|
],
|
|
"externalConsole": false,
|
|
"MIMode": "gdb",
|
|
"setupCommands": [
|
|
{
|
|
"description": "Enable pretty-printing for gdb",
|
|
"text": "-enable-pretty-printing",
|
|
"ignoreFailures": true
|
|
}
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
6. Click to debug
|
|
|
|
You can start your debugging journey with the rest,
|
|
|
|
|
|
|