Working with Verbose Logs

A directory is created every minute with the name format as YYYY-MM-DD-HH-MM. All the calls that are logged in a minute become part of one directory and so on. For each call, a sub-directory is created using the name <timestamp>-<Mashery Message ID>.

Mashery Message ID is a globally unique ID generated for every API call that is processed by TIBCO Mashery. The Mashery Message ID provides a possible mechanism for administrators to create a golden thread for debugging issues between TIBCO Mashery, your partners and your backend system. To be able to include this GUID in request and response headers, you can toggle on Include X-Mashery-Message-ID in Request and Include X-Mashery-Message-ID in Response properties on in the Services>Endpoint>Properties page in the TIBCO Mashery Administration Dashboard.

Within each sub-directory, four log files are InboundRequest.log, InboundProcessed.log, OutboundResponse.log, OutboundProcessed.log.
  • InboundRequest contains the request data on the API call as it is originally received by Mashery Local from the client application.
  • InboundProcessed contains the Mashery processed version of the inbound request as sent to API server (or to cache if enabled).
  • OutboundResponse contains the response data as it is originally received by Mashery from the API server (or from cache if enabled).
  • OutboundProcessed contains the Mashery processed version of the outbound response as sent to the client application.

Each of the four files contain some important metadata written as key-value pairs with 1 pair on one line. After the metadata, a new delimiter line is written followed by the actual message.

The metadata included are:
  • Key: Key a developer uses to get access to a Package Plan or API.
  • Service ID: TIBCO Mashery generated unique ID to identify an API.
  • Endpoint ID: TIBCO Mashery generated unique ID to identify an Endpoint.
  • Site ID: TIBCO Mashery generated unique ID to identify your Site within the TIBCO Mashery Network.
  • IP address: IP address of the client application invoking the API call.
  • Method (if available): Method that was being accessed in the API call (available if appropriate Method Configuration settings are specified in Services>End-points>Properties tab in the TIBCO Mashery Administration dashboard).
  • Cache hit: 1 if cache is enabled and response is met from cache, 0 otherwise.
  • Error message (if any): TIBCO Mashery generated error message on that API call (if any).