跳到主要内容
版本:v0.12

Tutorial

Overview

The Apache DevLake Config UI allows you to configure the data you wish to collect through a graphical user interface. Visit config-ui at http://localhost:4000.

Creating a Blueprint

Introduction

A Blueprint is the plan that covers all the work to get your raw data ready for query and metric computaion in the dashboards. We have designed the Blueprint to help you with data collection within only one workflow. Creating a Blueprint consists of four steps:

  1. Adding Data Connections: Add new or select from existing data connections for the data you wish to collect
  2. Setting Data Scope: Select the scope of data (e.g. GitHub projects or Jira boards) for your data connections
  3. Adding Transformation (Optional): Add transformation rules for the data scope you have selected in order to view corresponding metrics
  4. Setting Sync Frequency: Set up a schedule for how often you wish your data to be synced

Step 1 - Adding Data Connections

There are two ways to add data connections to your Blueprint: adding them during the creation of a Blueprint and adding them separately on the Data Integrations page. There is no difference between these two ways.

When adding data connections from the Blueprint, you can either create a new or select from an exisitng data connections.

Step 2 - Setting Data Scope

After adding data connections, click on "Next Step" and you will be prompted to select the data scope of each data connections. For instance, for a GitHub connection, you will need to enter the projects you wish to sync and for Jira, you will need to select the boards.

Step 3 - Adding Transformation (Optional)

This step is only required for viewing certain metrics in the pre-built dashboards that require data transformation. Without adding transformation rules, you can still view the basic metrics.

Currently, DevLake only supports transformation for GitHub and Jira connections.

Step 4 - Setting Sync Frequency

You can choose how often you would like to sync your data in this step by selecting a sync frequency option or enter a cron code to specify your prefered schedule.

After setting up the Blueprint, you will be prompted to the Blueprint's activity detail page, where you can track the progress of the current run and wait for it to finish before the dashboards become available. You can also view all historical runs of previously created Blueprints from the list on the Blueprint page.

Editing a Blueprint (Coming in v0.13)

Creating and Managing Data Connections

The Data Connections page allows you to view, create and manage all your data connections at one place.