[DOC] Update README.md (grafana#3349)

* Update README.md Add instructions on how to use the mixins. * Update operations/tempo-mixin/README.md * Update README.md * Update operations/tempo-mixin/README.md Co-authored-by: Heds Simons <[email protected]> --------- Co-authored-by: Heds Simons <[email protected]>
dimitris4000 · Feb 1, 2024 · 1883960 · 1883960
1 parent 326012f
commit 1883960
Showing 1 changed file with 32 additions and 3 deletions.
diff --git a/operations/tempo-mixin/README.md b/operations/tempo-mixin/README.md
@@ -1,14 +1,43 @@
 # tempo-mixin
 
-Dashboards, rules and alerts are in the [`yamls`](./yamls) folder. Use them directly in Prometheus & Grafana to monitor Tempo.
+Once installed via the build instructions below, dashboards, rules, and alerts are located in the [`operations/tempo-mixins-compiled`](..tempo-mixins-compiled) folder. Use them directly in Prometheus and Grafana to monitor Tempo.
 
-### Build
+You can either use the mixins in the `tempo-mixin-compiled` folder or you can build your own to incorporate your own changes. 
+
+## Build
 
 To regenerate dashboards, rule and alerts, run `make all`.
 
-This requires [jsonnet](https://jsonnet.org/) and [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler) to be installed, install these with the following commands:
+This requires [jsonnet](https://jsonnet.org/) and [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler) to be installed. 
+
+On macOS, you can install these with the following commands:
 
 ```console
 brew install jsonnet
+brew install jsonnet-bundler 
 go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/[email protected]
 ```
+
+## Use the mixins
+
+Once you run `make all`, the mixins are created in the `tempo-mixin-compiled` folder. 
+
+```
+➜   make all                                                                                                                          git:(main|)
+jb install
+jsonnet -J vendor -S dashboards.jsonnet -m ../tempo-mixin-compiled/dashboards/
+../tempo-mixin-compiled/dashboards/tempo-operational.json
+../tempo-mixin-compiled/dashboards/tempo-reads.json
+../tempo-mixin-compiled/dashboards/tempo-resources.json
+../tempo-mixin-compiled/dashboards/tempo-rollout-progress.json
+../tempo-mixin-compiled/dashboards/tempo-tenants.json
+../tempo-mixin-compiled/dashboards/tempo-writes.json
+jsonnet -J vendor -S alerts.jsonnet > ../tempo-mixin-compiled/alerts.yaml
+jsonnet -J vendor -S rules.jsonnet > ../tempo-mixin-compiled/rules.yaml
+```
+
+Alerts and rules are listed in their matching files: 
+* Alerts -> `tempo-mixin-compiled/alerts.yaml`
+* Rules -> 'tempo-mixin-compiled/rules.yaml`
+
+For information on using the dashboards, refer to the [mixin runbook](operations/tempo-mixin/runbook.md).