summaryrefslogtreecommitdiffstats
path: root/vnfs/DAaaS/applications/m3db_promql/promql_api/README.md
diff options
context:
space:
mode:
authorRajamohan Raj <rajamohan.raj@intel.com>2019-05-30 01:28:55 +0000
committerRajamohan Raj <rajamohan.raj@intel.com>2019-05-30 01:28:55 +0000
commitf3c04d861a585c9ae9138ea1e93aae24deeb46bf (patch)
tree21004ad707b73e4f0040cb7b41f4cf8862be47c2 /vnfs/DAaaS/applications/m3db_promql/promql_api/README.md
parent02331f878f0bdf256f5b41f2f3433f2ff1db6bc4 (diff)
PromQL api for query
Initial commit for promQL query api and sample app for using the api Change-Id: Id9c5d95f621edbb14b2eba7493c968c138d2d02a Issue-ID: ONAPARC-452 Signed-off-by: Rajamohan Raj <rajamohan.raj@intel.com>
Diffstat (limited to 'vnfs/DAaaS/applications/m3db_promql/promql_api/README.md')
-rw-r--r--vnfs/DAaaS/applications/m3db_promql/promql_api/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/vnfs/DAaaS/applications/m3db_promql/promql_api/README.md b/vnfs/DAaaS/applications/m3db_promql/promql_api/README.md
new file mode 100644
index 00000000..4493af22
--- /dev/null
+++ b/vnfs/DAaaS/applications/m3db_promql/promql_api/README.md
@@ -0,0 +1,50 @@
+## What does this API do ?
+This api as of now provides a function which takes in a lits of 'LABELS' of prometheus
+and returns the corresponding result_sets in a list.
+
+For eg:
+If the labels is
+
+```
+LABELS = ['irate(collectd_cpufreq{exported_instance="otconap7",cpufreq="1"}[2m])']
+```
+
+The return is:
+
+```
+[{'metric': {'cpufreq': '1',
+ 'endpoint': 'collectd-prometheus',
+ 'exported_instance': 'otconap7',
+ 'instance': '172.25.103.1:9103',
+ 'job': 'collectd',
+ 'namespace': 'edge1',
+ 'pod': 'plundering-liger-collectd-wz7xg',
+ 'service': 'collectd'},
+ 'value': [1559177169.415, '119727200']}]
+```
+
+## How to use this API ?
+
+```
+1. Copy the directory 'promql_api' to your working directory.
+```
+
+```
+2. Import the API function: query_m3db
+from promql_api.prom_ql_api import query_m3db
+```
+
+```
+3. have a global or local variable as 'LABELS'
+LABELS = ['irate(collectd_cpufreq{exported_instance="otconap7",cpufreq="1"}[2m])']
+```
+
+```
+4. Store the result set in a list:
+list_of_result_sets = query_m3db(LABELS)
+```
+
+## How to troubleshoot ?
+
+* Check the sample file - sample_promql_query.py in the repo.
+* Make sure the file __init__.py is present in promql_api directory after you copy the directory.