synapse/contrib/prometheus/synapse-v2.rules

groups:
- name: synapse
  rules:

  ###
  ### Prometheus Console Only
  ### The following rules are only needed if you use the Prometheus Console
  ### in contrib/prometheus/consoles/synapse.html
  ###
  - record: 'synapse_federation_client_sent'
    labels:
      type: "EDU"
    expr: 'synapse_federation_client_sent_edus_total + 0'
  - record: 'synapse_federation_client_sent'
    labels:
      type: "PDU"
    expr: 'synapse_federation_client_sent_pdu_destinations_count_total + 0'
  - record: 'synapse_federation_client_sent'
    labels:
      type: "Query"
    expr: 'sum(synapse_federation_client_sent_queries) by (job)'

  - record: 'synapse_federation_server_received'
    labels:
      type: "EDU"
    expr: 'synapse_federation_server_received_edus_total + 0'
  - record: 'synapse_federation_server_received'
    labels:
      type: "PDU"
    expr: 'synapse_federation_server_received_pdus_total + 0'
  - record: 'synapse_federation_server_received'
    labels:
      type: "Query"
    expr: 'sum(synapse_federation_server_received_queries) by (job)'

  - record: 'synapse_federation_transaction_queue_pending'
    labels:
      type: "EDU"
    expr: 'synapse_federation_transaction_queue_pending_edus + 0'
  - record: 'synapse_federation_transaction_queue_pending'
    labels:
      type: "PDU"
    expr: 'synapse_federation_transaction_queue_pending_pdus + 0'
  ###
  ### End of 'Prometheus Console Only' rules block
  ###


  ###
  ### Grafana Only
  ### The following rules are only needed if you use the Grafana dashboard
  ### in contrib/grafana/synapse.json
  ###
  - 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"})
    labels:
      type: remote
  - record: synapse_storage_events_persisted_by_source_type
    expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_entity="*client*",origin_type="local"})
    labels:
      type: local
  - record: synapse_storage_events_persisted_by_source_type
    expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_entity!="*client*",origin_type="local"})
    labels:
      type: bridges

  - record: synapse_storage_events_persisted_by_event_type
    expr: sum without(origin_entity, origin_type) (synapse_storage_events_persisted_events_sep_total)

  - record: synapse_storage_events_persisted_by_origin
    expr: sum without(type) (synapse_storage_events_persisted_events_sep_total)
  ###
  ### End of 'Grafana Only' rules block
  ###
update prometheus-config to new format 2017-11-07 15:35:35 +03:00			`groups:`
			`- name: synapse`
			`rules:`
Add comments to the Prometheus recording rules to make it clear which set of rules you need for Grafana or Prometheus Console. (#13876) 2022-09-23 13:46:45 +03:00
			`###`
			`### Prometheus Console Only`
			`### The following rules are only needed if you use the Prometheus Console`
			`### in contrib/prometheus/consoles/synapse.html`
			`###`
update prometheus-config to new format 2017-11-07 15:35:35 +03:00			`- record: 'synapse_federation_client_sent'`
			`labels:`
			`type: "EDU"`
Fix Prometheus recording rules to not use legacy metric names. (#13718) 2022-09-08 17:01:42 +03:00			`expr: 'synapse_federation_client_sent_edus_total + 0'`
update prometheus-config to new format 2017-11-07 15:35:35 +03:00			`- record: 'synapse_federation_client_sent'`
			`labels:`
			`type: "PDU"`
Fix Prometheus recording rules to not use legacy metric names. (#13718) 2022-09-08 17:01:42 +03:00			`expr: 'synapse_federation_client_sent_pdu_destinations_count_total + 0'`
update prometheus-config to new format 2017-11-07 15:35:35 +03:00			`- record: 'synapse_federation_client_sent'`
			`labels:`
			`type: "Query"`
			`expr: 'sum(synapse_federation_client_sent_queries) by (job)'`
Add prometheus config ... from https://github.com/matrix-org/synapse-prometheus-config. 2017-08-16 17:31:44 +03:00
update prometheus-config to new format 2017-11-07 15:35:35 +03:00			`- record: 'synapse_federation_server_received'`
			`labels:`
			`type: "EDU"`
Fix Prometheus recording rules to not use legacy metric names. (#13718) 2022-09-08 17:01:42 +03:00			`expr: 'synapse_federation_server_received_edus_total + 0'`
update prometheus-config to new format 2017-11-07 15:35:35 +03:00			`- record: 'synapse_federation_server_received'`
			`labels:`
			`type: "PDU"`
Fix Prometheus recording rules to not use legacy metric names. (#13718) 2022-09-08 17:01:42 +03:00			`expr: 'synapse_federation_server_received_pdus_total + 0'`
update prometheus-config to new format 2017-11-07 15:35:35 +03:00			`- record: 'synapse_federation_server_received'`
			`labels:`
			`type: "Query"`
			`expr: 'sum(synapse_federation_server_received_queries) by (job)'`
Add prometheus config ... from https://github.com/matrix-org/synapse-prometheus-config. 2017-08-16 17:31:44 +03:00
update prometheus-config to new format 2017-11-07 15:35:35 +03:00			`- record: 'synapse_federation_transaction_queue_pending'`
			`labels:`
			`type: "EDU"`
			`expr: 'synapse_federation_transaction_queue_pending_edus + 0'`
			`- record: 'synapse_federation_transaction_queue_pending'`
			`labels:`
			`type: "PDU"`
			`expr: 'synapse_federation_transaction_queue_pending_pdus + 0'`
Add comments to the Prometheus recording rules to make it clear which set of rules you need for Grafana or Prometheus Console. (#13876) 2022-09-23 13:46:45 +03:00			`###`
			`### End of 'Prometheus Console Only' rules block`
			`###`

Add missing prometheus rules for persisted events (#8802) The official dashboard uses data from these rules, but they were never added to the synapse-v2.rules. They are mentioned in this issue: https://github.com/matrix-org/synapse/issues/7917#issuecomment-661330409, but never got added to the rules. Adding them results in all graphs in the "Event persist rate" section to function as intended. Signed-off-by: Johanna Dorothea Reichmann <transcaffeine@finallycoffee.eu> 2020-12-02 18:18:41 +03:00
Add comments to the Prometheus recording rules to make it clear which set of rules you need for Grafana or Prometheus Console. (#13876) 2022-09-23 13:46:45 +03:00			`###`
			`### Grafana Only`
			`### The following rules are only needed if you use the Grafana dashboard`
			`### in contrib/grafana/synapse.json`
			`###`
Add missing prometheus rules for persisted events (#8802) The official dashboard uses data from these rules, but they were never added to the synapse-v2.rules. They are mentioned in this issue: https://github.com/matrix-org/synapse/issues/7917#issuecomment-661330409, but never got added to the rules. Adding them results in all graphs in the "Event persist rate" section to function as intended. Signed-off-by: Johanna Dorothea Reichmann <transcaffeine@finallycoffee.eu> 2020-12-02 18:18:41 +03:00			`- record: synapse_storage_events_persisted_by_source_type`
Fix Prometheus recording rules to not use legacy metric names. (#13718) 2022-09-08 17:01:42 +03:00			`expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_type="remote"})`
Add missing prometheus rules for persisted events (#8802) The official dashboard uses data from these rules, but they were never added to the synapse-v2.rules. They are mentioned in this issue: https://github.com/matrix-org/synapse/issues/7917#issuecomment-661330409, but never got added to the rules. Adding them results in all graphs in the "Event persist rate" section to function as intended. Signed-off-by: Johanna Dorothea Reichmann <transcaffeine@finallycoffee.eu> 2020-12-02 18:18:41 +03:00			`labels:`
			`type: remote`
			`- record: synapse_storage_events_persisted_by_source_type`
Fix Prometheus recording rules to not use legacy metric names. (#13718) 2022-09-08 17:01:42 +03:00			`expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_entity="client",origin_type="local"})`
Add missing prometheus rules for persisted events (#8802) The official dashboard uses data from these rules, but they were never added to the synapse-v2.rules. They are mentioned in this issue: https://github.com/matrix-org/synapse/issues/7917#issuecomment-661330409, but never got added to the rules. Adding them results in all graphs in the "Event persist rate" section to function as intended. Signed-off-by: Johanna Dorothea Reichmann <transcaffeine@finallycoffee.eu> 2020-12-02 18:18:41 +03:00			`labels:`
			`type: local`
			`- record: synapse_storage_events_persisted_by_source_type`
Fix Prometheus recording rules to not use legacy metric names. (#13718) 2022-09-08 17:01:42 +03:00			`expr: sum without(type, origin_type, origin_entity) (synapse_storage_events_persisted_events_sep_total{origin_entity!="client",origin_type="local"})`
Add missing prometheus rules for persisted events (#8802) The official dashboard uses data from these rules, but they were never added to the synapse-v2.rules. They are mentioned in this issue: https://github.com/matrix-org/synapse/issues/7917#issuecomment-661330409, but never got added to the rules. Adding them results in all graphs in the "Event persist rate" section to function as intended. Signed-off-by: Johanna Dorothea Reichmann <transcaffeine@finallycoffee.eu> 2020-12-02 18:18:41 +03:00			`labels:`
			`type: bridges`
Remove unused Prometheus recording rules from `synapse-v2.rules` and add comments describing where the rest are used. (#13756) 2022-09-08 20:50:15 +03:00
Add missing prometheus rules for persisted events (#8802) The official dashboard uses data from these rules, but they were never added to the synapse-v2.rules. They are mentioned in this issue: https://github.com/matrix-org/synapse/issues/7917#issuecomment-661330409, but never got added to the rules. Adding them results in all graphs in the "Event persist rate" section to function as intended. Signed-off-by: Johanna Dorothea Reichmann <transcaffeine@finallycoffee.eu> 2020-12-02 18:18:41 +03:00			`- record: synapse_storage_events_persisted_by_event_type`
Fix Prometheus recording rules to not use legacy metric names. (#13718) 2022-09-08 17:01:42 +03:00			`expr: sum without(origin_entity, origin_type) (synapse_storage_events_persisted_events_sep_total)`
Remove unused Prometheus recording rules from `synapse-v2.rules` and add comments describing where the rest are used. (#13756) 2022-09-08 20:50:15 +03:00
Add missing prometheus rules for persisted events (#8802) The official dashboard uses data from these rules, but they were never added to the synapse-v2.rules. They are mentioned in this issue: https://github.com/matrix-org/synapse/issues/7917#issuecomment-661330409, but never got added to the rules. Adding them results in all graphs in the "Event persist rate" section to function as intended. Signed-off-by: Johanna Dorothea Reichmann <transcaffeine@finallycoffee.eu> 2020-12-02 18:18:41 +03:00			`- record: synapse_storage_events_persisted_by_origin`
Fix Prometheus recording rules to not use legacy metric names. (#13718) 2022-09-08 17:01:42 +03:00			`expr: sum without(type) (synapse_storage_events_persisted_events_sep_total)`
Add comments to the Prometheus recording rules to make it clear which set of rules you need for Grafana or Prometheus Console. (#13876) 2022-09-23 13:46:45 +03:00			`###`
			`### End of 'Grafana Only' rules block`
			`###`