Connection metrics

Available from version 26.3: This topic describes how to enable and download performance metrics for individual connections.

Overview

Use connection metrics to troubleshoot synchronizations that take longer than expected. Metrics are collected per connection, so you can investigate one connection without changing logging behavior for all connections.

By default, connection metrics are disabled. Summary metrics capture one record per iteration. Detailed metrics capture each metric collection point in an iteration. If you enable detailed metrics, summary metrics are also enabled for that connection.

Manage connection metrics

Use the Connection Metrics dialog box to enable metrics and download metrics files.

To configure and download connection metrics:

  1. In the top banner, click Settings, and select Connection Metrics.
  2. In the Connection Metrics dialog box, locate the connection row.
  3. Select Summary Metrics or Detailed Metrics, and click Save.
  4. To download metrics files, click the download icon in the Actions column for the relevant connection.
  5. Open the downloaded package to review the summary and detailed metrics files.

Metrics collection starts only after you save the settings, and you can update these settings while the connection is running.

Metrics files

Metrics files are written in JSON format. For details about log locations, see Manage log files.

Each connection generates separate summary and detailed metrics files. File names include the connection name and the metrics type, for example, JiraCloud_Octane-summary-metrics.log and JiraCloud_Octane-details-metrics.log. Up to 10 files are retained per connection, per metric type. The maximum size is 25 MB per file, and older files are purged automatically.

Permissions

Site and Admin users can modify connection metrics settings. User and ReadOnly users can view connection metrics status but cannot modify metrics settings. For details, see Security roles.

Troubleshooting

If metrics files are not generated, verify that metrics are enabled and saved for the connection, and then run a new iteration.

See also