Skip to content
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

Remove default dashboard plots #198

Closed
ian-r-rose opened this issue Jun 24, 2021 · 3 comments · Fixed by #200
Closed

Remove default dashboard plots #198

ian-r-rose opened this issue Jun 24, 2021 · 3 comments · Fixed by #200

Comments

@ian-r-rose
Copy link
Collaborator

This extension gets its list of dask dashboard plots by querying the dashboard's individual-plots.json endpoint. These are then shown to the user as the orange buttons in the extension side bar. If, however, that request to individual-plots.json fails, we show a default listing, given by this:

export const DEFAULT_ITEMS = [
{ route: 'individual-task-stream', label: 'Task Stream' },
{ route: 'individual-progress', label: 'Progress' },
{ route: 'individual-workers', label: 'Workers' },
{ route: 'individual-nbytes', label: 'Memory (worker)' },
{ route: 'individual-cpu', label: 'CPU (workers)' },
{ route: 'statics/individual-cluster-map.html', label: 'Cluster Map' },
{ route: 'individual-graph', label: 'Graph' },
{ route: 'individual-nprocessing', label: 'Processing Tasks' },
{
route: 'individual-compute-time-per-key',
label: 'Compute Time (operation)'
},
{ route: 'individual-memory-by-key', label: 'Memory (operation)' },
{ route: 'individual-profile', label: 'Profile' },
{ route: 'individual-profile-server', label: 'Profile Server' },
{ route: 'individual-bandwidth-workers', label: 'Bandwidth (workers)' },
{ route: 'individual-bandwidth-types', label: 'Bandwidth (type)' },
{
route: 'individual-aggregate-time-per-action',
label: 'Compute/Transfer'
},
{ route: 'individual-gpu-memory', label: 'GPU Memory' },
{ route: 'individual-gpu-utilization', label: 'GPU Utilization' }
];
}

Historically, these default items were useful because we were checking for the individual-plots.json from the browser side. This request could fail for a valid dashboard URL (often for CORS-related reasons), and having the fallback meant that we could still iframe useful plots for the user. However, since #159 we are checking for individual-plots.json on the server side, which is not subject to the same restrictions as the browser. So as it stands today, the default items are mostly (only?) used to show the greyed out buttons when no dask dashboard is connected.

As the dask dashboard evolves, gains new plots, renames things, etc, it has become annoying to keep the default listing up-to-date. Furthermore, different scheduler plugins or distributions of dask could add different dashboards. So there really isn't much guarantee that the default listing is particularly accurate. We should consider removing them entirely, and just show something like a "No dashboard connected" info box.

Would anybody miss the grey buttons?

@jrbourbeau
Copy link
Member

I wouldn't miss the greyed out buttons. Additionally, as you already mentioned, it would make renaming plots (xref dask/distributed#4878) easier

@jacobtomlinson
Copy link
Member

Agree I wouldn't miss the greyed out buttons.

@jacobtomlinson
Copy link
Member

Once this is done we should also remove this backward compatibility in distributed.

https://github.com/dask/distributed/blob/97f10b196c2fc6f68aeb8858c4733267b12eafb6/distributed/dashboard/scheduler.py#L67-L71

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants