HeyQL Metrics supports lines and areas in charts and areas in tables.

You can use them to mark critical areas or to show the mean value as line of a metric.

Lines & Areas

Drawing

Lines

To draw a line inside your metric, just add a number to the field "Definitions".

If you need to draw several lines, you can add several numbers, separated by ";" (semicolon).
For instance: 1; 5.2 ;10. Spaces will be ignored.

Areas

If you need an area, you have to specify a range like 1.5-10. The syntax is:

[STARTVALUE] - [ENDVALUE]

If you need more than one area, just add a ";" before defining the next area.
For instance: 1-10; 30 - 35; 100-500. Spaces will be ignored.

You can combine areas and lines. Just use the already known ";" as separator: For instance: 1-10; 20; 30-35; 25

Colors

You can use each color you want for your lines and areas. Just add them to the field "Colors".

Each color definition is linked to the related area/line from the custom field "Metric Area Definition" based on their position.

So the first area/line gets the first defined color, the second area/line the second color and so on.

If you provide less colors as defined areas or lines, the areas/lines with a missing color definition will inherit its color from the last defined color.

For instance:

Metric Area Definition	1-10, 25; 50-100
Metric Area Color	red, blue

This will result in a red area, a blue line and an additional blue area.

Color formats

HeyQL Metrics understands the most common color specifications from the world wide web:

HTML color names like red, blue, aqua (Full list of supported names: Link)
Hexadecimal colors like #FF0000, #0000FF, #FFCC00
RGBA colors like rgba(255,0,0,1), rgba(120,50,200,1)

You are free to combine the different formats, like "red; rgba(200,200,200,0.5), blue, FFCC00".

We suggest to use the RGBA color format for areas. The advantage of RGBA is the alpha/transparency value at the end. This allows you to draw an area, in which you can still see the axis grid from the background. For instance:

rgba(0,0,0,1) → blackest, possible area. No transparency. No axis grid
rgba(0,0,0,0.5) → grayish area. 50% transparency. Axis grid visible
rgba(0,0,0,0) → invisible area. 100% transparency.

Labels

You can give each line or area a label. This will be shown on the left side, above a line or in the middle of an area.

Simply add the label to the "Labels" field.

If you have defined more than one line or area, you can set the label for each of them by separating the different labels with ";".
For instance: critical; ok; target.

Using Parameters

HeyQL Metrics provides some statistics around your metric. Each single statistics has its own jql parameter, which can be used inside JIRA's Issue Navigator as search parameter. Please see Metric Search for more information regarding available metric parameters.

These parameters can also be used inside the custom field "Metric Area Definition".
During chart or table drawing HeyQL Metrics replaces parameters by their corresponding value.

use cases

The following examples are values for the field "Definitions".

%metricMeanValue%	Marks the mean value as line
%metricDayLowestValue% - %metricDayHighestValue%	Shows an area as value range of the current day
%metricYearMeanValue% - %metricMonthMeanValue%	Shows the delta between the mean value of the last year and the mean value of the last month

HeyQL Metrics Documentation

Metric Areas & Lines