Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HPCC-32752 Update Loki4hpcclogs README #19167

Merged
merged 1 commit into from
Oct 4, 2024
Merged

HPCC-32752 Update Loki4hpcclogs README #19167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions helm/managed/logging/loki-stack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ A Loki Datasource is created automatically, which allowers users to monitor/quer
### Helm Deployment
To deploy the light-weight Loki Stack for HPCC component log processing issue the following command:

>helm install myloki HPCC-Systems/helm/managed/logging/loki-stack/
>helm install myloki4hpcclogs HPCC-Systems/helm/managed/logging/loki-stack/
Note: the deployment name 'myloki4hpcclogs' is customizable; however, any changes need to be reflected in the LogAccess configuration (See section on configuring LogAccess below)

### Dependencies
This chart is dependent on the Grafana Loki-stack Helm charts which in turn is dependent on Loki, Grafana, Promtail.
Expand All @@ -23,7 +24,9 @@ Helm provides a convenient command to automatically pull appropriate dependencie
##### HELM Install parameter
Otherwise, provide the "--dependency-update" argument in the helm install command
For example:
> helm install myloki HPCC-Systems/helm/managed/logging/loki-stack/ --dependency-update
> helm install myloki4hpcclogs HPCC-Systems/helm/managed/logging/loki-stack/ --dependency-update

Note: the deployment name 'myloki4hpcclogs' is customizable; however, any changes need to be reflected in the LogAccess configuration (See section on configuring LogAccess below)

### Components
Grafana Loki Stack is comprised of a set of components that which serve as a full-featured logging stack.
Expand Down Expand Up @@ -172,7 +175,7 @@ username: 5 bytes

The target HPCC deployment should be directed to use the desired Grafana endpoint with the Loki datasource, and the newly created secret by providing appropriate logAccess values (such as ./grafana-hpcc-logaccess.yaml).

Example use:
Example use for targeting a loki stack deployed as 'myloki4hpcclogs' on the default namespace:

```
helm install myhpcc hpcc/hpcc -f HPCC-Platform/helm/managed/logging/loki-stack/grafana-hpcc-logaccess.yaml
Expand All @@ -182,8 +185,10 @@ Example use:

The grafana hpcc logaccess values should provide Grafana connection information, such as the host, and port; the Loki datasource where the logs reside; the k8s namespace under which the logs were created (non-default namespace highly recommended); and the hpcc component log format (table|json|xml)

Example values file describing logAccess targeting loki stack deployed as 'myloki4hpcclogs' on the default namespace. Note that the "host" entry must reflect the name of the deployed Loki stack, as shown in the excerpt below (eg **_myloki4hpcclogs_**-grafana.default.svc.cluster.local):

```
Example use:

global:
logAccess:
name: "Grafana/loki stack log access"
Expand Down Expand Up @@ -220,4 +225,4 @@ For example:
<logMaps type="node" searchColumn="node_name" columnMode="ALL" storeName="stream" columnType="string"/>
<logMaps type="pod" searchColumn="pod" columnMode="DEFAULT" storeName="stream" columnType="string"/>
</logAccess>
```
```
Loading