Skip to content

Add link to LIKWID installation #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/en/docs/tutorials/prod-cc-backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -418,7 +418,9 @@ Here is an example:
Since it is tedious to write this by hand, we provide a
[Perl script](https://github.com/ClusterCockpit/cc-backend/blob/master/configs/generate-subcluster.pl)
as part of `cc-backend` that generates a subCluster template. This script only
works if the `LIKWID` tools are installed and in the PATH.
works if the `LIKWID` tools are installed and in the PATH. You also need the
`LIKWID` library for cc-metric-store. You find instructions on how to install
`LIKWID` [here](https://github.com/RRZE-HPC/likwid/wiki/Build).

The resource ID for cores is the OS processor ID. For GPUs we recommend to use
the PCI-E address as resource ID.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion content/en/docs/webinterface/views/analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
Metric Data Analysis View
categories: [cc-backend]
tags: [Frontend, Support, Admin]
weight: 14
weight: 15
---

{{< figure src="../../figures/analysis.png" alt="Analysis View" width="100%" class="ccfigure mw-xl"
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/webinterface/views/job.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
Detailed Single Job Information View
categories: [cc-backend]
tags: [Frontend, User, Manager, Support, Admin]
weight: 4
weight: 5
---

{{< figure src="../../figures/jobview.png" alt="Job View" width="100%" class="ccfigure mw-xl"
Expand Down
80 changes: 80 additions & 0 deletions content/en/docs/webinterface/views/jobcompare.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: Job Comparison
description: >
Compare Job Metric Statistics
categories: [cc-backend]
tags: [Frontend, User, Manager, Support, Admin]
weight: 4
---

{{< figure src="../../figures/compare_list.png" alt="Job List With Compare Switch" width="100%" class="ccfigure mw-xl"
caption="Job list with compare switch. In this example, filters return 145 jobs, while no job is selected manually."
>}}

Accessible from the job list primary view, the job compare view allows for the comparison of metric statistics in a pseudo-time-dependent manner.

The "Compare Jobs" button is located in the upper right corner of the job list view. Jobs for comparison are either selected by

1) ... a combination of filters resulting in a dataset of _500 jobs or less_.
2) ... manual job selection by checking the box in the job info card.

If too many jobs are returned by the current filter selection, the button will be disabled.

If jobs are directly selected from the current job list, the button will display the current count, as well as an additional "Reset" button, which will empty the list of selected jobs, if pressed.

Manual job selection will also work if the current job list has more than 500 returned jobs, while the subsequent job compare view will ignore all additional filters, and only show selected jobs. Returning to the job list also returns with the last used filters.

{{< alert >}}This allows manual job selection between pages, but also manual job selection between different filter combinations!{{< /alert >}}

## Fixed Compare Elements

{{< figure src="../../figures/compare_top.png" alt="Job Compare Options and Resource Compare" width="100%" class="ccfigure mw-xl"
caption="Job compare view top elements. The count of 145 jobs remains after switching to this view. The resource plot shows jobs sorted by their startTime, and all jobs have allocated accelerators (red data line)."
>}}

The compare view features a reduced header:

* Sorting is disabled, as jobs are _always_ sorted by `startTime` in ascending order.
* The filter component is removed and only shows the total number of compared jobs.
* The refresh component is also removed.

The "Metric Selection" is active and can be used to add additional metric comparison plots to the view, if desired.

"Return to List" closes the compare view and restores the former job list view.

The "Resource Compare" plot is always shown at the first position. It features a semi-logarithmic view of allocated job resources in a pseudeo-time-dependent manner, as all jobs are sorted by actual start time. The data is colored as follows:

* Black: Nodes - will always be at least `1` (Note: Also for shared jobs!)
* Blue: Hardware Threads ( ~ Cores)
* Red: Accelerators - Can be zero! If so, no line is rendered.

The legend includes further information, such as:

* Job-ID
* Cluster (and subCluster) on which the job ran
* Runtimeof the job

## Selectable Compare Elements

{{< figure src="../../figures/compare_down.png" alt="Job Compare Metric Plot and Table" width="100%" class="ccfigure mw-xl"
caption="Job compare view metric plot and table. 'Clock' metric statistics are plotted for every job sorted by their startTime. All information is also shown as sortable table at the bottom of the compare view."
>}}

Below the resource compare plot, the individual metric compare plots are rendered. For each job, the `Min/Max/Avg` of the respective metric is plotted in a banded manner.

Zooming is possible, and will be synchronized to all other rendered plots, including the resource comparison.

{{< alert >}}**Please Note:** Due to spacing reasons, not all jobIDs can be rendered as tick-marks if the total count of compared jobs is high!{{< /alert >}}

Below the plots, all information is again rendered as a single table consisting of the following columns:

* JobID
* Start Time
* Duration
* Cluster
* Resources (Nodes, Threads , Accs)
* For each Metric: Minimum, Maximum, Average

It is possible to filter for specific jobIDs or parts thereof, all other columns are sortable.

Clicking on a JobID will lead to the respective [Job View]({{< ref "job" >}} "Job View").
2 changes: 1 addition & 1 deletion content/en/docs/webinterface/views/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
All Metrics of One Selected Node
categories: [cc-backend]
tags: [Frontend, Admin]
weight: 13
weight: 14
---

{{< figure src="../../figures/nodeview.png" alt="Node View" width="100%" class="ccfigure mw-xl"
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/webinterface/views/nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
Node Based Metric Information of one Cluster
categories: [cc-backend]
tags: [Frontend, Admin]
weight: 12
weight: 13
---

## Node Overview
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/webinterface/views/projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
Table of All Projects Running Jobs on the Clusters
categories: [cc-backend]
tags: [Frontend, Support, Admin]
weight: 8
weight: 9
---

{{< figure src="../../figures/projecttable.png" alt="User Table" width="100%" class="ccfigure mw-lg"
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/webinterface/views/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
Hardware Usage Information
categories: [cc-backend]
tags: [Frontend, Admin]
weight: 16
weight: 17
---

The status view is always called in respect to one specified cluster. It displays the current state of utilization of the respective clusters resources, as well as user and project top lists and distribution histograms of the allocated resources per job.
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/webinterface/views/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
Lists Active Tags Used in the Frontend
categories: [cc-backend]
tags: [Frontend, User, Manager, Support, Admin]
weight: 10
weight: 11
---

{{< figure src="../../figures/tags.png" alt="Tag List View" width="100%" class="ccfigure mw-md">}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/webinterface/views/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: >
Table of All Users Running Jobs on the Clusters
categories: [cc-backend]
tags: [Frontend, Manager, Support, Admin]
weight: 6
weight: 7
---

{{< figure src="../../figures/usertable.png" alt="User Table" width="100%" class="ccfigure mw-lg"
Expand Down