HBASE-25531 Minor improvement to Profiler Servlet doc (#2905)

Signed-off-by: Sean Busbey <busbey@apache.org>
This commit is contained in:
Nick Dimiduk 2021-01-26 16:14:53 -08:00 committed by GitHub
parent 14928d22e9
commit b07549febb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 7 deletions

View File

@ -29,20 +29,26 @@
== Background == Background
HBASE-21926 introduced a new servlet that supports integrated profiling via async-profiler. https://issues.apache.org/jira/browse/HBASE-21926[HBASE-21926] introduced a new servlet that
supports integrated, on-demand profiling via the
https://github.com/jvm-profiling-tools/async-profiler[Async Profiler] project.
== Prerequisites == Prerequisites
Go to https://github.com/jvm-profiling-tools/async-profiler, download a release appropriate for your platform, and install on every cluster host. Go to the https://github.com/jvm-profiling-tools/async-profiler[Async Profiler Home Page], download
If 4.6 or later linux, be sure to set proc variables as per 'Basic Usage' section in the a release appropriate for your platform, and install on every cluster host. If running a Linux
<a href="https://github.com/jvm-profiling-tools/async-profiler">Async Profiler Home Page</a> kernel v4.6 or later, be sure to set proc variables as per the
(Not doing this will draw you diagrams with no content). https://github.com/jvm-profiling-tools/async-profiler#basic-usage[Basic Usage] section. Not doing
so will result in flame graphs that contain no content.
Set `ASYNC_PROFILER_HOME` in the environment (put it in hbase-env.sh) to the root directory of the async-profiler install location, or pass it on the HBase daemon's command line as a system property as `-Dasync.profiler.home=/path/to/async-profiler`. Set `ASYNC_PROFILER_HOME` in the environment (put it in hbase-env.sh) to the root directory of the
async-profiler install location, or pass it on the HBase daemon's command line as a system property
as `-Dasync.profiler.home=/path/to/async-profiler`.
== Usage == Usage
Once the prerequisites are satisfied, access to async-profiler is available by way of the HBase UI or direct interaction with the infoserver. Once the prerequisites are satisfied, access to async-profiler is available by way of the HBase UI
or direct interaction with the infoserver.
Examples: Examples: