Remove unused Prometheus recording rules from synapse-v2.rules and add comments describing where the rest are used. (#13756)

This commit is contained in:
reivilibre 2022-09-08 17:50:15 +00:00 committed by GitHub
parent f799eac7ea
commit 5261d2e2e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 23 deletions

1
changelog.d/13756.misc Normal file
View file

@ -0,0 +1 @@
Remove unused Prometheus recording rules from `synapse-v2.rules` and add comments describing where the rest are used.

View file

@ -1,29 +1,7 @@
groups: groups:
- name: synapse - name: synapse
rules: rules:
- record: "synapse_federation_transaction_queue_pendingEdus:total" # These 3 rules are used in the included Prometheus console
expr: "sum(synapse_federation_transaction_queue_pendingEdus or absent(synapse_federation_transaction_queue_pendingEdus)*0)"
- record: "synapse_federation_transaction_queue_pendingPdus:total"
expr: "sum(synapse_federation_transaction_queue_pendingPdus or absent(synapse_federation_transaction_queue_pendingPdus)*0)"
- record: 'synapse_http_server_request_count:method'
labels:
servlet: ""
expr: "sum(synapse_http_server_request_count) by (method)"
- record: 'synapse_http_server_request_count:servlet'
labels:
method: ""
expr: 'sum(synapse_http_server_request_count) by (servlet)'
- record: 'synapse_http_server_request_count:total'
labels:
servlet: ""
expr: 'sum(synapse_http_server_request_count:by_method) by (servlet)'
- record: 'synapse_cache:hit_ratio_5m'
expr: 'rate(synapse_util_caches_cache_hits[5m]) / rate(synapse_util_caches_cache[5m])'
- record: 'synapse_cache:hit_ratio_30s'
expr: 'rate(synapse_util_caches_cache_hits[30s]) / rate(synapse_util_caches_cache[30s])'
- record: 'synapse_federation_client_sent' - record: 'synapse_federation_client_sent'
labels: labels:
type: "EDU" type: "EDU"
@ -37,6 +15,7 @@ groups:
type: "Query" type: "Query"
expr: 'sum(synapse_federation_client_sent_queries) by (job)' expr: 'sum(synapse_federation_client_sent_queries) by (job)'
# These 3 rules are used in the included Prometheus console
- record: 'synapse_federation_server_received' - record: 'synapse_federation_server_received'
labels: labels:
type: "EDU" type: "EDU"
@ -50,6 +29,7 @@ groups:
type: "Query" type: "Query"
expr: 'sum(synapse_federation_server_received_queries) by (job)' expr: 'sum(synapse_federation_server_received_queries) by (job)'
# These 2 rules are used in the included Prometheus console
- record: 'synapse_federation_transaction_queue_pending' - record: 'synapse_federation_transaction_queue_pending'
labels: labels:
type: "EDU" type: "EDU"
@ -59,6 +39,7 @@ groups:
type: "PDU" type: "PDU"
expr: 'synapse_federation_transaction_queue_pending_pdus + 0' expr: 'synapse_federation_transaction_queue_pending_pdus + 0'
# These 3 rules are used in the included Grafana dashboard
- record: synapse_storage_events_persisted_by_source_type - record: synapse_storage_events_persisted_by_source_type
expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_type="remote"}) expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_type="remote"})
labels: labels:
@ -71,8 +52,12 @@ groups:
expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_entity!="*client*",origin_type="local"}) expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_entity!="*client*",origin_type="local"})
labels: labels:
type: bridges type: bridges
# This rule is used in the included Grafana dashboard
- record: synapse_storage_events_persisted_by_event_type - record: synapse_storage_events_persisted_by_event_type
expr: sum without(origin_entity, origin_type) (synapse_storage_events_persisted_events_sep_total) expr: sum without(origin_entity, origin_type) (synapse_storage_events_persisted_events_sep_total)
# This rule is used in the included Grafana dashboard
- record: synapse_storage_events_persisted_by_origin - record: synapse_storage_events_persisted_by_origin
expr: sum without(type) (synapse_storage_events_persisted_events_sep_total) expr: sum without(type) (synapse_storage_events_persisted_events_sep_total)