NVIDIA-NeMo / NVIDIA-NeMo/Curator

xenna_grafana_dashboard.json missing from the wheel — Xenna Grafana dashboard is never provisioned

Open Beginner friendly
#2,189 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

community-request waiting-on-customer
Dominant language
Python
Stars
1.8k
Forks
327
Avg merge
4d 5h
Merged PRs (30d)
30

Description

Summary

nemo_curator/metrics/xenna_grafana_dashboard.json exists in the git tree but is not included in the published wheel, so launch_grafana's dashboard copy silently skips and wheel users never get the Xenna dashboard in Grafana.

Reproduction (nemo-curator 1.2.0)

$ pip install nemo-curator
$ ls .venv/lib/python3.12/site-packages/nemo_curator/metrics/
__init__.py  constants.py  start_prometheus_grafana.py  utils.py

The json (and the module README) are absent. In nemo_curator/metrics/utils.py the copy is guarded:

xenna_dashboard_src = os.path.join(os.path.dirname(__file__), "xenna_grafana_dashboard.json")
...
if os.path.isfile(xenna_dashboard_src) and not os.path.isfile(xenna_dashboard_dst):
    shutil.copy(xenna_dashboard_src, xenna_dashboard_dst)

so the missing file skips silently: start_prometheus_grafana provisions the four auto-generated Ray dashboards but never the Xenna one.

Expected

The Xenna dashboard json ships in the wheel (package data), so monitoring set up per the metrics README includes the Xenna dashboard.

Suggested fix

Include nemo_curator/metrics/*.json as package data in the build configuration; optionally log a warning instead of skipping silently when the source json is missing.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect the build configuration alongside nemo_curator/metrics/xenna_grafana_dashboard.json and nemo_curator/metrics/utils.py, then review the launch_grafana entry point. Build or install a wheel using the reproduction steps and verify that the Xenna JSON is present under nemo_curator/metrics and that dashboard provisioning can find it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.