From 14acc1b21a3a95ae026fc4d1ae0a471bf84a4275 Mon Sep 17 00:00:00 2001
From: Nikolay Stanchev <ns17@it-innovation.soton.ac.uk>
Date: Fri, 8 Feb 2019 11:34:06 +0000
Subject: [PATCH] Updates docs for graph API
---
docs/clmc-service.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/docs/clmc-service.md b/docs/clmc-service.md
index db3e4c6..bf15a2f 100644
--- a/docs/clmc-service.md
+++ b/docs/clmc-service.md
@@ -194,9 +194,9 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
* Request:
Expects a JSON-formatted request body which declares the service function chain and service function chain instance for which the graph is built.
- The request body must include the service functions that must be included in the graph along with the measurement name, response time field, request size field and
- response size field for each service function. The time range is also declared in the body by the *from* and *to* parameters.
- The declared fields could be influx functions across multiple fields.
+ The request body must define the service functions that will be included in the graph along with the measurement name, response time field, request size field and
+ response size field for each service function. The declared fields could be influx functions across multiple fields.
+ The time range is also declared in the body by the *from* and *to* parameters.
* Request Body Example:
@@ -226,13 +226,13 @@ with **/clmc-service** so that the nginx reverse proxy server (listening on port
These parameters are then filled in the following influx query template:
```
- SELECT {0} AS mean_response_time, {1} AS mean_request_size, {2} AS mean_response_size FROM "{3}"."{4}".{5} WHERE "flame_sfc"=\'{6}\' and "flame_sfci"=\'{7}\' and time>={8} and time<{9} GROUP BY "flame_sfe", "flame_location", "flame_sf"
+ SELECT {0} AS mean_response_time, {1} AS mean_request_size, {2} AS mean_response_size FROM "{3}"."{4}".{5} WHERE "flame_sfc"=\'{6}\' and "flame_sfci"=\'{7}\' and "flame_sfp"=\'{8}\' and time>={9} and time<{10} GROUP BY "flame_sfe", "flame_location", "flame_sf"
```
- E.g. for the minio service function, the following query will be used to retrieve the data from influx (request url is */graph/build?from=1528385420&to=1528385860*):
+ E.g. for the minio service function (i.e. flame_sfp=minio), the following query will be used to retrieve the data from InfluxDB:
```
- SELECT mean(sum)/mean(count) AS mean_response_time, mean(request_size)/mean(count) AS mean_request_size, mean(response_size)/mean(count) AS mean_response_size FROM "MSDemo"."autogen".minio_http_requests_duration_seconds WHERE "flame_sfc"='MSDemo' and "flame_sfci"='MSDemo_1' and time>=1528385420000000000 and time<1528385860000000000 GROUP BY "flame_sfe", "flame_location", "flame_sf"
+ SELECT mean(sum)/mean(count) AS mean_response_time, mean(request_size)/mean(count) AS mean_request_size, mean(response_size)/mean(count) AS mean_response_size FROM "MSDemo"."autogen".minio_http_requests_duration_seconds WHERE "flame_sfc"='MSDemo' and "flame_sfci"='MSDemo_1' and "flame_sfp"='minio' and time>=1528385420000000000 and time<1528385860000000000 GROUP BY "flame_sfe", "flame_location", "flame_sf"
```
N.B. database name is assumed to be the SFC identifier
--
GitLab