Augur Documentation

As of April 15, 2026, we recommend exploring Augur’s successor, Aveloxis. Aveloxis is a next-generation tool, written in Go, with a test first programming philosophy, and a rigorous data collection testing cycle that ensures complete, fast, robust data collection. Aveloxis closed 80%+ of Augur’s open issues on day one, and our present benchmarks indicate its overall data collection is approximately 10x faster than Augur’s.

Welcome!

• Welcome to CHAOSS!
• Quickstart
  • Ubuntu 22.x Setup
  • OSX Setup
  • Docker Compose
• Explanations of Technologies
  • What does Redis Do?
  • What does RabbitMQ Do?
  • Possible EC2 Configuration Requirements
• About Augur
  • Scope of the Augur project
• Deployment
  • Setting up an Augur Server
  • Web Server Configuration
  • Running Augur in Production
• Getting Started
  • Database setup
  • Installation Guide
  • Collecting Data
  • Augur’s Frontend
  • Command Line Interface
• Development Guide
  • Installing for Development
  • Make commands
  • Logging
  • Writing documentation
  • Workers
  • Create a Metric
  • CLI (Command Line Interface)
  • Testing
  • Configuration file reference
  • Explanations of Technologies
• REST API Documentation
• Docker
  • Docker Quick Start
  • Getting Started
  • Docker Image Breakdown
  • Docker Compose Deployment
  • Docker Compose
  • Interacting with the containers
• Schema
  • Descriptions of Tables & Purposes
  • Complete Data Model on a Page
  • Focus: Issues
  • Focus: Commits
  • Focus: Pull Requests
  • Focus: Contributors
  • Focus: Dependencies
• Augur OAuth Flow
  • Prerequisites
  • Authorization Flow
  • Making Authenticated Requests
• Augur Standard Operating Procedures
  • The Augur Release Process

What is Augur?

Augur is a software tool that helps you collect and measure information about open source software projects. Augur focuses on collecting data from public git-based code hosting platforms (“Forges”) such as GitHub and GitLab to produce data about the health and sustainability of software projects based on the relevant CHAOSS metrics.

The main goal of Augur is to understand how healthy and sustainable a project is. Healthy projects are easier to rely on, and they are important because many software organizations or companies depend on open-source software.

How Augur works

1. Augur looks at the project’s repositories (the place where the project’s code and files live).

2. It collects data about activity that is happening in the project, including issues, comments, code changes, etc.

3. It organizes this data into a standard format called a data model.

4. Then it calculates metrics that tell you about the project’s health.

Example of a metric: Burstiness

• Burstiness is one of Augur’s metrics.

• It shows periods when a project has a lot of activity in a short time, followed by periods when activity goes back to normal.

• This helps you see a project’s focus, update patterns, and stability.

• In other words, you can tell how often big changes happen and whether the project works in a steady, predictable way.

Augur calculates many other metrics, which you can see in the full list.

Who develops Augur

• Augur is developed as part of CHAOSS (Community Health Analytics in Open Source Software).

• Many of Augur’s metrics come directly from the CHAOSS community.

• If you want to get involved, visit the CHAOSS website.

For the current list of Augur maintainers and contributors, please refer to the CONTRIBUTORS.md file.

See it in action

• You can check out Augur live on the CHAOSS instance.