Skip to content

added option to skip instrumenting specific modules via env variable #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

added option to skip instrumenting specific modules via env variable #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions elasticapm/instrumentation/packages/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import functools
import logging
import os

from elasticapm.traces import get_transaction
from elasticapm.utils import wrapt
Expand Down Expand Up @@ -169,6 +170,11 @@ def instrument(self):
if self.instrumented:
return

skip_env_var = 'SKIP_INSTRUMENT_' + str(self.name.upper())
if skip_env_var in os.environ:
logger.debug("Skipping instrumentation of %s. %s is set.",
self.name, skip_env_var)
return
try:
instrument_list = self.get_instrument_list()
skipped_modules = set()
Expand Down
8 changes: 8 additions & 0 deletions tests/instrumentation/base_tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# -*- coding: utf-8 -*-
import types

import mock
import pytest

from elasticapm.instrumentation.packages.base import (AbstractInstrumentedModule,
Expand Down Expand Up @@ -71,3 +72,10 @@ def test_uninstrument_py3():
instrumentation.uninstrument()
assert Dummy.dummy is original
assert not isinstance(Dummy.dummy, OriginalNamesBoundFunctionWrapper)


def test_skip_instrument_env_var():
instrumentation = _TestDummyInstrumentation()
with mock.patch.dict('os.environ', {'SKIP_INSTRUMENT_TEST_DUMMY_INSTRUMENT': 'foo'}):
instrumentation.instrument()
assert not instrumentation.instrumented