Stackalytics. Release 0.3.dev201.gae Mirantis Inc.

Size: px

Start display at page:

Download "Stackalytics. Release 0.3.dev201.gae Mirantis Inc."

Kerry Marshall
5 years ago
Views:

1 Stackalytics Release 0.3.dev201.gae15432 Mirantis Inc. October 30, 2013

3 CONTENTS i

4 ii

5 Stackalytics is a service that collects and processes development activity data such as commits, lines of code changed, and code reviews, and makes it possible to visualize them in a convenient web dashboard. The Stackalytics dashboard makes it possible to view data by project, company, contributor, and other factors. CONTENTS 1

6 2 CONTENTS

7 CHAPTER ONE OVERVIEW Wiki 3

8 4 Chapter 1. Overview

9 CHAPTER TWO API 2.1 Stackalytics JSON API v1.0 Note: JSON API v1.0 corresponds to Stackalytics v0.3.x General API information This section contains base info about the Stackalytics JSON API design. 1.2 Request / Response Types The Stackalytics API default response format is application/json. However if HTTP attribute callback is specified then JSONP response is returned. That allows to use response in client-side code and avoid same-host requests limitations. Example: GET /v1.0/data/companies or GET /v1.0/data/companies?callback=mycallback Accept: application/javascript 1.3 Faults The Stackalytics API returns an error response if a failure occurs while processing a request. Stackalytics uses only standard HTTP error codes. 4xx errors indicate problems in the particular request being sent from the client and 5xx errors indicate server-side problems Methods 2.1 Common Parameters All requests support common set of parameters that allow to filter resulting data. 5

10 Parameter release project_type module company user_id metric Description Name of OpenStack release or all, by default current release Type of project, e.g. core, by default openstack Name of module (repository name) Company name Launchpad id of user or if no Laucnhpad id is mapped. Metric: commits, loc, marks, s 2.2 Contribution by Modules Description Stats on contribution per modules. The data contains list of modules with their metric. Modules which metric is 0 are omitted. Request Verb URI Description GET /api/1.0/stats/modules Contribution by Modules Example Request GET /api/1.0/stats/modules?release=havana&metric=commits&project_type=openstack&user_id=zulcss Example Response "stats": [ "metric": 18, "id": "oslo-incubator", "name": "oslo-incubator", "metric": 7, "id": "keystone", "name": "keystone", "metric": 1, "id": "python-neutronclient", "name": "python-neutronclient" ] 2.3 Contribution by Companies Description Stats on contribution per companies. The data contains list of companies with their metric. Companies which metric is 0 are omitted. Request Verb URI Description GET /api/1.0/stats/companies Contribution by Companies Example Request 6 Chapter 2. API

11 GET /api/1.0/stats/companies?release=havana&metric=commits&project_type=openstack&module=neutron Example Response "stats": [ "metric": 155, "id": "VMware", "name": "VMware", "metric": 76, "id": "Mirantis", "name": "Mirantis", "metric": 53, "id": "Red Hat", "name": "Red Hat", "metric": 49, "id": "Cisco Systems", "name": "Cisco Systems", "metric": 46, "id": "*independent", "name": "*independent" ] 2.4 Contribution by Engineers Description Stats on contribution per engineers. The data contains list of engineers with their metric. Engineers who has metric 0 are omitted. For reviews also added column with review distribution. Request Verb URI Description GET /api/1.0/stats/engineers Contribution by Engineers Example Request: Commits GET /api/1.0/stats/engineers?release=havana&metric=commits&project_type=openstack&module=pbr Example Response "stats": [ "metric": 54, "id": "mordred", "name": "Monty Taylor", 2.1. Stackalytics JSON API v1.0 7

12 ],, "metric": 6, "id": "jdanjou", "name": "Julien Danjou" "metric": 4, "id": "doug-hellmann", "name": "Doug Hellmann" "metric": 3, "id": "slukjanov", "name": "Sergey Lukjanov" Example Request: Reviews GET /api/1.0/stats/engineers?release=havana&metric=marks&project_type=openstack&module=pbr Example Response "stats": [ "comment": " (96.2%)", "metric": 104, "id": "mordred", "name": "Monty Taylor", "comment": " (84.1%)", "metric": 82, "id": "cboylan", "name": "Clark Boylan", "comment": " (78.3%)", "metric": 60, "id": "doug-hellmann", "name": "Doug Hellmann" ] 2.5 Activity log Description Depending on selected metric Activity log contains commits, reviews, s or blueprints. Request Verb URI Description GET /api/1.0/activity Activity log Example Response 8 Chapter 2. API

13 "activity": [ "record_type": "commit", "primary_key": "63580a e d8d96859b4e96b017e3", "commit_id": "63580a e d8d96859b4e96b017e3", "user_id": "zulcss", "launchpad_id": "zulcss", "author_name": "Chuck Short", "author_ ": "chuck.short@canonical.com", "module": "ceilometer", "release": "havana", "blueprint_id": [], "bug_id": [], "date": , "branches": "master", "message": "Introduce py33 to tox.ini to make testing with python3 easier.\n", "subject": "python3: Introduce py33 to tox.ini", "change_id": [ "I96d1ecd3f e c83afc32673ffec" ], "company_name": "Canonical", "loc": 2, "files_changed": 1, "lines_added": 1, "lines_deleted": 1 ] 2.6 Contribution summary Description Get contribution summary: number of commits, locs, s, drafted and completed blueprints, review marks with distribution per mark (-2..+2). Request Verb URI Description GET /api/1.0/contribution Contribution summary Example Response "contribution": "loc": 252, "new_blueprint_count": 2, " _count": 7, "commit_count": 5, "competed_blueprint_count": 0, "marks": "0": 0, "1": 12, "2": 2, "-1": 5, "-2": Stackalytics JSON API v1.0 9

14 10 Chapter 2. API

15 CHAPTER THREE DEVELOPER GUIDE Other Resources 3.1 Project hosting with Launchpad The Stackalytics project homepage on Launchpad is Bug tracking Report Stackalytics bugs at Feature requests (Blueprints) Stackalytics uses Launchpad Blueprints to track feature requests. Blueprints are at Code Reviews with Gerrit Stackalytics uses the Gerrit tool to review proposed code changes. The review site is Gerrit is a complete replacement for Github pull requests. All Github pull requests to the Stackalytics repository will be ignored. See Gerrit Workflow Quick Reference for information about how to get started using Gerrit. See Gerrit, Jenkins and Github for more detailed documentation on how to work with Gerrit. 3.3 Continuous Integration with Jenkins Each change made to Stackalytics core code is tested with unit and integration tests and style checks flake8. Unit tests and style checks are performed on public OpenStack Jenkins managed by Zuul. Unit tests are checked using both python 2.6 and python 2.7. The result of those checks and Unit tests are +1 or -1 to Verify column in a code review from Jenkins user. 11

Infrastructure-as-Code and CI Infrastructure at Open Stack A look at one of the largest CI systems and system administration

Infrastructure-as-Code and CI Infrastructure at Open Stack A look at one of the largest CI systems and system administration Andreas Jaeger Product Manager SUSE aj@suse.com OpenStack Open source software