MatrixSynapse/synapse/config/metrics.py

70 lines
2.5 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
2016-01-07 05:26:29 +01:00
# Copyright 2015, 2016 OpenMarket Ltd
#
# 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 ._base import Config, ConfigError
2019-06-20 11:32:02 +02:00
MISSING_SENTRY = """Missing sentry-sdk library. This is required to enable sentry
integration.
"""
class MetricsConfig(Config):
def read_config(self, config, **kwargs):
self.enable_metrics = config.get("enable_metrics", False)
self.report_stats = config.get("report_stats", None)
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-02-12 14:55:58 +01:00
self.sentry_enabled = "sentry" in config
if self.sentry_enabled:
try:
import sentry_sdk # noqa F401
except ImportError:
raise ConfigError(MISSING_SENTRY)
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 default_config(self, report_stats=None, **kwargs):
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
# 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")
return res