From 8dde0cc7824e32f1a829b1528fa0e61a5707098f Mon Sep 17 00:00:00 2001 From: Emmett Cox Date: Mon, 17 Sep 2018 10:25:09 +0100 Subject: User guide documentation for data router Change-Id: If28014e4f937c9036e22f2db7599fd8568f0c13f Signed-off-by: Emmett Cox Issue-ID: DMAAP-552 --- docs/data-router/logging.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/data-router/logging.rst (limited to 'docs/data-router/logging.rst') diff --git a/docs/data-router/logging.rst b/docs/data-router/logging.rst new file mode 100644 index 00000000..ac6aa95c --- /dev/null +++ b/docs/data-router/logging.rst @@ -0,0 +1,25 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Logging +======= + + +Where to Access Information +--------------------------- +Data Router uses logback framework to generate logs. + +Error / Warning Messages +------------------------ +Currently Data Router does not have any unique error codes. However the following are the common HTTP error codes that +could possibly occur in Data Router: + + OK = 200 : The normal response from a successful update or get of a feed or subscription + CREATED = 201 : the normal response from successfully creating or subscribing to a feed. + NO_CONTENT = 204 : the normal response from a successful publish attempt and on successfully deleting a feed or subscription + MOVED_PERMANENTLY = 301 :the normal redirect response from prov to a publisher + BAD_REQUEST = 400: Usually indicates that either Json object in request body is incorrect in some way, or an Invalid parameter value was included in query string. + UNAUTHORIZED = 401 : Usually indicated either request was missing Authorization header, or indicates incorrect Username/password credentials + FORBIDDEN = 403 : Usually indicates the request originated from an unauthorized IP address, or that a client certificate was not a part of authorized list. + NOT_FOUND = 404 : Usually indicates an incorrect URI + METHOD_NOT_ALLOWED = 405 : Indicates an HTTP method is not accepted for given URI \ No newline at end of file -- cgit 1.2.3-korg