Report module

Available:

Bamboo 1.0 and later

Description

This defines a report module. A report module will appear under the Reports tab.

A report typically consists of two objects:

  • A ReportCollector object implementing the com.atlassian.bamboo.reports.collector.ReportCollector interface. This takes in a list of builds and generates a DataSet.
  • A ReportLineChart object extending the com.atlassian.bamboo.reports.charts.BambooReportLineChart class. This chart will be responsible for rendering the dataset results generated by the ReportCollector. Charts in Bamboo are generated via jFreeChart

Sample Module Descriptor Element

1
2
3
4
5
6
<report key="ratioOfSuccess" name="Percentage of Successful Builds"
                   class="com.atlassian.bamboo.reports.collector.RatioOfSuccessCollector">
    <description>Comparing success percentages gives you an idea of how stable a build is compared to one another.
      100% means your build is always rock solid. 0% means something is seriously wrong.</description>
    <chartClass>com.atlassian.bamboo.reports.charts.BuildSummarySuccessRatioLineChart</chartClass>
  </report>