5106818bd0
Refactor `GaugeBucketCollector` metrics to be homeserver-scoped
Part of https://github.com/element-hq/synapse/issues/18592
### Testing strategy
1. Add the `metrics` listener in your `homeserver.yaml`
```yaml
listeners:
# This is just showing how to configure metrics either way
#
# `http` `metrics` resource
- port: 9322
type: http
bind_addresses: ['127.0.0.1']
resources:
- names: [metrics]
compress: false
# `metrics` listener
- port: 9323
type: metrics
bind_addresses: ['127.0.0.1']
```
1. Start the homeserver: `poetry run synapse_homeserver --config-path
homeserver.yaml`
1. Fetch `http://localhost:9322/_synapse/metrics` and/or
`http://localhost:9323/metrics`
1. Adjust the number of [`msecs` in the `looping_call` so that
`_read_forward_extremities`](a82b8a966a/synapse/storage/databases/main/metrics.py (L79))
runs immediately instead of after an hour.
1. Observe response includes the `synapse_forward_extremities` and
`synapse_excess_extremity_events` metrics with the `server_name` label
89 lines
3.8 KiB
Python
89 lines
3.8 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
# Copyright (C) 2023 New Vector, Ltd
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as
|
|
# published by the Free Software Foundation, either version 3 of the
|
|
# License, or (at your option) any later version.
|
|
#
|
|
# See the GNU Affero General Public License for more details:
|
|
# <https://www.gnu.org/licenses/agpl-3.0.html>.
|
|
#
|
|
# Originally licensed under the Apache License, Version 2.0:
|
|
# <http://www.apache.org/licenses/LICENSE-2.0>.
|
|
#
|
|
# [This file includes modifications made by New Vector Limited]
|
|
#
|
|
#
|
|
|
|
from synapse.metrics import REGISTRY, generate_latest
|
|
from synapse.types import UserID, create_requester
|
|
|
|
from tests.unittest import HomeserverTestCase
|
|
|
|
|
|
class ExtremStatisticsTestCase(HomeserverTestCase):
|
|
def test_exposed_to_prometheus(self) -> None:
|
|
"""
|
|
Forward extremity counts are exposed via Prometheus.
|
|
"""
|
|
room_creator = self.hs.get_room_creation_handler()
|
|
|
|
user = UserID("alice", "test")
|
|
requester = create_requester(user)
|
|
|
|
# Real events, forward extremities
|
|
events = [(3, 2), (6, 2), (4, 6)]
|
|
|
|
for event_count, extrems in events:
|
|
room_id, _, _ = self.get_success(room_creator.create_room(requester, {}))
|
|
|
|
last_event = None
|
|
|
|
# Make a real event chain
|
|
for _ in range(event_count):
|
|
ev = self.create_and_send_event(room_id, user, False, last_event)
|
|
last_event = [ev]
|
|
|
|
# Sprinkle in some extremities
|
|
for _ in range(extrems):
|
|
ev = self.create_and_send_event(room_id, user, False, last_event)
|
|
|
|
# Let it run for a while, then pull out the statistics from the
|
|
# Prometheus client registry
|
|
self.reactor.advance(60 * 60 * 1000)
|
|
self.pump(1)
|
|
|
|
items = list(
|
|
filter(
|
|
lambda x: b"synapse_forward_extremities_" in x and b"# HELP" not in x,
|
|
generate_latest(REGISTRY).split(b"\n"),
|
|
)
|
|
)
|
|
|
|
expected = [
|
|
b'synapse_forward_extremities_bucket{le="1.0",server_name="test"} 0.0',
|
|
b'synapse_forward_extremities_bucket{le="2.0",server_name="test"} 2.0',
|
|
b'synapse_forward_extremities_bucket{le="3.0",server_name="test"} 2.0',
|
|
b'synapse_forward_extremities_bucket{le="5.0",server_name="test"} 2.0',
|
|
b'synapse_forward_extremities_bucket{le="7.0",server_name="test"} 3.0',
|
|
b'synapse_forward_extremities_bucket{le="10.0",server_name="test"} 3.0',
|
|
b'synapse_forward_extremities_bucket{le="15.0",server_name="test"} 3.0',
|
|
b'synapse_forward_extremities_bucket{le="20.0",server_name="test"} 3.0',
|
|
b'synapse_forward_extremities_bucket{le="50.0",server_name="test"} 3.0',
|
|
b'synapse_forward_extremities_bucket{le="100.0",server_name="test"} 3.0',
|
|
b'synapse_forward_extremities_bucket{le="200.0",server_name="test"} 3.0',
|
|
b'synapse_forward_extremities_bucket{le="500.0",server_name="test"} 3.0',
|
|
# per https://docs.google.com/document/d/1KwV0mAXwwbvvifBvDKH_LU1YjyXE_wxCkHNoCGq1GX0/edit#heading=h.wghdjzzh72j9,
|
|
# "inf" is valid: "this includes variants such as inf"
|
|
b'synapse_forward_extremities_bucket{le="inf",server_name="test"} 3.0',
|
|
b"# TYPE synapse_forward_extremities_gcount gauge",
|
|
b'synapse_forward_extremities_gcount{server_name="test"} 3.0',
|
|
b"# TYPE synapse_forward_extremities_gsum gauge",
|
|
b'synapse_forward_extremities_gsum{server_name="test"} 10.0',
|
|
]
|
|
self.assertEqual(items, expected)
|