googleapis / googleapis/google-cloud-python

tracing: avoid returning None if OpenTelemetry is not installed; instead return a custom noop-span

Đang mở
#15,909 1 bình luận 0 reaction 1 người được giao Được @c24t nhận Xem trên GitHub
api: spanner
Ngôn ngữ chính
Python
Star
5.4k
Fork
1.8k
Merge trung bình
3 ngày 4 giờ
Pull request đã merge (30 ngày)
122

Mô tả

Trying to uniformly instrument this library is really tricky in the case that OpenTelemetry is not installed.
Currently the code returns None in the case that the dependency wasn't imported.

Trying to invoke
```python
with trace_call('foo') as span:
if span:
# Add code
```

and then in other cases where we need to add span annotations firstly having to check if span is not None is awkward such as in https://github.com/googleapis/python-spanner/pull/1207
```python
if span is not None:
span.add_event(...)
```
we shouldn't labor ourselves with dependency implementation details which constitutes a leaky abstraction.

## Suggestion
Let's implement a NoopSpan class that'll be returned on every invocation if not installed and that should make it clean for this package to freely add events.

/cc @harshachinta @surbhigarg92

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.