CPU and Max RSS Analysis tools by ChrisPaulBennett · Pull Request #675 · cylc/cylc-uiserver

ChrisPaulBennett · 2025-03-12T09:14:27Z

This apart of 3 pull requests for adding CPU time and Max RSS analysis to the Cylc UI.

This adds the Max RSS and CPU time (as measured by cgroups) to the table view, box plot and time series views.

Linked to;
cylc/cylc-flow#6663
cylc/cylc-ui#2100

Check List

I have read CONTRIBUTING.md and added my name as a Code Contributor.
Contains logically grouped changes (else tidy your branch by rebase).
Does not contain off-topic changes (use other PRs for other changes).
Applied any dependency changes to both setup.cfg (and conda-environment.yml if present).
Tests are included (or explain why tests are not needed).
Changelog entry included if this is a change that can affect users
Cylc-Doc pull request opened if required at cylc/cylc-doc/pull/XXXX.
If this is a bug fix, PR should be raised against the relevant ?.?.x branch.

cylc/uiserver/schema.py

ChrisPaulBennett · 2025-04-15T07:48:58Z

I've merged in the previous changes to the SQL infrastructure that deals with task states. @oliver-sanders I've had to change some of your code that creates parts of the SQL query, mostly just to take into account the new join.
The codecov failures are from code that I haven't touched.

cylc/uiserver/schema.py

MetRonnie

These changes appear to have broken compatibility with workflows run in earlier versions of Cylc. I tested the tasks GraphQL query on a workflow that ran in 8.4.4.dev and got an empty result

query {
  tasks(live: false, workflows: ["wflow"]) {
    name
  }
}

{
  "data": {
    "tasks": []
  }
}

ChrisPaulBennett · 2025-07-18T10:10:43Z

This been fixed. Max RSS and CPU time will be 0, if no data is present. An update to the cylc-ui needs to be made to not show cpu time / max rss charts if there is no data

MetRonnie · 2025-08-12T15:01:53Z

This been fixed. Max RSS and CPU time will be 0, if no data is present. An update to the cylc-ui needs to be made to not show cpu time / max rss charts if there is no data

Is there a way to make this null instead of 0? Because currently the UI can't tell the difference between no data and times that are actually zero (to the nearest whole second).

ChrisPaulBennett · 2025-10-20T13:35:28Z

This been fixed. Max RSS and CPU time will be 0, if no data is present. An update to the cylc-ui needs to be made to not show cpu time / max rss charts if there is no data

Is there a way to make this null instead of 0? Because currently the UI can't tell the difference between no data and times that are actually zero (to the nearest whole second).

This has been fixed in the UI repo

wxtim · 2026-01-27T09:52:33Z

cylc/uiserver/tests/test_workflow_retrieval.py

+            task_events(
+                cycle TEXT, 
+                name TEXT, 
+                submit_num INTEGER,


I think that this order is wrong - time comes before submit number in the table. I'm going to push a PR which breaks one of these tests, but should make this setup safer by building the db using data from cylc-flow. This will make these tests more fragile in a desirable way.

ChrisPaulBennett#6

Apparently you have discussed this with Oliver and agreed that the hardcoded approach allows us to ensure back compat (legit). However I still think that the table order is wrong.

cylc/uiserver/tests/test_workflow_retrieval.py

wxtim · 2026-01-28T08:50:34Z

cylc/uiserver/tests/test_workflow_retrieval.py

-            'User',
-            'UsersJob',
-        ),
+        task_entries=[


You've used this chunk of database twice - I've pulled it out and turned it into a "module" scope pytest fixture to save on creating two databases in ChrisPaulBennett#6.

Also about 150 lines of code less.

wxtim · 2026-01-28T09:13:57Z

cylc/uiserver/tests/test_workflow_retrieval.py

    return conn


 def test_make_task_query_1():


I have proposed docstrings in my ChrisPaulBennett#6

* Simplify SQL where possible. * Only retrieve and process profiler fields when requested for the jobs query.

oliver-sanders

Tested this end-to-end and can confirm it is working as intended.

I have a couple of suggestions to simply things:

Switch the message format from string to JSON.
- SQL/Sqlite has JSON functionality which makes pulling multiple messages out of a single field easier.
- This removes the need for many of the INSTR and SUBSTR operators.
- This also removes the need for the CAST operators.
Only retrieve/process these new fields when they were requested.
- The jobs query is used for other things in the GUI.
- The tasks query isn't yet, but will be one day.
- To reduce the overhead added with this PR, we aught to avoid doing any heavy lifting when it isn't necessary.

I have implemented these suggestions in:

See what you think.

oliver-sanders · 2026-01-13T15:45:43Z

cylc/uiserver/schema.py

+WITH data AS (
+    SELECT
+        tj.*,
+        CAST(
+            SUBSTR(


The jobs query is used for more than just the Analysis views.

The Log view uses this query to retrieve the job's status in order to work out which log file to display.

Ideally, we wouldn't want to get SQL running around doing all of this maths unless the result is actually required.

Note, I think the requested fields are available as field_ids (see get_elements above in the call chain).

oliver-sanders · 2026-01-13T16:24:12Z

cylc/uiserver/schema.py

+        CAST(
+            SUBSTR(
+                te.message,
+                INSTR(te.message, 'max_rss ') + 9,
+                INSTR(te.message, ' mem_alloc') -
+                (INSTR(te.message, 'max_rss ') + 9)
+            ) AS INT
+        ) AS max_rss,


An alternative to this string processing would be JSON processing.

E.G, messages would look like profiler:{"max_rss": 1234, "mem_alloc": 2345, "cpu_time": 3456} with no constraint on field order.

The query would look like:

SELECT j.name j.cycle j.run_status JSON_EXTRACT(SUBSTR(e.message, 8), '$/cpu_time') cpu_time JSON_EXTRACT(SUBSTR(e.message, 8), '$/max_rss') max_rss JSON_EXTRACT(SUBSTR(e.message, 8), '$/mem_alloc') mem_alloc FROM task_jobs j LEFT JOIN task_events e ON j.name = e.name AND ... AND e.message LIKE 'profiler:%'

This would remove the need for the CAST and INSTR logic.

I think it would also remove the need for the WITH data AS part. Hopefully that would make it easier to turn the LEFT JOIN on/off depending on whether we require the additional values or not.

Have implemented: ChrisPaulBennett/cylc-flow#2, ChrisPaulBennett#7

cylc/uiserver/schema.py

ChrisPaulBennett marked this pull request as draft March 12, 2025 09:19

oliver-sanders reviewed Mar 12, 2025

View reviewed changes

cylc/uiserver/schema.py Outdated Show resolved Hide resolved

This was referenced Mar 13, 2025

CPU and Max RSS Analysis tools cylc/cylc-flow#6663

Open

CPU and Max RSS Analysis tools cylc/cylc-ui#2100

Open

ChrisPaulBennett marked this pull request as ready for review April 2, 2025 14:15

This comment was marked as resolved.

Sign in to view

ChrisPaulBennett requested a review from oliver-sanders April 15, 2025 07:49

This comment was marked as resolved.

Sign in to view

MetRonnie reviewed May 27, 2025

View reviewed changes

cylc/uiserver/schema.py Outdated Show resolved Hide resolved

cylc/uiserver/schema.py Outdated Show resolved Hide resolved

cylc/uiserver/schema.py Outdated Show resolved Hide resolved

MetRonnie reviewed Jul 14, 2025

View reviewed changes

cylc/uiserver/schema.py Outdated Show resolved Hide resolved

cylc/uiserver/schema.py Outdated Show resolved Hide resolved

cylc/uiserver/schema.py Outdated Show resolved Hide resolved

MetRonnie reviewed Jul 14, 2025

View reviewed changes

ChrisPaulBennett self-assigned this Jul 18, 2025

MetRonnie added this to the 1.8.0 milestone Aug 4, 2025

oliver-sanders modified the milestones: 1.8.0, 1.9.0 Sep 17, 2025

This comment was marked as resolved.

Sign in to view

ChrisPaulBennett force-pushed the memory_view branch from e14ad5c to 83dbbd6 Compare December 5, 2025 09:18

CPU/Memory Logging working

0d31a9f

ChrisPaulBennett force-pushed the memory_view branch from 83dbbd6 to 0d31a9f Compare December 5, 2025 09:19

Updated unit tests

75b3ce1

ChrisPaulBennett requested a review from MetRonnie December 30, 2025 15:33

oliver-sanders requested review from wxtim and removed request for MetRonnie January 13, 2026 15:38

wxtim reviewed Jan 27, 2026

View reviewed changes

wxtim reviewed Jan 28, 2026

View reviewed changes

cylc/uiserver/tests/test_workflow_retrieval.py Show resolved Hide resolved

wxtim reviewed Jan 28, 2026

View reviewed changes

cylc/uiserver/tests/test_workflow_retrieval.py Show resolved Hide resolved

wxtim reviewed Jan 28, 2026

View reviewed changes

cylc/uiserver/tests/test_workflow_retrieval.py Show resolved Hide resolved

wxtim reviewed Jan 28, 2026

View reviewed changes

profiler: change message format from string to JSON

b6c0dab

* Simplify SQL where possible. * Only retrieve and process profiler fields when requested for the jobs query.

oliver-sanders reviewed Feb 4, 2026

View reviewed changes

added row factory

9b2e5b8

ChrisPaulBennett force-pushed the memory_view branch from e30b993 to 9b2e5b8 Compare February 23, 2026 16:43

ChrisPaulBennett added 2 commits February 25, 2026 11:35

Merge remote-tracking branch 'Oliver/cylc_profiler' into memory_view

c8de253

Fixed unit test DB creation order

d3fd2f1

Conversation

ChrisPaulBennett commented Mar 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

This comment was marked as resolved.

ChrisPaulBennett commented Apr 15, 2025

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MetRonnie left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChrisPaulBennett commented Jul 18, 2025

Uh oh!

MetRonnie commented Aug 12, 2025

Uh oh!

ChrisPaulBennett commented Oct 20, 2025

Uh oh!

This comment was marked as resolved.

wxtim Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wxtim Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

wxtim Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wxtim Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

oliver-sanders left a comment

Choose a reason for hiding this comment

Uh oh!

oliver-sanders Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

oliver-sanders Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ChrisPaulBennett commented Mar 12, 2025 •

edited

Loading

MetRonnie left a comment •

edited

Loading

wxtim Jan 27, 2026 •

edited

Loading

wxtim Jan 28, 2026 •

edited

Loading

oliver-sanders Jan 13, 2026 •

edited

Loading