incubator-devlake

README

Apache DevLake(Incubating)

🤔 What is Apache DevLake?

Apache DevLake is an open-source dev data platform that ingests, analyzes, and visualizes the fragmented data from DevOps tools to distill insights for engineering productivity.

Apache DevLake is designed for developer teams looking to make better sense of their development process and to bring a more data-driven approach to their own practices. You can ask Apache DevLake many questions regarding your development process. Just connect and query.

🎯 What can be accomplished with Apache DevLake?

1. Collect DevOps data across the entire Software Development Life Cycle (SDLC) and connect the siloed data with a standard data model.
2. Visualize out-of-the-box engineering metrics in a series of use-case driven dashboards。
3. Easily extend DevLake to support your data sources, metrics, and dashboards with a flexible framework for data collection and ETL.

🤓 How do I use DevLake?

1. Set up DevLake

You can easily set up Apache DevLake by following our step-by step instruction for local setup or Kubernetes setup.

2. Create a Blueprint

The DevLake Configuration UI will guide you through the process (a Blueprint) to define the data connections, data scope, transformation and sync frequency of the data you wish to collect.

3. Track the Blueprint's progress

You can track the progress of the Blueprint you have just set up.

4. View the pre-built dashboards

Once the first run of the Blueprint is completed, you can view the corresponding dashboards.

5. Customize the dahsboards with SQL

If the pre-built dashboards are limited for your use cases, you can always customize or create your own metrics or dashboards with SQL.

💪 Supported Data Sources

Data Source	Domain	Versions
Feishu	Documentation	Cloud
GitHub	Source Code Management, Code Review, Issue/Task Management	Cloud
Gitlab	Source Code Management, Code Review, Issue/Task Management	Cloud, Community Edition 13.x+
Jenkins	CI/CD	2.263.x+
Jira	Issue/Task Management	Cloud, Server 8.x+, Data Center 8.x+
TAPD	Issue/Task Management	Cloud

🚀 Quick Start

• Deploy Locally
• Deploy to Kubernetes
• Deploy in Temporal Mode
• Deploy in Developer Mode

⌚ Project Roadmap

• Roadmap 2022: Detailed project roadmaps for 2022.

😍 How to Contribute

This section lists all the documents to help you contribute to the repo.

• Architecture: Architecture of Apache DevLake
• Data Model: Domain Layer Schema
• Add a Plugin: Guide to add a plugin
• Add Metrics: Guide to add metrics in a plugin
• Contribution Guidelines: Start from here if you want to make contribution

💙 Community

• Slack: Message us on Slack
• FAQ: Frequently Asked Questions
• Wechat Community:
  

📄 License

This project is licensed under Apache License 2.0 - see the LICENSE file for details.