Monitor APIs and API Firewall instances

There are three types of dashboards you can use to monitor your APIs:

  • General dashboard: This dashboard is fed by data from API Contract Security Audit, API Contract Conformance Scan, and your organizations in 42Crunch Platform. It collates statistics from all of your API collections and focus on the quality and security of your API definitions.
  • Collection dashboards: Like the general dashboard, but the statistics are based on only the APIs in the particular API collection.
  • Security dashboards: These dashboards are fed by data from API Firewall logs, and they focus on the API traffic to the protected APIs. To have data, you must first deploy an API Firewall instance to protect your API.

Note Organization administrators have access to view and modify all API collections in their organization. This means that all API collections in an organization are visible to all organization administrators like the collections were their own, both on the API Collections page and in the monitoring dashboards for API collections. If an organization has several API collections, we recommend using more descriptive collection names that just organization and company name to be able to tell all collections apart.

View API statistics

You can get an overall view on the quality and security of your APIs from the dashboard charts based on results from Security Audit and Conformance Scan.

  1. To view the general dashboard that collates all your API collections, click Dashboard in the main menu. You can see charts for all APIs in all your API collections.

    An example screenshot showing the Dashboard page populated with statistics from three API collections.

  2. Click the toggles to change the view in the charts. If you hover on the charts, you see additional information in tool tips.
  3. To view statistics for a single API collection, go to the collection you want, and click Collection Dashboard.

View security dashboards

After you have deployed the protection for your API, you can monitor the API Firewall instances currently protecting your API as well as the API traffic to it in 42Crunch Platform.

  1. In 42Crunch Platform, go to the API you want, and go to the Protection tab.
  2. To view the API Firewall instances currently protecting your API, click Active Instances. You can see, for example, the names of the instance and the cluster where it is running, and where the instance is storing logs.
  3. An example screenshot showing two active instances for the Pixi API.

  4. For at-a-glance view of the main trends with the protected API, click Security Dashboards.

    An example screenshot of the security dashboard of an API.

View API transaction trace

You can use Trace Explorer to view the detailed trace of the blocked API transactions of any protected API you have access to.

  1. In 42Crunch Platform, click Trace Explorer.

    An example screenshot of the Trace Explorer dialog.

  2. Select the API collection you want.
  3. Select the API which trace to view, and click View. You can see the transaction logs of all the transactions that the API Firewall instance protecting the API have blocked.

    An example screenshot from transaction logs overview on the Protection tab of an API.

  4. To view more details on a blocked transaction, such as the hostname of the API Firewall instance that blocked it, click the transaction you want.
  5. To view the how the transaction was processed, click either Request or Response depending which path you want to view.

    An example screenshot of a request trace showing the details of the request on the left and the processed stages on the right.

Tip You can also get to the transaction logs from the Protection tab of the API.

By default, API Firewall publishes logs to 42Crunch Platform, so that you can monitor the real-time traffic in the dashboards and Trace Explorer. However, you can also switch the logs destination for an API Firewall deployment to a directory you mount to it. For more details, see Switch logs destination for API Firewall logs.