From db7cc07d66f2ba81519e6f6dd95120b4e4c785c2 Mon Sep 17 00:00:00 2001
From: Rodrigo Pastrana <Rodrigo.Pastrana@lexisnexisrisk.com>
Date: Wed, 28 Aug 2024 16:06:59 -0400
Subject: [PATCH] HPCC-32531 Document BareMetal Logaccess config

- Adds baremetal section to logaccess README
- Adds new xml sample fle

Signed-off-by: Rodrigo Pastrana <rodrigo.pastrana@lexisnexisrisk.com>
---
 helm/managed/logging/loki-stack/README.md     | 21 +++++++++++++++++++
 .../grafana-hpcc-logaccess-baremetal.xml      | 18 ++++++++++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 helm/managed/logging/loki-stack/grafana-hpcc-logaccess-baremetal.xml

diff --git a/helm/managed/logging/loki-stack/README.md b/helm/managed/logging/loki-stack/README.md
index e50a0437444..030de113260 100644
--- a/helm/managed/logging/loki-stack/README.md
+++ b/helm/managed/logging/loki-stack/README.md
@@ -200,3 +200,24 @@ Example use:
       logFormat:
         type: "json"
 ```
+#### Baremetal configuration
+
+LogAccess can be configured on baremetal systems as well. It is not a common scenario because baremetal logs continue to be persisted on the local filesystem. Enabling LogAccess on a baremetal system would allow users to fetch remotely stored HPCC logs (not likely related to the host HPCC Systems deployment). To enable, inject a logAccess block with all configuration values properly filled in. The can be injected within the Sofware element in the active environment.xml or within the global element on the esp.xml.
+
+For example:
+
+```
+<logAccess name="MyGrafanaLogaccess" type="GrafanaCurl">
+      <!--username/pass only if secret not available!!-->
+      <connection protocol="http" port="3000" host="localhost" username="admin" password="xyz"/>
+      <datasource name="Loki" id="1"/> <!-- Find this info from Grafana: http://localhost:3000/api/datasources/ -->
+      <namespace name="hpcc"/> <!-- the namespace of the HPCC components which have forwarded logs to grafana -->
+      <logFormat type="table"/> <!--optional, only needed if HPCC log format set to XML or JSON-->
+      <logMaps type="global" searchColumn="log" columnMode="DEFAULT" columnType="string"/>
+      <logMaps type="timestamp" searchColumn="tsNs" columnMode="MIN" storeName="values" columnType="epoch"/>
+      <!-- logmaps based on streams can be found via http://localhost:3000/api/datasources/proxy/1/loki/api/v1/labels -->
+      <logMaps type="components" searchColumn="component" columnMode="ALL" storeName="stream" columnType="string"/>
+      <logMaps type="node" searchColumn="node_name" columnMode="ALL" storeName="stream" columnType="string"/>
+      <logMaps type="pod" searchColumn="pod" columnMode="DEFAULT" storeName="stream" columnType="string"/>
+   </logAccess>
+  ```
\ No newline at end of file
diff --git a/helm/managed/logging/loki-stack/grafana-hpcc-logaccess-baremetal.xml b/helm/managed/logging/loki-stack/grafana-hpcc-logaccess-baremetal.xml
new file mode 100644
index 00000000000..2f4c073ce1e
--- /dev/null
+++ b/helm/managed/logging/loki-stack/grafana-hpcc-logaccess-baremetal.xml
@@ -0,0 +1,18 @@
+<Environment>
+  <global>
+    <!-- logAccess element should be injected into active environment.xml-->
+    <logAccess name="grafanalogaccess" type="GrafanaCurl">
+      <!--username/pass only if secret not available!!-->
+      <connection protocol="http" port="3000" host="localhost" username="admin" password=""/>
+      <datasource name="Loki" id="1"/> <!-- Find this info from Grafana: http://localhost:3000/api/datasources/ -->
+      <namespace name="hpcc"/>
+      <logFormat type="table"/> <!--optional, only needed if HPCC log format set to XML or JSON-->
+      <logMaps type="global" searchColumn="log" columnMode="DEFAULT" columnType="string"/>
+      <logMaps type="timestamp" searchColumn="tsNs" columnMode="MIN" storeName="values" columnType="epoch"/>
+      <!-- logmaps based on streams can be found via http://localhost:3000/api/datasources/proxy/1/loki/api/v1/labels -->
+      <logMaps type="components" searchColumn="component" columnMode="ALL" storeName="stream" columnType="string"/>
+      <logMaps type="node" searchColumn="node_name" columnMode="ALL" storeName="stream" columnType="string"/>
+      <logMaps type="pod" searchColumn="pod" columnMode="DEFAULT" storeName="stream" columnType="string"/>
+   </logAccess>
+  </global>
+</Environment>
\ No newline at end of file