2019-07-11 05:36:03 -04:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
|
# 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 ._base import Config, ConfigError
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class TracerConfig(Config):
|
|
|
|
|
def read_config(self, config, **kwargs):
|
2019-07-18 10:06:54 -04:00
|
|
|
opentracing_config = config.get("opentracing")
|
|
|
|
|
if opentracing_config is None:
|
|
|
|
|
opentracing_config = {}
|
2019-07-11 05:36:03 -04:00
|
|
|
|
2019-07-18 10:06:54 -04:00
|
|
|
self.opentracer_enabled = opentracing_config.get("enabled", False)
|
|
|
|
|
if not self.opentracer_enabled:
|
|
|
|
|
return
|
2019-07-11 05:36:03 -04:00
|
|
|
|
2019-07-18 10:06:54 -04:00
|
|
|
# The tracer is enabled so sanitize the config
|
2019-07-11 05:36:03 -04:00
|
|
|
|
2019-07-18 10:06:54 -04:00
|
|
|
self.opentracer_whitelist = opentracing_config.get("homeserver_whitelist", [])
|
|
|
|
|
if not isinstance(self.opentracer_whitelist, list):
|
|
|
|
|
raise ConfigError("Tracer homeserver_whitelist config is malformed")
|
2019-07-11 05:36:03 -04:00
|
|
|
|
|
|
|
|
def generate_config_section(cls, **kwargs):
|
|
|
|
|
return """\
|
|
|
|
|
## Opentracing ##
|
2019-07-18 10:06:54 -04:00
|
|
|
|
|
|
|
|
# These settings enable opentracing, which implements distributed tracing.
|
|
|
|
|
# This allows you to observe the causal chains of events across servers
|
|
|
|
|
# including requests, key lookups etc., across any server running
|
|
|
|
|
# synapse or any other other services which supports opentracing
|
|
|
|
|
# (specifically those implemented with Jaeger).
|
|
|
|
|
#
|
|
|
|
|
opentracing:
|
|
|
|
|
# tracing is disabled by default. Uncomment the following line to enable it.
|
|
|
|
|
#
|
|
|
|
|
#enabled: true
|
|
|
|
|
|
|
|
|
|
# The list of homeservers we wish to send and receive span contexts and span baggage.
|
|
|
|
|
#
|
|
|
|
|
# Though it's mostly safe to send and receive span contexts to and from
|
|
|
|
|
# untrusted users since span contexts are usually opaque ids it can lead to
|
|
|
|
|
# two problems, namely:
|
|
|
|
|
# - If the span context is marked as sampled by the sending homeserver the receiver will
|
|
|
|
|
# sample it. Therefore two homeservers with wildly disparaging sampling policies
|
|
|
|
|
# could incur higher sampling counts than intended.
|
|
|
|
|
# - Span baggage can be arbitrary data. For safety this has been disabled in synapse
|
|
|
|
|
# but that doesn't prevent another server sending you baggage which will be logged
|
|
|
|
|
# to opentracing logs.
|
|
|
|
|
#
|
|
|
|
|
# This a list of regexes which are matched against the server_name of the
|
|
|
|
|
# homeserver.
|
|
|
|
|
#
|
|
|
|
|
# By defult, it is empty, so no servers are matched.
|
|
|
|
|
#
|
|
|
|
|
#homeserver_whitelist:
|
|
|
|
|
# - ".*"
|
2019-07-11 05:36:03 -04:00
|
|
|
"""
|
