d4af2970f3
Bulk refactor `Histogram` metrics to be homeserver-scoped. We also add lints to make sure that new `Histogram` metrics don't sneak in without using the `server_name` label (`SERVER_NAME_LABEL`). 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. Observe response includes the TODO metrics with the `server_name` label ### Todo - [x] Wait for https://github.com/element-hq/synapse/pull/18656 to merge ### Dev notes ``` LoggingDatabaseConnection make_conn make_pool make_fake_db_pool ``` ### Pull Request Checklist <!-- Please read https://element-hq.github.io/synapse/latest/development/contributing_guide.html before submitting your pull request --> * [x] Pull request is based on the develop branch * [x] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [x] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters))
68 lines
2.4 KiB
Python
68 lines
2.4 KiB
Python
#
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
#
|
|
# Copyright 2022 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 unittest.mock import MagicMock, patch
|
|
|
|
from synapse.storage.database import make_conn
|
|
from synapse.storage.engines import PostgresEngine
|
|
from synapse.storage.engines._base import IncorrectDatabaseSetup
|
|
|
|
from tests.unittest import HomeserverTestCase
|
|
from tests.utils import USE_POSTGRES_FOR_TESTS
|
|
|
|
|
|
class UnsafeLocaleTest(HomeserverTestCase):
|
|
if not USE_POSTGRES_FOR_TESTS:
|
|
skip = "Requires Postgres"
|
|
|
|
@patch("synapse.storage.engines.postgres.PostgresEngine.get_db_locale")
|
|
def test_unsafe_locale(self, mock_db_locale: MagicMock) -> None:
|
|
mock_db_locale.return_value = ("B", "B")
|
|
database = self.hs.get_datastores().databases[0]
|
|
server_name = self.hs.hostname
|
|
|
|
db_conn = make_conn(
|
|
db_config=database._database_config,
|
|
engine=database.engine,
|
|
default_txn_name="test_unsafe",
|
|
server_name=server_name,
|
|
)
|
|
with self.assertRaises(IncorrectDatabaseSetup):
|
|
database.engine.check_database(db_conn)
|
|
with self.assertRaises(IncorrectDatabaseSetup):
|
|
database.engine.check_new_database(db_conn)
|
|
db_conn.close()
|
|
|
|
def test_safe_locale(self) -> None:
|
|
database = self.hs.get_datastores().databases[0]
|
|
assert isinstance(database.engine, PostgresEngine)
|
|
server_name = self.hs.hostname
|
|
|
|
db_conn = make_conn(
|
|
db_config=database._database_config,
|
|
engine=database.engine,
|
|
default_txn_name="test_unsafe",
|
|
server_name=server_name,
|
|
)
|
|
with db_conn.cursor() as txn:
|
|
res = database.engine.get_db_locale(txn)
|
|
self.assertEqual(res, ("C", "C"))
|
|
db_conn.close()
|