GitLab Professional Services
Accelerate your software lifecycle with help from GitLab experts
Popular GitLab use cases
Enterprise Small Business Continuous Integration (CI/CD) Source Code Management (SCM) Out-of-the-box Pipelines (Auto DevOps) Security (DevSecOps) Agile Development Value Stream Management GitOpsGitLab Professional Services
Accelerate your software lifecycle with help from GitLab experts
Popular GitLab use cases
Enterprise Small Business Continuous Integration (CI/CD) Source Code Management (SCM) Out-of-the-box Pipelines (Auto DevOps) Security (DevSecOps) Agile Development Value Stream Management GitOpsStage/Group | PI Type | PI | Health | SaaS / SM | Implementation Status |
---|---|---|---|---|---|
Manage, Manage:Optimize | SMAU, GMAU | MAU Viewing Analytics Features | Okay | Both | Complete |
Plan, Plan:Project Management | SMAU, Paid GMAU | MAU Interacting With Issues | Okay | Both | Complete |
Create | SMAU | Unique users writing to a Git repository | Okay | Both | Complete |
Verify, Verify:CI | GMAU, SMAU | Unique users triggering pipelines | Okay | Both | Complete |
Package:Package | SMAU, GMAU | Count of users publishing packages | Okay | Both | Data available |
Release:Release | SMAU | Count of users triggering deployments using GitLab | Okay | Both | Complete |
Configure:Configure | SMAU, GMAU | Proxy user count based on attached clusters | Okay | Both | Complete |
Monitor:Monitor | SMAU, GMAU | Unique users that interact with Alerts and Incidents | Okay | Both | Complete |
Sec, Secure | Section MAU, SMAU | Unique users who have used a Secure scanner | Okay | Both | Complete |
Protect:Container Security | SMAU, GMAU | Users running Container Scanning or interacting with Protect UI | Attention | Both | Complete |
Stage/Group | PI Type | PI | Health | SaaS / SM | Implementation Status |
---|---|---|---|---|---|
Manage, Manage:Optimize | SMAU, GMAU | MAU Viewing Analytics Features | Okay | Both | Complete |
Manage:Access | Paid GMAU | MAU Using Paid SAML | Okay | SaaS | Complete |
Manage:Compliance | Paid GMAU | MAU Viewing Compliance Features | Attention | Both | Complete |
Manage:Import | GMAU | MAU importing | Unknown | Both | Dashboard |
Plan, Plan:Project Management | SMAU, Paid GMAU | MAU Interacting With Issues | Okay | Both | Complete |
Plan:Product Planning | Paid GMAU | MAU creating Epics each Month | Okay | Both | Complete |
Create:Source Code | GMAU | Unique users writing to a project Git repository | Okay | Both | Complete |
Create:Code Review | GMAU | Unique users using Merge Requests | Okay | Both | Complete |
Create:Editor | GMAU | Unique users committing via any web editor | Attention | Both | Complete |
Create:Ecosystem | GMAU | MAU of any integration | Unknown | Both | Instrumentation |
Enablement:Geo | Paid GMAU | Number of unique users utilizing a Geo secondary | Attention | Both | Instrumentation |
Enablement:Global Search | Paid GMAU | The number of unique paid users per month | Attention | Both | Complete |
Enablement:Infrastructure | Paid GMAU | Number of unique paid users that perform an action on GitLab.com | Attention | SaaS | Complete |
Verify, Verify:CI | GMAU, SMAU | Unique users triggering pipelines | Okay | Both | Complete |
Verify:Pipeline Authoring | GMAU | Number of unique users interacting with gitlab-ci.yml file | Unknown | Both | Implementation |
Verify:Testing | Paid GMAU | Count of active paid testing feature users | Unknown | Both | Data Availability |
Package:Package | SMAU, GMAU | Count of users publishing packages | Okay | Both | Data available |
Release:Release | SMAU | Count of users triggering deployments using GitLab | Okay | Both | Complete |
Configure:Configure | SMAU, GMAU | Proxy user count based on attached clusters | Okay | Both | Complete |
Monitor:Monitor | SMAU, GMAU | Unique users that interact with Alerts and Incidents | Okay | Both | Complete |
Secure:Static Analysis | GMAU | Users running Static Analysis jobs | Okay | Both | Complete |
Secure:Dynamic Analysis | GMAU | Users running DAST | Okay | Both | Complete |
Secure:Composition Analysis | GMAU | Users running any SCA scanners | Okay | Both | Complete |
Secure:Fuzz Testing | GMAU | Users running fuzz testing | Attention | Both | Definition |
Secure:Threat Insights | GMAU | Users interacting with Secure UI | Okay | SaaS | Definition |
Protect:Container Security | SMAU, GMAU | Users running Container Scanning or interacting with Protect UI | Attention | Both | Complete |
Stage/Group | PI Type | PI | Health | SaaS / SM | Implementation Status |
---|---|---|---|---|---|
Enablement | Section PPI, Stage PPI | Median End User Page Load Time | Attention | Both | Target |
Stage/Group | PI Type | PI | Health | SaaS / SM | Implementation Status |
---|---|---|---|---|---|
Enablement:Distribution | Group PPI | Percentage of installations on the 3 most recent versions of GitLab | Attention | Both | Complete |
Enablement:Memory | Group PPI | Memory Consumed | Attention | Both | Complete |
Enablement:Database | Group PPI | Database Query Apdex (100ms target, 250ms tolerable) | Attention | Both | Complete |
Verify:Runner | Other | Total downloads of runner binaries and docker images per month | Unknown | SM | Definition |
The number of unique users viewing any Analytics page.
SaaS/SM: Both
Target: 116050
Is Primary PI: true
Metric Name: analytics_total_unique_counts_monthly
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Number of unique users interacting with an issue (open, close, reopen, adjust label, adjust milestone, adjust weight, comment)
SaaS/SM: Both
Target: 484,510 for All, 148,176 for Paid
Is Primary PI: true
URL(s)
Metric Name: redis_hll_counters.issues_edit.issues_edit_total_unique_counts_monthly
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
Focus This Month (March):
A rolling count of the number of unique users who performed any Git write operation within the last 28 days.
SaaS/SM: Both
Target: Our target growth rate is 3% higher than the previous month for SMAU, and 4% for Paid SMAU.
Is Primary PI: true
URL(s)
Metric Name: action_monthly_active_users_project_repo
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
A rolling count of unique users triggering pipelines in the last 28 days because CI is the foundation for several downstream product areas, and improving SMAU for people using pipelines is important to help with discovery of these further features.
Funnel Description: Handbook Link
SaaS/SM: Both
Target: We delivered on 92% of our FY21 Q4 target of 1 million unique users triggering pipelines, and fell short of our 10% MoM growth. In FY22 Q1, we anticipate accomplishing this target of 1.1M unique users as predicted in our [tertiary chart](https://app.periscopedata.com/app/gitlab/798616/WIP-Linear-Predicted-Dashboard?widget=10611135).
Is Primary PI: true
Metric Name: ci_pipelines
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
The maximum distinct count of users who published a package to the Package Registry. In the future, this value will the distinct count of users across all Package AMAUs.
Funnel Description: Handbook Link
SaaS/SM: Both
Target: 10% higher than current month (SaaS and self-managed combined)
Is Primary PI: true
Metric Name: user_packages_total_unique_counts_monthly
Chart (Sisense↗)
Health: Okay
Implementation Status: Data available
Lessons Learned (February):
A rolling count of unique users triggering deployments with Gitlab in the last 28 days.
Funnel Description: Handbook Link
SaaS/SM: Both
Target: 301,000 for SMAU, 124,000 for paid SMAU
Is Primary PI: true
URL(s)
Metric Name: deployments
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
A count of all users in projects that have an attached cluster because project users receive benefit from the cluster without direct usage.
SaaS/SM: Both
Target: 18000
Is Primary PI: true
Metric Name: project_clusters_enabled, group_clusters_enabled, instance_clusters_enabled
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
Unique users that interact with alerts or incidents. (This metric represents the GMAU for the Monitor:Monitor group as well as the SMAU for the Monitor stage. It is based on usage of the Incident Management category which is the only category in the group or stage that is being actively developed. The definition for Monitor SMAU will be seperated from Monitor:Monitor GMAU when we are able to expand the definition to include usage of the other categories. That work is currently not a priority.)
Funnel Description: Handbook Link
SaaS/SM: Both
Target: 12,000 Estimated total SMAU
Is Primary PI: true
URL(s)
Metric Name: incident_management_total_unique_counts_monthly
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
The number of unique users who have run one or more Secure scanners.
SaaS/SM: Both
Target: 10% higher than current month (SaaS and self-managed combined)
Is Primary PI: true
Metric Name: user_unique_users_all_secure_scanners
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Focus This Month (March):
The number of users who have run a container scanning job or interacted with the Protect UI in the last 28 days of the month.
SaaS/SM: Both
Target: Progressively increasing month-over-month, >2%
Is Primary PI: true
Metric Name: user_container_scanning_jobs
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Attention
Implementation Status: Complete
Lessons Learned (February):
Focus This Month (March):
The number of unique users viewing any Analytics page.
SaaS/SM: Both
Target: 116050
Is Primary PI: true
Metric Name: analytics_total_unique_counts_monthly
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
The number of unique users logging into GitLab using SAML SSO for Groups.
SaaS/SM: SaaS
Target: 30000. See https://gitlab.com/gitlab-com/Product/-/issues/1832 for further detail.
Is Primary PI: true
Metric Name: user_auth_by_provider (Group_SAML)
Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
The number of unique users viewing Audit Events, Compliance Dashboard, or Credential Inventory.
SaaS/SM: Both
Target: TBD (expected [April 2021](https://gitlab.com/gitlab-org/manage/compliance/general/-/issues/13))
Is Primary PI: true
Metric Name: i_compliance_audit_events, g_compliance_audit_events, g_compliance_dashboard, i_compliance_credential_inventory, usage_data_g_compliance_dashboard, usage_data_a_compliance_audit_events_api
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Attention
Q2 2021
.Q2 2021
.Q2 2021
. - Adding additional credentials to the credential inventory. Planned for Q3 2021
.Implementation Status: Complete
A monthly count of the unique number of users performing an import
SaaS/SM: Both
Target: TBD - See Health section below for details
Is Primary PI: true
Metric Name: unique_users_all_imports
Health: Unknown
13.9
. This feature will enable a much easier migration of an entire GitLab group from one instance to another.Implementation Status: Dashboard
13.9
.Number of unique users interacting with an issue (open, close, reopen, adjust label, adjust milestone, adjust weight, comment)
SaaS/SM: Both
Target: 484,510 for All, 148,176 for Paid
Is Primary PI: true
URL(s)
Metric Name: redis_hll_counters.issues_edit.issues_edit_total_unique_counts_monthly
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
Focus This Month (March):
The number of unique users creating Epics each month.
SaaS/SM: Both
Target: 3,900 Combined Unique Users for Self Managed and SaaS
Is Primary PI: true
Metric Name: epics
Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
A rolling count of the number of unique users who performed any Git write operation within the last 28 days
SaaS/SM: Both
Target: Our target growth rate is 3% higher than the previous month for SMAU, and 4% for Paid SMAU.
Is Primary PI: true
URL(s)
Metric Name: action_monthly_active_users_project_repo
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
This is defined as users who perform one or more of the following actions in a merge request - create, merge, or close a Merge Request.
SaaS/SM: Both
Target: Our target growth rate is 3% higher than the previous month for SMAU, and 4% for Paid SMAU.
Is Primary PI: true
URL(s)
Metric Name: merge_requests_users
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
A rolling count of the number of unique users who performed a Git write operation to any respository using the Web IDE, Web Editor or Snippet within a stage in the last 28 days
SaaS/SM: Both
Target: 4% growth month over month for All
Is Primary PI: true
URL(s)
Metric Name: action_monthly_active_users_ide_edit
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Tertiary Chart (Sisense↗)
Health: Attention
Implementation Status: Complete
Monthly Unique Users of any GitLab integration.
SaaS/SM: Both
Target: TBD
Is Primary PI: true
URL(s)
Metric Name: TBD
Health: Unknown
Implementation Status: Instrumentation
Number of unique users utilizing a Geo secondary. This adoption metric helps us understand whether end users are actually seeing value in, and are using, geo secondaries.
SaaS/SM: Both
Target: TBD
Is Primary PI: true
URL(s)
Metric Name: geo_nodes
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Attention
Implementation Status: Instrumentation
Lessons Learned (February):
The number of unique active users and unique paid users interacting with either Basic Search or Advanced Search per month.
SaaS/SM: Both
Target: 10% month over month (SaaS and self-managed combined)
Is Primary PI: true
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Attention
Implementation Status: Complete
Lessons Learned (February):
The sum of all monthly active users on gitlab.com that roll up to paid accounts in a 28 day rolling period.
SaaS/SM: SaaS
Target: 111750
Is Primary PI: true
Metric Name: COUNT_EVENTS_ACTIVE_USERS_LAST_28_DAYS_BY_PLAN_WAS_PAID
Chart (Sisense↗)
Health: Attention
Implementation Status: Complete
Lessons Learned (February):
A rolling count of unique users triggering pipelines in the last 28 days because CI is the foundation for several downstream product areas, and improving SMAU for people using pipelines is important to help with discovery of these further features.
Funnel Description: Handbook Link
SaaS/SM: Both
Target: We delivered on 92% of our FY21 Q4 target of 1 million unique users triggering pipelines, and fell short of our 10% MoM growth. In FY22 Q1, we anticipate accomplishing this target of 1.1M unique users as predicted in our [tertiary chart](https://app.periscopedata.com/app/gitlab/798616/WIP-Linear-Predicted-Dashboard?widget=10611135).
Is Primary PI: true
Metric Name: ci_pipelines
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
Count the number of users that are pushing MRs to gitlab-ci.yml files. Since we'd like to count the on-going usage of our users with pipelines.
Funnel Description: Handbook Link
SaaS/SM: Both
Target: TBD
Is Primary PI: true
Metric Name: N/A
Chart
Health: Unknown
Implementation Status: Implementation
Lessons Learned (February):
A rolling count of unique users who have interacted with a paid testing feature in the last 28 days.
Funnel Description: Handbook Link
SaaS/SM: Both
Target: We are targeting X unique paid testing users by end of FY22 Q1.
Is Primary PI: true
Metric Name: NA
Chart (Sisense↗)
Health: Unknown
Implementation Status: Data Availability
Lessons Learned (February):
The maximum distinct count of users who published a package to the Package Registry. In the future, this value will the distinct count of users across all Package AMAUs.
Funnel Description: Handbook Link
SaaS/SM: Both
Target: 10% higher than current month (SaaS and self-managed combined)
Is Primary PI: true
Metric Name: user_packages_total_unique_counts_monthly
Chart (Sisense↗)
Health: Okay
Implementation Status: Data available
Lessons Learned (February):
A rolling count of unique users triggering deployments with Gitlab in the last 28 days.
Funnel Description: Handbook Link
SaaS/SM: Both
Target: 301,000 for SMAU, 124,000 for paid SMAU
Is Primary PI: true
URL(s)
Metric Name: deployments
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
A count of all users in projects that have an attached cluster because project users receive benefit from the cluster without direct usage.
SaaS/SM: Both
Target: 18000
Is Primary PI: true
Metric Name: project_clusters_enabled, group_clusters_enabled, instance_clusters_enabled
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
Unique users that interact with alerts or incidents. (This metric represents the GMAU for the Monitor:Monitor group as well as the SMAU for the Monitor stage. It is based on usage of the Incident Management category which is the only category in the group or stage that is being actively developed. The definition for Monitor SMAU will be seperated from Monitor:Monitor GMAU when we are able to expand the definition to include usage of the other categories. That work is currently not a priority.)
Funnel Description: Handbook Link
SaaS/SM: Both
Target: 12,000 Estimated total SMAU
Is Primary PI: true
URL(s)
Metric Name: incident_management_total_unique_counts_monthly
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
The highest of the number of unique users who have run SAST or Secret Detection jobs.
SaaS/SM: Both
Target: Progressively increasing month-over-month, >10%
Is Primary PI: true
URL(s)
Metric Name: user_sast_jobs, user_secret_detection_jobs
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
Focus This Month (March):
Number of unique users who have run one or more DAST jobs.
SaaS/SM: Both
Target: Progressively increasing month-over-month, >10% per-month
Is Primary PI: true
URL(s)
Metric Name: user_dast_jobs
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
Focus This Month (March):
The highest of the number of unique users who have run one or more Dependency Scanning jobs, or number of unique users who have run one or more License Scanning jobs.
SaaS/SM: Both
Target: 2% higher than current month (SaaS and self-managed combined) for All and Paid
Is Primary PI: true
URL(s)
Metric Name: user_license_management_jobs, user_dependency_scanning_jobs
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Okay
Implementation Status: Complete
Lessons Learned (February):
Focus This Month (March):
The highest of the number of unique users who have run one or more Fuzz Testing jobs.
SaaS/SM: Both
Target: Progressively increasing month-over-month, >10% per-month
Is Primary PI: true
URL(s)
Metric Name: user_coverage_fuzzing_jobs on self-managed, (options like '%gitlab-cov-fuzz%' OR options like '%FUZZAPI_REPORT%') on .com
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Attention
Implementation Status: Definition
Lessons Learned (February):
Focus This Month (March):
Number of unique sessions viewing a security dashboard, pipeline security report, or expanding MR security report. Same as Paid until OSS projects can be separated.
SaaS/SM: SaaS
Target: Progressively increasing month-over-month, >2% per-month
Is Primary PI: true
URL(s)
Metric Name: n/a
Chart (Sisense↗)
Health: Okay
Implementation Status: Definition
Lessons Learned (February):
Focus This Month (March):
The number of users who have run a container scanning job or interacted with the Protect UI in the last 28 days of the month.
SaaS/SM: Both
Target: Progressively increasing month-over-month, >2%
Is Primary PI: true
Metric Name: user_container_scanning_jobs
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Attention
Implementation Status: Complete
Lessons Learned (February):
Focus This Month (March):
Median end user page performance collected by Real User Monitoring. This metric captures how well we are doing in serving our primary customers, our end users, by measuring their end user experience.
SaaS/SM: Both
Target: TBD
Is Primary PI: true
Metric Name: performanceTiming
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Attention
Implementation Status: Target
Lessons Learned (February):
Of the total number of self-managed installs, what percentage are on one of the three most recent versions.
SaaS/SM: Both
Target: 40%
Is Primary PI: true
URL(s)
Metric Name: versions_behind_latest
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Attention
Implementation Status: Complete
Lessons Learned (February):
Average memory consumed by all invididual GitLab processes
SaaS/SM: Both
Target: 1.5GB
Is Primary PI: true
Metric Name: topology.nodes[0].node_services
Chart (Sisense↗)
Health: Attention
Implementation Status: Complete
Database query Apdex, with 100ms the target and 250ms tolerable. This measures the ratio of queries which complete within the satisfactory time, informing how well the database is scaling and performing.
SaaS/SM: Both
Target: 0.99
Is Primary PI: true
URL(s)
Metric Name: query_apdex_weekly_average
Chart (Sisense↗)
Secondary Chart (Sisense↗)
Health: Attention
Implementation Status: Complete
Lessons Learned (February):
Count of downloads of runner binaries grouped by platform, gitlab-runner and gitlab-runner helper container images. Measuring runner binaries' downloads will provide insight into whether we are making the right investments in core runner features and capabilities by platform (operating system and computing architecture). The assumption is that if self-managed users continue to maintain and upgrade their GitLab Runner build infrastructure, this may suggest continued long-term use of GitLab as their DevOps platform.
Funnel Description: Handbook Link
SaaS/SM: SM
Target: TBD
Is Primary PI: true
Metric Name: NA
Health: Unknown
Implementation Status: Definition
Lessons Learned (February):
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 |
Pages, such as the Engineering Function Performance Indicators page are rendered by an ERB template that contains HTML code.
Other PI Pages
sectionThese ERB templates calls custom helper functions that extract and transform data from the Performance Indicators data file.
kpi_list_by_org(org)
helper function takes a required string argument named org
(deparment or division level) that returns all the KPIs (pi.is_key == true) for a specific organization grouping (pi.org == org) from the Performance Indicators data file.pi_maturity_level(performance_indicator)
helper function automatically assigns a maturity level based on the availability of certain data properties for a particular PI.pi_maturity_reasons(performance_indicator)
helper function returns a reason
for a PI maturity based on other data properties.performance_indicators(org)
takes a required string argument named org
(deparment or division level) that returns two lists - a list of all KPIs and a list of all PIs for a specific organization grouping (department/division).signed_periscope_url(data)
takes in the sisense_data property information from Performance Indicators data files and returns a signed chart URL for embedding a Sisense chart into the handbook.The heart of pages like this are Performance Indicators data files which are YAML files. 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. For Product PIs, product hierarchy should be separate from name by " - " (Ex. {Stage Name}:{Group Name} - {PI Type} - {PI Name} |
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. For GMAU, the target should be quarterly. |
org |
Required | the organizational grouping (Ex: Engineering Function or Development Department). For Product Sections, ensure you have the word section (Ex : Dev Section) |
section |
Optional | the product section (Ex: dev) as defined in sections.yml |
stage |
Optional | the product stage (Ex: release) as defined in stages.yml |
group |
Optional | the product group (Ex: progressive_delivery) as defined in stages.yml |
category |
Optional | the product group (Ex: feature_flags) as defined in categories.yml |
is_key |
Required | boolean value (true/false) that indicates if it is a (key) performance indicator |
health |
Required | indicates the (K)PI health and reasons as nested attributes. This should be updated monthly before Key Meetings by the DRI. |
health.level |
Optional | indicates a value between 0 and 3 (inclusive) to represent the health of the (K)PI. This should be updated monthly before Key Meetings by the DRI. |
health.reasons |
Optional | indicates the reasons behind the health level. This should be updated monthly before Key Meetings by the DRI. Should be an array (indented lines starting with dashes) even if you only have one reason. |
urls |
Optional | list of urls associated with the (K)PI. Should be an array (indented lines starting with dashes) even if you only have one url |
funnel |
Optional | indicates there is a handbook link for a description of the funnel for this PI. Should be a URL |
sisense_data |
Optional | allows a Sisense dashboard to be embeded as part of the (K)PI using chart, dashboard, and embed as neseted attributes. |
sisense_data.chart |
Optional | indicates the numeric Sisense chart/widget ID. For example: 9090628 |
sisense_data.dashboard |
Optional | indicates the numeric Sisense dashboard ID. For example: 634200 |
sisense_data.shared_dashboard |
Optional | indicates the numeric Sisense shared_dashboard ID. For example: 185b8e19-a99e-4718-9aba-96cc5d3ea88b |
sisense_data.embed |
Optional | indicates the Sisense embed version. For example: v2 |
sisense_data_secondary |
Optional | allows a second Sisense dashboard to be embeded. Same as sisense data |
sisense_data_secondary.chart |
Optional | Same as sisense_data.chart |
sisense_data_secondary.dashboard |
Optional | Same as sisense_data.dashboard |
sisense_data_secondary.shared_dashboard |
Optional | Same as sisense_data.shared_dashboard |
sisense_data_secondary.embed |
Optional | Same as sisense_data.embed |
public |
Optional | boolean flag that can be set to false where a (K)PI does not meet the public guidelines. |
pi_type |
Optional | indicates the Product PI type (Ex: AMAU, GMAU, SMAU, Group PPI) |
product_analytics_type |
Optional | indicates if the metric is available on SaaS, SM (self-managed), or Both. |
is_primary |
Optional | boolean flag that indicates if this is the Primary PI for the Product Group. |
implementation |
Optional | indicates the implementation status and reasons as nested attributes. This should be updated monthly before Key Meetings by the DRI. |
implementation.status |
Optional | indicates the Implementation Status status. This should be updated monthly before Key Meetings by the DRI. |
implementation.reasons |
Optional | indicates the reasons behind the implementation status. This should be updated monthly before Key Meetings by the DRI. Should be an array (indented lines starting with dashes) even if you only have one reason. |
lessons |
Optional | indicates lessons learned from a K(PI) as a nested attribute. This should be updated monthly before Key Meetings by the DRI. |
lessons.learned |
Optional | learned is an attribute that can be nested under lessons and indicates lessons learned from a K(PI). This should be updated monthly before Key Meetings by the DRI. Should be an array (indented lines starting with dashes) even if you only have one lesson learned |
monthly_focus |
Optional | indicates monthly focus goals from a K(PI) as a nested attribute. This should be updated monthly before Key Meetings by the DRI. |
monthly_focus.goals |
Optional | indicates monthly focus goals from a K(PI). This should be updated monthly before Key Meetings by the DRI. Should be an array (indented lines starting with dashes) even if you only have one goal |
metric_name |
Optional | indicates the name of the metric in Self-Managed implemenation. The SaaS representation of the Self-Managed implementation should use the same name. |
Above ...
Below ...
At ...
At or above ...
At or below ...
shared_dashboard
, chart
, and the dashboard
key-value pairs to the corresponding Performance Indicators data file under the sisense_data
property:
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 :