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

feat(botocore): add override service name to botocore integration [backport 2.10] #9894

Merged
merged 2 commits into from
Jul 23, 2024

Conversation

github-actions[bot]
Copy link
Contributor

Backport 2bb0c4b from #9856 to 2.10.

Motivation:

Currently traces in botocore derive their service name from the service and endpoint, ex. aws.s3 or aws.sqs, and there is no way to change the service name. Other integrations allow for changing the default service name either by setting environment variables, or configuring with config['service'] or config['service_name']. This PR adds support for these methods of overriding the service name, which allows individual traces to have custom service names.

Examples:

@mock_s3
ddtrace.config.botocore['service_name'] = "botocore" # this sets service name to botocore.s3
ddtrace.config.botocore['service'] = "boto-service" # this overrides previous and sets service name to boto-service.s3

export DD_BOTOCORE_SERVICE="boto" # this overrides previous settings and sets service & service name to boto.s3

Checklist

  • PR author has checked that all the criteria below are met
  • The PR description includes an overview of the change
  • The PR description articulates the motivation for the change
  • The change includes tests OR the PR description describes a testing strategy
  • The PR description notes risks associated with the change, if any
  • Newly-added code is easy to change
  • The change follows the library release note guidelines
  • The change includes or references documentation updates if necessary
  • Backport labels are set (if applicable)

Reviewer Checklist

  • Reviewer has checked that all the criteria below are met
  • Title is accurate
  • All changes are related to the pull request's stated goal
  • Avoids breaking API changes
  • Testing strategy adequately addresses listed risks
  • Newly-added code is easy to change
  • Release note makes sense to a user of the library
  • If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment
  • Backport labels are set in a manner that is consistent with the release branch maintenance policy

…9856)

Motivation:

Currently traces in botocore derive their service name from the service
and endpoint, ex. `aws.s3` or `aws.sqs`, and there is no way to change
the service name. Other integrations allow for changing the default
service name either by setting environment variables, or configuring
with `config['service']` or `config['service_name']`. This PR adds
support for these methods of overriding the service name, which allows
individual traces to have custom service names.

Examples:

```
@mock_s3
ddtrace.config.botocore['service_name'] = "botocore" # this sets service name to botocore.s3
ddtrace.config.botocore['service'] = "boto-service" # this overrides previous and sets service name to boto-service.s3
```

`export DD_BOTOCORE_SERVICE="boto" # this overrides previous settings
and sets service & service name to boto.s3
`
## Checklist
- [x] PR author has checked that all the criteria below are met
- The PR description includes an overview of the change
- The PR description articulates the motivation for the change
- The change includes tests OR the PR description describes a testing
strategy
- The PR description notes risks associated with the change, if any
- Newly-added code is easy to change
- The change follows the [library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
- The change includes or references documentation updates if necessary
- Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist
- [x] Reviewer has checked that all the criteria below are met
- Title is accurate
- All changes are related to the pull request's stated goal
- Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes
- Testing strategy adequately addresses listed risks
- Newly-added code is easy to change
- Release note makes sense to a user of the library
- If necessary, author has acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment
- Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

---------

Co-authored-by: Zachary Groves <[email protected]>
Co-authored-by: erikayasuda <[email protected]>
(cherry picked from commit 2bb0c4b)
@github-actions github-actions bot requested review from a team as code owners July 22, 2024 17:06
@datadog-dd-trace-py-rkomorn
Copy link

Datadog Report

Branch report: backport-9856-to-2.10
Commit report: c07e031
Test service: dd-trace-py

✅ 0 Failed, 963 Passed, 0 Skipped, 38m 33.27s Total duration (2m 42.09s time saved)

@pr-commenter
Copy link

pr-commenter bot commented Jul 22, 2024

Benchmarks

Benchmark execution time: 2024-07-22 17:47:01

Comparing candidate commit c07e031 in PR branch backport-9856-to-2.10 with baseline commit 378d5b7 in branch 2.10.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 185 metrics, 11 unstable metrics.

@quinna-h quinna-h enabled auto-merge (squash) July 23, 2024 17:17
@quinna-h quinna-h merged commit 28efa94 into 2.10 Jul 23, 2024
60 of 72 checks passed
@quinna-h quinna-h deleted the backport-9856-to-2.10 branch July 23, 2024 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants