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

update readme with new dashboard usage struct #31

Merged
merged 1 commit into from
Nov 29, 2024
Merged
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
36 changes: 30 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,26 @@ The tool provides an API endpoint, `/api/v1/metrics`, which returns the usage da
"node_cpu_seconds_total": {
"usage": {
"dashboards": [
"https://demo.perses.dev/api/v1/projects/myinsight/dashboards/first_demo",
"https://demo.perses.dev/api/v1/projects/myworkshopproject/dashboards/myfirstdashboard",
"https://demo.perses.dev/api/v1/projects/perses/dashboards/nodeexporterfull",
"https://demo.perses.dev/api/v1/projects/showcase/dashboards/statchartpanel"
{
"id": "myinsight/first_demo",
"name": "first_demo",
"url": "https://demo.perses.dev/api/v1/projects/myinsight/dashboards/first_demo"
},
{
"id": "myworkshopproject/myfirstdashboard",
"name": "myfirstdashboard",
"url": "https://demo.perses.dev/api/v1/projects/myworkshopproject/dashboards/myfirstdashboard"
},
{
"id": "perses/nodeexporterfull",
"name": "nodeexporterfull",
"url": "https://demo.perses.dev/api/v1/projects/perses/dashboards/nodeexporterfull"
},
{
"id": "showcase/statchartpanel",
"name": "statchartpanel",
"url": "https://demo.perses.dev/api/v1/projects/showcase/dashboards/statchartpanel"
}
],
"recordingRules": [
{
Expand Down Expand Up @@ -70,7 +86,11 @@ The tool provides an API endpoint, `/api/v1/metrics`, which returns the usage da
"node_disk_discard_time_seconds_total": {
"usage": {
"dashboards": [
"https://demo.perses.dev/api/v1/projects/perses/dashboards/nodeexporterfull"
{
"id": "perses/nodeexporterfull",
"name": "nodeexporterfull",
"url": "https://demo.perses.dev/api/v1/projects/perses/dashboards/nodeexporterfull"
}
]
}
}
Expand Down Expand Up @@ -104,7 +124,11 @@ The API endpoint `/api/v1/partial_metrics` is exposing the usage for metrics tha
"node_cpu_utilization_${instance}": {
"usage": {
"dashboards": [
"https://demo.perses.dev/api/v1/projects/perses/dashboards/nodeexporterfull"
{
"id": "perses/nodeexporterfull",
"name": "nodeexporterfull",
"url": "https://demo.perses.dev/api/v1/projects/perses/dashboards/nodeexporterfull"
}
]
}
}
Expand Down