Enablement Section Performance Indicators

Maintained by:

Regular Performance Indicators

Percentage of installations on the 3 most recent versions of GitLab

Of the total number of self-managed installs, what percentage are on one of the three most recent versions.

Target: Undefined

URL(s)

Chart (Sisense↗)

Status: Unknown

We haven't defined a target yet.

Instrumentation: Attention

Instrumentation of sub metrics is in progress

Other PI Pages

Legends

Health

Value	Level	Meaning
3	Okay	The KPI is at an acceptable level compared to the threshold
2	Attention	This is a blip, or we’re going to watch it, or we just need to enact a proven intervention
1	Problem	We'll prioritize our efforts here
0	Unknown	Unknown

Instrumentation

Value	Level	Meaning
3	Okay	We are correctly capturing and measuring data for GitLab.com and self-managed instances.
2	Attention	Missing one of: GitLab.com or self-managed data.
1	Problem	Missing both: GitLab.com and self-managed data.
0	Unknown	Unknown

How to work with pages like this

Data

The heart of pages like this is the Performance Indicators data file which is in YAML file. Each - denotes a dictionary of values for a new (K)PI. The current elements (or data properties) are:

Property	Type	Description
`name`	Required	String value of the name of the (K)PI
`base_path`	Required	Relative path to the performance indicator page that this (K)PI should live on
`definition`	Required	refer to Parts of a KPI
`parent`	Optional	should be used when a (K)PI is a subset of another PI. For example, we might care about Hiring vs Plan at the company level. The child would be the division and department levels, which would have the parent flag.
`target`	Required	The target or cap for the (K)PI. Please use `Unknown until we reach maturity level 2` if this is not yet defined.
`org`	Required	the organizational grouping (Ex: Engineering Function or Development Department)
`is_key`	Required	boolean value (true/false) that indicates if it is a (key) performance indicator
`health`	Required	has two additional elements/property - level (inclusive value between 0-3) and reasons. This should be updated monthly before Key Meetings by the DRI.
`urls`	Optional	list of urls associated with the (K)PI
`sisense_data`	Optional	contains elements/properties related to Sisense, including chart (numeric Sisense widget ID), dashboard (numeric Sisense dashboard ID), shared_dashboard (Sisense shared dashboard ID), embed (v2)
`public`	Optional	boolean flag that can be set to `false` where a (K)PI does not meet the public guidelines.
`instrumentation`	Optional	has two additional elements/property - level (inclusive value between 0-3) and reasons. This should be updated monthly before Key Meetings by the DRI.

Guidelines

Each KPI chart should be a timeseries chart.
- Use Purple bars to denote values.
- Use a single Green bar for the current month (in progress).
- Use a Red stepped-line for timeseries target.
- Optional: Use a Black dashed-line for rolling average.
Each KPI should have a standalone dashboard with a single chart representing the KPI and a text box with a link back to the handbook definition.
- In Sisense, create a shared dashboard link to get the shared dashboard ID.
- In Sisense, use the Share Link action of the chart to get the chart (widget_id) and the dashboard ID.
- Add the shared_dashboard, chart , and the dashboard key-value pairs to the Performance Indicators data file under the sisense_data property
Avoid : in strings as it's an important character in YAML and will confuse the data parsing process. Put the string in "quotes" if you really need to use a :
urls: should be an array (indented lines starting with dashes) even if you only have one url
Both maturity.level and health.level display a value between 0 and 3 (inclusive). The health value is a manual input while the maturity is an automated value based on other discrete (K)PI data properties.