From 0cfd0baf13b2cf1d78cbe98b2c7ded9e51ffe952 Mon Sep 17 00:00:00 2001
From: Taseer Ahmed <taseer94@gmail.com>
Date: Tue, 15 Aug 2017 23:04:23 +0500
Subject: REST API for logs

JIRA: STORPERF-94

Change-Id: I59189109d7f731977fc682b3fb78e60bc92a8270
Signed-off-by: Taseer Ahmed <taseer94@gmail.com>
---
 docs/testing/user/test-usage.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'docs')

diff --git a/docs/testing/user/test-usage.rst b/docs/testing/user/test-usage.rst
index 3854e0a..8cd7f20 100644
--- a/docs/testing/user/test-usage.rst
+++ b/docs/testing/user/test-usage.rst
@@ -255,3 +255,20 @@ issuing an HTTP DELETE to the configurations API.
 You may also want to delete an environment, and then create a new one with a
 different number of VMs/Cinder volumes to test the impact of the number of VMs
 in your environment.
+
+Viewing StorPerf Logs
+=====================
+
+Logs are an integral part of any application as they help debugging the application. The user just
+needs to issue an HTTP request. To view the entire logs
+
+.. code-block:: bash
+
+  curl -X GET --header 'Accept: application/json' http://StorPerf:5000/api/v1.0/logs?lines=all
+
+Alternatively, one can also view a certain amount of lines by specifying the number in the
+request. If no lines are specified, then last 35 lines are returned
+
+.. code-block:: bash
+
+  curl -X GET --header 'Accept: application/json' http://StorPerf:5000/api/v1.0/logs?lines=12
\ No newline at end of file
-- 
cgit