NotificationsYou must be signed in to change notification settings
Fork321
Star786

fix: use debug logging level for OpenTelemetry message#442

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

tswast merged 5 commits intogoogleapis:masterfromtswast:issue441-telemetry-warning

Jan 11, 2021

Merged

fix: use debug logging level for OpenTelemetry message#442

tswast merged 5 commits intogoogleapis:masterfromtswast:issue441-telemetry-warning

Jan 11, 2021

Conversation

Copy link

Contributor

tswast commentedDec 21, 2020

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open an issue as abug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Fixes#441 🦕

fix: use debug logging level for OpenTelemetry message

dc39d0f

tswast requested review froma team andsteffnay and removed request fora team

December 21, 2020 15:26

google-clabot added the cla: yesThis human has signed the Contributor License Agreement. label

Dec 21, 2020

product-auto-labelbot added the api: bigqueryIssues related to the googleapis/python-bigquery API. label

Dec 21, 2020

tswast mentioned this pull request

Dec 21, 2020

Too noise logging about telemetry#441

Closed

tswast added2 commits

December 21, 2020 09:45

only warn at span creation time

5cc4e72

add unit test for skipping warning

43636f1

Copy link

ContributorAuthor

tswast commentedDec 21, 2020

Updated based onapache/airflow#13131 to not warn at import time.

mik-laj approved these changes

Dec 28, 2020

View reviewed changes

tswast requested a review fromshollyman

January 6, 2021 23:05

shollyman approved these changes

Jan 6, 2021

View reviewed changes

plamut reviewed

Jan 7, 2021

View reviewed changes

Copy link

Contributor

plamut left a comment

Choose a reason for hiding this comment

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

I agree that the warning should not be issued at import time, but instead when trying to actually use BigQuery (discussion).

DEBUG level is probably indeed better, asopentelemetry is not used by default (it's listed under extras), thus shouldn't bother users that don't choose to install it.

We should choose a different name for the flag, though, IMHO.

google/cloud/bigquery/opentelemetry_tracing.py Outdated

		"add opentelemetry-api and opentelemetry-instrumentation "
		"packages in order to get BigQuery Tracing data."
		)
		WARNED_OPENTELEMETRY=True

Copy link

Contributor

Choose a reason for hiding this comment

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

(nit) It's a bit unexpected to change a "constant", perhaps rename it? Also, since it's an internal state-keeping flag that users should neither know about nor modify it, we should probably mark it as such (e.g._warned_telemetry)