Traffic monitoring settings

The Traffic Monitor settings enable you to configure the traffic monitoring available in the web-based API Gateway 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 Server Settings node in the Policy Studio tree, and click Monitoring > Traffic Monitor. To confirm updates to these settings, click Save at the bottom right of the screen.

To access traffic monitoring in API Gateway Manager, go to http://localhost:8090, and click the Traffic button in the toolbar.

Configuration

You can configure the following Traffic Monitor settings:

Enable Traffic Monitor:
Select whether to enable the web-based traffic monitoring in in API Gateway Manager. This is enabled by default.

Transaction Store Location Settings:
Enter the Transaction Directory that stores the traffic monitoring data files and database. You must enter the location relative to the API Gateway instance directory, which is the location where the server instance runs. For example:

The Transaction Directory defaults to conf/opsdb.d. If this directory or the database does not exist when the API Gateway starts up, they are recreated automatically.

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.
Record sent data for transactions Select whether to record the sent payload data for the message transaction. This is enabled by default.
Record received data for transactions Select whether to record the received payload data for the message transaction. This is enabled by default.
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 the API Gateway Policy Developer Guide.

Details of inbound and outbound transactions are also written to the transaction event log. If recording of inbound or outbound transactions is disabled in Traffic Monitor settings, transaction data will not be written to the event log. For more details, see Transaction event log settings.

Transaction Expiry Settings:
The following settings configure when a new transaction file is created. This occurs when the maximum transaction file size is exceeded or when the maximum number of transactions is reached (whichever occurs first).

Target transaction file size

Enter the target size of the transaction file, and select the units from the list. Defaults to 8 MB. When this limit is exceeded, no new transactions are added to the file, and a new file is created.

Note Transaction files may exceed this limit due to continuing traffic on existing transactions. The current file is closed only when all current transactions using the file are complete.This means that the specified file size may be exceeded, but no more transactions are stored in the file when this limit is reached. For example, with the default of 8 MB, assume the current file size is 7 MB, and a 100 MB transaction is being logged, making a total of 107 MB. No more transactions are logged in this file, and a new file is created.
Maximum number of transactions per file Enter the maximum number of transactions stored in the file. Defaults to 100000 transactions. When this limit is reached, no new transactions are written. The current file is closed when all current transactions using the file are completed.
Maximum number of transaction files Enter the maximum number of transaction files to store on disk at any one time. Defaults to 128. When this limit is reached, old files that have no open transactions are purged.
NoteThe number of transaction files may be exceeded if the oldest file still has open transactions.

Related Links