HAWQ-1480 - Added documentation for packcore utility #123
Conversation
|
@dyozie this PR is pending for review. The packcore utility is already committed in hawq branch. This PR addresses its usage. |
markdown/admin/packcore.html.md.erb
Outdated
|
|
||
| ## <a id="packcore_definition"></a>Packcore | ||
|
|
||
| Packcore utility helps in packing a core file with its context – executable, application and system shared libraries from the current environment. This information can be later unpacked on a different system and can be used for debugging. Packcore takes a core file, extracts the name of the binary which generated the core and executes `ldd` (List Dynamic Dependencies) to get the required information into a single tar archive. |
There was a problem hiding this comment.
The Packcore utility helps pack a core file with its context, including the executable, application, and shared system libraries from the current environment. This information can be unpacked for later debugging on a different system. Packcore extracts the name of the binary that generated the core from the core file, then executes ldd (List Dynamic Dependencies) to create a single tar archive containing the core file information.
markdown/admin/packcore.html.md.erb
Outdated
|
|
||
| ## <a id="core_file_definition"></a>Core file | ||
|
|
||
| Core file is a disk file that records the image of a process' memory in case the process crashes or terminates abruptly. This image can be later used to debug the state of process at the time when it was terminated. This information can be very useful to debug the cause failure. |
There was a problem hiding this comment.
A core file is a disk file that records the memory image of a running process in the event the process crashes or terminates abruptly. The information in this image is useful for debugging the state of a process at the time when it was terminated.
markdown/admin/packcore.html.md.erb
Outdated
|
|
||
| ### <a id="using_packcore"></a>Using packcore | ||
|
|
||
| The packcore utility is located under `${GPHOME}/sbin`. Following are the options for packing a core file: |
There was a problem hiding this comment.
Run one of the following commands to pack a core file:
markdown/admin/packcore.html.md.erb
Outdated
|
|
||
| ./packcore -b|--binary $GPHOME/bin/postgres <core_file> | ||
| ``` | ||
| Once finished the utility will create a tar file named `packcore-<core_file>.tgz`. This file can be later unpacked on another system and used for debugging. |
There was a problem hiding this comment.
When processing is completed, the utility creates a tar file in the format: packcore-<core_file>.tgz. Unpack this file on another system to use it for debugging.
|
@janebeckman Thank you for the review. Incorporated your review comments in the latest commit. |
| @@ -117,6 +117,9 @@ | |||
| <li> | |||
| <a href="/docs/userguide/2.2.0.0-incubating/admin/logfiles.html">HAWQ Administrative Log Files</a> | |||
| </li> | |||
| <li> | |||
| <a href="/docs/userguide/2.2.0.0-incubating/admin/packcore.html">HAWQ packcore utility</a> | |||
There was a problem hiding this comment.
this is very minor - how about capitalizing the U in "utility"?
There was a problem hiding this comment.
@lisakowen changed the heading format to make it similar to naming convention of other headings.
There was a problem hiding this comment.
Thanks @outofmem0ry - merging this in now.
No description provided.