mirror of
https://github.com/element-hq/synapse.git
synced 2026-01-16 23:00:43 +00:00
b7e7f537f1
Part of https://github.com/element-hq/synapse/issues/18592 Separated out of https://github.com/element-hq/synapse/pull/18656 because it's a bigger, unique piece of the refactor ### 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 background processs metrics (`synapse_background_process_start_count`, `synapse_background_process_db_txn_count_total`, etc) with the `server_name` label
128 lines
3.8 KiB
Python
128 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]
|
|
#
|
|
#
|
|
|
|
import argparse
|
|
import logging
|
|
from typing import cast
|
|
|
|
import yaml
|
|
|
|
from twisted.internet import defer, reactor as reactor_
|
|
|
|
from synapse.config.homeserver import HomeServerConfig
|
|
from synapse.metrics.background_process_metrics import run_as_background_process
|
|
from synapse.server import HomeServer
|
|
from synapse.storage import DataStore
|
|
from synapse.types import ISynapseReactor
|
|
from synapse.util import SYNAPSE_VERSION
|
|
|
|
# Cast safety: Twisted does some naughty magic which replaces the
|
|
# twisted.internet.reactor module with a Reactor instance at runtime.
|
|
reactor = cast(ISynapseReactor, reactor_)
|
|
logger = logging.getLogger("update_database")
|
|
|
|
|
|
class MockHomeserver(HomeServer):
|
|
DATASTORE_CLASS = DataStore
|
|
|
|
def __init__(self, config: HomeServerConfig):
|
|
super().__init__(
|
|
hostname=config.server.server_name,
|
|
config=config,
|
|
reactor=reactor,
|
|
version_string=f"Synapse/{SYNAPSE_VERSION}",
|
|
)
|
|
|
|
|
|
def run_background_updates(hs: HomeServer) -> None:
|
|
server_name = hs.hostname
|
|
main = hs.get_datastores().main
|
|
state = hs.get_datastores().state
|
|
|
|
async def run_background_updates() -> None:
|
|
await main.db_pool.updates.run_background_updates(sleep=False)
|
|
if state:
|
|
await state.db_pool.updates.run_background_updates(sleep=False)
|
|
# Stop the reactor to exit the script once every background update is run.
|
|
reactor.stop()
|
|
|
|
def run() -> None:
|
|
# Apply all background updates on the database.
|
|
defer.ensureDeferred(
|
|
run_as_background_process(
|
|
"background_updates",
|
|
server_name,
|
|
run_background_updates,
|
|
)
|
|
)
|
|
|
|
reactor.callWhenRunning(run)
|
|
|
|
reactor.run()
|
|
|
|
|
|
def main() -> None:
|
|
parser = argparse.ArgumentParser(
|
|
description=(
|
|
"Updates a synapse database to the latest schema and optionally runs background updates"
|
|
" on it."
|
|
)
|
|
)
|
|
parser.add_argument("-v", action="store_true")
|
|
parser.add_argument(
|
|
"--database-config",
|
|
type=argparse.FileType("r"),
|
|
required=True,
|
|
help="Synapse configuration file, giving the details of the database to be updated",
|
|
)
|
|
parser.add_argument(
|
|
"--run-background-updates",
|
|
action="store_true",
|
|
required=False,
|
|
help="run background updates after upgrading the database schema",
|
|
)
|
|
|
|
args = parser.parse_args()
|
|
|
|
logging.basicConfig(
|
|
level=logging.DEBUG if args.v else logging.INFO,
|
|
format="%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(message)s",
|
|
)
|
|
|
|
# Load, process and sanity-check the config.
|
|
hs_config = yaml.safe_load(args.database_config)
|
|
|
|
config = HomeServerConfig()
|
|
config.parse_config_dict(hs_config, "", "")
|
|
|
|
# Instantiate and initialise the homeserver object.
|
|
hs = MockHomeserver(config)
|
|
|
|
# Setup instantiates the store within the homeserver object and updates the
|
|
# DB.
|
|
hs.setup()
|
|
|
|
if args.run_background_updates:
|
|
run_background_updates(hs)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|