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

[ENH] - Add JupyterHub specific Grafana pre-configured dashboards #1481

Open
Tracked by #1309
iameskild opened this issue Oct 5, 2022 · 6 comments
Open
Tracked by #1309

[ENH] - Add JupyterHub specific Grafana pre-configured dashboards #1481

iameskild opened this issue Oct 5, 2022 · 6 comments

Comments

@iameskild
Copy link
Member

iameskild commented Oct 5, 2022

Feature description

It would be great to have these monitoring dashboard already pre-configured:
https://github.com/jupyterhub/grafana-dashboards

Value and/or benefit

Although there are existing monitoring dashboards, these would make the first experience with monitoring potentially worthwhile and gives an idea of what is possible.

Anything else?

Add to Nebari Docs - Grafana 101

@Adam-D-Lewis
Copy link
Member

Adam-D-Lewis commented Apr 7, 2023

I'm working on this. Some dashboards in the latest version of the jupyterhub dashboard repo (https://github.com/jupyterhub/grafana-dashboards/tree/803ffa9b458fa325946de90eee288b065de46bc9) won't work until we upgrade jupyterhub to 3.1+(https://jupyterhub.readthedocs.io/en/3.0.0/reference/metrics.html)

@Adam-D-Lewis
Copy link
Member

So I had to manually render the dashboards, the process was:

def deploy_dashboard(dashboard_path, folder_uid, api, global_dash=False):
    db = build_dashboard(dashboard_path, api, global_dash)

    if not db:
        return

    db = layout_dashboard(db)
    db = populate_template_variables(api, db)

    data = {
        'dashboard': db,
        'folderId': folder_uid,
        'overwrite': True
    }
    import json
    with open(f"rendered/{db['title'].lower().replace(' ','_')}.json", 'w') as f:
        f.write(json.dumps(db, indent=4))
    # breakpoint()
    # api('/dashboards/db', data)
  • run modified deploy.py from the cloned repo

@Adam-D-Lewis
Copy link
Member

Some of the dashboards don't work on nebari bc we are on a old version of jupyterhub, some of the pods have different labels, etc. so we need to figure out how we want handle it. Fork the repo? Something else?

@Adam-D-Lewis Adam-D-Lewis moved this from Planned 💾 to In progress 🏗 in 🪴 Nebari Project Management Apr 11, 2023
@Adam-D-Lewis
Copy link
Member

Okay, I just rendered the dashboards locally and then made modifications as needed so they would work with Nebari. I deleted an NFS dashboard that showed how much disk space Jupyterhub users were using b/c I think it would require rewriting the whole thing, but that would be useful information to add eventually. I also deleted a dashboard that showed all the memory and compute requests/limits by each JHub user for the same reason, but again it may be nice to add at some point.

@Adam-D-Lewis Adam-D-Lewis mentioned this issue Apr 11, 2023
10 tasks
@Adam-D-Lewis
Copy link
Member

@github-project-automation github-project-automation bot moved this from In progress 🏗 to Done 💪🏾 in 🪴 Nebari Project Management Apr 14, 2023
@pavithraes
Copy link
Member

pavithraes commented Mar 5, 2024

I'm working on this. Some dashboards in the latest version of the jupyterhub dashboard repo (jupyterhub/grafana-dashboards@803ffa9) won't work until we upgrade jupyterhub to 3.1+(jupyterhub.readthedocs.io/en/3.0.0/reference/metrics.html)

Re-opeining - we now have jupyterhub to 3.1+, so it's worth revisiting https://jupyterhub.readthedocs.io/en/3.0.0/reference/metrics.html

@pavithraes pavithraes reopened this Mar 5, 2024
@github-project-automation github-project-automation bot moved this from Done 💪🏾 to In progress 🏗 in 🪴 Nebari Project Management Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In progress 🏗
Development

Successfully merging a pull request may close this issue.

4 participants