Reporting in Octopus 3.1+.
Also take a look at the Reporting features we shipped as part of Octopus 3.1 which provides reporting optimized views of the live deployment data, no longer requiring an XML export.
Ever wonder how many deployments you did this month? In this page, we'll help you to answer this question by walking you through how to export your deployments to Excel, and then to view them in a pivot table.
At a high-level, the steps are:
- Export all deployments to an XML file.
- Import the XML file in Excel.
- Report on the data using a pivot table.
Export All Deployments to an XML File
Before we can report on the data using Excel, we need to export it in a format that Excel can import. The easiest way to do this is using an XML file.
As of 2.5.10, Octo.exe can be used to export deployments to an XML file. The command looks like this:
octo.exe dump-deployments --server http://your-octopus --apiKey API-YOURAPIKEY1234 --filePath=Deployments.xml
The output will appear as follows:
Handshaking with Octopus Server: https://demo.octopus.com Handshake successful. Octopus version: 220.127.116.114; API version: 3.0.0 Listing projects Listing project groups Listing environments Dumping deployments... Wrote 30 of 112 deployments... Wrote 60 of 112 deployments... Wrote 90 of 112 deployments... Wrote 112 of 112 deployments...
The command will produce an XML file with contents similar to the following:
<Deployments> <Deployment> <Environment>Acceptance</Environment> <Project>OctoFX Trading Website</Project> <ProjectGroup>OctoFX</ProjectGroup> <Created>2014-10-08T14:10:25</Created> <Name>Deploy to Acceptance</Name> <Id>deployments-18046</Id> </Deployment> <Deployment> <Environment>Test</Environment> <Project>OctoFX Trading Website</Project> <ProjectGroup>OctoFX</ProjectGroup> <Created>2014-10-03T13:06:29</Created> <Name>Deploy to Test</Name> <Id>deployments-18044</Id> </Deployment> .....
This file is now ready to be imported into Excel.
Import the XML File in Excel
Now that we have an XML file containing our deployments, we can import it into Microsoft Excel. In this example we are using Excel 2013.
Open Microsoft Excel, and create a new, blank workbook.
On the Data ribbon tab, click From Other Sources, then choose From XML Data Import.
Excel will prompt you that the XML file does not refer to a schema, and that one will be created. Click OK.
Excel will ask you where to create a table. Choose the location in your workbook to put the new table, or just click OK.
You should now have a table that lists each of the deployments you have performed with Octopus, along with the name of the environment, project and the date of the deployment.
Report on the Data Using a Pivot Table
It's easy to turn the table of deployments into a pivot table for reporting.
Select any cell in the table, then from the Insert ribbon tab, click PivotTable.
Excel will prompt you to ask where to place the new pivot table. Click OK to add it to a new worksheet in your workbook.
You can now build the pivot table by dragging fields into the Rows or Columns of the pivot table.
For example, here's a breakdown of deployments by environment. Note that the Id field was dragged to the Values area, and Environment was dragged to Rows.
Here's another example, this time using Environment as a column, and Project as the rows:
You can also group the results by month or other measures of time. First, drag the Created field as as row.
Now, right click any of the date values, and click Group.
Choose the level of granularity that you want to group by, then click OK. In this example we chose Months.
And the results will now be grouped by month:
If you aren't happy with the order that environments or other items are shown in, you can right click and move them:
Finally, don't forget to add pretty graphs!
There are two major limits to this approach to be aware of:
- As you have seen, only a small amount of data is available for use for reporting.
- If you use retention policies, releases and deployments that have been deleted by the retention policy will also not be available for reporting.