Real-Time Monitoring Settings


You can configure real-time monitoring settings at the API Gateway process level. For example, these enable you to specify monitoring of the message content. API Service Manager and API Gateway Analytics use this data to display graphical reports in their web-based interfaces. In addition, for API Gateway Analytics, you can also specify the database to which the Process writes metrics data.

Configuring Metrics Settings

To configure real-time monitoring settings, select the Settings node in the Policy Studio tree, and click the Metrics tab at the bottom. The following fields are available on the Metrics tab.

Enable real time monitoring:

This enables real-time monitoring globally for the API Gateway. This setting must be selected to monitor traffic processed by the API Gateway, and is enabled by default. To disable real-time monitoring, disable this setting.

[Important] Important

Enabling real-time monitoring has a negative impact on performance. If you wish to maximize performance, disable this setting.

Configuring Reports Settings

Store real time monitoring data for charts/reports:

If you wish real-time monitoring data to be written to a database, select this setting. This enables the following fields.

Use the following database:

Click the button on the right to select a database in which you wish to store the metrics data. If you have already configured the database connection, you can select it in the tree. To add a database connection, right-click the Database Connections tree node, and select Add DB Connection. Alternatively, you can add database connections under the External Connections node in the Policy Studio tree view. For more information on configuring database connections, see the Database Connection topic.

[Note] Note

API Gateway Analytics must be configured to read metrics data from the database that the API Gateway is configured to write the metrics data to. For more details, see the chapter on configuring the database in the Oracle API Gateway Installation and Configuration Guide.

Store specified message attribute values:

Select this setting to store the values of specified messages attributes in the database. Click the Add button, enter the appropriate message attribute name in the Value field, and click OK. Repeat to add multiple message attributes.

When the specified message attributes are present in a message running through the API Gateway, their values are then stored the database. For example, you could specify my.example.attribute to be stored in the database. Then for any message running through the API Gateway that has the my.example.attribute attribute set, the message ID, attribute name, and the value (for example, My example message subject) are stored in database. You could then use this information to view reports for messages with specific message subjects or IDs.

CPU, Memory, Disk polling interval:

Specifies the interval in seconds when polling CPU use, free memory, and disk settings used in system monitoring. Defaults to 3 seconds.