Skip to content

GitLab Next

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
GitLab
GitLab
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 34,931
    • Issues 34,931
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Merge Requests 1,250
    • Merge Requests 1,250
  • Requirements
    • Requirements
    • List
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Security & Compliance
    • Security & Compliance
    • Dependency List
    • License Compliance
  • Operations
    • Operations
    • Metrics
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Code Review
    • Insights
    • Issue
    • Repository
    • Value Stream
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • GitLab.org
  • GitLabGitLab
  • Issues
  • #279039

Closed
Open
Opened Nov 08, 2020 by Orit Golowinski@ogolowinskiDeveloper0 of 6 tasks completed0/6 tasks

API support for Deployment Frequency

Release notes

Problem to solve

As an executive investing in DevOps, I want to see my ROI. I want to see an improvement in the deployment frequency of my dev team. This will most likely drive the KPIs of my team.

As a developer leader I want to see that the team is improving by measuring the deployment frequency and comparing it over time (over sprints)

I want to import the data from GitLab into an external monitoring tool, so I need API support to poll the data.

Intended users

  • Parker (Product Manager)
  • Delaney (Development Team Lead)
  • Rachel (Release Manager)

User experience goal

The user should be able to use the API to present the deployment frequency data in an external tool.

Proposal

  • REST API and backend service to perform calculations
  • REST API documentation
  • GraphQL equivalent of the REST endpoint

We need to support GET API for this. As parameters there should be a configurable timestamp - the default time, if not set should be 30 days.

For this iteration the API should return the deployment frequency for the project scope, but in the future we will add group level and instance level support. So this should be taken into consideration when developing this API.

Also in the future we would want to add support for the environment that there was a deployment to. In the true sense of DORA 4 - this is only meant for production, but there may be more than one prod environment and/or users may interested in non-prod environments

Further details

There is another consideration: some additional work to create a data structure (tables) to store the metrics, and I think this should be designed so it is flexible enough to:

  • commonly capture the data for all metrics
  • support a view at Project or any level of Group
  • support a minimal time slice which could then be aggregated

This is one metric out of 4 so there needs to be a common API structure to meet all needs.

Permissions and Security

Documentation

Availability & Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Is this a cross-stage feature?

Links / references

  • https://docs.gitlab.com/ee/development/value_stream_analytics.html
Edited Nov 08, 2020 by Orit Golowinski
Assignee
Assign to
13.7
Milestone
13.7 (Past due)
Assign milestone
Time tracking
None
Due date
None
Reference: gitlab-org/gitlab#279039