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

chore(docs): clarify gunicorn/gevent documentation #5251

Closed
wants to merge 1 commit into from

Conversation

Yun-Kim
Copy link
Contributor

@Yun-Kim Yun-Kim commented Mar 2, 2023

We've had a bit of confusion with our recent changes to our gunicorn documentation (#5228, #5248). This PR clarifies the gunicorn documentation and changelog to make it clear for users that ddtrace-run supports Gunicorn when not being run with Gunicorn's gevent worker type.

This should fix #5248.

Checklist

  • Change(s) are motivated and described in the PR description.
  • Testing strategy is described if automated tests are not included in the PR.
  • Risk is outlined (performance impact, potential for breakage, maintainability, etc).
  • Change is maintainable (easy to change, telemetry, documentation).
  • Library release note guidelines are followed.
  • Documentation is included (in-code, generated user docs, public corp docs).
  • Author is aware of the performance implications of this PR as reported in the benchmarks PR comment.

Reviewer Checklist

  • Title is accurate.
  • No unnecessary changes are introduced.
  • Description motivates each change.
  • Avoids breaking API changes unless absolutely necessary.
  • Testing strategy adequately addresses listed risk(s).
  • Change is maintainable (easy to change, telemetry, documentation).
  • Release note makes sense to a user of the library.
  • Reviewer is aware of, and discussed the performance implications of this PR as reported in the benchmarks PR comment.

@Yun-Kim Yun-Kim requested review from a team as code owners March 2, 2023 16:34
@Yun-Kim Yun-Kim added the changelog/no-changelog A changelog entry is not required for this PR. label Mar 2, 2023
emmettbutler
emmettbutler previously approved these changes Mar 2, 2023
@pr-commenter
Copy link

pr-commenter bot commented Mar 2, 2023

Benchmarks

Comparing candidate commit c5da033 in PR branch yunkim/clarify-gunicorn with baseline commit 58017b1 in branch 1.x.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 56 cases.

@Yun-Kim
Copy link
Contributor Author

Yun-Kim commented Mar 3, 2023

Closing as #5105 has made this obsolete.

@Yun-Kim Yun-Kim closed this Mar 3, 2023
@Yun-Kim Yun-Kim deleted the yunkim/clarify-gunicorn branch April 4, 2023 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog A changelog entry is not required for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unclear docs around dd-trace-py and gunicorn
2 participants