Make Falcon instrumentation compatible with Falcon >=3

[adriangb]

Replace falcon.api.Request -> falcon.Request which exists on both Falcon 2 & 3

Steps to reproduce:

1. Install Falcon >=3: pip install falcon==3.0.0
2. Run the docs: https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/falcon/falcon.html#usage

You'll get:

.../dist-packages/opentelemetry/instrumentation/falcon/__init__.py in <module>()
--> 129 _response_propagation_setter = FuncSetter(falcon.api.Response.append_header)
AttributeError: module 'falcon' has no attribute 'api'

And I verified that in Falcon >=3 falcon.api does not exit.

Also to note, falcon.API is being deprecated in favor of falcon.App. Not sure how you want to handle that. I reckon some version checks will be needed to support both Falcon 2 & 4.

[linux-foundation-easycla]

The committers are authorized under a signed CLA.

• ✅ Adrian Garcia Badaracco (d69fe14, 3609d8e, 96cabae, 73b5ff9)
• ✅ Owais Lone (79d7d7e)

[owais]

@adriangb Thanks for the PR. You'll also need to update the supported Falcon versions here:

opentelemetry-python-contrib/instrumentation/opentelemetry-instrumentation-falcon/src/opentelemetry/instrumentation/falcon/package.py

Line 16 in d69fe14

_instruments = ("falcon ~= 2.0",)

Also please sign the CLA and update the changelog.

[adriangb]

Thanks @owais . CLA link is giving me a 500, I opened a support ticket.

I edited the package and changelog. Will updating the package also run tests on 3.0?

[owais]

I edited the package and changelog. Will updating the package also run tests on 3.0?

No. You'll need to update the test matrix in tox.ini to do that.

[adriangb]

@owais CLA issue is fixed and signed, and I updated tox.ini, although I couldn't test locally because as per #444 the CONTRIBUTING.md instructions are broken. Can you please kick off CI?

[owais]

It is triggered automatically on every push. Looks like the falcon tests are failing.

[adriangb]

It is triggered automatically on every push.

Not if you're a first time contributor:

Looks like the falcon tests are failing.

I reverted the changes to tox.ini, there were version conflicts in the env. I guess I'll see if the current tests run or not (since I had not seen them run before because, as per above, workflows won't run for me)

I'd appreciate a bit more hands-on support here, the interdependency between the otel packages (api, sdk, core, contrib, etc.) and the packaging of the repo (monorepo, tox, etc.) compounded with broken contributing instructions make it a bit confusing for a first time contributor. It's taking a lot more work than I'd like to contribute a 1 line fix.

[adriangb]

@owais I saw you self assigned this. Will you be taking it over? I don't want us to duplicate work offline 😄

[owais]

@adriangb No, a PR assignee represents someone who has taken up the responsibility to review a PR and see it through. I don't intent to work on it :)

[adriangb]

Got it, thanks for clarifying. I'm going to pick this up again this week.

It does look like there's still some infrastructure / CI issues: I'm seeing failures in Celary tests and Linting timing out, which certainly aren't related to this change.

[owais]

We should update tox.ini to test multiple versions but not a blocker for me rigth now.

[adriangb]

Yep I was just waiting to see if the current failures would resolve before changing more stuff. Looks like the last run passed, so I'll try to put this change in again.