Merge pull request #19064 from rpastrana/HPCC-32531DocumentBMLogacces…

…sConfig HPCC-32531 Document BareMetal Logaccess config Reviewed-By: Greg Panagiotatos <[email protected]> Merged-by: Gavin Halliday <[email protected]>
hpcc-systems · Sep 30, 2024 · 1a2a7bf · 1a2a7bf
2 parents 60407b5 + 66cdf5c
commit 1a2a7bf
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 0 deletions.
diff --git 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 logAccess block can be injected within the Software 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>
+  ```
diff --git a/helm/managed/logging/loki-stack/grafana-hpcc-logaccess-baremetal.xml 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>