mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-01 01:36:05 -04:00
313581e4e9
* Pull runtime dep checks into their own module * Reimplement `check_requirements` using `importlib` I've tried to make this clearer. We start by working out which of Synapse's requirements we need to be installed here and now. I was surprised that there wasn't an easier way to see which packages were installed by a given extra. I've pulled out the error messages into functions that deal with "is this for an extra or not". And I've rearranged the loop over two different sets of requirements into one loop with a "must be instaled" flag. I hope you agree that this is clearer. * Test cases
114 lines
4.0 KiB
Python
114 lines
4.0 KiB
Python
# Copyright 2015, 2016 OpenMarket Ltd
|
|
# Copyright 2019 The Matrix.org Foundation C.I.C.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import attr
|
|
|
|
from synapse.util.check_dependencies import DependencyException, check_requirements
|
|
|
|
from ._base import Config, ConfigError
|
|
|
|
|
|
@attr.s
|
|
class MetricsFlags:
|
|
known_servers: bool = attr.ib(
|
|
default=False, validator=attr.validators.instance_of(bool)
|
|
)
|
|
|
|
@classmethod
|
|
def all_off(cls) -> "MetricsFlags":
|
|
"""
|
|
Instantiate the flags with all options set to off.
|
|
"""
|
|
return cls(**{x.name: False for x in attr.fields(cls)})
|
|
|
|
|
|
class MetricsConfig(Config):
|
|
section = "metrics"
|
|
|
|
def read_config(self, config, **kwargs):
|
|
self.enable_metrics = config.get("enable_metrics", False)
|
|
self.report_stats = config.get("report_stats", None)
|
|
self.report_stats_endpoint = config.get(
|
|
"report_stats_endpoint", "https://matrix.org/report-usage-stats/push"
|
|
)
|
|
self.metrics_port = config.get("metrics_port")
|
|
self.metrics_bind_host = config.get("metrics_bind_host", "127.0.0.1")
|
|
|
|
if self.enable_metrics:
|
|
_metrics_config = config.get("metrics_flags") or {}
|
|
self.metrics_flags = MetricsFlags(**_metrics_config)
|
|
else:
|
|
self.metrics_flags = MetricsFlags.all_off()
|
|
|
|
self.sentry_enabled = "sentry" in config
|
|
if self.sentry_enabled:
|
|
try:
|
|
check_requirements("sentry")
|
|
except DependencyException as e:
|
|
raise ConfigError(
|
|
e.message # noqa: B306, DependencyException.message is a property
|
|
)
|
|
|
|
self.sentry_dsn = config["sentry"].get("dsn")
|
|
if not self.sentry_dsn:
|
|
raise ConfigError(
|
|
"sentry.dsn field is required when sentry integration is enabled"
|
|
)
|
|
|
|
def generate_config_section(self, report_stats=None, **kwargs):
|
|
res = """\
|
|
## Metrics ###
|
|
|
|
# Enable collection and rendering of performance metrics
|
|
#
|
|
#enable_metrics: false
|
|
|
|
# Enable sentry integration
|
|
# NOTE: While attempts are made to ensure that the logs don't contain
|
|
# any sensitive information, this cannot be guaranteed. By enabling
|
|
# this option the sentry server may therefore receive sensitive
|
|
# information, and it in turn may then diseminate sensitive information
|
|
# through insecure notification channels if so configured.
|
|
#
|
|
#sentry:
|
|
# dsn: "..."
|
|
|
|
# Flags to enable Prometheus metrics which are not suitable to be
|
|
# enabled by default, either for performance reasons or limited use.
|
|
#
|
|
metrics_flags:
|
|
# Publish synapse_federation_known_servers, a gauge of the number of
|
|
# servers this homeserver knows about, including itself. May cause
|
|
# performance problems on large homeservers.
|
|
#
|
|
#known_servers: true
|
|
|
|
# Whether or not to report anonymized homeserver usage statistics.
|
|
#
|
|
"""
|
|
|
|
if report_stats is None:
|
|
res += "#report_stats: true|false\n"
|
|
else:
|
|
res += "report_stats: %s\n" % ("true" if report_stats else "false")
|
|
|
|
res += """
|
|
# The endpoint to report the anonymized homeserver usage statistics to.
|
|
# Defaults to https://matrix.org/report-usage-stats/push
|
|
#
|
|
#report_stats_endpoint: https://example.com/report-usage-stats/push
|
|
"""
|
|
return res
|