Skip to content

Commit

Permalink
HPCC-33181 Add ZAP information for container deployments to docs
Browse files Browse the repository at this point in the history
Signed-off-by: Panagiotatos <[email protected]>
  • Loading branch information
Panagiotatos committed Jan 9, 2025
1 parent 09ecc84 commit 77066d8
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 31 deletions.
29 changes: 0 additions & 29 deletions docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml
Original file line number Diff line number Diff line change
Expand Up @@ -466,35 +466,6 @@
like "python" or "java" - that specifically define memory uses for
those targets.</para>
</sect3>

<sect3 id="CNT_ESPandECLWatch">
<title>ESP and ECLWatch </title>

<para>ECL Watch works much the same way deployed via bare metal or a
container. There are a few exceptions. </para>

<sect4 id="CNTR_ZAP">
<title>Z.A.P. Utility</title>

<para>The Zipped Analysis Package (Z.A.P.) utility collects system
information and encapsulates it into a shareable package. This
utility packages up information to send for further analysis. ZAP
reports contain several artifacts related to a given workunit, to
aid in debugging. </para>

<para>The Component logs are one of most important artifacts
expected to be included in the report. In containerized deployments
logging is handled differently from bare metal. The log fetching is
dependent on a back-end log processor being properly configured and
available and the HPCC LogAccess feature configured to bind to the
log processor. If those 2 dependencies are not met, the
containerized cluster logs are not going to be included in ZAP
reports. To ensure inclusion of the logs in the ZAP report you must
have log access configured properly. See <link
linkend="Containerized_Logging">Containerized Logging</link> chapter
for more information.</para>
</sect4>
</sect3>
</sect2>
</sect1>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,40 @@
choose to integrate HPCC Systems logging data with any existing logging
solutions, or to implement another one specifically for HPCC Systems
data. Starting with HPCC Systems version 8.4, we provide a lightweight,
yet complete log-processing solution for your convenience. The following
sections will look at a couple of the possible solutions.</para>
yet complete log-processing solution for convenience. Subsequent
sections will look at a couple other possible log-processing
solutions.</para>

<sect3 id="LogP_Depends">
<title>Log Dependant Applications</title>

<para>Currently there is a utility delivered with a containerized HPCC
Systems deployment which is dependant on having a properly configured
log-processing solution for optimal results. </para>

<sect4 id="CNTR_ZAP">
<title>The Z.A.P. Utility</title>

<para>The Zipped Analysis Package (Z.A.P.) utility collects system
information and encapsulates it into a shareable package. This
utility packages up information to send for further analysis. ZAP
reports contain several artifacts related to a given workunit, to
aid in debugging.</para>

<para>The Component logs are one of most important artifacts
expected to be included in the report. In containerized deployments
logging is handled differently from bare metal. The log fetching is
dependent on a back-end log processor being properly configured and
available and the HPCC LogAccess feature configured to bind to the
log processor. If those 2 dependencies are not met, the
containerized cluster logs are not going to be included in ZAP
reports and those ZAP reports will be incomplete. To ensure
inclusion of the logs in the ZAP report you must have log access
configured properly. See the <link
linkend="Containerized_Logging">Containerized Logging</link>
sections for more information.</para>
</sect4>
</sect3>
</sect2>
</sect1>

Expand Down

0 comments on commit 77066d8

Please sign in to comment.