Skip to content

feat: Suppress internal spans by default #1533

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

jterapin
Copy link
Contributor

#1502

Description: The aws_sdk instrumentation now suppresses internal spans by default. This ensures that the additional low-level instrumentation does not generate additional costs for customers unknowingly.

The following work has been done to accommodate:

  • Deprecated :suppress_internal_instrumentation config
  • Introduced a new config, :enable_internal_instrumentation which is set false by default

To enable internal spans, users will have explicitly configure as follows:

OpenTelemetry::SDK.configure do |c|
  c.use 'OpenTelemetry::Instrumentation::AwsSdk', { enable_internal_instrumentation: true }
end

@ericmustin
Copy link
Contributor

Was this or the related Issue discussed at a SIG? seems like i'm missing some context, at the very least I have some ambivalence about multiple config options that do the same thing.

@jterapin
Copy link
Contributor Author

Was this or the related Issue discussed at a SIG? seems like i'm missing some context, at the very least I have some ambivalence about multiple config options that do the same thing.

I have not attended SIG so most likely not.

This PR drops the :suppress_internal_instrumentation config entirely in a favor of :enable_internal_instrumentation since the config name is quite explanatory of its default behavior. That being said - I'm fine with just reusing the old config but flipping the config default.

Comment on lines +41 to +42
* `:suppress_internal_instrumentation`: **Deprecated**. This configuration has been
deprecated in a favor of `:enable_internal_instrumentation`
Copy link
Collaborator

Choose a reason for hiding this comment

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

It looks like you are removing this option altogether resulting in a breaking change.

If you want to treat it as deprecated, as opposed to removed, I would recommend leaving the option present and giving precedence to the new option.

Copy link
Contributor

👋 This pull request has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this pull request will be closed eventually by the stale bot

@github-actions github-actions bot added the stale Marks an issue/PR stale label Jun 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Marks an issue/PR stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants