feat: readme update for nrql query

newrelic · Jul 16, 2020 · 0bc175b · 0bc175b
1 parent 9641982
commit 0bc175b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -38,7 +38,22 @@ Example hostnames:
 
 - [https://ezidebit.status.io/pages/history/598a973f96a8201305000142](https://ezidebit.status.io/pages/history/598a973f96a8201305000142)
 - [https://status.docker.com/pages/history/533c6539221ae15e3f000031](https://status.docker.com/pages/history/533c6539221ae15e3f000031)
-=======
+
+### NRQL query
+
+NRQL query requires three fields/aliases to be returned: *EventTimeStamp, EventStatus, EventName*.
+
+Example NRQL query:
+
+```sql
+FROM AlertViolationsSample SELECT timestamp as EventTimeStamp, priority as EventStatus, condition_name as EventName, entity.name LIMIT 50
+```
+
+or
+
+```sql
+SELECT timestamp as EventTimeStamp, priority as EventStatus, condition_name as EventName, entity.name FROM AlertViolationsSample LIMIT 50
+```
 
 ## Open Source License
 

diff --git a/utilities/formatters/nrql.js b/utilities/formatters/nrql.js
@@ -5,12 +5,10 @@ const NRQLSeverityToKnown = {
 };
 
 export const nrqlFormatter = data => {
-  let statusCode;
+  let statusCode = NRQLSeverityToKnown.None;
   let status = 'All Systems Operational';
 
-  if (data.raw.results[0].events.length === 0) {
-    statusCode = NRQLSeverityToKnown.None;
-  } else {
+  if (data.raw.results[0].events.length > 0) {
     const incident = data.raw.results[0].events[0];
     statusCode = NRQLSeverityToKnown[incident.EventStatus];