The Azure DevOps app is designed to offer detailed reporting information across your data in Azure DevOps (Formerly VSTS) at a level not currently possible within Azure DevOps itself. This guide is to show you how to set the app up and use it to its full potential.
There are a couple of measures that can be taken should you not wish to follow the recommended installation path
The force directed app is used to visualise work item relationships. To remove this app as a dependency, use of the app will need to be removed the Work Items view, whilst the Work Item Relationships view will cease to be of any use without significant rework
All searches within the app avoid specifying indexes. This is to enable dynamic security, allowing two users of separate roles to interact with the app in the same way, using an entirely different data set. Should this functionality not be required, changes will need to be made to every search in every view and macro. The easiest way to identify these is via reference to each sourcetype (AzureDevOps:[Work Item/Iteration/Capacity]).
The Summary screen is intended to provide a high level overview across all boards collected into Splunk. Initial load covers all work types, however a multi-select field atop the screen allows for selection and removal of work items as desired.
The Projects screen is intended to provide a deeper look into details of a specific project. This includes a broken down view of Work Item Types by State, Tag and Assignee. Other information regards high level information assigned to each sprint, allowing for easy identification of any work items assigned to am expired sprint and providing forward visibility for future sprints. A key feature for this view is that the report for any ingested project can be obtained via a single click on a table row.
The Iterations view displays information for a specific iteration within a project. Information displayed includes the majority of features in the Projects view at an iteration level with the addition of charts for Leave, Capacity, as well as a Burndown.
The iteration comparison view allows comparison for up to 3 separate iterations, either within the same project or across different ones. This makes for an easy comparison of Burndown Charts, along with leave overview and capacity vs work remaining.
The Member view allows for information specific to that person to be displayed in one screen. This allows for a view of all work allocated to the person over multiple projects and sprints. It also highlights any work remaining allocated to tasks and bugs, as well as identifying any leave entered in any sprint on any project.
The Work Item view allows for general reporting of work items, giving some detailed information for each work item when requested. This information includes, assignee, estimate, current state, tags, and a graphical representation of the relationships for the work item (Force Directed App).
Most burndowns on other views will direct to this view in order to provide a visualisation as to where the stats were generated in the previous view.
This screen is intended to visualise the relationships for all work items of a selected iteration, displaying the work item id’s and the relations between each. Visuals include:
• Parent > Child
• Predecessor > Successor
• Duplicates
• Relatives
• Etc
Please note this view is still a work-in-progress however it was included in the final release due to the lack of ability to visualise this information in any other way.
This view uses the Force Directed App in order to function. If the dependant app is not installed, this view should be disabled / removed
Should any additional views or searches be required, some macros have been created and are available for use within the app.
These macros are designed to get and return information for use in other searches
USE: GetUniqueOpenWorkItem
PARAM(S): None
PURPOSE: Get all open work items
USE: GetAllWorkItemsForBoard(1)
PARAM(S): Project Name
PURPOSE: Get all work items for a specific board
These macros are designed to calculate data for use after call
USE: CalcDaysFromNow(1)
PARAM(S): DateTime in standard Y-m-dTH:M:S format
PURPOSE: Calculate a DateTime value vs runtime
USE: CalcWorkDaysDifference(4)
PARAM(S): Start Date, End Date, MV Field of Work Days (Monday, Tuesday,…), MV Field of Dates to Exclude
PURPOSE: To calculate the exact work days difference between two dates, as opposed to a simple date difference which may include days off (e.g weekends)
These macros are designed to run as self-contained searches, whilst allowing for some flexibility not on offer if these are saved as reports
USE: GenerateBurndown(2)
PARAM(S): Project Name, Iteration
PURPOSE: To produce a burndown chart for an iteration
USE: GenerateCapacityOverview(2)
PARAM(S): Project Name, Iteration
PURPOSE: To produce a chart displaying individuals available capacity vs work remaining for an iteration
As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.