docs/sections/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 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   4
   5 Logging
   6 =======
   7
   8 .. note::
   9    * This section is used to describe the informational or diagnostic messages emitted from
  10      a software component and the methods or collecting them.
  11
  12    * This section is typically: provided for a platform-component and sdk; and
  13      referenced in developer and user guides
  14
  15    * This note must be removed after content has been added.
  16
  17
  18 Where to Access Information
  19 ---------------------------
  20 AAF uses log4j framework to generate logs and all the logs are stored in a persistent volume.
  21
  22 * For Standalone O/S, logs are placed on the machine. cd as follows
  23 * For any AAF Container or Kubernetes, get a bash prompt into that container. Then cd as follows.
  24
  25 .. code:: bash
  26
  27   $ cd /opt/app/osaaf/logs
  28
  29 For convenience, there is a tool to easily tail all component's transactions realtime, from this directory:
  30
  31 .. code:: bash
  32
  33  $ bash taillog
  34
  35 Error / Warning Messages
  36 ------------------------
  37 Following are the error codes
  38
  39 | Create a Permission - Expected=201, Explicit=403, 404, 406, 409
  40 | Set Description for Permission - Expected=200, Explicit=404, 406
  41 | Delete a Permission Expected=200, Explicit=404, 406
  42 | Update a Permission - Expected=200, Explicit==04, 406, 409
  43 | Get Permissions by Type - Expected=200, Explicit=404, 406
  44 | Get Permissions by Key - Expected=200, Explicit=404, 406
  45 | Get PermsByNS - Expected=200, Explicit==404, 406
  46 | Get Permissions by Role - Expected=200, Explicit=404, 406
  47 | Get Permissions by User, Query AAF Perms - Expected=200, Explicit=404, 406
  48 | Get Permissions by User - Expected=200, Explicit=404, 406
  49 | Create Role - Expected=201, Explicit=403, 404, 406, 409
  50 | Set Description for role= - Expected=200, Explicit=404, 406
  51 | Delete Role - Expected=200, Explicit==404, 406
  52 | Delete Permission from Role - Expected=200, Explicit=404, 406
  53 | Add Permission to Role - Expected=201, Explicit=403, 404, 406, 409
  54 | Set a Permission's Roles - Expected=201, Explicit=403, 404, 406, 409
  55 | GetRolesByFullName - Expected=200, Explicit=404, 406
  56 | GetRolesByNameOnly - Expected=200, Explicit=404, 406
  57 | GetRolesByNS - Expected=200, Explicit=404, 406
  58 | GetRolesByPerm - Expected=200, Explicit=404, 406
  59 | GetRolesByUser - Expected=200, Explicit=404, 406
  60 | Request User Role Access - Expected=201, Explicit=403, 404, 406, 409
  61 | Get if User is In Role - Expected=200, Explicit=403, 404, 406
  62 | Delete User Role - Expected=200, Explicit=403, 404, 406
  63 | Update Users for a role - Expected=200, Explicit=403, 404, 406
  64 | Update Roles for a user - Expected=200, Explicit=403, 404, 406
  65 | Get UserRoles by Role - Expected=200, Explicit=404, 406
  66 | Get UserRoles by User - Expected=200, Explicit=404, 406
  67 | Create a Namespace - Expected=201, Explicit=403, 404, 406, 409
  68 | Set a Description for a Namespace - Expected=200, Explicit=403, 404, 406
  69 | Delete a Namespace - Expected=200, Explicit=403, 404, 424
  70 | Add an Admin to a Namespace - Expected=201, Explicit=403, 404, 406, 409
  71 | Remove an Admin from a Namespace - Expected=200, Explicit=403, 404
  72 | Delete an Attribute from a Namespace - Expected=200, Explicit=403, 404
  73 | Add an Attribute from a Namespace - Expected=201, Explicit=403, 404, 406, 409
  74 | update an Attribute from a Namespace - Expected=200, Explicit=403, 404
  75 | Add a Responsible Identity to a Namespace - Expected=201, Explicit=403, 404, 406, 409
  76 | Remove a Responsible Identity from Namespace - Expected=200, Explicit=403, 404
  77 | get Ns Key List From Attribute - Expected=200, Explicit=403, 404
  78 | Return Information about Namespaces - Expected=200, Explicit=404, 406
  79 | Return Child Namespaces - Expected=200, Explicit=403, 404
  80 | Get Users By Permission - Expected=200, Explicit=404, 406
  81 | Get Users By Role - Expected=200, Explicit=403, 404, 406
  82 | Is given BasicAuth valid? - Expected=200, Explicit=403
  83 | Is given Credential valid? - Expected=200, Explicit=403
  84