Michel Hollands 4c15d5b2cd Update docs
Signed-off-by: Michel Hollands <michel.hollands@grafana.com>
2023-06-23 14:28:29 +01:00

44 lines
1.4 KiB
Markdown

# meta-monitoring-chart
This is a meta-monitoring chart for GEL, GEM and GET. It should be installed in a
separate namespace next to GEM, GEL or GET installations.
## Preparation
Create a values.yaml file based on the [default one](../charts/meta-monitoring/values.yaml).
1. Add or remove the namespaces to monitor in the `namespacesToMonitor` setting
1. Set the cluster name in the `clusterName` setting. This will be added as a label to all logs, metrics and traces.
1. Create a `meta` namespace.
## Local and cloud modes
The chart has 2 modes: local and cloud. In the local mode logs, metrics and traces are sent
to small Loki, Mimir and Tempo installations running in the meta-monitoring namespace.
![local mode](docs/images/Meta%20monitoring%20local.png)
To enable local mode set `local.enabled` to true.
In the cloud mode the logs, metrics and traces are sent to
![cloud mode](docs/images/Meta%20monitoring%20cloud.png)
To enable cloud mode set `cloud.enabled` to true. The `endpoint`, `username` and `password` settings for your Grafana Cloud logs, metrics and traces instances have to be filled in as well.
Both modes can be enabled at the same time.
## Installation
```
helm install -n meta -f values.yaml meta ./charts/meta-monitoring
```
For more instructions including how to update the chart go to the [installation](docs/installation.md) page.
## Developer help topics
- [update dependencies](docs/dev_update_dependencies.md)