feat: Suppress internal spans by default

[jterapin]

#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]

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]

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.

[github-actions]

👋 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]

👋 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

[arielvalentin]

@kaylareopelle I realize this is a common pattern we have in the code base already but I would recommend we look into refactoring cases like this where we create separate mixins for "untraced" instead of evaluating this logic with every request.

[arielvalentin]

How are we providing backward compatability for the deprecated option?

Is it not supposed to work at all?

[jterapin]

Well - this configuration handling was more trickier than i thought.....

The main challenge is that configuration hashes always contain default values, which makes it difficult to identify which settings were explicitly set by users.

I tried to solve this by removing the :suppress_internal_instrumentation option completely to detect user config, but discovered that unrecognized settings aren't passed through to the install block.

Then, I realized that users would only want to touch this setting to suppress internal traces- which happens to be the default behavior anyway. Any thoughts on mitigating this?

[arielvalentin]

Then I suppose it can be a breaking change there. We would need to call out in the release notes that the option is no longer available.