Support all OTEL keys for instrument suppression

[jlondonobo]

Add support for all OTEL keys for instrument suppression.

This PR adds support for the following keys:

• "suppress_instrumentation"
• _SUPPRESS_INSTRUMENTATION_KEY

[adriangb]

Why not use (and fix / expand if necessary) https://github.com/open-telemetry/opentelemetry-python-contrib/blob/f8758c6902ed725864ff677f739829aa6bce2078/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py#L188-L192?

[alexmojaki]

Some parts of OTEL still use the plain 'suppress_instrumentation' key, so we need to check/set that too, as you said in #135 (comment).

We could maybe upstream a fix to OTEL to consistently use one key, but we need this to also work for older OTEL versions.

[adriangb]

We should fix as much of OTEL as we can to make sure it both sets and respects all keys. But yes the unfortunate reality is that both us and OTEL will have to set and check for any keys ever used.

[adriangb]

@alexmojaki before you merge this could you address this comment? I'd like to understand why we can't just use the OTEL function or if we can't because it is missing some functionality I'd like to know that there is a plan to upstream it and then replace our function with theirs or something like that.

[alexmojaki]

But yes the unfortunate reality is that both us and OTEL will have to set and check for any keys ever used.

I thought we were already in agreement. Similarly, the OTEL util function is somewhat recent, I'd like to not reduce compatibility with older OTEL versions. We especially can't rely on a future version.

[alexmojaki]

Opened open-telemetry/opentelemetry-python-contrib#2543

[adriangb]

Great so to make sure I understand we agree that OTEL needs to make some changes that will make future versions work correctly because we do not want to bump our minimum version we are going to do the fixes by exposing our own utility functions.

Will our utility functions be able to to just point to the open telemetry ones in the future?

[alexmojaki]

Will our utility functions be able to to just point to the open telemetry ones in the future?

Sure, although I think it'll be some time before we decide we don't need a fallback for older OTEL versions.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[alexmojaki]

In https://pydanticlogfire.slack.com/archives/C06EDRBSAH3/p1714658053546979 a user essentially requested the suppress_instrumentation function, so I've made it public here.

This PR fixes #135 in the sense that those particular urllib3 logs don't get sent to logfire. They are now logged by the fallback handler of LogfireLoggingHandler which logs to stderr by default. After this, I want to add a snippet like the following to the docs showing how to filter those logs if the noise in the console is still annoying:

import logging
import time
from logging import DEBUG, basicConfig, getLogger

from logfire.integrations.logging import LogfireLoggingHandler

logfire_handler = LogfireLoggingHandler()

# Don't write to stderr the urllib3 debug logs created while exporting traces
urllib3_filter = logging.Filter('urllib3')
logfire_handler.fallback.addFilter(lambda record: not urllib3_filter.filter(record))

basicConfig(handlers=[logfire_handler], level=DEBUG)

logger = getLogger(__name__)

for _ in range(1000):
    logger.info('log')
    time.sleep(0.6)

[alexmojaki]

Thanks @jlondonobo for your help, your changes were pretty much exactly what was needed!