From 09030e08f6910469d6529b7e1cace5f0ab6e6640 Mon Sep 17 00:00:00 2001
From: Hossam Hammady <github@hammady.net>
Date: Wed, 9 Jun 2021 18:17:48 -0400
Subject: [PATCH] Add New Relic query examples

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/README.md b/README.md
index bc37219..1616ee3 100644
--- a/README.md
+++ b/README.md
@@ -75,6 +75,27 @@ configuration file.
 
 If you prefer to use New Relic monitoring, replace the `-g` parameter with `--enable-newrelic-reporting`.
 If enabled, must set the environment variables `NEW_RELIC_LICENSE_KEY` and `NEW_RELIC_APP_NAME` (see below).
+Once enabled, the below will be reported:
+
+- `Custom/WebReplicas/service`
+- `Custom/WorkerReplicas/service`
+- `Custom/WebMetric/service`
+- `Custom/WorkerMetric/service`
+- `Custom/Scaltainer/ticks`
+
+Where `service` is a placeholder for each service defined in `yourconfig.yml`.
+
+Here is an example NRQL to query the metrics:
+
+```
+FROM Metric
+SELECT max(newrelic.timeslice.value)
+WHERE appName = 'YOUR APP NAME'
+WITH METRIC_FORMAT 'Custom/WebReplicas/{web}'
+FACET web
+SINCE 1 day ago TIMESERIES MAX
+```
+
 ## Configuration
 
 ### Environment variables