Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix: validate opentelemetry span job attributes have values #1327

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.

Sign up for GitHub

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

Merged
shollyman merged 4 commits into from
Aug 29, 2022
Merged

fix: validate opentelemetry span job attributes have values #1327

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54758d5
fix(bigquery): sanity check opentelemetry span attributes for jobs
shollyman Aug 25, 2022
6838d0c
add unit test for validating values
shollyman Aug 25, 2022
fd0809c
iterate by values
shollyman Aug 25, 2022
bdf59fd
cover/linting
shollyman Aug 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions google/cloud/bigquery/opentelemetry_tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,7 @@ def _set_client_attributes(client):
def _set_job_attributes(job_ref):
job_attributes = {
"db.name": job_ref.project,
"location": job_ref.location,
"num_child_jobs": job_ref.num_child_jobs,
"job_id": job_ref.job_id,
"parent_job_id": job_ref.parent_job_id,
"state": job_ref.state,
}

Expand All @@ -125,4 +122,13 @@ def _set_job_attributes(job_ref):
if job_ref.ended is not None:
job_attributes["timeEnded"] = job_ref.ended.isoformat()

if job_ref.location is not None:
job_attributes["location"] = job_ref.location

if job_ref.parent_job_id is not None:
job_attributes["parent_job_id"] = job_ref.parent_job_id

if job_ref.num_child_jobs is not None:
job_attributes["num_child_jobs"] = job_ref.num_child_jobs

return job_attributes
26 changes: 26 additions & 0 deletions tests/unit/test_opentelemetry_tracing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,32 @@ def test_default_job_attributes(setup):
assert span.attributes == expected_attributes


@pytest.mark.skipif(opentelemetry is None, reason="Require `opentelemetry`")
def test_optional_job_attributes(setup):
# This test ensures we don't propagate unset values into span attributes
import google.cloud._helpers

time_created = datetime.datetime(
2010, 5, 19, 16, 0, 0, tzinfo=google.cloud._helpers.UTC
)

with mock.patch("google.cloud.bigquery.job._AsyncJob") as test_job_ref:
test_job_ref.job_id = "test_job_id"
test_job_ref.location = None
test_job_ref.project = "test_project_id"
test_job_ref.created = time_created
test_job_ref.state = "some_job_state"
test_job_ref.num_child_jobs = None
test_job_ref.parent_job_id = None

with opentelemetry_tracing.create_span(
TEST_SPAN_NAME, attributes=TEST_SPAN_ATTRIBUTES, job_ref=test_job_ref
) as span:
assert span is not None
for val in span.attributes.values():
assert val is not None


@pytest.mark.skipif(opentelemetry is None, reason="Require `opentelemetry`")
def test_default_no_data_leakage(setup):
import google.auth.credentials
Expand Down