Skip to content
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.

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

Improve falcon instrumentation examples #3370

Merged
merged 2 commits into from
Mar 21, 2025

Conversation

andremm
Copy link
Contributor

@andremm andremm commented Mar 17, 2025

Description

Some instrumentation examples inside falcon don't run. This PR fixes the examples, so they run. It also ports the usage example to the README.rst, which was missing.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

  1. Clone contrib repo: git clone https://github.com/open-telemetry/opentelemetry-python-contrib
  2. Clone OTel Python repo: git clone https://github.com/open-telemetry/opentelemetry-python
  3. Access the contrib repo: cd opentelemetry-python-contrib
  4. Create a virtual env: python3 -m venv otelvenv
  5. Activate the virtual env: source otelvenv/bin/activate
  6. Install common dependencies:
pip install opentelemetry-distro/ opentelemetry-instrumentation/ \
 ../opentelemetry-python/opentelemetry-semantic-conventions/ \
 ../opentelemetry-python/opentelemetry-api/ \
 ../opentelemetry-python/opentelemetry-sdk/ \
 ../opentelemetry-python/opentelemetry-proto/ \
 ../opentelemetry-python/exporter/opentelemetry-exporter-otlp-proto-common
  1. Install falcon specific requirements:
pip install -r instrumentation/opentelemetry-instrumentation-falcon/test-requirements.txt
  1. Copy the instrumentation examples inside the instrumentation main __init__.py file into different Python files and try to run them.

Does This PR Require a Core Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@xrmx xrmx added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Mar 17, 2025
@xrmx xrmx enabled auto-merge (squash) March 20, 2025 15:55
@xrmx xrmx merged commit 3c60b62 into open-telemetry:main Mar 21, 2025
712 checks passed
@andremm andremm deleted the falcon-snippet branch March 21, 2025 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants