Skip to content

Commit cb12a4e

Browse files
committed
[QC-1286] Full TOC
1 parent bff913c commit cb12a4e

File tree

6 files changed

+77
-136
lines changed

6 files changed

+77
-136
lines changed

README.md

Lines changed: 66 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,15 @@ For a general overview of our (O2) software, organization and processes, please
2020
* [Post-processing example](doc/QuickStart.md#post-processing-example)
2121
* [Modules development](doc/ModulesDevelopment.md)
2222
* [Context](doc/ModulesDevelopment.md#context)
23-
* [QC architecture](doc/ModulesDevelopment.md#qc-architecture)
23+
* [QC architecture](doc/ModulesDevelopment.md#qc-architecture)
2424
* [DPL](doc/ModulesDevelopment.md#dpl)
2525
* [Data Sampling](doc/ModulesDevelopment.md#data-sampling)
26-
* [Custom Data Sampling Condition](doc/ModulesDevelopment.md#custom-data-sampling-condition)
27-
* [Bypassing the Data Sampling](doc/ModulesDevelopment.md#bypassing-the-data-sampling)
2826
* [Code Organization](doc/ModulesDevelopment.md#code-organization)
2927
* [Developing with aliBuild/alienv](doc/ModulesDevelopment.md#developing-with-alibuildalienv)
3028
* [User-defined modules](doc/ModulesDevelopment.md#user-defined-modules)
3129
* [Repository](doc/ModulesDevelopment.md#repository)
32-
* [Paths](doc/ModulesDevelopment.md#paths)
3330
* [Module creation](doc/ModulesDevelopment.md#module-creation)
3431
* [Test run](doc/ModulesDevelopment.md#test-run)
35-
* [Saving the QC objects in a local file](doc/ModulesDevelopment.md#saving-the-qc-objects-in-a-local-file)
3632
* [Modification of the Task](doc/ModulesDevelopment.md#modification-of-the-task)
3733
* [Check](doc/ModulesDevelopment.md#check)
3834
* [Configuration](doc/ModulesDevelopment.md#configuration)
@@ -49,95 +45,72 @@ For a general overview of our (O2) software, organization and processes, please
4945
* [DPL workflow](doc/ModulesDevelopment.md#dpl-workflow)
5046
* [Run number and other run attributes (period, pass type, provenance)](doc/ModulesDevelopment.md#run-number-and-other-run-attributes-period-pass-type-provenance)
5147
* [A more advanced example](doc/ModulesDevelopment.md#a-more-advanced-example)
52-
* [Monitoring](doc/ModulesDevelopment.md#monitoring)
48+
* [Framework](doc/Framework.md)
49+
* [Plugging the QC to an existing DPL workflow](doc/Framework.md#plugging-the-qc-to-an-existing-dpl-workflow)
50+
* [Production of QC objects outside this framework](doc/Framework.md#production-of-qc-objects-outside-this-framework)
51+
* [Multi-node setups](doc/Framework.md#multi-node-setups)
52+
* [Batch processing](doc/Framework.md#batch-processing)
53+
* [Moving window](doc/Framework.md#moving-window)
54+
* [Monitor cycles](doc/Framework.md#monitor-cycles)
55+
* [Custom merging](doc/Framework.md#custom-merging)
56+
* [Critical, resilient and non-critical tasks](doc/Framework.md#critical-resilient-and-non-critical-tasks)
57+
* [QC with DPL Analysis](doc/Framework.md#qc-with-dpl-analysis)
58+
* [Propagating Check results to RCT in Bookkeeping](doc/Framework.md#propagating-check-results-to-rct-in-bookkeeping)
59+
* [Solving performance issues](doc/Framework.md#solving-performance-issues)
60+
* [Understanding and reducing memory footprint](doc/Framework.md#understanding-and-reducing-memory-footprint)
61+
* [Monitoring](doc/Framework.md#monitoring)
5362
* [Post-processing](doc/PostProcessing.md)
54-
* [The post-processing framework](doc/PostProcessing.md#the-post-processing-framework)
55-
* [Post-processing interface](doc/PostProcessing.md#post-processing-interface)
56-
* [Configuration](doc/PostProcessing.md#configuration)
57-
* [Definition and access of user-specific configuration](doc/PostProcessing.md#definition-and-access-of-user-specific-configuration)
58-
* [Running it](doc/PostProcessing.md#running-it)
59-
* [Convenience classes](doc/PostProcessing.md#convenience-classes)
60-
* [The TrendingTask class](doc/PostProcessing.md#the-trendingtask-class)
61-
* [The SliceTrendingTask class](doc/PostProcessing.md#the-slicetrendingtask-class)
62-
* [The QualityTask class](doc/PostProcessing.md#the-qualitytask-class)
63-
* [The BigScreen class](doc/PostProcessing.md#the-bigscreen-class)
64-
* [More examples](doc/PostProcessing.md#more-examples)
65-
* [Advanced topics](doc/Advanced.md)
66-
* [Framework](doc/Advanced.md#framework)
67-
* [Plugging the QC to an existing DPL workflow](doc/Advanced.md#plugging-the-qc-to-an-existing-dpl-workflow)
68-
* [Production of QC objects outside this framework](doc/Advanced.md#production-of-qc-objects-outside-this-framework)
69-
* [Multi-node setups](doc/Advanced.md#multi-node-setups)
70-
* [Batch processing](doc/Advanced.md#batch-processing)
71-
* [Moving window](doc/Advanced.md#moving-window)
72-
* [Monitor cycles](doc/Advanced.md#monitor-cycles)
73-
* [Writing a DPL data producer](doc/Advanced.md#writing-a-dpl-data-producer)
74-
* [Custom merging](doc/Advanced.md#custom-merging)
75-
* [Critical, resilient and non-critical tasks](doc/Advanced.md#critical-resilient-and-non-critical-tasks)
76-
* [QC with DPL Analysis](doc/Advanced.md#qc-with-dpl-analysis)
77-
* [Uploading objects to QCDB](doc/Advanced.md#uploading-objects-to-qcdb)
78-
* [Propagating Check results to RCT in Bookkeeping](doc/Advanced.md#propagating-check-results-to-rct-in-bookkeeping)
79-
* [Conversion details](doc/Advanced.md#conversion-details)
80-
* [Solving performance issues](doc/Advanced.md#solving-performance-issues)
81-
* [Dispatcher](doc/Advanced.md#dispatcher)
82-
* [QC Tasks](doc/Advanced.md#qc-tasks-1)
83-
* [Mergers](doc/Advanced.md#mergers)
84-
* [Understanding and reducing memory footprint](doc/Advanced.md#understanding-and-reducing-memory-footprint)
85-
* [Analysing memory usage with valgrind](doc/Advanced.md#analysing-memory-usage-with-valgrind)
86-
* [CCDB / QCDB](doc/Advanced.md#ccdb--qcdb)
87-
* [Accessing objects in CCDB](doc/Advanced.md#accessing-objects-in-ccdb)
88-
* [Access GRP objects with GRP Geom Helper](doc/Advanced.md#access-grp-objects-with-grp-geom-helper)
89-
* [Global Tracking Data Request helper](doc/Advanced.md#global-tracking-data-request-helper)
90-
* [Custom metadata](doc/Advanced.md#custom-metadata)
91-
* [Details on the data storage format in the CCDB](doc/Advanced.md#details-on-the-data-storage-format-in-the-ccdb)
92-
* [Local CCDB setup](doc/Advanced.md#local-ccdb-setup)
93-
* [Instructions to move an object in the QCDB](doc/Advanced.md#instructions-to-move-an-object-in-the-qcdb)
94-
* [Asynchronous Data and Monte Carlo QC operations](doc/Advanced.md#asynchronous-data-and-monte-carlo-qc-operations)
95-
* [QCG](doc/Advanced.md#qcg)
96-
* [Display a non-standard ROOT object in QCG](doc/Advanced.md#display-a-non-standard-root-object-in-qcg)
97-
* [Canvas options](doc/Advanced.md#canvas-options)
98-
* [Local QCG (QC GUI) setup](doc/Advanced.md#local-qcg-qc-gui-setup)
99-
* [FLP Suite](doc/Advanced.md#flp-suite)
100-
* [Developing QC modules on a machine with FLP suite](doc/Advanced.md#developing-qc-modules-on-a-machine-with-flp-suite)
101-
* [Switch detector in the workflow <em>readout-dataflow</em>](doc/Advanced.md#switch-detector-in-the-workflow-readout-dataflow)
102-
* [Get all the task output to the infologger](doc/Advanced.md#get-all-the-task-output-to-the-infologger)
103-
* [Using a different config file with the general QC](doc/Advanced.md#using-a-different-config-file-with-the-general-qc)
104-
* [Enable the repo cleaner](doc/Advanced.md#enable-the-repo-cleaner)
105-
* [Configuration](doc/Advanced.md#configuration-1)
106-
* [Merging multiple configuration files into one](doc/Advanced.md#merging-multiple-configuration-files-into-one)
107-
* [Definition and access of simple user-defined task configuration ("taskParameters")](doc/Advanced.md#definition-and-access-of-simple-user-defined-task-configuration-taskparameters)
108-
* [Definition and access of user-defined configuration ("extendedTaskParameters")](doc/Advanced.md#definition-and-access-of-user-defined-configuration-extendedtaskparameters)
109-
* [Definition of new arguments](doc/Advanced.md#definition-of-new-arguments)
110-
* [Plugging the QC to an existing DPL workflow](#plugging-the-qc-to-an-existing-dpl-workflow)
111-
* [Production of QC objects outside this framework](#production-of-qc-objects-outside-this-framework)
112-
* [Multi-node setups](#multi-node-setups)
113-
* [Batch processing](#batch-processing)
114-
* [Moving window](#moving-window)
115-
* [Monitor cycles](#monitor-cycles)
116-
* [Writing a DPL data producer](#writing-a-dpl-data-producer)
117-
* [Custom merging](#custom-merging)
118-
* [Critical, resilient and non-critical tasks](#critical-resilient-and-non-critical-tasks)
119-
* [QC with DPL Analysis](#qc-with-dpl-analysis)
120-
* [Uploading objects to QCDB](#uploading-objects-to-qcdb)
121-
* [Propagating Check results to RCT in Bookkeeping](#propagating-check-results-to-rct-in-bookkeeping)
122-
* [Conversion details](#conversion-details)
123-
* [Solving performance issues](#solving-performance-issues)
124-
* [Dispatcher](#dispatcher)
125-
* [QC Tasks](#qc-tasks-1)
126-
* [Mergers](#mergers)
127-
* [Understanding and reducing memory footprint](#understanding-and-reducing-memory-footprint)
128-
* [Configuration](doc/Configuration.md)
129-
* [Global configuration structure](doc/Configuration.md#global-configuration-structure)
130-
* [Common configuration](doc/Configuration.md#common-configuration)
131-
* [QC Tasks configuration](doc/Configuration.md#qc-tasks-configuration)
132-
* [QC Checks configuration](doc/Configuration.md#qc-checks-configuration)
133-
* [QC Aggregators configuration](doc/Configuration.md#qc-aggregators-configuration)
134-
* [QC Post-processing configuration](doc/Configuration.md#qc-post-processing-configuration)
135-
* [External tasks configuration](doc/Configuration.md#external-tasks-configuration)
136-
* [Miscellaneous](doc/Advanced.md#miscellaneous)
137-
* [Data Sampling monitoring](doc/Advanced.md#data-sampling-monitoring)
138-
* [Monitoring metrics](doc/Advanced.md#monitoring-metrics)
139-
* [Common check IncreasingEntries](doc/Advanced.md#common-check-increasingentries)
140-
* [Update the shmem segment size of a detector](doc/Advanced.md#update-the-shmem-segment-size-of-a-detector)
63+
* [The post-processing framework](doc/PostProcessing#the-post-processing-framework)
64+
* [Post-processing interface](doc/PostProcessing#post-processing-interface)
65+
* [Configuration](doc/PostProcessing#configuration)
66+
* [Running it](doc/PostProcessing#running-it)
67+
* [Convenience classes](doc/PostProcessing#convenience-classes)
68+
* [The TrendingTask class](doc/PostProcessing#the-trendingtask-class)
69+
* [The SliceTrendingTask class](doc/PostProcessing#the-slicetrendingtask-class)
70+
* [The ReferenceComparatorTask class](doc/PostProcessing#the-referencecomparatortask-class)
71+
* [The CcdbInspectorTask class](doc/PostProcessing#the-ccdbinspectortask-class)
72+
* [The QualityTask class](doc/PostProcessing#the-qualitytask-class)
73+
* [The BigScreen class](doc/PostProcessing#the-bigscreen-class)
74+
* [More examples](#more-examples)
75+
* [Configuration reference](doc/Configuration.md)
76+
* [Global configuration structure](doc/Configuration.md#global-configuration-structure)
77+
* [Common configuration](doc/Configuration.md#common-configuration)
78+
* [QC Tasks configuration](doc/Configuration.md#qc-tasks-configuration)
79+
* [QC Checks configuration](doc/Configuration.md#qc-checks-configuration)
80+
* [QC Aggregators configuration](doc/Configuration.md#qc-aggregators-configuration)
81+
* [QC Post-processing configuration](doc/Configuration.md#qc-post-processing-configuration)
82+
* [External tasks configuration](doc/Configuration.md#external-tasks-configuration)
83+
* [Merging multiple configuration files into one](doc/Configuration.md#merging-multiple-configuration-files-into-one)
84+
* [Templating config files](doc/Configuration.md#templating-config-files)
85+
* [Definition and access of simple user-defined task configuration ("taskParameters")](doc/Configuration.md#definition-and-access-of-simple-user-defined-task-configuration-taskparameters)
86+
* [Definition and access of user-defined configuration ("extendedTaskParameters")](doc/Configuration.md#definition-and-access-of-user-defined-configuration-extendedtaskparameters)
87+
* [QCDB and CCDB](doc/QCDB.md)
88+
* [QCDB vs CCDB](doc/QCDB.md#qcdb-vs-ccdb)
89+
* [Details on the data storage format in the QCDB](doc/QCDB.md#details-on-the-data-storage-format-in-the-qcdb)
90+
* [Custom metadata for QC objects in the QCDB](doc/QCDB.md#custom-metadata-for-qc-objects-in-the-qcdb)
91+
* [Instructions to move an object in the QCDB](doc/QCDB.md#instructions-to-move-an-object-in-the-qcdb)
92+
* [Accessing objects in CCDB](doc/QCDB.md#accessing-objects-in-ccdb)
93+
* [Access GRP objects with GRP Geom Helper](doc/QCDB.md#access-grp-objects-with-grp-geom-helper)
94+
* [Global Tracking Data Request helper](doc/QCDB.md#global-tracking-data-request-helper)
95+
* [Local CCDB setup](doc/QCDB.md#local-ccdb-setup)
96+
* [FLP Suite](doc/FLPsuite.md)
97+
* [Developing QC modules on a machine with FLP suite](doc/FLPsuite.md#developing-qc-modules-on-a-machine-with-flp-suite)
98+
* [Switch detector in the workflow <em>readout-dataflow</em>](doc/FLPsuite.md#switch-detector-in-the-workflow-readout-dataflow)
99+
* [Get all the task output to the infologger](doc/FLPsuite.md#get-all-the-task-output-to-the-infologger)
100+
* [Using a different config file with the general QC](doc/FLPsuite.md#using-a-different-config-file-with-the-general-qc)
101+
* [Enable the repo cleaner](doc/FLPsuite.md#enable-the-repo-cleaner)
102+
* [Definition of new arguments](doc/FLPsuite.md#definition-of-new-arguments)
103+
* [Reference data](doc/FLPsuite.md#reference-data)
104+
* [Miscellaneous](doc/Miscellaneous.md)
105+
* [Asynchronous Data and Monte Carlo QC operations](doc/Miscellaneous.md#asynchronous-data-and-monte-carlo-qc-operations)
106+
* [QCG](doc/Miscellaneous.md#qcg)
107+
* [Data Sampling monitoring](doc/Miscellaneous.md#data-sampling-monitoring)
108+
* [Monitoring metrics](doc/Miscellaneous.md#monitoring-metrics)
109+
* [Common check IncreasingEntries](doc/Miscellaneous.md#common-check-increasingentries)
110+
* [Common check TrendCheck](doc/Miscellaneous.md#common-check-trendcheck)
111+
* [Update the shmem segment size of a detector](doc/Miscellaneous.md#update-the-shmem-segment-size-of-a-detector)
112+
* [Readout chain](doc/Miscellaneous.md#readout-chain)
113+
* [Writing a DPL data producer](doc/Miscellaneous.md#writing-a-dpl-data-producer)
141114

142115
### Where to get help
143116

doc/Configuration.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ Configuration reference
55
<!--TOC generated with https://github.com/ekalinin/github-markdown-toc-->
66
<!--./gh-md-toc --insert --no-backup --hide-footer QualityControl/doc/Configuration.md -->
77
<!--ts-->
8-
* [Configuration reference](#configuration-reference)
98
* [Global configuration structure](#global-configuration-structure)
109
* [Common configuration](#common-configuration)
1110
* [QC Tasks configuration](#qc-tasks-configuration)

doc/FAQ.md

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@
1515
* [Run](#run)
1616
* [Why are my QC processes using 100% CPU ?](#why-are-my-qc-processes-using-100-cpu-)
1717
* [QCDB](#qcdb)
18-
* [How to see which objects are stored in the CCDB ?](#how-to-see-which-objects-are-stored-in-the-ccdb-)
19-
* [How to delete objects from the CCDB ?](#how-to-delete-objects-from-the-ccdb-)
18+
* [How to see which objects are stored in the QCDB ?](#how-to-see-which-objects-are-stored-in-the-ccdb-)
2019
* [My objects are not stored due to their size. What can I do ?](#my-objects-are-not-stored-due-to-their-size-what-can-i-do-)
2120
<!--te-->
2221

@@ -72,38 +71,12 @@ There are more options in the "Advanced" section of this guide.
7271

7372
## QCDB
7473

75-
### How to see which objects are stored in the CCDB ?
74+
### How to see which objects are stored in the QCDB ?
7675

7776
The easiest is to use the QCG (QC GUI). If you use the central test CCDB, you can use the central test QCG. Simply direct your browser to [https://qcg-test.cern.ch](https://qcg-test.cern.ch).
7877

7978
If for some reason you don't want or can't use the QCG, the CCDB provides a web interface accessible at [http://ccdb-test.cern.ch:8080/browse/](http://ccdb-test.cern.ch:8080/browse/).
8079

81-
### How to delete objects from the CCDB ?
82-
83-
#### The nuclear option
84-
85-
By accessing `http://ccdb-test.cern.ch:8080/truncate/path/to/folder/.*` you will delete all the objects at the given path. Careful with that please ! Don't delete data of others.<br/>In production it will of course not be possible to do so.
86-
87-
#### A set of run exported from the logbook
88-
89-
Use `o2-qc-repo-delete-objects-in-runs`. The `--help` will tell you all you need to know about this tool.
90-
`--print-list` is very useful to see what will be deleted.
91-
92-
Here is an example:
93-
```
94-
o2-qc-repo-delete-objects-in-runs --url http://localhost:8083 --path qc/EMC/.* --runs-csv-file /tmp/runs_standalone_bad_LHC22m.csv
95-
```
96-
97-
#### By time period
98-
99-
Use `o2-qc-repo-delete-time-interval`. The `--help` will tell you all you need to know about this tool.
100-
`--print-list` is very useful to see what will be deleted.
101-
102-
Here is an example:
103-
```
104-
o2-qc-repo-delete-time-interval --url http://localhost:8083 --path qc_async/EMC/MO/AsyncTrend --from 0 --to 1654706422910
105-
```
106-
10780
### My objects are not stored due to their size. What can I do ?
10881

10982
You see warnings in the logs:

doc/Framework.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ Framework
55
<!--TOC generated with https://github.com/ekalinin/github-markdown-toc-->
66
<!--./gh-md-toc --insert --no-backup --hide-footer --indent 3 QualityControl/doc/Advanced.md -->
77
<!--ts-->
8-
* [Framework](#framework)
98
* [Plugging the QC to an existing DPL workflow](#plugging-the-qc-to-an-existing-dpl-workflow)
109
* [Production of QC objects outside this framework](#production-of-qc-objects-outside-this-framework)
1110
* [Multi-node setups](#multi-node-setups)
@@ -750,4 +749,4 @@ is setup, one can update the monitoring url in the config file to point to it.
750749

751750
---
752751

753-
[← Go back to Post-Processing](PostProcessing.md) | [↑ Go to the Table of Content ↑](../README.md) | [Continue to Configuration →](Configuration.md)
752+
[← Go back to Modules development](ModulesDevelopment.md) | [↑ Go to the Table of Content ↑](../README.md) | [Continue to Configuration →](Configuration.md)

0 commit comments

Comments
 (0)