Jump to content

Coin glossary for Grafana users: Difference between revisions

From Qt Wiki
No edit summary
describe tasks and workitems vocabulary
Line 1: Line 1:
COIN is Qt company CI (Continuous Integration) system.
This article explains the glossary related to '''COIN''', the Qt Company Continuous Integration system, from a Grafana user’s perspective. It provides a basic understanding of COIN terminology that is helpful for correctly interpreting metrics, dashboards, and trends. The page presents a simplified view of COIN concepts as they appear in Grafana and intentionally omits internal implementation details. For deeper technical explanations, see the references listed in ''Further reading''.


From Grafana user point of view some basic vocabulary understanding COIN is needed to get better insight into data. This page shows simplified views of Coin and skips all additional details that are covered elsewhere (see further reading).
A '''task''' represents a single CI job scheduled either by a user or by agents. Every task has a specific type, such as:


From data point of view COIN jobs are called TASKS. Task consists of subtasks called WORKITEMS.
[[File:Coin task types jpg.jpg|thumb]]


Task - single CI job scheduled by user or agents. A task has a type:
* '''Integration'''
* '''Early warning'''
* '''Status check'''
* '''Nightly and Healthchecks'''


- Integration (is a task scheduled by )
Task types are labeled in the COIN web interface, they have distinct icons, and the same categorization (for example, Integration vs. Status check) also appears in different tables across Grafana dashboards. Status checks are jobs scheduled by users directly on coin web, Early warning are pre-checks scheduled from Gerrit. Integrations are tasks in which actual qt code is attempted to be integrated. HealtCheck are special tusks run every night, it builds and tests the latest qt5.git and all submodules on their last submodule-updated SHA-1s. 


- Early Warning
See related dashboards:


- StatusCheck.
[https://testresults.qt.io/grafana/d/d55b6230-5ceb-4962-acc2-83810e2be68c/things-gone-wrong-in-last-healthcheck Things Gone Wrong in last HealthCheck]


- Nightly and Healtchecks
For most flaky test statistics, only test results from integrations tasks are typically considered.


The types are marked on coin web front. The categorization (Integration/StatusCheck) may show up in different Grafana dashboard tables.  
ach task has a unique '''task id''', which serves as its identifier. This id can be used to construct a URL that shows the status and results of a COIN task, following the pattern:[[File:Task url.jpg|thumb]]<nowiki>https://testresults.qt.io/coin/integration/qt/{module_name}/tasks/{task_id}</nowiki>


For most of the flaky test statistics - only results of test runs from  Integrations are usually used. 
for example:


[[File:Coin task types jpg.jpg|thumb]]
https://testresults.qt.io/coin/integration/qt/qt5/tasks/nightly1767303902


Here, &lt;code&gt;qt5&lt;/code&gt; is the &lt;code&gt;module_name&lt;/code&gt; and &lt;code&gt;nightly1767303902&lt;/code&gt; is the &lt;code&gt;task_id&lt;/code&gt;..


[[File:Coin task types.png|thumb]]
Tasks urls can be found in panels providing detailed information about test runs (see picture).


[[File:Screenshot from 2026-01-02 17-10-09.png|thumb]]'''Workitems'''


A '''task''' can contain one or more subtasks called '''workitems'''.


Task id. Every task has its own identifier -
Workitems represent a set of jobs and are roughly categorized into three types:


Identifier allows to build url showing status and result of coin task for example<nowiki/>https://testresults.qt.io/coin/integration/qt/qt5/tasks/nightly1767303902
* '''Provision'''
* '''Build'''
* '''Test'''


In this url "nightly1767303902" is actual task id.


Those urls you will also find in panels providing detailed information about test runs:
[[File:Task url.jpg|thumb]]


'''Workitem States'''
Each workitem has a '''state''' that describes its current status or final outcome. Possible states include:[[File:Test workitem state.png|thumb]]


* '''Done''' – completed successfully
* '''Running''' – currently in progress
* '''Cancelled''' – manually stopped before completion
* Waiting for hardware
* '''Failed''' – encountered some sort of execution error
*  '''Error''' – any failure outside of the VM running instructions
* '''Timeout'''
* '''Insignificant''' – does not affect the overall task result


A TASK can contain one to many subtask called Workitems.


Workitem are set of jobs roughly categorized to 3 types:
[[File:Screenshot from 2026-01-02 17-10-09.png|thumb]]






[[File:Test workitem state.png|thumb]]
- Provision


- Build


- Test




Workitems  have state - that describes its status or result outcome: Done, Running, Cancelled, Failed (Error) and finally Insignificant.




Test workitems contain test execution logs.and






Test workitems contain test execution logs.and
[[File:Coin tasks workitems.jpg|thumb]]






[[File:Coin tasks workitems.jpg|thumb]]
''Further reading''.


https://testresults.qt.io/coin/coininfo
https://testresults.qt.io/coin/coininfo
[[Early Warning System]]

Revision as of 14:59, 22 January 2026

This article explains the glossary related to COIN, the Qt Company Continuous Integration system, from a Grafana user’s perspective. It provides a basic understanding of COIN terminology that is helpful for correctly interpreting metrics, dashboards, and trends. The page presents a simplified view of COIN concepts as they appear in Grafana and intentionally omits internal implementation details. For deeper technical explanations, see the references listed in Further reading.

A task represents a single CI job scheduled either by a user or by agents. Every task has a specific type, such as:

  • Integration
  • Early warning
  • Status check
  • Nightly and Healthchecks

Task types are labeled in the COIN web interface, they have distinct icons, and the same categorization (for example, Integration vs. Status check) also appears in different tables across Grafana dashboards. Status checks are jobs scheduled by users directly on coin web, Early warning are pre-checks scheduled from Gerrit. Integrations are tasks in which actual qt code is attempted to be integrated. HealtCheck are special tusks run every night, it builds and tests the latest qt5.git and all submodules on their last submodule-updated SHA-1s.

See related dashboards:

Things Gone Wrong in last HealthCheck

For most flaky test statistics, only test results from integrations tasks are typically considered.

ach task has a unique task id, which serves as its identifier. This id can be used to construct a URL that shows the status and results of a COIN task, following the pattern:

https://testresults.qt.io/coin/integration/qt/{module_name}/tasks/{task_id}

for example:

https://testresults.qt.io/coin/integration/qt/qt5/tasks/nightly1767303902

Here, <code>qt5</code> is the <code>module_name</code> and <code>nightly1767303902</code> is the <code>task_id</code>..

Tasks urls can be found in panels providing detailed information about test runs (see picture).

Workitems

A task can contain one or more subtasks called workitems.

Workitems represent a set of jobs and are roughly categorized into three types:

  • Provision
  • Build
  • Test


Workitem States

Each workitem has a state that describes its current status or final outcome. Possible states include:

  • Done – completed successfully
  • Running – currently in progress
  • Cancelled – manually stopped before completion
  • Waiting for hardware
  • Failed – encountered some sort of execution error
  • Error – any failure outside of the VM running instructions
  • Timeout
  • Insignificant – does not affect the overall task result







Test workitems contain test execution logs.and



Further reading.

https://testresults.qt.io/coin/coininfo

Early Warning System