mirror of
https://git.anonymousland.org/anonymousland/synapse-product.git
synced 2024-12-25 05:09:23 -05:00
105 lines
3.7 KiB
Python
105 lines
3.7 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.
|
|
|
|
from typing import Any, Optional
|
|
|
|
import attr
|
|
|
|
from synapse.types import JsonDict
|
|
from synapse.util.check_dependencies import 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: JsonDict, **kwargs: Any) -> None:
|
|
self.enable_metrics = config.get("enable_metrics", False)
|
|
|
|
"""
|
|
### `enable_legacy_metrics` (experimental)
|
|
|
|
**Experimental: this option may be removed or have its behaviour
|
|
changed at any time, with no notice.**
|
|
|
|
Set to `true` to publish both legacy and non-legacy Prometheus metric names,
|
|
or to `false` to only publish non-legacy Prometheus metric names.
|
|
Defaults to `true`. Has no effect if `enable_metrics` is `false`.
|
|
|
|
Legacy metric names include:
|
|
- metrics containing colons in the name, such as `synapse_util_caches_response_cache:hits`, because colons are supposed to be reserved for user-defined recording rules;
|
|
- counters that don't end with the `_total` suffix, such as `synapse_federation_client_sent_edus`, therefore not adhering to the OpenMetrics standard.
|
|
|
|
These legacy metric names are unconventional and not compliant with OpenMetrics standards.
|
|
They are included for backwards compatibility.
|
|
|
|
Example configuration:
|
|
```yaml
|
|
enable_legacy_metrics: false
|
|
```
|
|
|
|
See https://github.com/matrix-org/synapse/issues/11106 for context.
|
|
|
|
*Since v1.67.0.*
|
|
"""
|
|
self.enable_legacy_metrics = config.get("enable_legacy_metrics", True)
|
|
|
|
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:
|
|
check_requirements("sentry")
|
|
|
|
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: Optional[bool] = None, **kwargs: Any
|
|
) -> str:
|
|
if report_stats is not None:
|
|
res = "report_stats: %s\n" % ("true" if report_stats else "false")
|
|
else:
|
|
res = "\n"
|
|
return res
|