Repository: incubator-hawq-docs Updated Branches: refs/heads/master 53ccf3db3 -> bce28faa4
HAWQ-1480 - Added documentation for packcore utility (closes #123) Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/bce28faa Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/bce28faa Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/bce28faa Branch: refs/heads/master Commit: bce28faa46e08d84116bfb1dad02047cf9224174 Parents: 53ccf3d Author: outofmem0ry <[email protected]> Authored: Thu Oct 12 10:10:44 2017 -0700 Committer: David Yozie <[email protected]> Committed: Thu Oct 12 10:10:44 2017 -0700 ---------------------------------------------------------------------- .../source/subnavs/apache-hawq-nav.erb | 3 ++ markdown/admin/packcore.html.md.erb | 55 ++++++++++++++++++++ 2 files changed, 58 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/bce28faa/book/master_middleman/source/subnavs/apache-hawq-nav.erb ---------------------------------------------------------------------- diff --git a/book/master_middleman/source/subnavs/apache-hawq-nav.erb b/book/master_middleman/source/subnavs/apache-hawq-nav.erb index f473dab..03f0755 100644 --- a/book/master_middleman/source/subnavs/apache-hawq-nav.erb +++ b/book/master_middleman/source/subnavs/apache-hawq-nav.erb @@ -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> + </li> </ul> </li> <li class="has_submenu"> http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/bce28faa/markdown/admin/packcore.html.md.erb ---------------------------------------------------------------------- diff --git a/markdown/admin/packcore.html.md.erb b/markdown/admin/packcore.html.md.erb new file mode 100644 index 0000000..a34a722 --- /dev/null +++ b/markdown/admin/packcore.html.md.erb @@ -0,0 +1,55 @@ +--- +title: HAWQ packcore utility +--- + +<!-- +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. +--> + +## <a id="core_file_definition"></a>Core file + +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. + +## <a id="packcore_definition"></a>Packcore + +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. + +### <a id="using_packcore"></a>Using packcore + +The packcore utility is located under `${GPHOME}/sbin`. Run one of the following commands to pack a core file: + +```shell +$ $GPHOME/sbin/packcore <core_file> +``` + +or + +```shell +$ $GPHOME/sbin/packcore -b|--binary $GPHOME/bin/postgres <core_file> +``` + +Alternatively, you can navigate to `$GPHOME/sbin` and run the following: + +```shell +$ ./packcore <core_file> +``` + +or + +```shell +$ ./packcore -b|--binary $GPHOME/bin/postgres <core_file> +``` +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.
