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.

Sign up for GitHub

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

feat: adding panel descriptions in all dashboards #2878

Merged
merged 1 commit into from
May 7, 2024
Merged

feat: adding panel descriptions in all dashboards #2878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 16 additions & 11 deletions cmd/tools/grafana/dashboard_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1464,17 +1464,19 @@ func checkDescription(t *testing.T, path string, data []byte, count *int) {
ignoreList := []string{
// These are from fsa
"Volume Access ($Activity) History", "Volume Access ($Activity) History By Percent", "Volume Modify ($Activity) History", "Volume Modify ($Activity) History By Percent",
// These are from snapmirror
"Destination Relationships per Node", "Source Relationships per SVM", "Destination Relationships per SVM",
// This is from workload
"Service Latency by Resources",
// These are from svm
"NFSv3 Latency Heatmap", "NFSv3 Read Latency Heatmap", "NFSv3 Write Latency Heatmap",
"NFSv4 Latency Heatmap", "NFSv4 Read Latency Heatmap", "NFSv4 Write Latency Heatmap",
"NFSv4.1 Latency Heatmap", "NFSv4.1 Read Latency Heatmap", "NFSv4.1 Write Latency Heatmap",
"NFSv3 Latency Heatmap", "NFSv3 Read Latency Heatmap", "NFSv3 Write Latency Heatmap", "NFSv3 Latency by Op Type", "NFSv3 IOPs per Type",
"NFSv4 Latency Heatmap", "NFSv4 Read Latency Heatmap", "NFSv4 Write Latency Heatmap", "NFSv4 Latency by Op Type", "NFSv4 IOPs per Type",
"NFSv4.1 Latency Heatmap", "NFSv4.1 Read Latency Heatmap", "NFSv4.1 Write Latency Heatmap", "NFSv4.1 Latency by Op Type", "NFSv4.1 IOPs per Type",
"NFSv4.2 Latency by Op Type", "NFSv4.2 IOPs per Type", "SVM NVMe/FC Throughput", "Copy Manager Requests",
// This is from volume
"Top $TopResources Volumes by Inode Files Used Percentage", "Top $TopResources Volumes by Number of Compress Attempts", "Top $TopResources Volumes by Number of Compress Fail",
"Volume Latency by Op Type", "Volume IOPs per Type",
"Top $TopResources Volumes by Number of Compress Attempts", "Top $TopResources Volumes by Number of Compress Fail", "Volume Latency by Op Type", "Volume IOPs per Type",
// This is from lun
"IO Size",
// This is from nfs4storePool
"Allocations over 50%", "All nodes with 1% or more allocations in $Datacenter",
}

VisitAllPanels(data, func(_ string, _, value gjson.Result) {
Expand All @@ -1494,9 +1496,10 @@ func checkDescription(t *testing.T, path string, data []byte, count *int) {
if description == "" {
if len(targetsSlice) == 1 {
expr := targetsSlice[0].Get("expr").String()
if strings.Contains(expr, "/") || strings.Contains(expr, "+") || strings.Contains(expr, "-") || strings.Contains(expr, "on") {
if strings.Contains(expr, "/") || strings.Contains(expr, "+") || strings.Contains(expr, "-") || strings.Contains(expr, " on ") {
// This indicates expressions with arithmetic operations, After adding appropriate description, this will be uncommented.
// t.Errorf(`dashboard=%s panel="%s" has arithmetic operations`, dashPath, value.Get("title").String())
// *count++
// t.Errorf(`dashboard=%s panel="%s" has arithmetic operations %d`, dashPath, value.Get("title").String(), *count)
fmt.Printf(`dashboard=%s panel="%s" has arithmetic operations \n`, dashPath, title)
} else {
*count++
Expand All @@ -1505,9 +1508,11 @@ func checkDescription(t *testing.T, path string, data []byte, count *int) {
} else {
// This indicates table/timeseries with more than 1 expression, After deciding next steps, this will be uncommented.
if panelType == "table" {
fmt.Printf(`dashboard=%s panel="%s" has table with multiple expression \n`, dashPath, title)
*count++
t.Errorf(`dashboard=%s panel="%s" has table with multiple expression %d`, dashPath, title, *count)
} else {
fmt.Printf(`dashboard=%s panel="%s" has many expressions \n`, dashPath, title)
*count++
t.Errorf(`dashboard=%s panel="%s" has many expressions %d`, dashPath, title, *count)
}
}
} else if !strings.HasPrefix(description, "$") && !strings.HasSuffix(description, ".") {
Expand Down
18 changes: 9 additions & 9 deletions grafana/dashboards/cmode/aggregate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1490,7 +1490,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of Percentage saved by compacting the data and Percentage of space saved by storage efficiency.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -1681,7 +1681,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of Number of user-visible files used in the referenced file system and Maximum number of user-visible files that this referenced file system can currently hold.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -1777,7 +1777,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of number of files that can currently be stored on disk for system metadata files and number of files that can currently be stored on disk for user-visible files.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -1873,7 +1873,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of space used by snapshot copies and available space for Snapshot copies in bytes.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2247,7 +2247,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of total files allowed in snapshot copies and total files created in snapshot copies.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2344,7 +2344,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of files in use by snapshot copies, the largest value to which the maxfiles-available parameter can be increased by reconfiguration, on the referenced file system and maximum files available for snapshot copies.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -3422,7 +3422,7 @@
"panels": [
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of percentage of HDD read operations replace by SSD and number of HDD read operations replaced by SSD reads per second.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -3559,7 +3559,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of average of RAID I/O latency on read hit and average read miss latency.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -3657,7 +3657,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of total read/write/total cached SSD blocks.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down
6 changes: 3 additions & 3 deletions grafana/dashboards/cmode/datacenter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1267,7 +1267,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows error detail of disk, shelf, node, network port, license compliance, HA down and sensor failure alerts.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -1387,7 +1387,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows warning detail of disk, shelf, health monitor, lif, volume move and volume anti-ransomware alerts.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2595,7 +2595,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of power consumed by a node/shelf/total in Watts.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down
1 change: 1 addition & 0 deletions grafana/dashboards/cmode/details/volumeBySVM.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "This panel shows volume performance detail.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down
9 changes: 5 additions & 4 deletions grafana/dashboards/cmode/details/volumeDeepDive.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "This panel shows volume performance details.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2656,7 +2657,7 @@
"panels": [
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of physical size, physical space used, logical space used and size used of the volume, in bytes.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2773,7 +2774,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of physical used %, logical used % and size used % of the volume.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2887,7 +2888,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of snapshot available size, snapshot reserve size, snapshot reserve available and snapshots size used of the volume.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -3008,7 +3009,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of snapshot reserve %, snapshot reserve used % and size used % of the volume.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down
10 changes: 5 additions & 5 deletions grafana/dashboards/cmode/disk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2229,7 +2229,7 @@
"panels": [
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of number of disk kilobytes (KB) read/written per second.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2327,7 +2327,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of bytes written/read through a host adapter.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2425,7 +2425,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of array of counts of different types of Consistency Points (CP) and average latency in microseconds for the WAFL filesystem to process write request to the volume.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2564,7 +2564,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of external cache hit rate and estimated number of disk reads per second replaced by cache.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2694,7 +2694,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of percentage of HDD read operations replace by SSD and number of HDD read operations replaced by SSD reads per second.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down
5 changes: 5 additions & 0 deletions grafana/dashboards/cmode/lun.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3933,6 +3933,7 @@
"panels": [
{
"datasource": "${DS_PROMETHEUS}",
"description": "This panels shows average read/write latency in microseconds for all operations on the LUN.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -4027,6 +4028,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "This panel shows Read/Write bytes data.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -4121,6 +4123,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "This panel shows number of read/write operations.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -4216,6 +4219,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "This panel shows detail of I/O to or from a LUN which is not owned by the storage system handling the I/O and number of operations received by a storage system that does not own the LUN targeted by the operations.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -4323,6 +4327,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "This panel shows detail of number of compare and write requests, number of unmap command requests, number of write same command requests, number of write same commands requests with unmap bit set and total number of xcopy operations on the LUN.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down
6 changes: 3 additions & 3 deletions grafana/dashboards/cmode/network.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of total number of FC-NVMe/FCP operations and amount of FC-NVMe/FCP traffic to and from the storage system.",
"fieldConfig": {
"defaults": {
"mappings": [],
Expand Down Expand Up @@ -367,7 +367,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of number of FC-NVMe/FC read operations and amount of data read from the storage system (FC-NVMe/FC).",
"fieldConfig": {
"defaults": {
"mappings": [],
Expand Down Expand Up @@ -460,7 +460,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "",
"description": "This panel shows detail of Number of FC-NVMe/FC write operations and amount of data written to the storage system (FC-NVMe/FC).",
"fieldConfig": {
"defaults": {
"mappings": [],
Expand Down
1 change: 1 addition & 0 deletions grafana/dashboards/cmode/nfsTroubleshooting.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -764,6 +764,7 @@
},
{
"datasource": "${DS_PROMETHEUS}",
"description": "This panel shows SVM performance detail.",
"fieldConfig": {
"defaults": {
"color": {
Expand Down
Loading