Viewing API interactions - BlueCat Address Manager - 9.3.0

Address Manager API Guide

prodname
BlueCat Address Manager
version_custom
9.3.0

You can view API interactions with Address Manager in the api-diagnostics.log file. It's a rolling log file that, by default, rotates when it reaches 100MB in size.

To view the api-diagnostics.log file :

  1. Log in to Address Manager via SSH using the root account.
  2. Run the following command:
    root@bam12:/opt/server/proteus/log# vi api-diagnostics.log
    The file contents display in JSON format, similar to the following example:
    {"t":"2017-03-22T17:56:32.890Z","id":155,"m":"addEntity","tid":3442,"c":
    "172.16.6.87","u":"api","us":38,"hm":"POST","ma":{"parentId":1,"entity":
    {"id":0,"name":"Config-AddDeploymentOptionsRestIT-60856961-15af729c09a",
    "type":"Configuration","properties":null}}}
    {"t":"2017-03-22T17:56:32.935Z","id":155,"m":"addEntity","hs":200,"rt":
    "Long","r":101078,"d":44}
    {"t":"2017-03-22T17:56:33.000Z","id":156,"m":"addEntity","tid":43,"c":
    "172.16.6.87","u":"api","us":38,"hm":"POST","ma":{"parentId":101078,
    "entity":{"id":0,"name":"DeploymentOptioninServerGroup","type":
    "ServerGroup","properties":null}}}
    {"t":"2017-03-22T17:56:33.018Z","id":156,"m":"addEntity","hs":200,"rt":
    "Long","r":101090,"d":18}
    {"t":"2017-03-22T17:56:33.095Z","id":157,"m":"addServer","tid":48,"c":
    "172.16.6.87","u":"api","us":38,"hm":"POST","ma":{"configurationId":101078,
    "name":"testServer1","defaultInterfaceAddress":"1.1.1.1","fullHostName":
    "test.server1.com","profile":"ADONIS_1950","properties":{}}}
    Below is an example of a single API call within the file:
    {"t":"2017-03-22T17:56:36.160Z","id":158,"m":"linkEntities","tid":43,"c":
    "172.16.6.87","u":"api","us":38,"hm":"PUT","ma":{"entity1Id":101090,"entity2Id"
    :101091,"properties":{}}}
    {"t":"2017-03-22T17:56:36.189Z","id":158,"m":"linkEntities","hs":200,
    "r":null,"d":29}

    Fields in the api-diagnostics.log file

    The following table describes the meaning of each field shown in the api-diagnostics.log file.

    Field type Abbreviation Meaning
    Common "t" The date and time of the API call
    "id" The API call ID
    "m" The API call method
    Enter "tid" The API call thread ID
    "c" The client IP address where the API call is from
    "u" The username used in the API call
    "us" The user session of the API call
    "hm" The HTTP method of the API call (REST only)
    "ma" The method arguments of the API call
    Exit "hs" The HTTP status of the API call (REST only)
    "rt" The result type of the API call (non-void results only)
    "rl" The result length of the API call (array results only)
    "r" The user session of the API call (non-void results only)
    Exception "e" The exception localized message
    Common exit/exception "d" The time to respond in milliseconds