Skip to content

Commit d6b45a7

Browse files
Update and align Grafana dashboard to use regex matching for job=~"$job" (#19400)
We're already using `job=~"$job"` in the majority of the other panels. This is just aligning the stragglers. ### Background For a variable in Grafana, when the "All" value is selected, it translates the variable into a wildcard regex. By default, this is just a giant list of all of the possible values or'd together. It's possible to define a "custom all value" like we've done for `index` as `.*` and feels like we should also do this in a follow-up PR. Input: ``` job="$job" ``` Before (using **exact** match) -> resulted in matching nothing: ``` job="(appservice|background_worker|client_reader|device_lists|event_creator|event_persister|federation_inbound|federation_reader|federation_sender|media_repository|pusher|stream_writers|synapse|synchrotron|user_dir)"" ``` After (using **regex** match) -> matches all jobs as expected: ``` job=~"(appservice|background_worker|client_reader|device_lists|event_creator|event_persister|federation_inbound|federation_reader|federation_sender|media_repository|pusher|stream_writers|synapse|synchrotron|user_dir)"" ```
1 parent 9a743a4 commit d6b45a7

File tree

2 files changed

+22
-21
lines changed

2 files changed

+22
-21
lines changed

changelog.d/19400.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update and align Grafana dashboard to use regex matching for `job` selectors (`job=~"$job"`) so the "all" value works correctly across all panels.

contrib/grafana/synapse.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2268,7 +2268,7 @@
22682268
"datasource": {
22692269
"uid": "${DS_PROMETHEUS}"
22702270
},
2271-
"expr": "sum(avg_over_time(synapse_http_server_in_flight_requests_count{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size]))",
2271+
"expr": "sum(avg_over_time(synapse_http_server_in_flight_requests_count{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size]))",
22722272
"interval": "",
22732273
"legendFormat": "Total",
22742274
"refId": "B"
@@ -4167,7 +4167,7 @@
41674167
"uid": "${DS_PROMETHEUS}"
41684168
},
41694169
"exemplar": true,
4170-
"expr": "sum(rate(synapse_push_bulk_push_rule_evaluator_push_rules_state_size_counter_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size]))",
4170+
"expr": "sum(rate(synapse_push_bulk_push_rule_evaluator_push_rules_state_size_counter_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size]))",
41714171
"format": "time_series",
41724172
"interval": "",
41734173
"intervalFactor": 2,
@@ -4210,7 +4210,7 @@
42104210
"uid": "${DS_PROMETHEUS}"
42114211
},
42124212
"exemplar": true,
4213-
"expr": "sum(rate(synapse_push_bulk_push_rule_evaluator_push_rules_invalidation_counter_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size]))",
4213+
"expr": "sum(rate(synapse_push_bulk_push_rule_evaluator_push_rules_invalidation_counter_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size]))",
42144214
"format": "time_series",
42154215
"interval": "",
42164216
"intervalFactor": 2,
@@ -4253,7 +4253,7 @@
42534253
"uid": "${DS_PROMETHEUS}"
42544254
},
42554255
"exemplar": true,
4256-
"expr": "sum(rate(synapse_util_caches_cache_hits{job=\"$job\",index=~\"$index\",name=\"push_rules_delta_state_cache_metric\",server_name=\"$server_name\"}[$bucket_size]))/sum(rate(synapse_util_caches_cache{job=\"$job\",index=~\"$index\", name=\"push_rules_delta_state_cache_metric\",server_name=\"$server_name\"}[$bucket_size]))",
4256+
"expr": "sum(rate(synapse_util_caches_cache_hits{job=~\"$job\",index=~\"$index\",name=\"push_rules_delta_state_cache_metric\",server_name=\"$server_name\"}[$bucket_size]))/sum(rate(synapse_util_caches_cache{job=~\"$job\",index=~\"$index\", name=\"push_rules_delta_state_cache_metric\",server_name=\"$server_name\"}[$bucket_size]))",
42574257
"format": "time_series",
42584258
"interval": "",
42594259
"intervalFactor": 2,
@@ -4268,7 +4268,7 @@
42684268
"uid": "${DS_PROMETHEUS}"
42694269
},
42704270
"exemplar": true,
4271-
"expr": "sum(rate(synapse_util_caches_cache{job=\"$job\",index=~\"$index\", name=\"push_rules_delta_state_cache_metric\",server_name=\"$server_name\"}[$bucket_size]))",
4271+
"expr": "sum(rate(synapse_util_caches_cache{job=~\"$job\",index=~\"$index\", name=\"push_rules_delta_state_cache_metric\",server_name=\"$server_name\"}[$bucket_size]))",
42724272
"format": "time_series",
42734273
"interval": "",
42744274
"intervalFactor": 2,
@@ -4310,7 +4310,7 @@
43104310
"uid": "${DS_PROMETHEUS}"
43114311
},
43124312
"exemplar": true,
4313-
"expr": "sum(rate(synapse_util_caches_cache_hits{job=\"$job\",index=~\"$index\",name=\"room_push_rule_cache\",server_name=\"$server_name\"}[$bucket_size]))/sum(rate(synapse_util_caches_cache{job=\"$job\",index=~\"$index\", name=\"room_push_rule_cache\",server_name=\"$server_name\"}[$bucket_size]))",
4313+
"expr": "sum(rate(synapse_util_caches_cache_hits{job=~\"$job\",index=~\"$index\",name=\"room_push_rule_cache\",server_name=\"$server_name\"}[$bucket_size]))/sum(rate(synapse_util_caches_cache{job=~\"$job\",index=~\"$index\", name=\"room_push_rule_cache\",server_name=\"$server_name\"}[$bucket_size]))",
43144314
"format": "time_series",
43154315
"interval": "",
43164316
"intervalFactor": 2,
@@ -4325,7 +4325,7 @@
43254325
"uid": "${DS_PROMETHEUS}"
43264326
},
43274327
"exemplar": true,
4328-
"expr": "sum(rate(synapse_util_caches_cache{job=\"$job\",index=~\"$index\", name=\"room_push_rule_cache\",server_name=\"$server_name\"}[$bucket_size]))",
4328+
"expr": "sum(rate(synapse_util_caches_cache{job=~\"$job\",index=~\"$index\", name=\"room_push_rule_cache\",server_name=\"$server_name\"}[$bucket_size]))",
43294329
"format": "time_series",
43304330
"interval": "",
43314331
"intervalFactor": 2,
@@ -4367,7 +4367,7 @@
43674367
"uid": "${DS_PROMETHEUS}"
43684368
},
43694369
"exemplar": true,
4370-
"expr": "sum(rate(synapse_util_caches_cache_hits{job=\"$job\",index=~\"$index\",name=\"_get_rules_for_room\",server_name=\"$server_name\"}[$bucket_size]))/sum(rate(synapse_util_caches_cache{job=\"$job\",index=~\"$index\", name=\"_get_rules_for_room\",server_name=\"$server_name\"}[$bucket_size]))",
4370+
"expr": "sum(rate(synapse_util_caches_cache_hits{job=~\"$job\",index=~\"$index\",name=\"_get_rules_for_room\",server_name=\"$server_name\"}[$bucket_size]))/sum(rate(synapse_util_caches_cache{job=~\"$job\",index=~\"$index\", name=\"_get_rules_for_room\",server_name=\"$server_name\"}[$bucket_size]))",
43714371
"format": "time_series",
43724372
"interval": "",
43734373
"intervalFactor": 2,
@@ -4382,7 +4382,7 @@
43824382
"uid": "${DS_PROMETHEUS}"
43834383
},
43844384
"exemplar": true,
4385-
"expr": "sum(rate(synapse_util_caches_cache{job=\"$job\",index=~\"$index\", name=\"_get_rules_for_room\",server_name=\"$server_name\"}[$bucket_size]))",
4385+
"expr": "sum(rate(synapse_util_caches_cache{job=~\"$job\",index=~\"$index\", name=\"_get_rules_for_room\",server_name=\"$server_name\"}[$bucket_size]))",
43864386
"format": "time_series",
43874387
"interval": "",
43884388
"intervalFactor": 2,
@@ -4712,7 +4712,7 @@
47124712
"datasource": {
47134713
"uid": "${DS_PROMETHEUS}"
47144714
},
4715-
"expr": "histogram_quantile(0.99, sum(rate(synapse_storage_schedule_time_bucket{index=~\"$index\",server_name=\"$server_name\",job=\"$job\"}[$bucket_size])) by (le))",
4715+
"expr": "histogram_quantile(0.99, sum(rate(synapse_storage_schedule_time_bucket{index=~\"$index\",server_name=\"$server_name\",job=~\"$job\"}[$bucket_size])) by (le))",
47164716
"format": "time_series",
47174717
"intervalFactor": 1,
47184718
"legendFormat": "99%",
@@ -4722,7 +4722,7 @@
47224722
"datasource": {
47234723
"uid": "${DS_PROMETHEUS}"
47244724
},
4725-
"expr": "histogram_quantile(0.9, sum(rate(synapse_storage_schedule_time_bucket{index=~\"$index\",server_name=\"$server_name\",job=\"$job\"}[$bucket_size])) by (le))",
4725+
"expr": "histogram_quantile(0.9, sum(rate(synapse_storage_schedule_time_bucket{index=~\"$index\",server_name=\"$server_name\",job=~\"$job\"}[$bucket_size])) by (le))",
47264726
"format": "time_series",
47274727
"intervalFactor": 1,
47284728
"legendFormat": "90%",
@@ -4732,7 +4732,7 @@
47324732
"datasource": {
47334733
"uid": "${DS_PROMETHEUS}"
47344734
},
4735-
"expr": "histogram_quantile(0.75, sum(rate(synapse_storage_schedule_time_bucket{index=~\"$index\",server_name=\"$server_name\",job=\"$job\"}[$bucket_size])) by (le))",
4735+
"expr": "histogram_quantile(0.75, sum(rate(synapse_storage_schedule_time_bucket{index=~\"$index\",server_name=\"$server_name\",job=~\"$job\"}[$bucket_size])) by (le))",
47364736
"format": "time_series",
47374737
"intervalFactor": 1,
47384738
"legendFormat": "75%",
@@ -4742,7 +4742,7 @@
47424742
"datasource": {
47434743
"uid": "${DS_PROMETHEUS}"
47444744
},
4745-
"expr": "histogram_quantile(0.5, sum(rate(synapse_storage_schedule_time_bucket{index=~\"$index\",server_name=\"$server_name\",job=\"$job\"}[$bucket_size])) by (le))",
4745+
"expr": "histogram_quantile(0.5, sum(rate(synapse_storage_schedule_time_bucket{index=~\"$index\",server_name=\"$server_name\",job=~\"$job\"}[$bucket_size])) by (le))",
47464746
"format": "time_series",
47474747
"intervalFactor": 1,
47484748
"legendFormat": "50%",
@@ -6943,7 +6943,7 @@
69436943
"uid": "${DS_PROMETHEUS}"
69446944
},
69456945
"editorMode": "code",
6946-
"expr": "rate(synapse_notifier_users_woken_by_stream_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
6946+
"expr": "rate(synapse_notifier_users_woken_by_stream_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
69476947
"format": "time_series",
69486948
"hide": false,
69496949
"intervalFactor": 2,
@@ -7122,7 +7122,7 @@
71227122
"datasource": {
71237123
"uid": "${DS_PROMETHEUS}"
71247124
},
7125-
"expr": "rate(synapse_handler_presence_notified_presence_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
7125+
"expr": "rate(synapse_handler_presence_notified_presence_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
71267126
"interval": "",
71277127
"legendFormat": "Notified",
71287128
"refId": "A"
@@ -7131,7 +7131,7 @@
71317131
"datasource": {
71327132
"uid": "${DS_PROMETHEUS}"
71337133
},
7134-
"expr": "rate(synapse_handler_presence_federation_presence_out_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
7134+
"expr": "rate(synapse_handler_presence_federation_presence_out_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
71357135
"interval": "",
71367136
"legendFormat": "Remote ping",
71377137
"refId": "B"
@@ -7140,7 +7140,7 @@
71407140
"datasource": {
71417141
"uid": "${DS_PROMETHEUS}"
71427142
},
7143-
"expr": "rate(synapse_handler_presence_presence_updates_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
7143+
"expr": "rate(synapse_handler_presence_presence_updates_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
71447144
"interval": "",
71457145
"legendFormat": "Total updates",
71467146
"refId": "C"
@@ -7149,7 +7149,7 @@
71497149
"datasource": {
71507150
"uid": "${DS_PROMETHEUS}"
71517151
},
7152-
"expr": "rate(synapse_handler_presence_federation_presence_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
7152+
"expr": "rate(synapse_handler_presence_federation_presence_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
71537153
"interval": "",
71547154
"legendFormat": "Remote updates",
71557155
"refId": "D"
@@ -7158,7 +7158,7 @@
71587158
"datasource": {
71597159
"uid": "${DS_PROMETHEUS}"
71607160
},
7161-
"expr": "rate(synapse_handler_presence_bump_active_time_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
7161+
"expr": "rate(synapse_handler_presence_bump_active_time_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
71627162
"interval": "",
71637163
"legendFormat": "Bump active time",
71647164
"refId": "E"
@@ -7193,7 +7193,7 @@
71937193
"uid": "${DS_PROMETHEUS}"
71947194
},
71957195
"editorMode": "code",
7196-
"expr": "rate(synapse_handler_presence_state_transition_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
7196+
"expr": "rate(synapse_handler_presence_state_transition_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
71977197
"interval": "",
71987198
"legendFormat": "{{from}} -> {{to}}",
71997199
"range": true,
@@ -7229,7 +7229,7 @@
72297229
"uid": "${DS_PROMETHEUS}"
72307230
},
72317231
"editorMode": "code",
7232-
"expr": "rate(synapse_handler_presence_notify_reason_total{job=\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
7232+
"expr": "rate(synapse_handler_presence_notify_reason_total{job=~\"$job\",index=~\"$index\",server_name=\"$server_name\"}[$bucket_size])",
72337233
"interval": "",
72347234
"legendFormat": "{{reason}}",
72357235
"range": true,

0 commit comments

Comments
 (0)