fourkeys

command module
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 27, 2022 License: MIT Imports: 12 Imported by: 0

README

fourkeys

PkgGoDev Go Report Card tests codecov

Let's measure the performance of your team's software delivery.

DORA's Four Keys

Deployment Frequency
  • The days of deployments to production per week.
  • Elite: Over the last 3 months, the median number is greater than 3.
Lead Time for Changes
  • The time for a commit to be deployed into production.
  • Elite: Over the last 3 months, the median amount is less than 1 day.
Time to Restore Services
  • The time between the which caused the failure and the remediation.
  • Elite: Over the last 3 months, the median amount is less than 1 day.
Change Failure Rate
  • The number of failures per the number of deployments.
  • Elite: Over the last 3 months, the median amount is less than 15 %.

Required

  • Google Cloud Run
  • Google BigQuery
  • Google Secret Manager

Configuration

  • Set GitHub Personal Access Token to Secret Manager as PAT.
    • scope: repo

Build and Deploy

export IMAGE=gcr.io/${PROJECT_ID}/fourkeys
export ENV_VARS=GOOGLE_CLOUD_PROJECT=${PROJECT_ID},DATASET_LOCATION=${REGION},GIN_MODE=release

gcloud builds submit --tag ${IMAGE}
gcloud run deploy --image ${IMAGE} --set-env-vars=${ENV_VARS} --update-secrets=PAT=PAT:latest fourkeys

How to fetch activity

export SERVICE_URL=$(gcloud run services describe fourkeys --format 'value(status.url)')
export AUTH_HEADER="Authorization: Bearer $(gcloud auth print-identity-token)"

curl -s -H "${AUTH_HEADER}" ${SERVICE_URL}/_fetch/${OWNER}/${REPOSITORY}/_init
curl -s -H "${AUTH_HEADER}" ${SERVICE_URL}/_fetch/${OWNER}/${REPOSITORY}/pullreqs/update
curl -s -H "${AUTH_HEADER}" ${SERVICE_URL}/_fetch/${OWNER}/${REPOSITORY}/commits
curl -s -H "${AUTH_HEADER}" ${SERVICE_URL}/_fetch/${OWNER}/${REPOSITORY}/events
curl -s -H "${AUTH_HEADER}" ${SERVICE_URL}/_fetch/${OWNER}/${REPOSITORY}/releases
curl -s -H "${AUTH_HEADER}" ${SERVICE_URL}/_fetch/${OWNER}/${REPOSITORY}/pullreqs
curl -s -H "${AUTH_HEADER}" ${SERVICE_URL}/_fetch/${OWNER}/${REPOSITORY}/pullreqs/commits
curl -s -H "${AUTH_HEADER}" ${SERVICE_URL}/_fetch/${OWNER}/${REPOSITORY}/actions/runs
curl -s -H "${AUTH_HEADER}" ${SERVICE_URL}/_fetch/${OWNER}/${REPOSITORY}/actions/jobs

Query

WITH A AS (
SELECT
  DATE_ADD(DATE(date), INTERVAL - EXTRACT(DAYOFWEEK FROM DATE_ADD(DATE(date), INTERVAL -0 DAY)) +1 DAY) as week,
  COUNT(date) as days_deployed
FROM `${PROJECT_ID}.itsubaki_fourkeys._frequency_jobs`
WHERE date > DATE_SUB(CURRENT_DATE(), INTERVAL 3 MONTH)
GROUP BY week
)

SELECT
  DISTINCT(PERCENTILE_CONT(days_deployed, 0.5) OVER()) as days_deployed_median
FROM A
SELECT
  DISTINCT(PERCENTILE_CONT(lead_time, 0.5) OVER()) as lead_time_median
FROM `$PROJECT_ID.itsubaki_fourkeys._pullreqs_leadtime`
WHERE updated_at > TIMESTAMP(DATE_SUB(CURRENT_DATE(), INTERVAL 3 MONTH))
SELECT
  DISTINCT(PERCENTILE_CONT(ttr, 0.5) OVER()) as ttr_median
FROM `${PROJECT_ID}.itsubaki_fourkeys._pullreqs_ttr`
WHERE resolved_at > TIMESTAMP(DATE_SUB(CURRENT_DATE(), INTERVAL 3 MONTH))
SELECT
  SUM(failure) / SUM(runs) as failure_rate
FROM `${PROJECT_ID}.itsubaki_fourkeys._failure_rate`
WHERE date > DATE_SUB(CURRENT_DATE(), INTERVAL 3 MONTH)

Reference

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL