MatrixSynapse/synapse/config/metrics.py

119 lines
4.1 KiB
Python
Raw Normal View History

2016-01-07 05:26:29 +01:00
# Copyright 2015, 2016 OpenMarket Ltd
2019-09-06 17:45:51 +02:00
# 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.
from typing import Any, Optional
2019-09-06 17:45:51 +02:00
import attr
from synapse.types import JsonDict
from synapse.util.check_dependencies import DependencyException, check_requirements
from ._base import Config, ConfigError
2019-09-06 17:45:51 +02:00
@attr.s
2020-09-04 12:54:56 +02:00
class MetricsFlags:
known_servers: bool = attr.ib(
default=False, validator=attr.validators.instance_of(bool)
)
2019-09-06 17:45:51 +02:00
@classmethod
def all_off(cls) -> "MetricsFlags":
2019-09-06 17:45:51 +02:00
"""
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: JsonDict, **kwargs: Any) -> None:
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"
)
2015-04-30 18:52:20 +02:00
self.metrics_port = config.get("metrics_port")
2015-05-22 15:51:22 +02:00
self.metrics_bind_host = config.get("metrics_bind_host", "127.0.0.1")
2019-09-06 17:45:51 +02: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 14:55:58 +01:00
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
)
2019-02-18 17:53:56 +01:00
self.sentry_dsn = config["sentry"].get("dsn")
if not self.sentry_dsn:
raise ConfigError(
2019-06-20 11:32:02 +02:00
"sentry.dsn field is required when sentry integration is enabled"
2019-02-18 17:53:56 +01:00
)
2019-02-12 14:55:58 +01:00
def generate_config_section(
self, report_stats: Optional[bool] = None, **kwargs: Any
) -> str:
res = """\
## Metrics ###
# Enable collection and rendering of performance metrics
#
#enable_metrics: false
2019-02-12 14:55:58 +01:00
2019-02-13 17:14:37 +01:00
# 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.
#
2019-02-12 14:55:58 +01:00
#sentry:
# dsn: "..."
2019-02-20 14:21:44 +01:00
2019-09-06 17:45:51 +02:00
# 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
2019-09-06 17:45:51 +02:00
# servers this homeserver knows about, including itself. May cause
# performance problems on large homeservers.
#
#known_servers: true
2019-02-20 14:21:44 +01:00
# Whether or not to report anonymized homeserver usage statistics.
#
"""
if report_stats is None:
res += "#report_stats: true|false\n"
else:
2019-06-20 11:32:02 +02:00
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