grafana documentation update

README-grafana.md

@@ -74,15 +74,30 @@ services:
     # uncomment the following section and set the variables if you are exposing Grafana to the internet behind a rev web proxy:
     environment:
     # windrose panel plugin is needed for polar plots:
-      - GF_INSTALL_PLUGINS=fatcloud-windrose-panel
+      - GF_INSTALL_PLUGINS=snuids-radar-panel,fatcloud-windrose-panel
     # uncomment and set the following variables if you are exposing Grafana to the internet behind a rev web proxy:
     #   - GF_SERVER_ROOT_URL=https://mywebsite.com/grafana/
     #   - GF_SERVER_SERVE_FROM_SUB_PATH=true
+    # The following variables are needed if you want to expose and embed any dashboards publicly:
+    #  - GF_AUTH_ANONYMOUS_ENABLED=true
+    #  - GF_AUTH_ANONYMOUS_ORG_NAME=public
+    #  - GF_SECURITY_ALLOW_EMBEDDING=true
+    #  - GF_PANELS_DISABLE_SANITIZE_HTML=true
+    #  - GF_FEATURE_TOGGLES_ENABLE=publicDashboards
+    # The following variables will allow you to "share/render" dashboards as PNG graphics.
+    # You should also enabled the renderer container below.
+    #  - GF_RENDERING_SERVER_URL=http://renderer:8081/render
+    #  - GF_RENDERING_CALLBACK_URL=http://grafana:3000/
+    #  - GF_LOG_FILTERS=rendering:debug
     ports:
       - 3000:3000
     volumes:
       - grafana:/var/lib/grafana
 
+# The `renderer` container is needed if you want to share images of your dashboard as a graphic:
+renderer:
+    image: grafana/grafana-image-renderer:latest
+
   prometheus:
     image: prom/prometheus
     container_name: prometheus
@@ -115,10 +130,10 @@ docker compose up -d
 
 ## Step 3: Configuring Prometheus
 
-Prometheus needs to be told where to look for the data from the ultrafeeder. We will create a target prometheus configuration file that does this, please copy and paste the following. Make sure to replace `ip_of_ultrafeeder_machine` with the IP address or hostname of the machine where `ultrafeeder` is running:
+Prometheus needs to be told where to look for the data from the ultrafeeder. We will create a target prometheus configuration file that does this, please copy and paste the following. Make sure to replace `ip_xxxxxxx` with the IP address or hostname of the machine where `ultrafeeder` is running:
 
 ```bash
-docker exec -it prometheus sh -c "echo -e \"  - job_name: 'readsb'\n    static_configs:\n      - targets: ['ip_of_ultrafeeder_machine:9273', 'ip_of_ultrafeeder_machine:9274']\" >> /etc/prometheus/prometheus.yml"
+docker exec -it prometheus sh -c "echo -e \"  - job_name: 'ultrafeeder'\n    static_configs:\n      - targets: ['ip_xxxxxxx:9273', 'ip_xxxxxxx:9274']\" >> /etc/prometheus/prometheus.yml"
 docker stop prometheus
 docker compose up -d
 ```
@@ -144,17 +159,69 @@ After you have logged into the `grafana` console the following manual steps are
 
 Option | Input
 ------------- | -------------
-Name | readsb
+Name | ultrafeeder
 URL | `http://prometheus:9090/`
 
 Clicking `Save & Test` should return a green message indicating success. The dashboard can now be imported with the following steps
 
 1. Hover over the `four squares` icon in the sidebar, click `+ Import`
 2. Enter `18398` into the `Import via grafana.com` section and click `Load`
-3. Select `readsb` from the bottom drop down list
+3. Select `ultrafeeder` from the bottom drop down list
 4. Click `Import` on the subsequent dialogue box
 
 At this point you should see a very nice dashboard, you can find it under `General` in the `Dashboards` section.
 <img src="https://user-images.githubusercontent.com/15090643/228942953-ed8b64aa-3a38-4c6f-bd42-e929b72399b2.png">
 <img src="https://user-images.githubusercontent.com/15090643/228943041-7e135856-543a-416a-9331-50853d2e0929.png">
 <img src="https://user-images.githubusercontent.com/15090643/228943083-c017c5a0-f5aa-4d03-b241-8e58f2c8a5f6.png">
+
+## Advanced Configuration: support for dashboards for multiple ultrafeeder instances
+
+If you have multiple feeder stations with multiple instances of `ultrafeeder`, you can configure a dashboard for each of them. Here's how. In our example, we have two `ultrafeeder` instance called `heerlen` and `trenton`. You can adjust these names in accordance with your needs.
+
+First execute all steps above, and then continue here.
+
+### Step 1: Edit your Prometheus config file so it looks like this
+
+```yaml
+  - job_name: 'heerlen'
+    static_configs:
+      - targets: ['10.0.0.100:9273', '10.0.0.100:9274']
+  - job_name: 'trenton'
+    static_configs:
+      - targets: ['10.0.0.101:9273', '10.0.0.101:9274']
+```
+
+Here, `10.0.0.100` is the IP address of the `heerlen` station, and `10.0.0.101` is the IP address of the `trenton` station. Yours will be different. Please keep the ports as you mapped them for Ultrafeeder in each instance. You should have a `- job_name` block for each ultrafeeder instance.
+
+You can remove the `ultrafeeder` section as it will probably be a duplicate of what you just created.
+
+Once you are done editing, restart Prometheus (`docker restart prometheus`).
+
+### Step 2: Change your initial Grafana dashboard to use the new job name
+
+In the previous step, you replaced the `ultrafeeder` job name by two or more new names. Now, we need to create a copy of the dashboard for each of the job names and make sure they each use the data source from the correct `ultrafeeder` instance.
+
+Step 2a: Log into Grafana and open the Ultrafeeder dashboard that you already created
+Step 2b: Click on the cogwheel (`Dashboard Settings`) in the top of the screen
+Step 2c: Choose `JSON Model` from the Setting menu on the left of the screen and click anywhere in the JSON text
+Step 2d. Press CTRL-F (Window/Linux) or CMD-F (Mac) and press the `>` button to show Find and Replace:
+image
+Step 2e: Find all instances of `job=\"ultrafeeder\"` and replace them with `job=\"heerlen\"` (or whatever name your first feeder has)
+Step 2f: Press `Save dashboard` at the top right of the screen, followed by `Save` on the next screen
+Step 2g: Press ESC to go back to your dashboard
+
+Now your first Grafana dashboard gets its data from the your first `ultrafeeder` instance.
+
+### Step 3: Clone the dashboard and repoint it at your second `ultrafeeder` instance
+
+If you followed the steps above, you should be at your updated (first) dashboard. We'll now clone and adapt it for your second `ultrafeeder` instance:
+
+Step 3a: Press the `Share` icon (to the right of the star, next to the page title)
+Step 3b: Click the `Export` tab. Switch on `Export for sharing externally`
+Step 3c: Press `View JSON` and `Copy to Clipboard`
+Step 3d: `X` out of the popup box, leave the Dashboard, and go back to the `Browse Dashboards` page.
+Step 3e: Click `New` -> `Import`. Right-click in the `Import via panel json` box, and paste your clipboard. Press `Load`
+Step 3f: Change the `Name` and `uid` (pick anything you want), and select `Prometheus` as data source. IMPORTANT: if you do not change the `Name` and `uid`, it will overwrite your existing dashboard. CHANGE BOTH OF THEM! Then press `Import`
+Step 3g: You will see your new dashboard, but it's still getting data from your first one. Follow steps 2b - 2g above to change the data source from `heerlen` (or whatever you named it) to `trenton` (or whatever name you want to give to it)
+
+Now you have 2 dashboards for 2 instances of Ultrafeeder!