docs(grafana): add gpuWorkloadHistory deep-link endpoint (#824)#103
Open
SekiXu wants to merge 1 commit into
Open
docs(grafana): add gpuWorkloadHistory deep-link endpoint (#824)#103SekiXu wants to merge 1 commit into
SekiXu wants to merge 1 commit into
Conversation
Document GET /api/v1/datacenters/{dataCenter}/grafana/gpuWorkloadHistory/{hostname}
returning the device dashboard (UID i-device) deep-links for GPU
Utilization (panel 50) and VRAM (panel 51), filtered by var-GPU_HOST.
Adds the GetGpuWorkloadHistoryLinksResponse schema.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
Docs — OpenAPI spec (document a new endpoint).
Which issue(s) this PR fixes?
Backend track of bigstack-oss/cubecos#824 and bigstack-oss/cubecos#825. Documents the endpoint implemented in cube-cos-api (companion PR on branch
feat/824-gpu-workload-history-backend).What this PR does?
Adds the OpenAPI definition for
GET /api/v1/datacenters/{dataCenter}/grafana/gpuWorkloadHistory/{hostname}, which returns the Device dashboard (UIDi-device) deep-links for a physical node's GPU Utilization (panel 50) and VRAM (panel 51)./api/v1/datacenters/{dataCenter}/grafana/gpuWorkloadHistory/{hostname}(tagGrafana, operationIdgetGrafanaGpuWorkloadHistory), mirroring the existing/grafana/hosts/{hostname}entry.GetGpuWorkloadHistoryLinksResponsewithdata: { gpuUtilizationUrl, vramUrl, enabled }.Example
200response:{ "code": 200, "data": { "gpuUtilizationUrl": "http://example-data-center/grafana/d/i-device/device?orgId=1&var-GPU_HOST=example-node-0&from=now-3h&to=now&viewPanel=50", "vramUrl": "http://example-data-center/grafana/d/i-device/device?orgId=1&var-GPU_HOST=example-node-0&from=now-3h&to=now&viewPanel=51", "enabled": true }, "msg": "fetch gpu workload history links successfully", "status": "ok" }Test results (optional)
yq -o=json -I=4 docs.yamlconverts cleanly (validated in the cube-cos-api build container);task generateApiDocsregeneratesdocs.jsonwith the new endpoint present.sky150(companion cube-cos-api PR): valid node → both URLs +enabled:true; non-existent hostname →enabled:false.🤖 Generated with Claude Code