From 77066d8f52fff639f2b080d567cba1eacd42c67d Mon Sep 17 00:00:00 2001 From: Panagiotatos Date: Thu, 9 Jan 2025 17:46:50 -0500 Subject: [PATCH] HPCC-33181 Add ZAP information for container deployments to docs Signed-off-by: Panagiotatos --- .../ContainerizedMods/ConfigureValues.xml | 29 --------------- .../ContainerizedMods/ContainerLogging.xml | 36 +++++++++++++++++-- 2 files changed, 34 insertions(+), 31 deletions(-) diff --git a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml index 36c176a702f..0394c028f98 100644 --- a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml +++ b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ConfigureValues.xml @@ -466,35 +466,6 @@ like "python" or "java" - that specifically define memory uses for those targets. - - - ESP and ECLWatch - - ECL Watch works much the same way deployed via bare metal or a - container. There are a few exceptions. - - - Z.A.P. Utility - - 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. - - 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 Containerized Logging chapter - for more information. - - diff --git a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml index 3bcbccdd27c..773c56709f4 100644 --- a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml +++ b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml @@ -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. + yet complete log-processing solution for convenience. Subsequent + sections will look at a couple other possible log-processing + solutions. + + + Log Dependant Applications + + 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. + + + The Z.A.P. Utility + + 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. + + 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 Containerized Logging + sections for more information. + +