From 85f089d5b8d54e2e20621d206f4ba097be4580b2 Mon Sep 17 00:00:00 2001
From: Abhishek Singh <abhishek17513@gmail.com>
Date: Thu, 22 Feb 2024 03:00:03 +0530
Subject: [PATCH] add doc for grafana

---
 doc/grafana.md  | 62 +++++++++++++++++++++++++++++++++++++++++++++++++
 doc/services.md |  1 +
 2 files changed, 63 insertions(+)
 create mode 100644 doc/grafana.md

diff --git a/doc/grafana.md b/doc/grafana.md
new file mode 100644
index 00000000..82aa2095
--- /dev/null
+++ b/doc/grafana.md
@@ -0,0 +1,62 @@
+# Grafana Open Source
+
+Grafana open source is open source visualization and analytics software. It allows you to query, visualize, alert on, and explore your metrics, logs, and traces no matter where they are stored. It provides you with tools to turn your time-series database (TSDB) data into insightful graphs and visualizations.
+
+## Getting Started
+
+```nix
+# In `perSystem.process-compose.<name>`
+{
+  services.grafana."gf1".enable = true;
+}
+```
+
+{#tips}
+## Tips & Tricks
+
+{#change-database}
+### Changing Grafana database
+
+By default, Grafana stores data in the `sqlite3` [database](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#database). It also supports `mysql` and `postgres`.
+
+To change the database to `postgres`, we can use the following config:
+
+1. Create `postgres` service.
+
+```nix
+services.postgres."pg1" = {
+  enable = true;
+  listen_addresses = "127.0.0.1";
+  port = 5435;
+  initialDatabases = [{
+    name = "grafana-db";
+  }];
+  initialScript.after = ''
+    CREATE USER gfuser with PASSWORD 'gfpassword' SUPERUSER;
+  '';
+};
+```
+
+2. Create `grafana` service, and change its config to use the `postgres` database.
+
+```nix
+services.grafana."gf1" = {
+  enable = true;
+  http_port = 3001;
+  extraConf = {
+    database = {
+      type = "postgres";
+      host = "127.0.0.1:5435";
+      name = "grafana-db";
+      user = "gfuser";
+      password = "gfpassword";
+    };
+  };
+};
+```
+
+3. Add a setting to start `grafana` only after `postgres` is running.
+
+```nix
+settings.processes."gf1".depends_on."pg1".condition = "process_healthy";
+```
diff --git a/doc/services.md b/doc/services.md
index c5ee9cd8..0478b02d 100644
--- a/doc/services.md
+++ b/doc/services.md
@@ -16,6 +16,7 @@ short-title: Services
 - [ ] Redis
 - [ ] Redis Cluster
 - [ ] Zookeeper
+- [ ] [[grafana]]#
 - [ ] ...
 
 [gh]: https://github.com/juspay/services-flake