EngineeringProductivity/Projects/Treeherder: Difference between revisions

Revision as of 18:44, 17 April 2015

Overview

Treeherder is a reporting dashboard for checkins to Mozilla projects (for example, mozilla-central or gaia). It allows users to see the results of automatic builds and their respective tests. Treeherder also provides a rich set of API's that can be used by other projects interested in this information.

Treeherder is the successor to TBPL.

Contributing

To make UI changes, in many cases you only need to perform a very simple setup running a local webserver pointing at the production instance, described here. If you wish to hack on the backend, or the UI and backend together, you will instead need to set up both the treeherder-ui and treeherder-service Github repos as a pair, following these steps.

A-Team Bootcamp: Best practices for working on A-Team projects of which Treeherder is one. If you're new to Mozilla or the A-Team, please read this guide thoroughly before proceeding.
Good first bugs for new developers: Bugs Ahoy
Bugzilla: File a bug / All open bugs / Recently fixed / Bug tables
Chat on IRC: #treeherder / Channel logs (to learn about IRC see IRC)
Meetings: Notes & dial-in details
Mozilla Treeherder instances: Dev / Staging / Production (mana page)

Source and Docs

UI: Source / Docs
Backend: Source / Docs / API Docs
Treeherder data submission clients:
- Python: Source / Readme
- NodeJS: Source / Readme

Roadmap

Milestone M1: Functional Prototype

Deliver a functional prototype that sheriffs can use for E2E testing.
Status: [DONE] delivered 2014 Q1.

Milestone M2: Production Deployment

Complete a security review and deploy into production with IT.
Status: [DONE] delivered 2014 Q2.

Milestone M3: Sheriff Transition from TBPL

Work with the sheriffs to address bugs and workflow issues so that Treeherder is a viable alternate for TBPL for their workflow, and transition the sheriffs to using Treeherder for their day-to-day work. Bugs: see dependents of bug 1030636.
Status: [DONE] delivered 2014 Q3 (newsgroup post).

Milestone M4: Make TBPL redundant for all users

Work to implement other developer use cases, refine sheriffing work flows, and make TBPL redundant for all of its users.
Status: [DONE] delivered 2015 Q1 (newsgroup post).

Milestone M5: Performance Data

We want to obsolete Graphserver and Datazilla, and make Treeherder the dashboard that is used to visualize performance data generated by Talos and other sources. This will be comprised of at least the following:
- A performance panel in pushlog view that can be used to see details about the performance data submitted for a particular push, plus recent antecedents.
- A performance summary tab that gives a high-level overview by branch, platform, and suite.
Status: [PROPOSED] detailed planning to take place in late 2014 Q4, with delivery in 2015 Q1.

Possible Future Tasks

Migrating to Heroku
Using virtualenv/peep for more reliable package management
Merging the treeherder-ui and treeherder-service repos
Removing the objectstore
Splitting of oauth credentials from the datasource table
Improving UI performance/memory consumption
Storing job artefacts in S3
Improving task debug-ability (eg more logging, log aggregation)
Making it easier for new contributors to setup/perform common tasks
Adding more UI tests
Refactoring of jobs.py, including splitting out refdata
Moving away from datasource (ie using Django ORM)
Creating a log viewer UI for displaying json logs
Intermittent bug filer
Annotation of backouts, tree closures
Better performance graphs
Integration of performance alerts
Integration of OrangeFactor, GoFaster dashboards
Create a display for code coverage data
Additional metrics and visualizations