Custom Aggregated Metrics (actual)

Owned by Maksim Chorny
Last updated: Jul 18, 2024
3 min read

 

This page describes the process of creating and managing custom aggregated metrics. As a creator of aggregated metric for a required unit, ensure that the following conditions are met:

  1. You have the Aggregation Admin permissions.

  2. You are on required high-level unit.

  3. There is an aggregation dataset on the PERF platform. More information on Aggregation Dataset here: Aggregation Dataset

Create  Сustom Aggregated Metric

  1. On the main menu, click Perf, and then open the required high-level unit and open the Delivery Metrics page.

  2. Click Add → Metrics on the Delivery Metrics. The Metric Catalog is opened.

  3. Find Custom Aggregated Metric category in the left navigation menu.

  4. Click Create New Aggregated Metric.

  5. Provide a Metric Name. The following requirements should be met:

  • The minimum length of the name should be 5 characters.

  • The name must be unique among all metrics, whether they are published or in draft status.

  • Cyrillic symbols are not permitted; only English characters are allowed.

  1. You can add a metric overview in the "Description." This text will be displayed in the metric catalog and in the widget tooltip.

  2. Click Next.

As soon as 'Next' is clicked and navigation is made to the next step, the metric is saved and becomes available in the metric catalog in draft state.

8. Create custom data selection over PERF data using PERF Query Language (more about it in the Dataset selection) and click Next.

 

  1. Visualize chart (also see Chart Preview)

  1. Click Next

  2. You can add drill downs (more details Drill Downs)

  3. Click Publish.

Edit Custom Aggregated Metric

On the Delivery Metrics page, for the required high-level unit:

1. Click Add → Metrics on the Delivery Metrics. The Metric Catalog is opened. 

2. Find Custom Aggregated Metric category in the left navigation menu and open the category

3. Click the gear icon for the necessary aggregated metric and click Edit. 

If a user clicks 'Edit,' it locks the metric for editing by other users until the changes are either published or deleted by the editor. The name of the editor is displayed in the notification message about the metric lock.

The metric will be automatically unlocked after two business days.

  • Until the user publishes updates, the metric widget will display the previously published version.

  • When a user starts editing the metric, a draft is created (a metric with the same name and a 'Draft' label appears in the Metric Catalog). It is visible only to that user. After publication, the changes from the draft are merged with the previously published version, and the metric is updated.

Delete Custom Aggregated Metric from Metric Catalogue

To delete Custom Aggregated Metric from the Metric Catalog: 

  1. Open required high-level unit on the Delivery Metrics page.

  2. Click Add → Metrics on the Delivery Metrics. The Metric Catalog is opened. 

  3. Find Custom Aggregated Metric category in the left navigation menu and open the category

  4. Click the gear icon for the necessary aggregated metric and click Delete. 

Add Custom Aggregated Metric to Unit Board

To add Custom Aggregated Metric to the Delivery Metrics page:

  1. Open required high-level unit on the Delivery Metrics page.

  2. Click Add → Metrics on the Delivery Metrics. The Metric Catalog is opened. 

  3. Find Custom Aggregated Metric category in the left navigation menu and open the category

  4. Click Add for the necessary aggregated metric.

Remove Custom Aggregated Metric from Unit Board

To remove Custom Aggregated Metric from Delivery Metrics page:

  1. Open required high-level unit on the Delivery Metrics page.

  2. Find required Custom Aggregated Metric and click 3-dots widget menu.

  3. Click Delete.