Introduction to the KPI Widgets
Basic introduction to the KPI Widgets
In this article, we will go through the current KPI Widgets that are available in Sigmetic. We will see how they work, how we can configure them, and what they are especially useful for.
‘Issues’ and ‘Pull Requests’ widgets
The first two widgets we see are ‘Issues’ and ‘Pull Request’.
These widgets are status widgets and they provide an insight into the current status of a repository (or set of repositories).
More specifically, these widgets will show us the number of issues / pull requests that are currently present in our repository (or set of repositories).
When we configure these status widgets, we can choose a repository to get feedback from, or we can choose to aggregate data from all of the repositories in the set. If we have chosen more than one repository in our dashboard plan, we will see an ‘Aggregate’ toggle next to the repositories dropdown.
You can also choose to filter the data based on state: ‘Open’, ‘Closed’, or ‘All.
For the ‘Pull Requests’ widget, you can also choose to filter by status: ‘Mergeable’, ‘Blocked’, or ‘All.
For both widgets, we can filter by labels. The labels on the list are the labels that are available on your repository (or set of repositories).
‘Commit Trend’ widget
The next widget we can choose is the ‘Commit Trend’ widget.
This is a trend widget, and for these types of widgets, we have to specify a range in time that we want to observe. We do that by specifying a date range.
The ‘Commit Trend’ widget gives us an overview of the commits given in
the specified range of time.
We can see the breakdown of widgets over the different repositories and branches, and we can see how much was committed on a day-by-day progression.
We also get some quick information about the total number of commits, which branch has received the most commits, and which committer who has committed the most.
As with the status widgets, we can choose a repository to get feedback from, or we can choose to aggregate data from all of the repositories. With the trend widgets, we can also choose to compare the given range in time with the period prior to the one specified. We do that by checking the ‘Compare to past’ checkbox.
‘Issue Burnup’ widget
The ‘Issue Burnup’ widget is also a trend widget, and the configuration is similar to the ‘Commit Trend’ widget.
With the ‘Issue Burnup’ widget we can see how the opening and closing of issues accumulate over time, which makes it easy to identify the progress in the given range in time.
‘Top Contributor’ widget
The last widget we can choose is the ‘Top Contributor’ widget.
These are activity widgets, and for these types of widgets, we need to specify a range in time, just as we did with the trend widgets.
The activity widgets tell us something about the activities on our repository (or set of repositories), and the ‘Top Contributor’ widgets can show us the top contributors on various parameters.
When configuring this widget, we notice that there is a pagination
on the bottom of the settings window (the blue dots).
The first page of the settings will be similar to the ones of the trend widgets, but if we navigate to the second page, we will see that there are some additional settings here.
On this page, we can specify how many of the top-n contributors we want to see in the list, and we can specify which type of contributions we want to observe.
Currently supported are the contribution types:
- Created Issues
- Merged PRs
- Lines of code
More widgets are coming up
This was all the widgets that are currently available in Widget Library, but many more widgets will come soon!
Sigmetic is currently in beta, and we are more than eager to listen to your feedback!
— Simon LH, Creator