docs/logging/logging.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Logging
   5 =======
   6
   7 .. note::
   8    * This section is used to describe the informational or diagnostic messages emitted from
   9      a software component and the methods or collecting them.
  10
  11    * This section is typically: provided for a platform-component and sdk; and
  12      referenced in developer and user guides
  13
  14    * This note must be removed after content has been added.
  15
  16
  17 Where to Access Information
  18 ---------------------------
  19 Message Router uses logback framework to generate logs and all the logs are emitted to the console.
  20
  21 Error / Warning Messages
  22 ------------------------
  23 Following are the error codes
  24
  25 | RESOURCE_NOT_FOUND=3001
  26 | SERVER_UNAVAILABLE=3002
  27 | METHOD_NOT_ALLOWED=3003
  28 | GENERIC_INTERNAL_ERROR=1004
  29 | MSG_SIZE_EXCEEDS_BATCH_LIMIT=5001
  30 | UNABLE_TO_PUBLISH=5002
  31 | INCORRECT_BATCHING_FORMAT=5003
  32 | MSG_SIZE_EXCEEDS_MSG_LIMIT=5004
  33 | INCORRECT_JSON=5005
  34 | CONN_TIMEOUT=5006
  35 | PARTIAL_PUBLISH_MSGS=5007
  36 | CONSUME_MSG_ERROR=5008
  37 | PUBLISH_MSG_ERROR=5009
  38 | RETRIEVE_TRANSACTIONS=5010
  39 | RETRIEVE_TRANSACTIONS_DETAILS=5011
  40 | TOO_MANY_REQUESTS=5012
  41 | RATE_LIMIT_EXCEED=301
  42 | GET_TOPICS_FAIL=6001
  43 | GET_TOPICS_DETAILS_FAIL=6002
  44 | CREATE_TOPIC_FAIL=6003
  45 | DELETE_TOPIC_FAIL=6004
  46 | GET_PUBLISHERS_BY_TOPIC=6005
  47 | GET_CONSUMERS_BY_TOPIC=6006
  48 | GET_CONSUMER_CACHE=6011
  49 | DROP_CONSUMER_CACHE=6012
  50 | GET_METRICS_ERROR=6013
  51 | TOPIC_NOT_IN_AAF=6017
  52