This guide explains how to explore, filter, and understand the metrics used in Kiuwan Analyses. To access the Metrics, navigate to this option Model Management > Metrics.
Here, you can view all available metrics, which are active in your current model version, and organize them with filters. While Kiuwan metrics are not editable, you can tag them as needed. All the available metrics are mandatory; when a model is published, all of them will be automatically added to the current model. This way, your analyses will contain as much information about metrics as Kiuwan can give you.
Metrics Section
Filters
The filter panel helps you narrow down the metrics displayed. You can combine multiple filters to refine your search.
- Active: Shows the active metrics
- Name or description: Shows the metrics that match the pattern written. This pattern is contained in the name or description of the metric and is highlighted in the metrics tree.
- Language: Shows the metrics that match the selected language.
- Category: Shows the metrics that match the selected category.
- Tag: Shows the metrics that contain one or more tags.
- + Filters: Contains more advanced filters:
- Metric code: Show the metrics whose metric identifier matches the specified pattern.
- Engine version: Show the metrics that match with the selected Kiuwan engine version.
- Default configuration: Shows the metrics that have the default configuration.
Each time the filter is changed, the metric counter under the filter section is updated according to the specified filter.
Metrics tree
The metrics are displayed in a tree structure, which you can collapse or expand using the Expand all and Collapse all buttons. By default, the tree is collapsed.
Each metric shows its active status, its name, its category, and the technologies that it implements. Hover over a language item to view the supported languages.
Or, hover over the help iconto view details of some of the properties of each metric.
Metric Information
Click the name of a metric to show the metric details window, divided into several sections:
| Name | Description |
| Languages | The languages this metric covers. |
| Name | Name of the metric. |
| Description | A full description of the metric explaining how it operates and the programming languages it applies to. |
| Parameters | The parameters of the metrics. |
| Thresholds | It contains indicative information about which metric values are considered: Good, Bad, or Regular. Thresholds can be defined by technology. |
| Tags | Metrics can be tagged. The field Custom tag is editable and you can add your tags or use Kiuwan's. |
| Category | It shows the category the metric belongs to. This value is not editable. |
| Range | It shows the valid values for the metric and how to know when a value is good for your application. These values aren't editable. |
| Value meaning | It shows the documentation references for the metric. These values aren't editable. |
| References | References to the source of the metric. |
| Code Examples | This section shows the value obtained when the metric is applied to the code examples provided. A code example is provided for each supported technology. |
| Details |
|
| Implementations | Choose one of the technologies supported by the metric and see its implementation code, Java class, and description. |
| Internal parameters | The name-value pairs of the parameters used internally by the metric. |