Skip to end of metadata
Go to start of metadata

Introduction

The API Logs page displays a table of all API processing logs as well as debug logs (if debug logging is enabled) to provide publishers and consumers help in troubleshooting related issues. Logs display for Custom, OData, and Proxy APIs when they are called through the Jitterbit API Gateway in the cloud or through the on-premises Jitterbit Private API Gateway. 

You must have already published an API and executed at least one API request in order to see API log data.

Debug logging can be enabled on a new API at the time it is created and published or the Enable Debug Mode Until field can be set on any existing API by accessing the API in My APIs and selecting View/Edit.  Detailed instructions to create or edit an API and instructions to enable debug mode are available at API Creation and Configuration.

To access the API Logs page, log in to the Harmony Portal and select the API Manager card. Click on the My APIs dropdown menu and select API Logs from the list.

The top of the API Logs page displays as shown in the image below.

Filter By

The Filter by dropdowns allow you to drill down and display API logs based on specific criteria across any combination of environments, APIs, profiles, status codes, or request methods, as needed.

Each filter displays a dropdown list of criteria from which you can select one or multiple criteria. The default value for each filter is All

The filters display along the top of the page to the right of the My APIs dropdown menu. Each filter is described below.

  • Environments: The dropdown displays a list of the environments created within the Organization. Select one environment to filter the logs to only APIs created in that environment (URLs contain the environment name) or select multiple environments to view a larger subset. 
  • APIs: The dropdown displays a list of the APIs that are published within the Organization and includes all published versions of each API.  Select one API to filter the logs to the specific version of one API or multiple APIs to view a larger subset.
  • Profiles: The dropdown displays a list of the security profiles created within the Organization. Select one profile (i.e. a user or a group of users) to filter the logs to only users that access an API by authenticating through the selected profile or select multiple profiles to view a larger subset. 
  • Status Codes: The dropdown displays HTTP response status codes by group (i.e. Success (2xx), Redirections (3xx), Client Errors (4xx), Server Errors (5xx)). For reference see w3.org status code definitions. Select one status code group to filter the logs to API requests that are assigned a status code within the selected group or select multiple status codes to view a larger subset.

  • Request Methods:  The dropdown displays a list of the HTTP request methods (i.e. GET, PUT, POST, DELETE, PATCH). For reference see w3.org request methods or wikipedia.org request methods. Select one or multiple request methods to view a subset of the logs. 

View Data

The View Data option allows you to display logs within a specific period of time. The default setting for the period of time is Last 7 Days.

  • Select the dropdown arrow to the right of View Data in the upper right corner of the API Logs page and select the desired period of time from the dropdown list (i.e. Last 10 Minutes, Last 1 Hour, Last 10 Hours, Last 24 Hours, Last 7 Days, Last 1 Month, Custom).
  • Selecting Custom allows you to display API logs within the specified custom time period. When this option is selected, additional From and To calendar fields display. 

    • Click on the calendar icon  in the right corner of the From field to display the calendar showing the current date and time.
    • Click on the clock icon  to display the current time. Use the plus (+) and minus (-) symbols to set the desired hour and minutes. Then click the Set Time button to return to the calendar.
    • Use the greater than (<) and less than (>) symbols to scroll to the desired month and click on the desired day within the month.
    • Click the dropdown arrow next to the current year to display a list of years and select the desired year.  Click Done at the bottom to close the calendar.  The new starting date and time display in the From field. 
    • Repeat these steps within the To field to set the ending date and time for your custom time period.

Use the search bar to filter the logs table by the queried criteria.

    • Valid search formats correspond with the column names and values in the logs table. Examples of valid search criteria are provided below the search bar on the API Logs page. The Search Examples table below includes examples of valid and invalid search criteria.
    • You can also search based on a combination of criteria. Enter a semi-colon ";" between each criterion to create a combined search. Examples of valid combined searches are listed below.
    • To execute the search, click the magnifying glass to the right of the search bar.
    • To further restrict search results only to logs with messages (i.e. empty logs are excluded), click the checkbox for Only logs with messages to the far right of the search bar. The search results will automatically refresh.

Search Examples

Column NameValid SearchInvalid Search
Request ID

requestid=123%;

requestid=fI9KRyjM%;

requestid!=123%;
Request URI

requesturi=%acme2.jitterbit.net%;

requesturi=%jitterbit.net/defaultUrlPrefix/test;

requesturi=%[environment]/[version]/test;

requesturi=%[environment]/[version]/tes%

requesturi!=%acme2.jitterbit.net%;

Response Time

responsetime>5;

responsetime<5;

responsetime>=5;

responsetime<=5;

responsetime=0;

responsetime!=5;


Source IPsourceip=14.141%;

sourceip!=14.141%;

Source Application

sourceapp=Mozilla%;

sourceapp=%Chrome%;

sourceapp!=Mozilla%;

Message

message=%REJECT%; 

message=%Access Denied%;

message=%Ran successfully!%;

message!=%REJECT%;

Combined Search Examples

message=%Access Denied%;requesturi=%contacts%;

requestid=%yzaccwui%;message=%REJECT%;
requesturi=%contacts%;responsetime<=2;
responsetime>=5;sourceapp=%Chrome%;
responsetime>=5;sourceip=70.5%;
sourceapp=%Chrome%;message=%REJECT%;

sourceapp=%Chrome%;responsetime<=1;

sourceip=70.5%;requesturi=%contacts%;

Additional Options

Additional API log options display on the left side of the page directly above the search bar.

View Last Refreshed

The logs displayed in the table refresh dynamically as you select filter options and drill down to specific target criteria.  View Last Refreshed displays the last time the data was refreshed either dynamically or manually (time format: h:mm:ss AM/PM).

Refresh

Manually refresh the logs table (based on the current filter, view and search selections) by clicking on the Refresh link. 

Download as CSV 

Debug logs (if enabled) contain a great deal of searchable information about the inbound or outbound call. You can download the detailed log data (based on your filter, view and search selections) by clicking on the Download as CSV link. The file named debug-log.csv automatically downloads.

TIP: Debug logging can be turned on at any time by opening the API in View/Edit mode within the API Creation and Configuration page.

View API Logs

The following data displays in the API Logs table:

  • Time Stamp: The timestamp of the API request, in the current time zone.
  • Status Code: The HTTP status code. For reference see w3.org status code definitions.
  • Request ID: A unique ID for the API request.
  • Request Method: The API request method (e.g. GET, PUT, POST, custom type).
  • Request URI: The full URL that was called for the API request or response. Hover over the Request URI field to view the full URL and right-click to copy the link.
  • Response Time: The amount of time, in milliseconds, that the operation took to execute.
  • Source IP: The external IP of the application or server that called the API.
  • Source Application: This field will be blank unless you are using a custom request header. Hover over the Source Application field to view the full description.
  • Logs are displayed twenty per page.  You can view all the logs within the filter, view and search criteria using the Next and Previous buttons at the bottom of the pages.

View Log Detail

TIP: Debug logging can be turned on at any time by opening the API in View/Edit mode within the API Creation and Configuration page.

  • Click the orange Plus sign at the far right of the row and view more details for a specific log entry. 
  • Debug logs (if enabled) contain a great deal of searchable information about the inbound or outbound call. The debug logs can also be downloaded by selecting the Download to CSV link in the upper left side of the page.

On This Page

Related Topics

Last updated:  Aug 07, 2019


  • No labels