Interface Dorametrix

Description

Dorametrix creates and gets events in our expected DORA metrics format using a repository.

interface Dorametrix {
    getChangeFailureRate(incidentCount: number, deploymentCount: number): string;
    getDeploymentFrequency(deploymentCount: number, fromTimestamp: string, toTimestamp: string): string;
    getLastDeployment(lastDeployment: Deployment): DeploymentResponse;
    getLeadTimeForChanges(changes: Change[], deployments: Deployment[]): string;
    getTimeToRestoreServices(incidents: Incident[]): string;
}

Index

Methods

getChangeFailureRate getDeploymentFrequency getLastDeployment getLeadTimeForChanges getTimeToRestoreServices

Methods

getChangeFailureRate

getChangeFailureRate(incidentCount, deploymentCount): string
Parameters
- incidentCount: number
- deploymentCount: number
Returns string
Description
Get a change failure rate as an averaged number for a period of time.
- Defined in interfaces/Dorametrix.ts:33

getDeploymentFrequency

getDeploymentFrequency(deploymentCount, fromTimestamp, toTimestamp): string
Parameters
- deploymentCount: number
- fromTimestamp: string
- toTimestamp: string
Returns string
Description
Get the averaged deployment frequency for a period of time.
- Defined in interfaces/Dorametrix.ts:19

getLastDeployment

getLastDeployment(lastDeployment): DeploymentResponse
Parameters
- lastDeployment: Deployment
Returns DeploymentResponse
Description
Get the commit ID for the last deployment to production.
- Defined in interfaces/Dorametrix.ts:14

getLeadTimeForChanges

getLeadTimeForChanges(changes, deployments): string
Parameters
- changes: Change[]
- deployments: Deployment[]
Returns string
Description
Get the averaged lead time for a change getting into production (deployment).
- Defined in interfaces/Dorametrix.ts:28

getTimeToRestoreServices

getTimeToRestoreServices(incidents): string
Parameters
- incidents: Incident[]
Returns string
Description
Get the time to restore service as an averaged value.
- Defined in interfaces/Dorametrix.ts:38