Call Stack Recording Functions¶

The pv_memory_profiling(type int) and environment variable MALLOC_CONF are used by GaussDB(DWS) to control the enabling and disabling of the memory allocation call stack recording module and the output of the memory call stack. The following figure illustrates the process.

MALLOC_CONF¶

The environment variable MALLOC_CONF is used to enable the monitoring module. It is in the ${BIGDATA_HOME}/mppdb/.mppdbgs_profile file and is enabled by default. Note the following points:

Restart the database after modifying this environment variable.
If om_monitor is enabled in the cluster, restart the om_monitor process and then the database after setting this environment variable, so that the setting can take effect.
This environment variable can be set on all servers in the cluster or on some servers where the module needs to be enabled. For the GaussDB process, each process determines whether to enable the module based on the MALLOC_CONF environment variable.

Commands for enabling and disabling MALLOC_CONF:

Enabling the monitoring module:
```
export MALLOC_CONF=prof:true
```
Disabling the monitoring module:
```
export MALLOC_CONF=prof:false
```

pv_memory_profiling (type int)¶

Parameter description: Controls the backtrace recording and output of memory allocation functions such as malloc in the kernel.

Value range: a positive integer from 0 to 3.

**Table 1** Values and descriptions of **pv_memory_profiling**¶
pv_memory_profiling Value	Description
0	Disables the memory trace function and does not record information of call stacks such as malloc.
1	Enables the memory trace function to record information of call stacks such as malloc.
2	Outputs trace logs of call stacks such as malloc. Output path: /proc/pid/cwd directory. pid indicates the ID of the GaussDB process. Output log name format: jeprof.<pid>.``.heap, where pid* indicates the ID of the GaussDB process and `` indicates the unique sequence number of the output trace log, for example, jeprof.195473.0.u0.heap*.
3	Outputs memory statistics. Output path: /proc/pid/cwd directory. pid indicates the ID of the GaussDB process. Log name format: Node name + Process ID + Time + heap_stats + .out. You can use vim to open the file.

Return type: Boolean

Note:

If the function is called successfully, true is returned. Otherwise, false is returned.
If Memory profiling failed, check if $MALLOC_CONF contain 'prof:true'. is displayed, it indicates that the module is used when MALLOC_CONF=prof:true is not set. In this case, you need to set the environment variable.
If Type %d is not supported. The valid range is 0-3. is displayed, the parameter value is incorrect. The correct values are 0, 1, 2, and 3.
If Memory profiling failed, inputed type is %d, failed number is %d. is displayed, contact technical support for assistance.

Outputting Memory Call Stack Information¶

Procedure:

Execute the following statement to output the memory call stack information and output the trace file in the directory where the GaussDB process is located:
```
select * from pv_memory_profiling(2);
```
Use the jeprof tool provided by jemalloc to parse log information.
Method 1: Output in text format.
```
jeprof --text --show_bytes $GAUSSHOME/bin/gaussdb trace file 1 >prof.txt
```
Method 2: Export the report in PDF format.
```
jeprof --pdf --show_bytes $GAUSSHOME/bin/gaussdb trace file 1 > prof.pdf
```
Note
- To parse the memory call stack information, you need to use the GaussDB source code for analysis. You need to send the trace file to R&D engineers for analysis.
- To analyze the trace file, you need to use the jeprof tool, which is generated by jemalloc. The Perl environment is required for using the tool. To generate PDF calling diagrams, you need to install the Graphviz tool that matches the OS.

Example¶

-- Log in as the system administrator, set environment variables, and start the database.
export MALLOC_CONF=prof:true

-- Disable the memory trace recording function when the database is running.
select pv_memory_profiling(0);
pv_memory_profiling
----------------------------
t
(1 row)

-- Enable the memory trace recording function when the database is running.
select pv_memory_profiling(1);
pv_memory_profiling
----------------------------
t
(1 row)

-- Output memory trace records.
select pv_memory_profiling(2);
pv_memory_profiling
----------------------------
t
(1 row)

-- Generate the trace file in text or PDF format in the directory where the GaussDB process is located.
jeprof --text --show_bytes $GAUSSHOME/bin/gaussdb trace file 1 >prof.txt
jeprof --pdf --show_bytes $GAUSSHOME/bin/gaussdb trace file 1 > prof.pdf

-- Output memory statistics.
Execute the following statement to generate the memory statistics file in the directory where the GaussDB process is located. The file can be directly read.
select pv_memory_profiling(3);
pv_memory_profiling
----------------------------
t
(1 row)

last updated: 2024-05-20 03:31