Partial report definition file

General layout of the file is the following: first define the report metrics that need to be used in the report, then define the layout of the subsections that are visible in the report.

An example partial report definition file:

<partialReport name="com.allinea.myReport"
            xmlns="http://www.allinea.com/2016/AllineaReports">
<reportMetrics>
    <!-- multiple <reportMetric> elements can be defined -->
    <!-- source attribute must be set to "metric" -->
    <reportMetric id="com.allinea.metrics.sample.average"
                tooltip="Metric tooltip."
                displayName="Average of custom interrupt metric"
                units="/s"
                colour="hsl(19, 70, 71)"
                source="metric">
    <!-- metricRef: reference to an entry in metricdefinitions element -->
    <!-- sampleValue: data value from each sample to take: min, max, mean or sum across processes -->
    <!-- aggregation: how to aggregate per-sample values into a single value: min, max, mean across time -->
    <sourceDetails metricRef="com.allinea.metrics.sample.interrupts"
                    sampleValue="mean"
                    aggregation="mean"/>
    </reportMetric>
</reportMetrics>
<subsections>
    <!-- multiple <subsection> elements can be defined -->
    <subsection id="my_metrics"
                heading="My metrics"
                colour="hsl(23, 83, 59)">
    <text>Section one:</text>
    <!-- multiple <entry> elements can be defined -->
    <entry reportMetric="com.allinea.metrics.sample.average"
            group="interruptGroup" />
    </subsection>
</subsections>
</partialReport>

<partialReport>

<partialReport name="com.allinea.myReport"
           xmlns="http://www.allinea.com/2016/AllineaReports">
</partialReport>

name: A name that uniquely identifies this report. The name is used to distinguish between different kind of reports. See Reserved Names/IDs and Restrictions for reserved names.
xmlns: The xmlns="http://www.allinea.com/2016/AllineaReports" attribute must be included in the <partialReport> element.

<reportMetrics>

Container for one or more <reportMetric> elements.

<reportMetric>

Each <reportMetric> element describes a single metric that is stored as a double value.

<reportMetric id="com.allinea.metrics.sample.average"
displayName="Average of custom interrupt metric" tooltip="Metric
tooltip." units="/s" colour="hsl(19, 70, 71)"

id

A unique identifier for this metric. This is used to reference this metric in <entry> elements. Ids with dots in their value must not be substrings of each other.

For example, com.allinea.metrics.sample is a substring of com.allinea.metrics.sample.average and therefore not allowed. See Reserved Names/IDs and Restrictions for reserved names.

displayName

The name for this metric, as it appears in the report.

tooltip (optional)

A tooltip to be displayed when hovering over the metric name.

units

The units this metric is measured in, as it appears in the report. Units are auto-scaled with SI (G, M, k) and IEC (Gi, Mi, ki) prefixes, but no negative exponent scaling is performed. You must scale custom metrics and select custom units accordingly.

colour (optional)

The colour to be used for this metric when it is named in the report. Color is also used for comparison bars showing the relative value of this metric. See Color codes.

source

Source type of this metric, must be set to metric.

<sourceDetails>

Describes the details of the source metric used in this report element.

<sourceDetails metricRef="com.allinea.metrics.sample.interrupts"
sampleValue="mean" aggregation="mean"/>

metricRef: Reference to an existing metric, can be either an Arm-defined or a user-defined (custom) metric.
sampleValue: Which sample value of the referenced source metric to be used (options: min/max/mean).
aggregation: How aggregated samples are aggregated (options: min/max/mean).

<subsections>

Container for one or more <subsection> elements.

<subsection>

Describes the layout of the data to be displayed.

<subsection id="my_metrics"
           heading="My metrics"
           colour="hsl(23, 83, 59)">
<!-- can add a <text> element with further description -->
<!-- multiple <entry> elements can be defined -->
</subsection>

id: A unique identifier for this subsection.
heading: The display name for this subsection.
colour (optional): The colour to use for the heading text. See Color codes.

<text>

Short static description of this subsection.

<entry>

Describes one of the metrics to be listed in the subsections of the report.

<entry reportMetric="com.allinea.metrics.sample.average"
  group="interruptGroup" />

reportMetric: Referenced report metric that is to be displayed.
group (optional): The optional group attribute is used to determine how to scale comparison bars that indicate the relative size of two or more metric values. If two <entry> elements have the same value for their group attribute, they are considered comparable and have comparison bars drawn using the same scale.