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

Add more 2.x deprecation warnings #3647

Open
wants to merge 2 commits into
base: 1.x-stable
Choose a base branch
from

Conversation

delner
Copy link
Contributor

@delner delner commented May 14, 2024

What does this PR do?

Adds some more deprecation warnings for changes outlined in the upgrade guide. Includes:

  • Use of non-strings for 'env' configuration is deprecated. Use a string instead.
  • Use of non-strings for 'service' configuration is deprecated. Use a string instead.

Motivation:

To help users more easily through the 2.x upgrade process. These warnings should make it easier for users to identify breaking changes on existing 1.x deployments, and update their code in a 1.x/2.x compatible way, before undertaking a 2.x upgrade.

Additional Notes:

There are many changes in the upgrade guide. Some may be worth warning about, others may be more trouble than they are worth. I'm mostly focusing on actionable.

We also should be careful with how verbose some of these warnings could be, especially when they are in the instrumentation path (and could be triggered many times.) Perhaps we should add some more explicit "print once" behavior?

@delner delner added feature Involves a product feature deprecation Involves a deprecation 2.0 labels May 14, 2024
@delner delner added this to the 1.23.1 milestone May 14, 2024
@delner delner self-assigned this May 14, 2024
@github-actions github-actions bot added the core Involves Datadog core libraries label May 14, 2024
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.24%. Comparing base (cf264ae) to head (8f1430e).

Additional details and impacted files
@@             Coverage Diff             @@
##           1.x-stable    #3647   +/-   ##
===========================================
  Coverage       98.24%   98.24%           
===========================================
  Files            1255     1255           
  Lines           74651    74659    +8     
  Branches         3544     3548    +4     
===========================================
+ Hits            73342    73352   +10     
+ Misses           1309     1307    -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@delner delner force-pushed the delner/add_2x_deprecation_warnings branch from 8f1430e to 7ddccc5 Compare May 30, 2024 17:52
@delner
Copy link
Contributor Author

delner commented May 31, 2024

I'd like to rebase this on the changes implemented in #3675, so that these deprecation warnings can utilize the limit feature.

@TonyCTHsu TonyCTHsu removed this from the 1.23.1 milestone Jun 5, 2024
Copy link
Contributor

@p-datadog p-datadog left a comment

Choose a reason for hiding this comment

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

This LGTM

@delner delner force-pushed the delner/add_2x_deprecation_warnings branch from 7ddccc5 to 4b44893 Compare July 11, 2024 18:55
@delner
Copy link
Contributor Author

delner commented Jul 11, 2024

I've rebased the changes on top of the "log limit" functionality backported via #3780. This should prevent verbosity on the configuration path.

We could go further with changes here, but I think I want to stop here for now; I need to move onto other changes, and want to get this merged before it gets either too large or stale.

Should be ready for review.

@delner delner marked this pull request as ready for review July 11, 2024 18:58
@delner delner requested a review from a team as a code owner July 11, 2024 18:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.0 core Involves Datadog core libraries deprecation Involves a deprecation feature Involves a product feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants