[WIP] Wrapper script #1709

basepi · 2022-12-12T19:35:25Z

What does this pull request do?

Adds the wrapper script to automate instrumentation without code changes.

Also adds support for no-code-changes instrumentation in Flask, plus a bunch of test fixes around that.

Related issues

Closes #1019
Closes #1598

apmmachine · 2022-12-12T19:54:48Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2023-01-25T19:55:40.355+0000
Duration: 19 min 33 sec

Test stats 🧪

Test	Results
Failed	0
Passed	5081
Skipped	3679
Total	8760

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.
/test linters : Run the Python linters only.
/test full : Run the full matrix of tests.
/test benchmark : Run the APM Agent Python benchmarks tests.
run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

apmmachine · 2022-12-12T20:03:06Z

🌐 Coverage report

Name	Metrics % (`covered/total`)	Diff
Packages	100.0% (`73/73`)	💚
Files	100.0% (`241/241`)	💚
Classes	100.0% (`241/241`)	💚
Lines	91.927% (`18754/20401`)	👎 -0.146
Conditionals	75.046% (`2884/3843`)	👎 -0.118

It's causing some other failures. Tests pass by themselves so it's something related to cleanup on that new test, I think

basepi · 2023-01-11T19:13:57Z

setup.cfg

@@ -163,6 +168,7 @@ markers =
    aiobotocore
    kafka
    grpc
+addopts=--random-order


I added this while debugging the test failures on the old flask tests. I think we should leave it on, to try to prevent adding any tests that rely on order.

basepi · 2023-01-12T17:39:08Z

tests/client/transaction_tests.py

@@ -445,7 +445,7 @@ def test_backdating_transaction(elasticapm_client):
    elasticapm_client.begin_transaction("test", start=time.time() - 1)
    elasticapm_client.end_transaction()
    transaction = elasticapm_client.events[constants.TRANSACTION][0]
-    assert 1000 < transaction["duration"] < 2000
+    assert 900 < transaction["duration"] < 2000


This was a windows failure:

[2023-01-11T19:42:05.004Z] elasticapm_client = <tests.fixtures.TempStoreClient object at 0x0000018EBF6B4188> [2023-01-11T19:42:05.004Z] [2023-01-11T19:42:05.004Z] def test_backdating_transaction(elasticapm_client): [2023-01-11T19:42:05.004Z] elasticapm_client.begin_transaction("test", start=time.time() - 1) [2023-01-11T19:42:05.004Z] elasticapm_client.end_transaction() [2023-01-11T19:42:05.004Z] transaction = elasticapm_client.events[constants.TRANSACTION][0] [2023-01-11T19:42:05.004Z] > assert 1000 < transaction["duration"] < 2000 [2023-01-11T19:42:05.004Z] E assert 1000 < 999.971 [2023-01-11T19:42:05.004Z] [2023-01-11T19:42:05.004Z] tests\client\transaction_tests.py:448: AssertionError

I assume it's a side effect of --random-order....or maybe it's a clock issue on the VM? I don't know. I just added some wiggle room.

beniwohli

Great work!

docs/wrapper.asciidoc

elasticapm/instrumentation/register.py

docs/wrapper.asciidoc

beniwohli

Just one little nitpick, otherwise 👍 . Great work!

elasticapm/instrumentation/register.py

basepi added 4 commits December 12, 2022 12:27

Add wrapper script and sitecustomize.py

5750d03

Add inline config

208402a

Add automated test for wrapper script

81d1f43

Simplify wrapper test

95e016e

github-actions bot added the agent-python label Dec 12, 2022

basepi added 2 commits December 12, 2022 12:48

Add entry_points to setup.cfg

9a95086

Disable wrapper test on Windows

8dc0237

basepi added 3 commits December 13, 2022 11:17

Fix missing import

aa51a02

Remove testwrapper.py and call the wrapper script directly

4eabe80

Update copyright year

78f9b1f

basepi mentioned this pull request Dec 14, 2022

Python apm agent doesn't captured spans in aws lambda functions #1711

Closed

basepi added 14 commits December 15, 2022 15:51

Set activation_method for wrapper script

58c52cc

Add activation_method to the wrapper test

273e74d

Add Flask instrumentation

4d7ba5b

Add flask instrumentation to register

64e0239

Target the instance, rather than the return value

009d758

Add a test for Flask auto-instrumentation

651826c

It's causing some other failures. Tests pass by themselves so it's something related to cleanup on that new test, I think

Move the uninstrument behavior to the instrumentation

1839932

Merge remote-tracking branch 'upstream/main' into wrapper

6d176dd

Fix newly-flakey tests + pytest random order

7fcbc4d

Fix test that was leaving things instrumented

d9117b3

Add pytest-random-order to test reqs

69ef31a

Modify new flask test to ensure fixture order

3875d5c

Even better cleanup on test_framework_name

ca73d0e

Fix always_uninstrument() fixture failures

1549085

basepi force-pushed the wrapper branch from d398cf8 to 1549085 Compare January 11, 2023 19:13

basepi commented Jan 11, 2023

View reviewed changes

basepi added 2 commits January 11, 2023 12:28

Late-import flask ElasticAPM object

58855a5

Fix some more random_order test failures

5e580f6

basepi force-pushed the wrapper branch from d42477d to 5e580f6 Compare January 12, 2023 17:37

basepi commented Jan 12, 2023

View reviewed changes

Add docs

8869483

basepi marked this pull request as ready for review January 13, 2023 17:25

basepi requested a review from beniwohli January 13, 2023 17:25

basepi added 2 commits January 13, 2023 11:39

Merge branch 'main' into wrapper

e375ba5

Fix a typo

e257b14

beniwohli reviewed Jan 17, 2023

View reviewed changes

docs/wrapper.asciidoc Outdated Show resolved Hide resolved

elasticapm/instrumentation/register.py Outdated Show resolved Hide resolved

docs/wrapper.asciidoc Outdated Show resolved Hide resolved

basepi added 2 commits January 18, 2023 10:58

Use __main__ to make python -m cleaner

ca08d64

Merge remote-tracking branch 'upstream/main' into wrapper

83eba9d

basepi force-pushed the wrapper branch from 131cfc1 to 83eba9d Compare January 18, 2023 17:59

Create separate instrumentation register for wrapper script

ab689f8

basepi requested a review from beniwohli January 18, 2023 19:17

beniwohli approved these changes Jan 24, 2023

View reviewed changes

elasticapm/instrumentation/register.py Outdated Show resolved Hide resolved

Rename register_wrapper to register_wrapper_instrumentations

f2ed315

basepi enabled auto-merge (squash) January 25, 2023 18:04

basepi merged commit 7b2de88 into elastic:main Jan 25, 2023

basepi mentioned this pull request Mar 21, 2023

Add wrapper instrumentation for Django #1780

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Wrapper script #1709

[WIP] Wrapper script #1709

basepi commented Dec 12, 2022 •

edited

Loading

apmmachine commented Dec 12, 2022 •

edited

Loading

Build stats

Test stats 🧪

apmmachine commented Dec 12, 2022 •

edited

Loading

basepi Jan 11, 2023

basepi Jan 12, 2023 •

edited

Loading

beniwohli left a comment

beniwohli left a comment

[WIP] Wrapper script #1709

[WIP] Wrapper script #1709

Conversation

basepi commented Dec 12, 2022 • edited Loading

What does this pull request do?

Related issues

apmmachine commented Dec 12, 2022 • edited Loading

💚 Build Succeeded

Build stats

Test stats 🧪

💚 Flaky test report

🤖 GitHub comments

apmmachine commented Dec 12, 2022 • edited Loading

🌐 Coverage report

basepi Jan 11, 2023

Choose a reason for hiding this comment

basepi Jan 12, 2023 • edited Loading

Choose a reason for hiding this comment

beniwohli left a comment

Choose a reason for hiding this comment

beniwohli left a comment

Choose a reason for hiding this comment

basepi commented Dec 12, 2022 •

edited

Loading

apmmachine commented Dec 12, 2022 •

edited

Loading

apmmachine commented Dec 12, 2022 •

edited

Loading

basepi Jan 12, 2023 •

edited

Loading