Configuring admin API statistics

Configure summary statistics by editing the server.conf.yaml file or by using the administration REST API.

Summary statistics are enabled by default when an integration server is created.

Configuration properties

The Summary section in the server.conf.yaml file controls the in-memory collection and management of summary records used by the /summary administrative APIs:

Property	Description	Default value
summaryOn	Controls whether the in-memory collection of summary records is enabled. Set to active to enable or inactive to disable.	active

Configuring summary statistics

Summary statistics are stored in memory and are enabled automatically when the integration server starts. You can modify the behavior by editing the Summary section in the server.conf.yaml file:

Statistics:
  Summary:
    # Controls the in-memory collection and management of summary records used by the /summary administrative APIs.
    summaryOn: 'active'       # Specifies whether the in-memory collection of summary records is enabled.
                              # valid values: active | inactive
                              # default: active

After modifying the configuration, restart the integration server for the changes to take effect.

Dynamic configuration using REST API

You can dynamically update summary statistics configuration properties without restarting the integration server by using the PATCH endpoint:

PATCH https://hostname:port/apiv2/statistics/summary

{
  "properties": {
    "summaryOn": "active", 
  }
}

The following properties can be configured dynamically:

summaryOn: Set to active to enable or inactive to disable the in-memory collection of summary records.

Changes made through the REST API take effect immediately but are not persisted to the server.conf.yaml file. The summaryOn property can be made permanent by editing the configuration file and restarting the integration server.

Verifying configuration

To verify that Admin API statistics are configured correctly:

Check that the summaryOn property is set to active in the server.conf.yaml file.
Send test messages through a message flow.
Use the summary REST API to retrieve current statistics:
```
GET https://hostname:port/apiv2/statistics/summary
```
Verify that the response contains statistics data with appropriate timestamps.