diff --git a/README.md b/README.md index d0a9cf8..ce74f9d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # meta-monitoring-chart -This is a meta-monitoring chart for Loki. - -Note that this is pre-production software at the moment. +This is a meta-monitoring chart for Loki, specifically Loki installed via the Loki helm chart. ## Local and cloud modes @@ -11,19 +9,15 @@ to small Loki, Mimir and Tempo installations running in the meta-monitoring name ![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/or traces are sent to Grafana Cloud. ![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. Cloud mode is preferred. ## Installation -For more instructions including how to update the chart go to the [installation](docs/installation.md) page. +For more instructions including how to install the chart go to the [installation](docs/installation.md) page. ## Supported features @@ -33,8 +27,7 @@ For more instructions including how to update the chart go to the [installation] - Specify PII regexes that are applied to logs before they are sent to Loki (cloud or local). The capture group in the regex is replaced with *****. - a Grafana instance is installed (when local mode is used) with the relevant datasources installed. The following dashboards are installed: - logs dashboards - - agent dashboards -- Retention is set to 24 hours + - Alloy dashboards Most of these features are enabled by default. See the values.yaml file for how to enable/disable them. @@ -42,8 +35,7 @@ Most of these features are enabled by default. See the values.yaml file for how - This has not been tested on Openshift yet. - The underlying Loki, Mimir and Tempo are at the default size installed by the Helm chart. This might need changing when monitoring bigger Loki, Mimir or Tempo installations. -- MinIO is used as storage at the moment with a limited retention. At the moment this chart cannot be used for monitoring over longer periods. -- Agent self monitoring is not done at the moment. +- MinIO is used as storage for the local mode at the moment with a limited retention. At the moment this chart cannot be used for monitoring over longer periods. ## Developer help topics diff --git a/docs/dev_update_dependencies.md b/docs/dev_update_dependencies.md index b47e923..fd9cc90 100644 --- a/docs/dev_update_dependencies.md +++ b/docs/dev_update_dependencies.md @@ -1,8 +1,12 @@ # Update the dependencies -The dependencies are the version of Loki, Mimir, Agent and so on that are included in this chart. +The dependencies are the versions of Loki, Mimir, Agent and so on that are included in this chart. The current versions can be found in the [Chart.yaml](../charts/meta-monitoring/Chart.yaml) file. +A Github action runs daily to see if updated versions are available. A PR will be created. + +The manual steps are as follows: + Run this in the charts/meta-monitoring directory after updating a dependency: ``` diff --git a/docs/installation.md b/docs/installation.md index ff1742b..b3bdcb1 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -4,7 +4,7 @@ 1. Use an existing Grafana Cloud account or setup a new one. Then create an access token: - 1. In Grafana go to Administration -> Users and Access -> Cloud access policies. + 1. In a Grafana instance on Grafana Cloud go to Administration -> Users and Access -> Cloud access policies. 1. Click `Create access policy`. @@ -39,7 +39,7 @@ --from-literal=endpoint='https://otlp-gateway-prod-us-east-0.grafana.net/otlp' ``` - The logs, metrics and traces usernames are the `User / Username / Instance IDs` of the Loki, Prometheus/Mimir and OpenTelemetry instances in Grafana Cloud. From `Home` in Grafana click on `Stacks`. Then go to the `Details` pages of Loki and Prometheus/Mimir. For OpenTelemetry go to the `Configure` page. + The logs, metrics and traces usernames are the `User / Username / Instance IDs` of the Loki, Prometheus/Mimir and OpenTelemetry instances in Grafana Cloud. From `Home` in Grafana click on `Stacks`. Then go to the `Details` pages of Loki and Prometheus/Mimir. For OpenTelemetry go to the `Configure` page. The endpoints will also have to be changed to match your settings. 1. Create a values.yaml file based on the [default one](../charts/meta-monitoring/values.yaml). Fill in the names of the secrets created above as needed. An example minimal values.yaml looks like this: @@ -102,7 +102,7 @@ enabled: true ``` -## Installing the chart +## Installing, updating and deleting the chart 1. Add the repo @@ -175,7 +175,7 @@ For each of the dashboard files in charts/meta-monitoring/src/dashboards folder ## Configure Loki to send traces -1. In the Loki config enable tracing: +1. In the Loki that is being monitored enable tracing in the config: ``` loki: