summaryrefslogtreecommitdiffstats
path: root/docs/logging
diff options
context:
space:
mode:
authorsu622b <sunil.unnava@att.com>2018-04-16 16:50:25 -0400
committersu622b <sunil.unnava@att.com>2018-04-16 16:50:52 -0400
commit1c624de20ff321fe5c86c4df873952d82b1946b3 (patch)
tree5bc44799ec76af23108d7bee9d71f8038fd0a05a /docs/logging
parent7cd58518e9dc263521f252c1095a43244e464222 (diff)
updated the documentation
Issue-ID: DMAAP-413 Change-Id: I4955f7e512e594c189c5183ec83c5769d33d8f05 Signed-off-by: su622b <sunil.unnava@att.com>
Diffstat (limited to 'docs/logging')
-rw-r--r--docs/logging/logging.rst52
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/logging/logging.rst b/docs/logging/logging.rst
new file mode 100644
index 0000000..0ddf365
--- /dev/null
+++ b/docs/logging/logging.rst
@@ -0,0 +1,52 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging
+=======
+
+.. note::
+ * This section is used to describe the informational or diagnostic messages emitted from
+ a software component and the methods or collecting them.
+
+ * This section is typically: provided for a platform-component and sdk; and
+ referenced in developer and user guides
+
+ * This note must be removed after content has been added.
+
+
+Where to Access Information
+---------------------------
+CLAMP uses logback framework to generate logs and all the logs are emitted to the console.
+
+Error / Warning Messages
+------------------------
+Following are the error codes
+
+RESOURCE_NOT_FOUND=3001
+SERVER_UNAVAILABLE=3002
+METHOD_NOT_ALLOWED=3003
+GENERIC_INTERNAL_ERROR=1004
+MSG_SIZE_EXCEEDS_BATCH_LIMIT=5001
+UNABLE_TO_PUBLISH=5002
+INCORRECT_BATCHING_FORMAT=5003
+MSG_SIZE_EXCEEDS_MSG_LIMIT=5004
+INCORRECT_JSON=5005
+CONN_TIMEOUT=5006
+PARTIAL_PUBLISH_MSGS=5007
+CONSUME_MSG_ERROR=5008
+PUBLISH_MSG_ERROR=5009
+RETRIEVE_TRANSACTIONS=5010
+RETRIEVE_TRANSACTIONS_DETAILS=5011
+TOO_MANY_REQUESTS=5012
+RATE_LIMIT_EXCEED=301
+GET_TOPICS_FAIL=6001
+GET_TOPICS_DETAILS_FAIL=6002
+CREATE_TOPIC_FAIL=6003
+DELETE_TOPIC_FAIL=6004
+GET_PUBLISHERS_BY_TOPIC=6005
+GET_CONSUMERS_BY_TOPIC=6006
+GET_CONSUMER_CACHE=6011
+DROP_CONSUMER_CACHE=6012
+GET_METRICS_ERROR=6013
+TOPIC_NOT_IN_AAF=6017
+