Skip to content

Commit 4d560a2

Browse files
authored
update grafana dashboard and exported metrics doc for watchable_panics_recovered_total (#5036)
* update Grafana dashboard and metrics docs for watchable_panics_recovered_total Signed-off-by: DeeBi9 <[email protected]> * Fix: Remove runner filter in watchable_panics_recovered_total query Signed-off-by: DeeBi9 <[email protected]> * Fix: Remove 'repeat' configuration for 'Runner' to display a single panel for recovered panics Signed-off-by: DeeBi9 <[email protected]> * docs: move 'watchable_panics_recovered_total' documentation to the correct file Signed-off-by: DeeBi9 <[email protected]> * test: update generated test files after changes in envoy-gateway-global.json Signed-off-by: DeeBi9 <[email protected]> --------- Signed-off-by: DeeBi9 <[email protected]>
1 parent a1e2022 commit 4d560a2

File tree

4 files changed

+226
-0
lines changed

4 files changed

+226
-0
lines changed

charts/gateway-addons-helm/dashboards/envoy-gateway-global.json

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,81 @@
403403
"title": "Status Updater",
404404
"type": "row"
405405
},
406+
{
407+
"datasource": {
408+
"type": "prometheus",
409+
"uid": "$datasource"
410+
},
411+
"description": "Total number of panics recovered in the system.",
412+
"fieldConfig": {
413+
"defaults": {
414+
"color": {
415+
"mode": "palette-classic"
416+
},
417+
"mappings": [],
418+
"thresholds": {
419+
"mode": "absolute",
420+
"steps": [
421+
{
422+
"color": "green",
423+
"value": null
424+
},
425+
{
426+
"color": "red",
427+
"value": 80
428+
}
429+
]
430+
},
431+
"unit": "none"
432+
},
433+
"overrides": []
434+
},
435+
"gridPos": {
436+
"h": 7,
437+
"w": 7,
438+
"x": 0,
439+
"y": 8
440+
},
441+
"id": 25,
442+
"options": {
443+
"colorMode": "value",
444+
"graphMode": "none",
445+
"justifyMode": "auto",
446+
"orientation": "auto",
447+
"reduceOptions": {
448+
"calcs": [
449+
"lastNotNull"
450+
],
451+
"fields": "",
452+
"values": false
453+
},
454+
"showPercentChange": false,
455+
"textMode": "value_and_name",
456+
"wideLayout": false
457+
},
458+
"pluginVersion": "11.0.0",
459+
"repeatDirection": "v",
460+
"targets": [
461+
{
462+
"datasource": {
463+
"type": "prometheus",
464+
"uid": "$datasource"
465+
},
466+
"disableTextWrap": false,
467+
"editorMode": "builder",
468+
"expr": "sum(watchable_panics_recovered_total{namespace=\"$Namespace\"})",
469+
"fullMetaSearch": false,
470+
"includeNullMetadata": true,
471+
"instant": false,
472+
"legendFormat": "Recovered Panics",
473+
"range": true,
474+
"refId": "A",
475+
"useBackend": false
476+
}
477+
],
478+
"title": "Recovered Panics",
479+
"type": "stat"
480+
},
406481
{
407482
"datasource": {
408483
"type": "prometheus",

site/content/en/latest/tasks/observability/gateway-exported-metrics.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Envoy Gateway collects the following metrics in Watching Components:
2222
| `watchable_depth` | Current depth of watchable map. |
2323
| `watchable_subscribe_duration_seconds` | How long in seconds a subscribed watchable queue is handled. |
2424
| `watchable_subscribe_total` | Total number of subscribed watchable queue. |
25+
| `watchable_panics_recovered_total` | Total recovered panics in the watchable infrastructure. |
2526

2627
Each metric includes the `runner` label to identify the corresponding components,
2728
the relationship between label values and components is as follows:

test/helm/gateway-addons-helm/default.out.yaml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2767,6 +2767,81 @@ data:
27672767
"title": "Status Updater",
27682768
"type": "row"
27692769
},
2770+
{
2771+
"datasource": {
2772+
"type": "prometheus",
2773+
"uid": "$datasource"
2774+
},
2775+
"description": "Total number of panics recovered in the system.",
2776+
"fieldConfig": {
2777+
"defaults": {
2778+
"color": {
2779+
"mode": "palette-classic"
2780+
},
2781+
"mappings": [],
2782+
"thresholds": {
2783+
"mode": "absolute",
2784+
"steps": [
2785+
{
2786+
"color": "green",
2787+
"value": null
2788+
},
2789+
{
2790+
"color": "red",
2791+
"value": 80
2792+
}
2793+
]
2794+
},
2795+
"unit": "none"
2796+
},
2797+
"overrides": []
2798+
},
2799+
"gridPos": {
2800+
"h": 7,
2801+
"w": 7,
2802+
"x": 0,
2803+
"y": 8
2804+
},
2805+
"id": 25,
2806+
"options": {
2807+
"colorMode": "value",
2808+
"graphMode": "none",
2809+
"justifyMode": "auto",
2810+
"orientation": "auto",
2811+
"reduceOptions": {
2812+
"calcs": [
2813+
"lastNotNull"
2814+
],
2815+
"fields": "",
2816+
"values": false
2817+
},
2818+
"showPercentChange": false,
2819+
"textMode": "value_and_name",
2820+
"wideLayout": false
2821+
},
2822+
"pluginVersion": "11.0.0",
2823+
"repeatDirection": "v",
2824+
"targets": [
2825+
{
2826+
"datasource": {
2827+
"type": "prometheus",
2828+
"uid": "$datasource"
2829+
},
2830+
"disableTextWrap": false,
2831+
"editorMode": "builder",
2832+
"expr": "sum(watchable_panics_recovered_total{namespace=\"$Namespace\"})",
2833+
"fullMetaSearch": false,
2834+
"includeNullMetadata": true,
2835+
"instant": false,
2836+
"legendFormat": "Recovered Panics",
2837+
"range": true,
2838+
"refId": "A",
2839+
"useBackend": false
2840+
}
2841+
],
2842+
"title": "Recovered Panics",
2843+
"type": "stat"
2844+
},
27702845
{
27712846
"datasource": {
27722847
"type": "prometheus",

test/helm/gateway-addons-helm/e2e.out.yaml

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2849,6 +2849,81 @@ data:
28492849
"title": "Status Updater",
28502850
"type": "row"
28512851
},
2852+
{
2853+
"datasource": {
2854+
"type": "prometheus",
2855+
"uid": "$datasource"
2856+
},
2857+
"description": "Total number of panics recovered in the system.",
2858+
"fieldConfig": {
2859+
"defaults": {
2860+
"color": {
2861+
"mode": "palette-classic"
2862+
},
2863+
"mappings": [],
2864+
"thresholds": {
2865+
"mode": "absolute",
2866+
"steps": [
2867+
{
2868+
"color": "green",
2869+
"value": null
2870+
},
2871+
{
2872+
"color": "red",
2873+
"value": 80
2874+
}
2875+
]
2876+
},
2877+
"unit": "none"
2878+
},
2879+
"overrides": []
2880+
},
2881+
"gridPos": {
2882+
"h": 7,
2883+
"w": 7,
2884+
"x": 0,
2885+
"y": 8
2886+
},
2887+
"id": 25,
2888+
"options": {
2889+
"colorMode": "value",
2890+
"graphMode": "none",
2891+
"justifyMode": "auto",
2892+
"orientation": "auto",
2893+
"reduceOptions": {
2894+
"calcs": [
2895+
"lastNotNull"
2896+
],
2897+
"fields": "",
2898+
"values": false
2899+
},
2900+
"showPercentChange": false,
2901+
"textMode": "value_and_name",
2902+
"wideLayout": false
2903+
},
2904+
"pluginVersion": "11.0.0",
2905+
"repeatDirection": "v",
2906+
"targets": [
2907+
{
2908+
"datasource": {
2909+
"type": "prometheus",
2910+
"uid": "$datasource"
2911+
},
2912+
"disableTextWrap": false,
2913+
"editorMode": "builder",
2914+
"expr": "sum(watchable_panics_recovered_total{namespace=\"$Namespace\"})",
2915+
"fullMetaSearch": false,
2916+
"includeNullMetadata": true,
2917+
"instant": false,
2918+
"legendFormat": "Recovered Panics",
2919+
"range": true,
2920+
"refId": "A",
2921+
"useBackend": false
2922+
}
2923+
],
2924+
"title": "Recovered Panics",
2925+
"type": "stat"
2926+
},
28522927
{
28532928
"datasource": {
28542929
"type": "prometheus",

0 commit comments

Comments
 (0)