HPCC-30571 LogAccess to report log column alias

- Introduces logaccess column alias concept - Adds WsLogAccess.getinfo Alias column - Populates Alias column if reported in configuration - Annotates ALA v1 instance with hpcc_log_component name - Adds alias to helm schema Signed-off-by: Rodrigo Pastrana <[email protected]>
hpcc-systems · Oct 19, 2023 · 33e0b82 · 33e0b82
1 parent 9cab6fd
commit 33e0b82
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 4 deletions.
diff --git a/esp/scm/ws_logaccess.ecm b/esp/scm/ws_logaccess.ecm
@@ -76,13 +76,14 @@ ESPenum LogColumnValueType : string
     enum("enum")
 };
 
-ESPStruct LogColumn
+ESPStruct [nil_remove] LogColumn
 {
     string Name;
     ESPenum LogColumnType LogType;
     ESParray<string> EnumeratedValues;
     LogSelectColumnMode ColumnMode;
     ESPenum LogColumnValueType ColumnType;
+    [min_ver("1.06")] string Alias;
 };
 
 ESPResponse GetLogAccessInfoResponse
@@ -219,7 +220,7 @@ ESPResponse GetLogsResponse
     [min_ver("1.02")] unsigned int TotalLogLinesAvailable;
 };
 
-ESPservice [auth_feature("WsLogAccess:READ"), version("1.05"), default_client_version("1.05"), exceptions_inline("xslt/exceptions.xslt")] ws_logaccess
+ESPservice [auth_feature("WsLogAccess:READ"), version("1.06"), default_client_version("1.06"), exceptions_inline("xslt/exceptions.xslt")] ws_logaccess
 {
     ESPmethod GetLogAccessInfo(GetLogAccessInfoRequest, GetLogAccessInfoResponse);
     ESPmethod GetLogs(GetLogsRequest, GetLogsResponse);

diff --git a/esp/services/ws_logaccess/WsLogAccessService.cpp b/esp/services/ws_logaccess/WsLogAccessService.cpp
@@ -71,6 +71,26 @@ bool Cws_logaccessEx::onGetLogAccessInfo(IEspContext &context, IEspGetLogAccessI
                                 WARNLOG("Invalid col type found in logaccess logmap config");
                             }
                         }
+                        if (clientVer >= 1.06)
+                        {
+                            if (column.hasProp("@alias"))
+                            {
+                                try
+                                {
+                                    espLogColumn->setAlias(column.queryProp("@alias"));
+                                }
+                                catch (IException *e)
+                                {
+                                    VStringBuffer msg("Invalid alias found in logaccess logmap config for '%s'", csearchColumn);
+                                    EXCLOG(e, msg.str());
+                                    e->Release();
+                                }
+                                catch(...)
+                                {
+                                    WARNLOG("Invalid alias found in logaccess logmap config");
+                                }
+                            }
+                        }
                         logColumns.append(*espLogColumn.getClear());
                     }
                     else

diff --git a/helm/examples/azure/log-analytics/loganalytics-hpcc-logaccess.yaml b/helm/examples/azure/log-analytics/loganalytics-hpcc-logaccess.yaml
@@ -59,7 +59,7 @@ global:
     - type: "instance"
       storeName: "ContainerInventory"
       searchColumn: "Name"
-      projectName: "hpcc_log_component"
+      alias: "hpcc_log_component"
       columnMode: "ALL"
       columnType: "string"
     - type: "node"

diff --git a/helm/hpcc/values.schema.json b/helm/hpcc/values.schema.json
@@ -3003,7 +3003,7 @@
         "type": {
           "type": "string",
           "description" : "The searchable HPCC log column to be mapped - 'global' applies to all known fields",
-          "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host", "node", "message", "logid", "processid", "threadid", "timestamp"]
+          "enum": [ "global", "workunits", "components", "audience", "class", "instance", "host", "node", "message", "logid", "processid", "threadid", "timestamp", "alias"]
         },
         "timeStampColumn": {
           "description" : "Name of timestamp column related to mapped field (only requried for 'global' mapping)",