Metric Meta Data
HeyQL Metrics can read information about metric title, subtitle and more from fields on the "Configuration" tab. So if you want to change the title of a metric all you have to do is to edit the related title field. HeyQL Metrics will automatically reload its charts and tables right after you stored your changes.
HeyQL Metrics uses the following information as default values:
| Information | Default value |
|---|---|
| metric title | current issue key |
| metric subtitle | not shown |
| metric x axis label | "time" |
| metric y axis label | "number" |
Parameters
HeyQL Metrics supports a bunch of parameters, which will be automatically replaced by the related information.
This makes it possible to combine different field values of your issue and use it as metric title or to add actual information like time and date.
| parameter | description |
|---|---|
| %key% | issue key |
| %summary% | issue summary |
| %assignee% | issue assignee full name |
| %assignee_img% | issue assignee avatar |
| %reporter% | issue reporter full name |
| %reporter_img% | issue reporter avatar |
| %project% | project name |
| %project_img% | project avatar |
| %date% | current date |
| %time% | current time |
Statistic Parameters
Each metric statistic has its own name, which can be used inside JQL based searches in JIRA (e.g. metricMeanValue, metricDayMonthValue).
This name can also be used as parameter. A complete list of all search parameters can be found in Metric Search.
Usage
To use a parameter is quite simple. Just add it into the related field. For instance to get the actuall assignee into the metric title:
My metric title for %assignee%
You are free to combine different parameters.
Metric for %assigne_img% %assignee%. Title: %summary%
HTML Support
You can use standard HTML tags to formate specific parts of metric title, subtitel and the axis labels.
Common HTML tags
| HTML tag | description | Example |
|---|---|---|
| <b>my metric</b> | Makes the text bold | my metric |
| <i>my metric</i> | Makes the text italic | my metric |
| <u>my metric</u> | Underlines the text | my metric |
| <font color="blue">my metric</font> | Makes the text blue | my metric |
You are free to combine different html tags. For instance
<b><font color="red"><i> My </i></font> metric <b>
will result in: My metric
Examples
Empty fields
| Title | |
|---|---|
| Subtitle | |
| X axis label | |
| Y axis label |
Static information
| Title | my title |
|---|---|
| Subtitle | my subtitle |
| X axis label | x axis |
| Y axis label | y axis |
Formated, static information
| Title | <b>SW Quality</b> Metric |
|---|---|
| Subtitle | <font color="red">Team X</font> |
| X axis label | Time |
| Y axis label | <i>Issues</i> |
Dynamic information
| Title | %project_img% %key%: %summary% for %assignee_img% %assignee% |
|---|---|
| Subtitle | %date% - %time% -Reported by %reporter% %reporter_img% |
| X axis label | Time |
| Y axis label | Issues |
Formated, dynamic information
| Title | %project_img% %key%: <b>%summary%</b> for %assignee_img% <u>%assignee%</u> |
|---|---|
| Subtitle | <font color="#555">%date% - %time% -Reported by %reporter% %reporter_img%</font> |
| X axis label | Time |
| Y axis label | Issues |
