Skip to content

Commit

Permalink
Start a general troubleshooting tips section and link to the Alloy UI…
Browse files Browse the repository at this point in the history
… section (#558)

Signed-off-by: Pete Wall <[email protected]>
  • Loading branch information
petewall authored Jun 10, 2024
1 parent eaee988 commit 54a7212
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions charts/k8s-monitoring/docs/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,26 @@

This document contains some information about frequently encountered issues and how to resolve them.

- [Troubleshooting](#troubleshooting)
- [Instructions for specific Cluster platform providers](#instructions-for-specific-cluster-platform-providers)
- [General Tips](#general-tips)
- [Instructions for specific Cluster platform providers](#instructions-for-specific-cluster-platform-providers)
- [Frequently seen problems](#frequently-seen-problems)
- [CustomResourceDefinition conflicts](#customresourcedefinition-conflicts)
- [Pod log files in `/var/lib/docker/containers`](#pod-log-files-in-varlibdockercontainers)
- [Authentication error: invalid scope requested](#authentication-error-invalid-scope-requested)

## General tips

### Alloy Web UI

Grafana Alloy has a
[web user interface](https://grafana.com/docs/alloy/latest/tasks/debug/#alloy-ui) that shows every configuration
component that Alloy instance is using and their statuses. By default, the web UI runs on each Alloy pod on port
`12345`. Since that UI is typically not exposed external to the Cluster, you can use port-forwarding to access it.

`kubectl port-forward svc/grafana-k8s-monitoring-alloy 12345:12345`

Then open a browser to `http://localhost:12345`

## Instructions for specific Cluster platform providers

Certain Kubernetes Cluster platforms require some specific configurations for this Helm chart. If your Cluster is
Expand All @@ -18,7 +32,9 @@ running on one of these platforms, see the example for the changes required to r
- [IBM Cloud](../../../examples/ibm-cloud)
- [OpenShift](../../../examples/openshift-compatible)

## CustomResourceDefinition conflicts
## Frequently seen problems

### CustomResourceDefinition conflicts

The Kubernetes Monitoring chart deploys
the [Prometheus Operator custom resource definitions](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus-operator-crds)
Expand All @@ -40,7 +56,7 @@ To fix this problem, you can either:
enabled: false
```
## Pod log files in `/var/lib/docker/containers`
### Pod log files in `/var/lib/docker/containers`

On certain Kubernetes Clusters, Pod logs are stored inside of `/var/lib/docker/containers` with `/var/log/pods` being
symlinked to that directory, but the Grafana Alloy instance doesn't mount it by default.
Expand All @@ -61,7 +77,7 @@ alloy-logs:

([source](https://github.com/grafana/k8s-monitoring-helm/issues/309))

## Authentication error: invalid scope requested
### Authentication error: invalid scope requested

To deliver telemetry data to Grafana Cloud, you use
an [Access Policy Token](https://grafana.com/docs/grafana-cloud/account-management/authentication-and-permissions/access-policies/)
Expand Down

0 comments on commit 54a7212

Please sign in to comment.