Adding a metric bar to value streams#

Add the Metric bar to the value stream.

You can provide metrics data to value streams and display the data in charts on the Metric bar. To enable the Metric bar, add metricsBar definitions to the value_stream_name.json file attached to the value stream.

Note: Before starting, define metrics definitions

To add the metrics bar data to the value_stream_name.json file, complete the following steps:

  1. On the Value Stream page, click Download value stream map, .
  2. Using a text editor, add metricsBar definition to the value_stream_name.json file. The properties are defined later in this topic.
  3. Upload the file to your value stream.
  4. On the value stream page, click Metric bar .

After enabling the metric bar, add charts for the metric data related to the value stream. Adding items to the value stream is described later in this topic.

Metric bar JSON parameters#

Metric bar parameters are defined in the metricsBar area of the value_stream_name.json file.

Efficiency Metric Description
relativeTime Date range for data calculation. Valid values are: HOUR24, DAY7, DAY30, DAY90, MONTH6, YEAR1, ALL.
metricDefinitionId Metric definition to apply. Any metric definition defined to HCL™ Accelerate can be referenced.
name Metric name
displayType Determines how data is rendered. Valid values are: bar, percent.
calculationType Determines how the data is aggregated. Valid values are: mostRecent, trendMostRecent. The mostRecent value shows the most recent run compared to the average. The trendMostRecent adds a trend breakdown to the most recent data.

The following example adds a bar chart for work items over the past 30 days.

 "metricsBar": [
    {
      "relativeTime": "DAY30",
      "metricDefinitionId": "WORK_ITEM_TYPE_COUNT",
      "name": "Work Item Type Count",
      "displayType": "bar",
      "calculationType": "trendMostRecent"
    }
  ]

Metrics definitions#

The Value Streams page metric definitions are detailed in the following tables.

Delivery flow-type charts

Chart Description
Lead Time The time required for a dot to go from business accepted to value realization. This includes both engineering time and non-value-added waiting time between sub-processes.
Cycle Time This is similar to lead time, except cycle time is measured from when the development team begins work to when that work reaches the customer.
Build Counts Number of builds by type in a specified time period.
Deployment Counts Number of deploys by status in a specified time period. The metric can be set to process names, environment, result, type, or application. The default metric is result. The data can scoped by data set, environment, process, result, or version.
Average Load The number of work items active or waiting in a value stream at a given time. Load measures utilization capabilities of value streams related to productivity in the process flow. "Active" refers to the stages from the lead-time start until the lead-time end.
Throughput The rate of work items completed during a period of time. Improving throughput can result in better responsiveness to customer requirements and may yield lead time reductions for value streams.
Distribution The proportion of different types of work items over time. This provides teams visibility into the type of work being completed (features, defects, tasks, and so forth.)

For uncommon metric names between the Value Streams and Insights pages associated with delivery charts, refer to the following equivalence table for details.

Metric name equivalences

Value Streams Insights
Build Frequency Build Counts
Deploy Frequency Deployment Counts
Average Load Load
Bottlleneck A constriction in local throughput that limits the global throughput of a system. Bottlenecks include a set of events or conditions that occur in the value stream that you monitor in the process. Refer to the bottleneck detection page for further details. Note:Bottleneck is not a metric. This indicator can be added and viewed only on the metrics bar and the value stream table view. N/A

Quality-type charts

Chart Description
Coverage By Branch Percent of branches with associated tests executed during testing.
Coverage By Function Percent of program functions executed during testing.
Coverage By Line Percent of lines of code executed during testing.
Functional Tests Number of functional tests by status in a specified period of time.
Static Code Analysis Number of issues by severity in a specified period of time.
Unit Tests Number of tests by status in a specified period of time.

Risk-type charts

Chart Description
Container Vulnerabilities Number of container vulnerabilities by severity in a specified period of time. The metric can be set to process names, environment, result, type, application, tag, or team. The default metric is result. The data can scoped by data set, process, or version.
Application Vulnerabilities Number of application vulnerabilities by severity in a specified period of time.

Metric bar display types#

To add metric data to the Metric bar, complete the following steps:

  1. On the value stream page, click metric bar icon to display the metric bar.
  2. Click add a metric icon to display the Add Metrics window.
  3. Click add metric icon to add the required metric or click expand collapse icon to expand the required metric that you want to add to the Metric bar.

    Note: For metrics having an expand and collapse button, you can define the metric in the following step. For metrics having only an add button, Metric added! is displayed when you click the button.

  4. Define the metric by completing the following steps:

    1. In the Metric Title field, enter a name for the metric. The title is displayed on the Metric bar.
    2. In the Relative time field, select a time range. Data within the time range are calculated.
  5. Click Add to insert the metric into the Metric bar.
  6. The Metric added! popup is displayed next to the add metric icon icon.
  7. To remove a metric, hover over the metric, click overflow icon and then select Remove metric.

Note: In addition to lead- and cycle-time, you can select up to six metrics for a total of eight metrics that can be displayed at one time on the metric bar. Also, when you click on either the Lead Time or Cycle Time on the Metric bar, the Lead time distribution or Cycle time distribution graph window is respectively displayed.

Parent topic: Value stream metrics