{"id":13557647,"url":"https://github.com/NDHWAlliance/gitlab-analytics","last_synced_at":"2025-04-03T12:30:55.379Z","repository":{"id":217151526,"uuid":"138120331","full_name":"NDHWAlliance/gitlab-analytics","owner":"NDHWAlliance","description":null,"archived":false,"fork":false,"pushed_at":"2021-11-05T13:01:04.000Z","size":403,"stargazers_count":33,"open_issues_count":2,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-04T08:35:21.512Z","etag":null,"topics":["github-api","grafana","kpi-report","python","statistics"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NDHWAlliance.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-21T04:45:41.000Z","updated_at":"2024-09-09T01:46:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"0bf2efa0-cca3-4190-935a-230b03699bb7","html_url":"https://github.com/NDHWAlliance/gitlab-analytics","commit_stats":null,"previous_names":["ndhwalliance/gitlab-analytics"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NDHWAlliance%2Fgitlab-analytics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NDHWAlliance%2Fgitlab-analytics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NDHWAlliance%2Fgitlab-analytics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NDHWAlliance%2Fgitlab-analytics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NDHWAlliance","download_url":"https://codeload.github.com/NDHWAlliance/gitlab-analytics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247002169,"owners_count":20867415,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-api","grafana","kpi-report","python","statistics"],"created_at":"2024-08-01T12:04:28.061Z","updated_at":"2025-04-03T12:30:55.371Z","avatar_url":"https://github.com/NDHWAlliance.png","language":"Python","funding_links":[],"categories":["Python","github-api"],"sub_categories":[],"readme":"# gitlab-analytics \n\n### Goals\n\n* Improve the developers' enthusiasm to build more standard gitlab's project. \n* Provide a guidance to the developers for gitlab's features. \n* Analysis the activity of gitlab's users via statistics.\n* Support kpi's measurement for project managers.\n\n### Analytics\n\n* commits\n* wikis\n* issues\n* comments\n* merge-requests\n\n![alt text](https://github.com/NDHWAlliance/gitlab-analytics/blob/master/display.jpeg)\n\n# Installation\n\n### Prerequest\n\n* A gitlab instance\n* A server\n  * with docker installed\n  * has a domain name or IP that can be accessed by gitlab instance.\n\nSuppose the hostname of the server you deploy gitlab-analytics on is `gitlab-analytics.example.com`\n\n### Initialize with Docker\n\n```shell\ngit clone https://github.com/NDHWAlliance/gitlab-analytics.git\ncd gitlab-analytics\ndocker-compose up mysql grafana ga\n```\n\nIf you are a Chinese user, you can use following commands to speed up `ga` image\nbuild process;\n\n```shell\ngit clone https://github.com/NDHWAlliance/gitlab-analytics.git\ncd gitlab-analytics\ndocker-compose build --build-arg INDEX_URL=https://mirrors.aliyun.com/pypi/simple ga\ndocker-compose up mysql grafana ga\n```\n\n\n\n### Configuration\n\n* Step 1: Access `http://gitlab-analytics.example.com:8080` .\n  * Set a password to access the setting page.\n  * In the setting page\n    * Default webhook(External Url) is the '$base_url/web_hook/' like `http://gitlab-analytics.example.com:8080/web_hook/`.\n    * set gitlab server URL and access token, the access token should have complete read/write access to gitlab API.\n    * If your gitlab's version is higher than 10.6, remember to check the option [\"Allow requests to the local network from hooks and services\"](https://docs.gitlab.com/ee/security/webhooks.html) in the \"Outbound requests\" section inside the Admin area under Settings. \n* Step 2: In the hooks page, choose the projects that you would like to add the webhook.\n* Step 3: If you would like to bind the webhook to your new project automatically, just configure the system hook '$base_url/system_hook' to your gitlab， like: `http://gitlab-analytics.example.com:8080/system_hook/`.\n\n### analytics page\n\nYou can access analytics page from the following URL:\n\n    http://gitlab-analytics.example.com:3000\n\nThe default user/password is admin/admin.\n\n### \n\n# Reference\n* [Install Docker-Compose](https://docs.docker.com/compose/install/)\n* [Initializing Grafana with preconfigured dashboards](https://ops.tips/blog/initialize-grafana-with-preconfigured-dashboards/)\n* [Dockerize Simple Flask App](http://containertutorials.com/docker-compose/flask-simple-app.html)\n* https://hub.docker.com/_/mariadb/\n* https://hub.docker.com/r/grafana/grafana/\n* [Using MySQL in Grafana - Configure the Datasource with Provisioning](http://docs.grafana.org/features/datasources/mysql/#configure-the-datasource-with-provisioning)\n* [Provisioning Grafana](http://docs.grafana.org/administration/provisioning/)\n* [Webhook for gitlab's events](http://developer.dpstorm.com/help/user/project/integrations/webhooks.md)\n* [System hook for gitlab's events](https://docs.gitlab.com/ee/system_hooks/system_hooks.html)\n* [Python-gitlab](http://python-gitlab.readthedocs.io/en/stable)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNDHWAlliance%2Fgitlab-analytics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNDHWAlliance%2Fgitlab-analytics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNDHWAlliance%2Fgitlab-analytics/lists"}