summaryrefslogtreecommitdiff
path: root/osprofiler/sqlalchemy.py
blob: e33ed5ed2de08f4d493405f4581645f3a77047a9 (plain)
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
# Copyright 2014 Mirantis Inc.
# All Rights Reserved.
#
#    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 osprofiler import profiler


def before_execute(name):
    """Add listener that will send trace info before query is executed."""

    def handler(conn, clauseelement, multiparams, params):
        info = {"db.statement": str(clauseelement),
                "db.multiparams": str(multiparams),
                "db.params": str(params)}
        profiler.start(name, info=info)

    return handler


def after_execute():
    """Add listener that will send trace info after query is executed."""

    def handler(conn, clauseelement, multiparams, params, result):
        profiler.stop(info=None)

    return handler


_DISABLED = False


def disable():
    """add_tracing does not add event listeners for sqlalchemy.

    This is quite important in case of sql migrations. Because it's not allowed
    to add these events.
    """
    global _DISABLED
    _DISABLED = True


def enable():
    """add_tracing adds event listeners for sqlalchemy."""

    global _DISABLED
    _DISABLED = False


def add_tracing(sqlalchemy, engine, name):
    """Add tracing to all sqlalchemy calls."""

    if not _DISABLED:
        sqlalchemy.event.listen(engine, 'before_execute', before_execute(name))
        sqlalchemy.event.listen(engine, 'after_execute', after_execute())