CollectOSS Documentation

Welcome!

• Welcome to CHAOSS!
• Quickstart
  • Docker Compose
• Explanations of Technologies
  • What does Redis Do?
  • What does RabbitMQ Do?
  • Possible EC2 Configuration Requirements
• About CollectOSS
  • Scope of the CollectOSS project
• Deployment
  • Running CollectOSS in Production
• Getting Started
  • Database setup
  • Collecting Data
  • Command Line Interface
• Development Guide
  • Installing for Development
  • 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
• CollectOSS OAuth Flow
  • Prerequisites
  • Authorization Flow
  • Making Authenticated Requests
• CollectOSS Standard Operating Procedures
  • The CollectOSS Release Process

What is CollectOSS?

CollectOSS is a software tool that helps you collect and measure information about open source software projects. CollectOSS 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 CollectOSS 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 CollectOSS works

1. CollectOSS 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 CollectOSS’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.

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

Who develops CollectOSS

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

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

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

For the current list of CollectOSS maintainers and contributors, please refer to the CREDITS.md file.