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.

Sign up for GitHub

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

feat(pprof): Supports both heap profiling and heap sampling #1684

Merged
merged 3 commits into from
Nov 20, 2023
Merged

feat(pprof): Supports both heap profiling and heap sampling #1684

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
45fba17
1
acelyc111 Nov 16, 2023
e9fb9e2
msg
acelyc111 Nov 16, 2023
0f17cbe
comments
acelyc111 Nov 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 60 additions & 21 deletions src/http/pprof_http_service.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,23 @@

namespace dsn {

bool check_TCMALLOC_SAMPLE_PARAMETER()
{
char *str = getenv("TCMALLOC_SAMPLE_PARAMETER");
if (str == nullptr) {
return false;
}
char *endptr;
int val = strtol(str, &endptr, 10);
return (*endptr == '\0' && val > 0);
}

bool has_TCMALLOC_SAMPLE_PARAMETER()
{
static bool val = check_TCMALLOC_SAMPLE_PARAMETER();
return val;
}

// //
// == ip:port/pprof/symbol == //
// //
Expand Down Expand Up @@ -345,31 +362,53 @@ void pprof_http_service::heap_handler(const http_request &req, http_response &re
resp.status_code = http_status_code::internal_server_error;
return;
}
auto cleanup = dsn::defer([this]() { _in_pprof_action.store(false); });

// If "seconds" parameter is specified with a valid value, use heap profiling,
// otherwise, use heap sampling.
bool use_heap_profile = false;
uint32_t seconds = 0;
const auto &iter = req.query_args.find("seconds");
if (iter != req.query_args.end() && buf2uint32(iter->second, seconds)) {
// This is true between calls to HeapProfilerStart() and HeapProfilerStop(), and
// also if the program has been run with HEAPPROFILER, or some other
// way to turn on whole-program profiling.
if (IsHeapProfilerRunning()) {
LOG_WARNING("heap profiling is running, dump the full profile directly");
char *profile = GetHeapProfile();
resp.status_code = http_status_code::ok;
resp.body = profile;
free(profile);
return;
}

const std::string SECOND = "seconds";
const uint32_t kDefaultSecond = 10;

// get seconds from query params, default value is `kDefaultSecond`
uint32_t seconds = kDefaultSecond;
const auto iter = req.query_args.find(SECOND);
if (iter != req.query_args.end()) {
const auto seconds_str = iter->second;
dsn::internal::buf2unsigned(seconds_str, seconds);
}

std::stringstream profile_name_prefix;
profile_name_prefix << "heap_profile." << getpid() << "." << dsn_now_ns();
std::stringstream profile_name_prefix;
profile_name_prefix << "heap_profile." << getpid() << "." << dsn_now_ns();

HeapProfilerStart(profile_name_prefix.str().c_str());
sleep(seconds);
const char *profile = GetHeapProfile();
HeapProfilerStop();
HeapProfilerStart(profile_name_prefix.str().c_str());
sleep(seconds);
char *profile = GetHeapProfile();
HeapProfilerStop();

resp.status_code = http_status_code::ok;
resp.body = profile;
delete profile;
resp.status_code = http_status_code::ok;
resp.body = profile;
free(profile);
} else {
if (!has_TCMALLOC_SAMPLE_PARAMETER()) {
static const std::string kNoEnvMsg = "The environment variable "
"TCMALLOC_SAMPLE_PARAMETER should set to a "
"positive value, such as 524288, before running.";
LOG_WARNING(kNoEnvMsg);
resp.status_code = http_status_code::internal_server_error;
resp.body = kNoEnvMsg;
return;
}

_in_pprof_action.store(false);
std::string buf;
MallocExtension::instance()->GetHeapSample(&buf);
resp.status_code = http_status_code::ok;
resp.body = std::move(buf);
}
}

// //
Expand Down
Loading