From 76725555d29c93333e76412161aa1a916253ec85 Mon Sep 17 00:00:00 2001
From: pancho horrillo <pancho.horrillo@bbva.com>
Date: Fri, 18 Dec 2020 12:22:41 +0100
Subject: [PATCH] doc: /server/log/<prefix> endpoint
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Roberto Abdelkader Martínez Pérez <robertomartinezp@gmail.com>
---
 docs/source/concepts/resource_tree.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/docs/source/concepts/resource_tree.rst b/docs/source/concepts/resource_tree.rst
index 1d3409b..d2e2d39 100644
--- a/docs/source/concepts/resource_tree.rst
+++ b/docs/source/concepts/resource_tree.rst
@@ -50,6 +50,10 @@ Overview
     │─ route
     │  └──── id                     Id of the route that matched this request.
     │
+    |─ server
+    │  └──── log                    Log to server stderr
+    │        └──── <prefix>         Optional prefix to the message
+    │
     └─ response
       ├──── status                  HTTP status code
       ├──── headers
@@ -431,6 +435,25 @@ then, when handling the request:
    ecd5d63f-f28b-11ea-ac55-ec21e5089c1f
 
 
+``/server/log/<prefix>``
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Allows logging to Kapow!'s server stderr:
+
+.. code-block:: console
+
+   $ kapow set /server/log/my_banana_peeler 'banana too slippery!'
+
+... meanwhile, in the server...
+
+.. code-block:: console
+
+   2020/12/18 11:15:49.437642 620846c6-4122-11eb-abeb-002b671b12f9 my_banana_peeler: banana too slippery!
+
+Note that the '/my_banana_peeler' part is an optional arbitrary prefix,
+and can be omitted.
+
+
 ``/response/status`` Resource
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~