From f8e28d3a42aedcccad4930a043130955a7e35d1f Mon Sep 17 00:00:00 2001 From: g-pan Date: Thu, 12 Oct 2023 16:24:35 -0400 Subject: [PATCH] HPCC-28758 Update docs for elastic4hpcclogs chart info Signed-off-by: g-pan --- .../ContainerizedMods/ContainerLogging.xml | 69 +++++++------------ 1 file changed, 23 insertions(+), 46 deletions(-) diff --git a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml index 51787bcf528..12349160019 100644 --- a/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml +++ b/docs/EN_US/ContainerizedHPCC/ContainerizedMods/ContainerLogging.xml @@ -214,7 +214,7 @@ myelk-kibana-68688b4d4d-d489b 1/1 Running 0 - + Confirming the Elastic Services To confirm the Elastic services are running, issue the following @@ -279,47 +279,24 @@ myelk-kibana LoadBalancer 10.110.129.199 localhost 5601:31465/TCP 68m logs. The way you direct HPCC Systems to do so is by providing a values file that includes the log mappings. We have provided a default values file and we provide an example command line that inserts that - values file into your deployment. - - These are the Elastic4HPCCLogs values: - - # Configures HPCC logAccess to target elastic4hpcclogs deployment -global: - logAccess: - name: "Elastic4HPCCLogs" - type: "elasticstack" - connection: - protocol: "http" - host: "elasticsearch-master.default.svc.cluster.local" - port: 9200 - logMaps: - - type: "global" #These settings apply to all log mappings - storeName: "hpcc-logs*" #Logs are expected to be housed in ES inde - searchColumn: "message" #The 'message' field is to be targeted for - timeStampColumn: "@timestamp" #The '@timestamp' field contains time log - - type: "workunits" #Search by workunits specific log mapping - storeName: "hpcc-logs*" # Only needed if differs from global.store - searchColumn: "hpcc.log.jobid" # Field containing WU information - - type: "components" #Search by components specific log mapping - searchColumn: "kubernetes.container.name" # Field containing container information - - type: "audience" #Search by audience specific log mapping - searchColumn: "hpcc.log.audience" # Field containing audience information - - type: "class" #Search by log class specific log mapping - searchColumn: "hpcc.log.class" # Field containing log class information - - type: "instance" #Search by log source instance specific ma - searchColumn: "kubernetes.pod.name" # Field containing source instance informa - - type: "host" #Search by log source host specific mappin - searchColumn: "kubernetes.node.hostname" # Field containing source host information - - You can use the delivered Elastic4HPCCLogs chart, provided on - https://github.com/hpcc-systems/HPCC-Platform/tree/master/helm/managed/logging/elastic - or you can add the values there to your customized configuration - values yaml file. You can then install it using a command such - as: + values file into your deployment. This suggested configuration values + file for enabling log access can be found in the HPCC Systems Platform + GitHub repository. - helm install mycluster hpcc/hpcc -f elastic4hpcclogs-hpcc-logaccess.yaml + https://github.com/hpcc-systems/HPCC-Platform + + Then navigating to the + helm/examples/azure/log-analytics/loganalytics-hpcc-logaccess.yaml + file. - + You can use the delivered Elastic4HPCCLogs chart provided or you + can add the values there to your customized configuration values yaml + file. + + You can then install it using a command such as: + + helm install mycluster hpcc/hpcc -f elastic4hpcclogs-hpcc-logaccess.yaml @@ -619,10 +596,10 @@ ContainerLog Target Audience Filtering The availble target audiences include operator(OPR), user(USR), - programmer(PRO), monitor(MON), audit(ADT), or all. The filter is controlled by the - <section>.logging.audiences value. The string value is comprised - of 3 letter codes delimited by the aggregation operator (+) or the - removal operator (-). + programmer(PRO), monitor(MON), audit(ADT), or all. The filter is + controlled by the <section>.logging.audiences value. The string + value is comprised of 3 letter codes delimited by the aggregation + operator (+) or the removal operator (-). For example, all component log output to include Programmer and User messages only: @@ -634,8 +611,8 @@ ContainerLog Target Category Filtering The available target categories include disaster(DIS), error(ERR), - information(INF), warning(WRN), progress(PRO), event(EVT), metrics(MET). The - category (or class) filter is controlled by the + information(INF), warning(WRN), progress(PRO), event(EVT), metrics(MET). + The category (or class) filter is controlled by the <section>.logging.classes value, comprised of 3 letter codes delimited by the aggregation operator (+) or the removal operator (-).