mirror of
https://mau.dev/maunium/synapse.git
synced 2024-08-25 03:35:28 +00:00
![Jacek Kuśnierz](/assets/img/avatar_default.png)
Signed-off-by: Jacek Kusnierz <jacek.kusnierz@tum.de> Co-authored-by: Brendan Abolivier <babolivier@matrix.org>
65 lines
2.3 KiB
Python
65 lines
2.3 KiB
Python
# Copyright 2019 The Matrix.org Foundation C.I.C.d
|
|
#
|
|
# 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, List, Set
|
|
|
|
from synapse.types import JsonDict
|
|
from synapse.util.check_dependencies import check_requirements
|
|
|
|
from ._base import Config, ConfigError
|
|
|
|
|
|
class TracerConfig(Config):
|
|
section = "tracing"
|
|
|
|
def read_config(self, config: JsonDict, **kwargs: Any) -> None:
|
|
opentracing_config = config.get("opentracing")
|
|
if opentracing_config is None:
|
|
opentracing_config = {}
|
|
|
|
self.opentracer_enabled = opentracing_config.get("enabled", False)
|
|
|
|
self.jaeger_config = opentracing_config.get(
|
|
"jaeger_config",
|
|
{"sampler": {"type": "const", "param": 1}, "logging": False},
|
|
)
|
|
|
|
self.force_tracing_for_users: Set[str] = set()
|
|
|
|
if not self.opentracer_enabled:
|
|
return
|
|
|
|
check_requirements("opentracing")
|
|
|
|
# The tracer is enabled so sanitize the config
|
|
|
|
self.opentracer_whitelist: List[str] = opentracing_config.get(
|
|
"homeserver_whitelist", []
|
|
)
|
|
if not isinstance(self.opentracer_whitelist, list):
|
|
raise ConfigError("Tracer homeserver_whitelist config is malformed")
|
|
|
|
force_tracing_for_users = opentracing_config.get("force_tracing_for_users", [])
|
|
if not isinstance(force_tracing_for_users, list):
|
|
raise ConfigError(
|
|
"Expected a list", ("opentracing", "force_tracing_for_users")
|
|
)
|
|
for i, u in enumerate(force_tracing_for_users):
|
|
if not isinstance(u, str):
|
|
raise ConfigError(
|
|
"Expected a string",
|
|
("opentracing", "force_tracing_for_users", f"index {i}"),
|
|
)
|
|
self.force_tracing_for_users.add(u)
|