> For the complete documentation index, see [llms.txt](https://knowledgebase.autorabit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/metric-rules.md).

# Metric Rules

A metric produces a measured value during an assessment, such as the number of blocker issues or the number of batch jobs. Quality gate conditions compare these values with required results. A metric only runs for an application when it is included in that technology's metric profile. Use this tab to review what each metric measures, the value it returns and where it runs.

Open it from **Operations** → **Quality Control** → **Metric rules** in the sidebar.

{% hint style="warning" %}
You need a role that can view metric rules. Creating, editing, cloning, deleting and activating metrics in profiles need the matching metric permissions.
{% endhint %}

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2FmDPORzGRLr8thShGyaNF%2Fv2-qc-metric-rules.png?alt=media&amp;token=f0575328-479f-4036-afaa-1213434d40de" alt="Metric rules tab with filters and the metric definitions table"><figcaption></figcaption></figure>

## Filters

| Filter                             | Description                                                            |
| ---------------------------------- | ---------------------------------------------------------------------- |
| **Technology**                     | The technology the metric applies to.                                  |
| **Assessment scope**               | Where the metric runs, for example `APPLICATION`, `PROJECT` or `FILE`. |
| **Output**                         | The type of value it returns, for example `NUMBER` or `STRING`.        |
| **Origin**                         | **Supplied** or **Custom**.                                            |
| **Implementation language**        | The language the metric's logic is written in.                         |
| **Search name, identifier or tag** | Finds metrics by name, identifier or tag.                              |

**Saved filters** and **Save filters** keep a combination of filters for later.

## Metric Definitions

The count shows how many metrics match. **Refresh** reloads the table, **Columns** shows or hides columns and **Export** downloads the table.

| Column                          | Description                                                                                                                                                                                                                                   |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Metric**                      | The metric name. Click it to open the metric.                                                                                                                                                                                                 |
| **Technology**                  | The technology the metric applies to.                                                                                                                                                                                                         |
| **Output**                      | The type of value it returns.                                                                                                                                                                                                                 |
| **Assessment scope**            | Where it runs.                                                                                                                                                                                                                                |
| **Origin**                      | **Supplied** or **Custom**.                                                                                                                                                                                                                   |
| **Last updated**                | When the metric last changed. The list shows the most recently changed metrics first; click **Last updated** or the name column to sort.                                                                                                      |
| **Manage / profile membership** | **Edit metric**, **Clone metric** (asks for confirmation, then creates a custom copy and opens it), **Activate in profile** (adds it to metric profiles) and, for custom metrics, **Delete metric**. The actions you see depend on your role. |

{% hint style="info" %}
A metric's presence in this library does not mean every application evaluates it. Profile membership decides which metrics are measured.
{% endhint %}

{% hint style="danger" %}
Deleting a custom metric cannot be undone.
{% endhint %}

## Create a Metric

1. Click **Create metric**.
2. Fill in the fields on **Purpose & measurement**, **Customer guidance** and **Implementation**.
3. Click **Create metric**. **Back to metrics** or **Back to metric rules** leaves without saving.
4. Use **Activate in profile** to include the metric in the metric profiles that need it.

<figure><img src="https://1912836914-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9vAxMuDrkUkB4OXlH9CL%2Fuploads%2Fcet4qEWOclobKJAIpIqP%2Fv2-qc-metric-editor.png?alt=media&amp;token=c178b826-9376-4fd0-9aca-4299d81f1e86" alt="Create metric page with the Purpose and measurement tab"><figcaption></figcaption></figure>

| Field                       | Description                                                                                                                                         |
| --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Metric name**             | Required. A descriptive name, up to 100 characters.                                                                                                 |
| **Technology**              | Required. The technology the metric applies to.                                                                                                     |
| **Metric key**              | Required. The stable identifier that quality gate conditions use. Renaming the metric keeps this key.                                               |
| **Output type**             | Required. The type of value the metric returns.                                                                                                     |
| **Assessment scope**        | Required. Where the metric runs.                                                                                                                    |
| **Tags**                    | Type a tag and press Enter or a comma, or pick an existing tag.                                                                                     |
| **Guidance (Markdown)**     | On **Customer guidance**: what the value means, why it matters and what the application owner should do. **Guidance preview** shows how it renders. |
| **Implementation language** | On **Implementation**: required. The language of the metric's logic, together with the implementation itself.                                       |

## Open or Edit a Metric

Click a metric's name to open it. **Edit definition** lets you change it; click **Save definition** to keep the change, or **Cancel**. **Activate in profile** adds it to metric profiles. Supplied metrics have no **Implementation** tab; clone one to make a custom version you can change.

## Next Steps

* [Metric Profiles](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/metric-profiles.md): include metrics in the profile for a technology.
* [Quality Gates](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/quality-gates.md): use a metric's value in a gate condition.
* [Quality Rules](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/quality-rules.md): review the rules whose findings many metrics count.
* [Quality Control](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control.md): return to the Quality Control overview.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-suite/operations/quality-control/metric-rules.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
