summary refs log tree commit diff
path: root/synapse/util/metrics.py
blob: 059bb7fedf56e31b3b2075fca61501ae68247a79 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# -*- coding: utf-8 -*-
# Copyright 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 twisted.internet import defer

from synapse.util.logcontext import LoggingContext
import synapse.metrics

from functools import wraps
import logging


logger = logging.getLogger(__name__)


metrics = synapse.metrics.get_metrics_for(__name__)

# total number of times we have hit this block
response_count = metrics.register_counter(
    "block_count",
    labels=["block_name"],
    alternative_names=(
        # the following are all deprecated aliases for the same metric
        metrics.name_prefix + x for x in (
            "_block_timer:count",
            "_block_ru_utime:count",
            "_block_ru_stime:count",
            "_block_db_txn_count:count",
            "_block_db_txn_duration:count",
        )
    )
)

block_timer = metrics.register_counter(
    "block_time_seconds",
    labels=["block_name"],
    alternative_names=(
        metrics.name_prefix + "_block_timer:total",
    ),
)

block_ru_utime = metrics.register_counter(
    "block_ru_utime_seconds", labels=["block_name"],
    alternative_names=(
        metrics.name_prefix + "_block_ru_utime:total",
    ),
)

block_ru_stime = metrics.register_counter(
    "block_ru_stime_seconds", labels=["block_name"],
    alternative_names=(
        metrics.name_prefix + "_block_ru_stime:total",
    ),
)

block_db_txn_count = metrics.register_counter(
    "block_db_txn_count", labels=["block_name"],
    alternative_names=(
        metrics.name_prefix + "_block_db_txn_count:total",
    ),
)

# seconds spent waiting for db txns, excluding scheduling time, in this block
block_db_txn_duration = metrics.register_counter(
    "block_db_txn_duration_seconds", labels=["block_name"],
    alternative_names=(
        metrics.name_prefix + "_block_db_txn_count:total",
    ),
)

# seconds spent waiting for a db connection, in this block
block_db_sched_duration = metrics.register_counter(
    "block_db_sched_duration_seconds", labels=["block_name"],
)


def measure_func(name):
    def wrapper(func):
        @wraps(func)
        @defer.inlineCallbacks
        def measured_func(self, *args, **kwargs):
            with Measure(self.clock, name):
                r = yield func(self, *args, **kwargs)
            defer.returnValue(r)
        return measured_func
    return wrapper


class Measure(object):
    __slots__ = [
        "clock", "name", "start_context", "start", "new_context", "ru_utime",
        "ru_stime",
        "db_txn_count", "db_txn_duration_ms", "db_sched_duration_ms",
        "created_context",
    ]

    def __init__(self, clock, name):
        self.clock = clock
        self.name = name
        self.start_context = None
        self.start = None
        self.created_context = False

    def __enter__(self):
        self.start = self.clock.time_msec()
        self.start_context = LoggingContext.current_context()
        if not self.start_context:
            self.start_context = LoggingContext("Measure")
            self.start_context.__enter__()
            self.created_context = True

        self.ru_utime, self.ru_stime = self.start_context.get_resource_usage()
        self.db_txn_count = self.start_context.db_txn_count
        self.db_txn_duration_ms = self.start_context.db_txn_duration_ms
        self.db_sched_duration_ms = self.start_context.db_sched_duration_ms

    def __exit__(self, exc_type, exc_val, exc_tb):
        if isinstance(exc_type, Exception) or not self.start_context:
            return

        duration = self.clock.time_msec() - self.start
        block_timer.inc_by(duration, self.name)

        context = LoggingContext.current_context()

        if context != self.start_context:
            logger.warn(
                "Context has unexpectedly changed from '%s' to '%s'. (%r)",
                self.start_context, context, self.name
            )
            return

        if not context:
            logger.warn("Expected context. (%r)", self.name)
            return

        ru_utime, ru_stime = context.get_resource_usage()

        block_ru_utime.inc_by(ru_utime - self.ru_utime, self.name)
        block_ru_stime.inc_by(ru_stime - self.ru_stime, self.name)
        block_db_txn_count.inc_by(
            context.db_txn_count - self.db_txn_count, self.name
        )
        block_db_txn_duration.inc_by(
            (context.db_txn_duration_ms - self.db_txn_duration_ms) / 1000.,
            self.name
        )
        block_db_sched_duration.inc_by(
            (context.db_sched_duration_ms - self.db_sched_duration_ms) / 1000.,
            self.name
        )

        if self.created_context:
            self.start_context.__exit__(exc_type, exc_val, exc_tb)