如何获得在 Gitlab 中花费的总时间？

Question

Is there a way to get the total time spend on all issues that a user have spend with the time tracking /spend slash command ?

Time tracking stats with the API gets just a small amount of data: https://docs.gitlab.com/ce/api/issues.html#get-time-tracking-stats

Gitlab CE 9.1.4

Answer 1

As I see it is possible to parse comments from API v3 and calculate total.

For example,

https://gitlab.com/api/v3/projects/:id/issues/:issue_id/notes?private_token=your_token

{
  id: 73113225,
  body: "added 1h of time spent at 2018-05-15",
  attachment: null,
  author: {
    ...
    username: "mnvxxx",
  },
  ...
}

More info: https://docs.gitlab.com/ee/api/notes.html

UPDATE

Currently I has created instrument for calculating spent time by every contributor. I hope it will be helpful:

https://github.com/zubroide/gitpab

Answer 2

Here is a very simple Python script that works with API v4:

import requests

API_KEY = ""  # Enter your API key here
BASE_URL = "https://{{enter gitlab url here}}/api/v4/"

item_counter = 0
total_seconds = 0

for i in range(1, 57):  # manually set range of issues here. All issues doesn't work well.
    issue = requests.get(BASE_URL + 'projects/2/issues/' + str(i) + '/time_stats')
    total_seconds += issue.json()['total_time_spent']
    item_counter += 1

print("Hours on all issues: %.2f" % float((total_seconds / 60) / 60))
print("Total issues: " + str(item_counter))

I'm posting to this thread because this is the first answer that comes up on Google, and there isn't really any other ready-made solutions to be found.

Answer 3

Building on top of what @josh-harkema has provided, this is a version that lists all closed issues that were assigned to a specific username that have been updated in a given time period (and do not have the label 'paid' set):

import requests
import os

username = os.environ.get('GITLAB_REPORTING_USERNAME')
project_id = os.environ.get('GITLAB_REPORTING_PROJECTID') # in the top of your project page
access_token = os.environ.get('GITLAB_REPORTING_TOKEN')  # https://gitlab.com/profile/personal_access_tokens
base_url = "https://gitlab.com/api/v4"

updated_after = "2019-06-01T00:00:00.00Z"
updated_before = "2019-07-01T00:00:00.00Z"

item_counter = 0
total_seconds = 0

headers = { 'Private-Token': access_token }
url_template = "{base_url}/projects/{project_id}/issues?" \
               "state=closed&assignee_username={username}&updated_after={updated_after}&updated_before={updated_before}"
url = url_template.format(base_url=base_url, project_id=project_id, username=username,
                          updated_after=updated_after, updated_before=updated_before)

# call API
issues = requests.get(url, headers = headers)

total_seconds = 0
issues_to_pay = []
line_template = "id: {id}    closed: {closed_at}    time spent: {time}\ttitle: {title}\turl: {url}"
print("Issue statistics for {u} from {f} to {t}:\n".format(u=username,f=updated_after, t=updated_before))

for issue in issues.json():

    time_val = issue['time_stats']['human_total_time_spent']
    already_paid = u'paid' in issue['labels'] # you can put a label 'paid' to exclude an issue
    if already_paid:
        time_val = time_val + " *"
    else:
        # if the issue has been paid, already, don't add the time, and don't list as to be paid
        total_seconds += issue['time_stats']['total_time_spent']
        issues_to_pay.append(str(issue['id']))

    line = line_template.format(
        id=issue['id'],
        closed_at=issue['closed_at'],
        title=issue['title'],
        time=time_val,
        url=issue['web_url']
    )
    print(line)
print("")
print("Hours to pay on all issues: %.2f" % float((float(total_seconds) / 60) / 60))
print("")
print("* = issue has been paid for, already")
print("All issue to pay: {issues}".format(issues=",".join(issues_to_pay)))

Note: You need to have environment variables set for the GITLAB_REPORTING_USERNAME , the GITLAB_REPORTING_PROJECTID , as well as the GITLAB_REPORTING_TOKEN .

We use this to pay contractors. Hope this helps!

Answer 4

I was myself looking for the same and after more searching, I found this excellent CLI tool called gitlab-time-tracker . It generates comprehensive reports of tracked-time that you can customise by multiple options and can print them even as PDFs !

For keeping this answer relevant to OP's question, you can print (in your terminal) total time spent by a user using following command**:

gtt report "namespace/project" --user username --closed --from="2017-03-01" --to="2017-04-01"

** This assumes that you've installed this tool (gtt) and setup your Gitlab PAT (with "api" scope activated) in its config file.

Answer 5

Because I like the speed of Go:

package main

import (
    "encoding/json"
    "fmt"
    "io/ioutil"
    "log"
    "net/http"
)

type AutoGeneratedStuff struct {
    TimeEstimate        int         `json:"time_estimate"`
    TotalTimeSpent      int         `json:"total_time_spent"`
    HumanTimeEstimate   interface{} `json:"human_time_estimate"`
    HumanTotalTimeSpent interface{} `json:"human_total_time_spent"`
}

func main() {
    //for performance, specify the range of issues (i)
    for i := 1; i <= 5; i++ {

        var url string = "https://{{Your_URL_here }}/api/v4/projects/{{ proj_id_here }}/issues/" + fmt.Sprint(i) + "/time_stats"
        var timestuff AutoGeneratedStuff
        var bearer = "Bearer " + "{{your_API_token_here}}"

        // Create a new request using http
        req, err := http.NewRequest("GET", url, nil)

        // add authorization header to the req
        req.Header.Add("Authorization", bearer)

        // Send req using http Client
        client := &http.Client{}
        resp, err := client.Do(req)
        if err != nil {
            log.Println("Error on response.\n[ERROR] -", err)
        }
        defer resp.Body.Close()

        body, err := ioutil.ReadAll(resp.Body)
        if err != nil {
            log.Println("Error while reading the response bytes:", err)
        }
        Data := []byte(body)

        err2 := json.Unmarshal(Data, &timestuff)

        if err2 != nil {

            fmt.Println(err)
        }
        fmt.Println("Time estimate is:", timestuff.TimeEstimate)
        fmt.Println("Human time estimate is:", timestuff.HumanTimeEstimate)
        fmt.Println("Total time is:", timestuff.TotalTimeSpent)
        fmt.Println("Human total time is:", timestuff.HumanTotalTimeSpent)

    }
}

Example response:

Time estimate is: 86400
Human time estimate is: 3d
Total time is: 300
Human total time is: 5m