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: add integration registry #13051

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Conversation

wconti27
Copy link
Contributor

@wconti27 wconti27 commented Apr 3, 2025

Description

This PR adds a registry for integrations, that for a start contains the name of the integration and the package dependency name. The PR also adds a whitelist for directories within ddtrace/contrib/internal that do not have an associated package, including internal python packages, the ddtrace api, and abstracted integrations like dbapi. The PR also adds a test to ensure that new integration directories cannot be added without being added to the registry or whitelist.

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

@wconti27 wconti27 requested review from a team as code owners April 3, 2025 17:28
Copy link
Contributor

github-actions bot commented Apr 3, 2025

CODEOWNERS have been resolved as:

.riot/requirements/145e80e.txt                                          @DataDog/apm-python
.riot/requirements/15eda63.txt                                          @DataDog/apm-python
.riot/requirements/18e0d52.txt                                          @DataDog/apm-python
.riot/requirements/1fc6c2b.txt                                          @DataDog/apm-python
.riot/requirements/2f38690.txt                                          @DataDog/apm-python
.riot/requirements/fb0ddd0.txt                                          @DataDog/apm-python
ddtrace/contrib/integration_registry/registry.csv                       @DataDog/apm-core-python @DataDog/apm-idm-python
ddtrace/contrib/integration_registry/whitelist.csv                      @DataDog/apm-core-python @DataDog/apm-idm-python
tests/contrib/test_registry.py                                          @DataDog/apm-core-python @DataDog/apm-idm-python
riotfile.py                                                             @DataDog/apm-python

Copy link
Contributor

github-actions bot commented Apr 3, 2025

Bootstrap import analysis

Comparison of import times between this PR and base.

Summary

The average import time from this PR is: 230 ± 3 ms.

The average import time from base is: 233 ± 2 ms.

The import time difference between this PR and base is: -2.7 ± 0.1 ms.

Import time breakdown

The following import paths have shrunk:

ddtrace.auto 2.071 ms (0.90%)
ddtrace.bootstrap.sitecustomize 1.400 ms (0.61%)
ddtrace.bootstrap.preload 1.400 ms (0.61%)
ddtrace.internal.products 1.400 ms (0.61%)
ddtrace.internal.remoteconfig.client 0.663 ms (0.29%)
ddtrace 0.671 ms (0.29%)

@wconti27 wconti27 marked this pull request as draft April 3, 2025 19:15
name = entry.get("integration_name", "UNKNOWN_ENTRY")
is_external = entry.get("is_external_package")

if is_external is True: # Only check external packages
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Quality Violation

Suggested change
if is_external is True: # Only check external packages
if is_external: # Only check external packages
do not make equal with true (...read more)

Do not use variable == True, just use variable. Comparing against True makes the code more complicated to read.

View in Datadog  Leave us feedback  Documentation

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.

1 participant