2019-07-11 11:36:03 +02: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 16:06:54 +02:00
|
|
|
opentracing_config = config.get("opentracing")
|
|
|
|
|
if opentracing_config is None:
|
|
|
|
|
opentracing_config = {}
|
2019-07-11 11:36:03 +02:00
|
|
|
|
2019-07-18 16:06:54 +02:00
|
|
|
self.opentracer_enabled = opentracing_config.get("enabled", False)
|
2019-07-23 16:46:04 +02:00
|
|
|
|
|
|
|
|
self.jaeger_config = opentracing_config.get(
|
|
|
|
|
"jaeger_config",
|
|
|
|
|
{"sampler": {"type": "const", "param": 1}, "logging": False},
|
|
|
|
|
)
|
|
|
|
|
|
2019-07-18 16:06:54 +02:00
|
|
|
if not self.opentracer_enabled:
|
|
|
|
|
return
|
2019-07-11 11:36:03 +02:00
|
|
|
|
2019-07-18 16:06:54 +02:00
|
|
|
# The tracer is enabled so sanitize the config
|
2019-07-11 11:36:03 +02:00
|
|
|
|
2019-07-18 16:06:54 +02: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 11:36:03 +02:00
|
|
|
|
|
|
|
|
def generate_config_section(cls, **kwargs):
|
|
|
|
|
return """\
|
|
|
|
|
## Opentracing ##
|
2019-07-18 16:06:54 +02: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.
|
2019-07-22 12:15:21 +02:00
|
|
|
# See docs/opentracing.rst
|
|
|
|
|
# This is a list of regexes which are matched against the server_name of the
|
2019-07-18 16:06:54 +02:00
|
|
|
# homeserver.
|
|
|
|
|
#
|
|
|
|
|
# By defult, it is empty, so no servers are matched.
|
|
|
|
|
#
|
|
|
|
|
#homeserver_whitelist:
|
|
|
|
|
# - ".*"
|
2019-07-23 16:46:04 +02:00
|
|
|
|
|
|
|
|
# Jaeger can be configured to sample traces at different rates.
|
|
|
|
|
# All configuration options provided by Jaeger can be set here.
|
|
|
|
|
# Jaeger's configuration mostly related to trace sampling which
|
|
|
|
|
# is documented here:
|
|
|
|
|
# https://www.jaegertracing.io/docs/1.13/sampling/.
|
|
|
|
|
#
|
|
|
|
|
#jaeger_config:
|
|
|
|
|
# sampler:
|
|
|
|
|
# type: const
|
|
|
|
|
# param: 1
|
|
|
|
|
|
|
|
|
|
# Logging whether spans were started and reported
|
|
|
|
|
#
|
|
|
|
|
# logging:
|
|
|
|
|
# false
|
2019-07-11 11:36:03 +02:00
|
|
|
"""
|
