2015-02-24 14:30:14 +00:00
|
|
|
#
|
2023-11-21 20:29:58 +00:00
|
|
|
# This file is licensed under the Affero General Public License (AGPL) version 3.
|
|
|
|
#
|
|
|
|
# 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]
|
2015-02-24 14:30:14 +00:00
|
|
|
#
|
|
|
|
#
|
|
|
|
|
2022-04-11 16:07:23 +00:00
|
|
|
from typing import Any, Optional
|
|
|
|
|
2019-09-06 15:45:51 +00:00
|
|
|
import attr
|
|
|
|
|
2022-04-11 16:07:23 +00:00
|
|
|
from synapse.types import JsonDict
|
2022-06-30 17:48:04 +00:00
|
|
|
from synapse.util.check_dependencies import check_requirements
|
2019-02-12 16:01:41 +00:00
|
|
|
|
2019-09-11 13:00:37 +00:00
|
|
|
from ._base import Config, ConfigError
|
2015-02-24 14:30:14 +00:00
|
|
|
|
|
|
|
|
2019-09-06 15:45:51 +00:00
|
|
|
@attr.s
|
2020-09-04 10:54:56 +00:00
|
|
|
class MetricsFlags:
|
2021-12-09 16:15:46 +00:00
|
|
|
known_servers: bool = attr.ib(
|
|
|
|
default=False, validator=attr.validators.instance_of(bool)
|
|
|
|
)
|
2019-09-06 15:45:51 +00:00
|
|
|
|
|
|
|
@classmethod
|
2021-12-09 16:15:46 +00:00
|
|
|
def all_off(cls) -> "MetricsFlags":
|
2019-09-06 15:45:51 +00:00
|
|
|
"""
|
|
|
|
Instantiate the flags with all options set to off.
|
|
|
|
"""
|
|
|
|
return cls(**{x.name: False for x in attr.fields(cls)})
|
|
|
|
|
|
|
|
|
2015-02-24 14:30:14 +00:00
|
|
|
class MetricsConfig(Config):
|
2019-10-10 08:39:35 +00:00
|
|
|
section = "metrics"
|
|
|
|
|
2022-04-11 16:07:23 +00:00
|
|
|
def read_config(self, config: JsonDict, **kwargs: Any) -> None:
|
2019-03-19 10:06:40 +00:00
|
|
|
self.enable_metrics = config.get("enable_metrics", False)
|
2022-08-24 11:35:54 +00:00
|
|
|
|
2015-09-22 11:57:40 +00:00
|
|
|
self.report_stats = config.get("report_stats", None)
|
2019-09-12 10:24:57 +00:00
|
|
|
self.report_stats_endpoint = config.get(
|
|
|
|
"report_stats_endpoint", "https://matrix.org/report-usage-stats/push"
|
|
|
|
)
|
2015-04-30 16:52:20 +00:00
|
|
|
self.metrics_port = config.get("metrics_port")
|
2015-05-22 13:51:22 +00:00
|
|
|
self.metrics_bind_host = config.get("metrics_bind_host", "127.0.0.1")
|
2015-02-24 14:30:14 +00:00
|
|
|
|
2019-09-06 15:45:51 +00:00
|
|
|
if self.enable_metrics:
|
|
|
|
_metrics_config = config.get("metrics_flags") or {}
|
|
|
|
self.metrics_flags = MetricsFlags(**_metrics_config)
|
|
|
|
else:
|
|
|
|
self.metrics_flags = MetricsFlags.all_off()
|
|
|
|
|
2019-02-12 13:55:58 +00:00
|
|
|
self.sentry_enabled = "sentry" in config
|
|
|
|
if self.sentry_enabled:
|
2022-06-30 17:48:04 +00:00
|
|
|
check_requirements("sentry")
|
2019-02-12 16:01:41 +00:00
|
|
|
|
2019-02-18 16:53:56 +00:00
|
|
|
self.sentry_dsn = config["sentry"].get("dsn")
|
|
|
|
if not self.sentry_dsn:
|
|
|
|
raise ConfigError(
|
|
|
|
"sentry.dsn field is required when sentry integration is enabled"
|
|
|
|
)
|
2019-02-12 13:55:58 +00:00
|
|
|
|
2022-04-11 16:07:23 +00:00
|
|
|
def generate_config_section(
|
|
|
|
self, report_stats: Optional[bool] = None, **kwargs: Any
|
|
|
|
) -> str:
|
2022-06-14 14:53:42 +00:00
|
|
|
if report_stats is not None:
|
|
|
|
res = "report_stats: %s\n" % ("true" if report_stats else "false")
|
2018-12-21 15:04:57 +00:00
|
|
|
else:
|
2022-06-14 14:53:42 +00:00
|
|
|
res = "\n"
|
2018-12-21 15:04:57 +00:00
|
|
|
return res
|