From b04a1485d19e3d5ddf4d44de26b16770ea76e79f Mon Sep 17 00:00:00 2001
From: Camden Cheek <camden@ccheek.com>
Date: Mon, 8 Jun 2020 17:08:05 -0400
Subject: [PATCH] Update sample custom-query with comments

---
 oracledb-custom-query.yml.sample | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/oracledb-custom-query.yml.sample b/oracledb-custom-query.yml.sample
index 0d0f81d..c14a94d 100644
--- a/oracledb-custom-query.yml.sample
+++ b/oracledb-custom-query.yml.sample
@@ -1,5 +1,6 @@
 ---
 queries:
+  # Metric names are set to the column names in the query results
   - query: >-
       SELECT
         SUM(stat.gets) AS "gets",
@@ -9,6 +10,11 @@ queries:
       FROM GV$ROLLSTAT stat, GV$INSTANCE inst
       WHERE stat.inst_id=inst.inst_id
       GROUP BY inst.inst_id
+    
+    # If not set explicitly here, metric type will default to 
+    # 'gauge' for numbers and 'attribute' for strings
     metric_types:
       gets: gauge
+
+    # If unset, sample_name defaults to OracleCustomSample
     sample_name: MyCustomSample