Configuring Traffic Monitoring

Overview

The Traffic Monitor settings enable you to configure the traffic monitoring available in the web-based API Service Manager tool. For example, you can configure where the data is stored and what message transaction details are recorded in the message traffic log.

To access the Traffic Monitor settings, click the Settings node in the Policy Studio tree, and select the Traffic Monitor tab at the bottom of the screen. To access traffic monitoring in API Service Manager, go to http://localhost:8090, and click the Traffic button in the toolbar. For more details, see the topic on Monitoring Services.

[Important] Important

Traffic monitoring may have a negative impact on performance. If you wish to maximize performance, you can disable traffic monitoring.

Configuration

You can configure the following Traffic Monitor settings:

Enable Traffic Monitor:

Select whether to enable the web-based Traffic Monitor tool. This is enabled by default.

Data Directory:

Enter the directory that stores the traffic monitoring data files and database (data.sdb). Enter the location relative to the directory in which the API Gateway is installed. Defaults to conf/opsdb.d. If this directory and/or the database do not exist when the API Gateway starts up, they are recreated automatically.

Data Persistence Settings:

You can configure the following data persistence settings:

Record inbound transactions Select whether to record inbound message transactions received by the API Gateway. This is enabled by default.
Record outbound transactions Select whether to record outbound message transactions sent from the API Gateway to remote hosts. This is enabled by default.
Record policy path Select whether to record the policy path for the message transaction, which shows the filters that the message passes through. This is enabled by default.
Record trace Select whether to record the trace output for the message transaction. This is enabled by default.


[Note] Note

These settings are global for all traffic passing through the API Gateway. You can override these persistence settings at the port level when configuring an HTTP or HTTPS interface. For more details, see Configuring HTTP Services.

Data Expiry Settings:

You can configure the following data expiry settings:

Max. database entries Enter the maximum number of rows stored in the traffic monitoring database. Defaults to 1000000 rows.
Max. database size Enter the maximum size of the traffic monitoring database file, and select the database size units from the list. Defaults to 1 GB.
Purge data older than Enter the period of time to store data, and select the time units from the list. Data older than the specified time is purged from the database. Defaults to 5 days.