|
| 1 | +# BSD 3-Clause License |
| 2 | +# |
| 3 | +# Copyright (c) 2022, Elasticsearch BV |
| 4 | +# All rights reserved. |
| 5 | +# |
| 6 | +# Redistribution and use in source and binary forms, with or without |
| 7 | +# modification, are permitted provided that the following conditions are met: |
| 8 | +# |
| 9 | +# * Redistributions of source code must retain the above copyright notice, this |
| 10 | +# list of conditions and the following disclaimer. |
| 11 | +# |
| 12 | +# * Redistributions in binary form must reproduce the above copyright notice, |
| 13 | +# this list of conditions and the following disclaimer in the documentation |
| 14 | +# and/or other materials provided with the distribution. |
| 15 | +# |
| 16 | +# * Neither the name of the copyright holder nor the names of its |
| 17 | +# contributors may be used to endorse or promote products derived from |
| 18 | +# this software without specific prior written permission. |
| 19 | +# |
| 20 | +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 21 | +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 22 | +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 23 | +# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
| 24 | +# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 25 | +# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| 26 | +# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| 27 | +# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| 28 | +# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 29 | +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 30 | + |
| 31 | +import logging |
| 32 | + |
| 33 | +from elasticapm.instrumentation.packages.base import AbstractInstrumentedModule |
| 34 | + |
| 35 | + |
| 36 | +class FlaskInstrumentation(AbstractInstrumentedModule): |
| 37 | + name = "flask" |
| 38 | + |
| 39 | + instrument_list = [("flask", "Flask.__init__")] |
| 40 | + |
| 41 | + creates_transactions = True |
| 42 | + |
| 43 | + def call(self, module, method, wrapped, instance, args, kwargs): |
| 44 | + from elasticapm.contrib.flask import ElasticAPM |
| 45 | + |
| 46 | + wrapped(*args, **kwargs) |
| 47 | + client = ElasticAPM(instance) |
| 48 | + instance.elasticapm_client = client |
| 49 | + self.instance = instance |
| 50 | + |
| 51 | + def uninstrument(self): |
| 52 | + """ |
| 53 | + This is mostly here for testing. If we want to support live |
| 54 | + instrumenting and uninstrumenting, we'll need to also extend the |
| 55 | + `instrument()` method to add the signals removed here. |
| 56 | + """ |
| 57 | + super().uninstrument() |
| 58 | + |
| 59 | + # Only remove signals during uninstrument if we auto-instrumented |
| 60 | + flask_app = getattr(self, "instance", None) |
| 61 | + if flask_app: |
| 62 | + client = flask_app.elasticapm_client |
| 63 | + from flask import signals |
| 64 | + |
| 65 | + signals.request_started.disconnect(client.request_started) |
| 66 | + signals.request_finished.disconnect(client.request_finished) |
| 67 | + # remove logging handler if it was added |
| 68 | + logger = logging.getLogger() |
| 69 | + for handler in list(logger.handlers): |
| 70 | + if getattr(handler, "client", None) is client.client: |
| 71 | + logger.removeHandler(handler) |
| 72 | + self.instance = None |
0 commit comments