Skip to content

Latest commit

 

History

History
347 lines (249 loc) · 21.6 KB

CONTRIBUTING.md

File metadata and controls

347 lines (249 loc) · 21.6 KB
Raw

Contributing to opentelemetry-python-contrib

The Python special interest group (SIG) meets regularly. See the OpenTelemetry community repo for information on this and other language SIGs.

See the public meeting notes for a summary description of past meetings. To request edit access, join the meeting or get in touch on Slack.

See to the community membership document on how to become a Member, Approver and Maintainer.

Before you can contribute, you will need to sign the Contributor License Agreement.

Please also read the OpenTelemetry Contributor Guide.

Index

Find a Buddy and get Started Quickly

If you are looking for someone to help you find a starting point and be a resource for your first contribution, join our Slack and find a buddy!

  1. Join Slack and join our chat room.
  2. Post in the room with an introduction to yourself, what area you are interested in (check issues marked "Help Wanted"), and say you are looking for a buddy. We will match you with someone who has experience in that area.

Your OpenTelemetry buddy is your resource to talk to directly on all aspects of contributing to OpenTelemetry: providing context, reviewing PRs, and helping those get merged. Buddies will not be available 24/7, but is committed to responding during their normal contribution hours.

Development

This project uses tox to automate some aspects of development, including testing against multiple Python versions. To install tox, run:

pip install tox

You can run tox with the following arguments:

  • tox to run all existing tox commands, including unit tests for all packages under multiple Python versions
  • tox -e docs to regenerate all docs
  • tox -e py312-test-instrumentation-aiopg to e.g. run the aiopg instrumentation unit tests under a specific Python version
  • tox -e spellcheck to run a spellcheck on all the code
  • tox -e lint-some-package to run lint checks on some-package
  • tox -e generate-workflows to run creation of new CI workflows if tox environments have been updated
  • tox -e ruff to run ruff linter and formatter checks against the entire codebase

ruff check and ruff format are executed when tox -e ruff is run. We strongly recommend you to configure pre-commit locally to run ruff automatically before each commit by installing it as git hooks. You just need to install pre-commit in your environment:

pip install pre-commit -c dev-requirements.txt

and run this command inside the git repository:

pre-commit install

See tox.ini for more detail on available tox commands.

Troubleshooting

Some packages may require additional system-wide dependencies to be installed. For example, you may need to install libpq-dev to run the postgresql client libraries instrumentation tests or libsnappy-dev to run the prometheus exporter tests. If you encounter a build error, please check the installation instructions for the package you are trying to run tests for.

For docs building, you may need to install mysql-client and other required dependencies as necessary. Ensure the Python version used in your local setup matches the version used in the CI to maintain compatibility when building the documentation.

Benchmarks

Some packages have benchmark tests. To run them, run tox -f benchmark. Benchmark tests use pytest-benchmark and they output a table with results to the console.

To write benchmarks, simply use the pytest benchmark fixture like the following:

def test_simple_start_span(benchmark):
    def benchmark_start_as_current_span(span_name, attribute_num):
        span = tracer.start_span(
            span_name,
            attributes={"count": attribute_num},
        )
        span.end()

    benchmark(benchmark_start_as_current_span, "benchmarkedSpan", 42)

Make sure the test file is under the benchmarks/ folder of the package it is benchmarking and further has a path that corresponds to the file in the package it is testing. Make sure that the file name begins with test_benchmark_. (e.g. propagator/opentelemetry-propagator-aws-xray/benchmarks/trace/propagation/test_benchmark_aws_xray_propagator.py)

Pull Requests

How to Send Pull Requests

Everyone is welcome to contribute code to opentelemetry-python-contrib via GitHub pull requests (PRs).

To create a new PR, fork the project in GitHub and clone the upstream repo:

git clone https://github.com/open-telemetry/opentelemetry-python-contrib.git
cd opentelemetry-python-contrib

Add your fork as an origin:

git remote add fork https://github.com/YOUR_GITHUB_USERNAME/opentelemetry-python-contrib.git

make sure you have all supported versions of Python installed, install tox only for the first time:

pip install tox

Run tests in the root of the repository (this will run all tox environments and may take some time):

tox

Check out a new branch, make modifications and push the branch to your fork:

git checkout -b feature

After you edit the files, stage changes in the current directory:

git add .

Then run the following to commit the changes:

git commit
git push fork feature

Open a pull request against the main opentelemetry-python-contrib repo.

How to Receive Comments

  • If the PR is not ready for review, please put [WIP] in the title, tag it as work-in-progress, or mark it as draft.
  • Make sure tests and lint are passing locally before requesting a review.
  • Make sure CLA is signed and CI is clear.

How to Get PRs Reviewed

The maintainers and approvers of this repo are not experts in every instrumentation there is here. In fact each one of us knows enough about them to only review a few. Unfortunately it can be hard to find enough experts in every instrumentation to quickly review every instrumentation PR. The instrumentation experts are listed in .github/component_owners.yml with their corresponding files or directories that they own. The owners listed there will be notified when PRs that modify their files are opened.

If you are not getting reviews, please contact the respective owners directly.

How to Get PRs Merged

A PR is considered to be ready to merge when:

  • It has received two approvals from Approvers / Maintainers (at different companies).
  • Major feedbacks are resolved.
  • It has been open for review for at least one working day. This gives people reasonable time to review.
  • Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day.
  • Urgent fix can take exception as long as it has been actively communicated.
  • A changelog entry is added to the corresponding changelog for the code base, if there is any impact on behavior. e.g. doc entries are not required, but small bug entries are.

Any Approver / Maintainer can merge the PR once it is ready to merge.

Design Choices

As with other OpenTelemetry clients, opentelemetry-python follows the opentelemetry-specification.

It's especially valuable to read through the library guidelines.

Focus on Capabilities, Not Structure Compliance

OpenTelemetry is an evolving specification, one where the desires and use cases are clear, but the method to satisfy those uses cases are not.

As such, contributions should provide functionality and behavior that conforms to the specification, but the interface and structure is flexible.

It is preferable to have contributions follow the idioms of the language rather than conform to specific API names or argument patterns in the spec.

For a deeper discussion, see: open-telemetry/opentelemetry-specification#165

Running Tests Locally

  1. Go to your Contrib repo directory. git clone [email protected]:open-telemetry/opentelemetry-python-contrib.git && cd opentelemetry-python-contrib.
  2. Make sure you have tox installed. pip install tox.
  3. Run tox without any arguments to run tests for all the packages. Read more about tox.

Some tests can be slow due to pre-steps that do dependencies installs. To help with that, you can run tox a first time, and after that run the tests using previous installed dependencies in toxdir as following:

  1. First time run (e.g., opentelemetry-instrumentation-aiopg)
tox -e py312-test-instrumentation-aiopg
  1. Run tests again without pre-steps:
.tox/py312-test-instrumentation-aiopg/bin/pytest instrumentation/opentelemetry-instrumentation-aiopg

Testing against a different Core repo branch/commit

Some of the tox targets install packages from the OpenTelemetry Python Core Repository via pip. The version of the packages installed defaults to the main branch in that repository when tox is run locally. It is possible to install packages tagged with a specific git commit hash by setting an environment variable before running tox as per the following example:

CORE_REPO_SHA=c49ad57bfe35cfc69bfa863d74058ca9bec55fc3 tox

The continuous integration overrides that environment variable with as per the configuration here.

Style Guide

Guideline for instrumentations

Below is a checklist of things to be mindful of when implementing a new instrumentation or working on a specific instrumentation. It is one of our goals as a community to keep the implementation specific details of instrumentations as similar across the board as possible for ease of testing and feature parity. It is also good to abstract as much common functionality as possible.

Update supported instrumentation package versions

  • Navigate to the instrumentation package directory:
    • Update pyproject.toml file by modifying instruments entry in the [project.optional-dependencies] section with the new version constraint
    • Update _instruments variable in instrumentation package.py file with the new version constraint
  • At the root of the project directory, run tox -e generate to regenerate necessary files

If you're adding support for a new version of the instrumentation package, follow these additional steps:

  • At the instrumentation package directory: Add new test-requirements.txt file with the respective package version required for testing
  • At the root of the project directory: Add a new test environment entry for the package version in tox.ini and run tox -e generate-workflows to regenerate new workflows accordingly. In the same tox.ini file, search for opentelemetry-instrumentation-{package}/test-requirements and add a new line to point to the new test-requirements.txt you created in the previous step so tox can install the correct requirements.

Example PRs: #2976, #2845

Guideline for GenAI instrumentations

Instrumentations that relate to Generative AI systems will be placed in the instrumentation-genai folder. This section covers contributions related to those instrumentations. Please note that the guidelines for instrumentations and expectations from contributors still apply.

Get Involved

  • Reviewing PRs: If you would like to be tagged as reviewer in new PRs related to these instrumentations, please submit a PR to add your GitHub handle to component_owners.yml under the corresponding instrumentation folder(s).

  • Approving PRs: If you would like to be able to approve PRs related to these instrumentations, you must join opentelemetry-python-contrib-approvers team. Please ask one of the Python contrib maintainers to be accepted into the team.

  • Tracking and Creating Issues: For tracking issues related to Generative AI, please filter or add the label gen-ai when creating or searching issues. If you do not see an issue related to an instrumentation you would like to contribute to, please create a new tracking issue so the community is aware of its progress.

Expectations from contributors

OpenTelemetry is an open source community, and as such, greatly encourages contributions from anyone interested in the project. With that being said, there is a certain level of expectation from contributors even after a pull request is merged, specifically pertaining to instrumentations. The OpenTelemetry Python community expects contributors to maintain a level of support and interest in the instrumentations they contribute. This is to ensure that the instrumentation does not become stale and still functions the way the original contributor intended. Some instrumentations also pertain to libraries that the current members of the community are not so familiar with, so it is necessary to rely on the expertise of the original contributing parties.

Updating supported Python versions

Bumping the Python baseline

When updating the minimum supported Python version remember to:

  • Remove the version in pyproject.toml trove classifiers
  • Remove the version from tox.ini
  • Update github workflows accordingly with tox -e generate-workflows
  • Search for sys.version_info usage and remove code for unsupported versions
  • Bump py-version in .pylintrc for Python version dependent checks

Adding support for a new Python release

When adding support for a new Python release remember to:

  • Add the version in tox.ini
  • Add the version in pyproject.toml trove classifiers
  • Update github workflows accordingly with tox -e generate-workflows; lint and benchmarks use the latest supported version
  • Update .pre-commit-config.yaml
  • Update tox examples in the documentation