Configuring the amount of metrics data to record

To configure the metrics you want to include, you use a setting in portal-ext.properties. This setting applies to both the metrics log file and the Performance Metrics page.

The metrics logging can include:
  • Queries by Dgraph nodes.
  • Portlet server executions by component. The server side code is written in Java.

    It handles configuration updates, configuration persistence, and Dgraph queries. The server-side code generates results to send back to the client-side code.

    Server executions include component render, resource, and action requests.

  • Component client executions for each component. The client-side code is hosted in the browser and is written in JavaScript. It issues requests to the server code, then renders the results as HTML. The client code also handles any dynamic events within the browser.

By default, only the Dgraph queries and component server executions are included.

You use the df.performanceLogging setting in portal-ext.properties to configure the metrics to include. The setting is:
df.performanceLogging=<metrics to include>
Where <metrics to include> is a comma-separated list of the metrics to include. The available values to include in the list are:
Value Description
QUERY If this value is included, then the page includes information for Dgraph queries.
PORTLET If this value is included, then the page includes information on component server executions.
CLIENT If this value is included, then the page includes information on component client executions.
In the default configuration, where only the Dgraph queries and component server executions are included, the value is:
df.performanceLogging=QUERY,PORTLET
To include all of the available metrics, you would add the CLIENT option:
df.performanceLogging=QUERY,PORTLET,CLIENT
Note that for performance reasons, this configuration is not recommended.
If you make the value empty, then the metrics log file and Performance Metrics page also are empty.
df.performanceLogging=