googleapis / googleapis/google-cloud-python

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

Aperta
#15,909 1 commento 0 reazioni 1 assegnatario Rivendicata da @c24t Vedi su GitHub
api: spanner
Lingua principale
Python
Stelle
5.4k
Fork
1.8k
Merge medio
3g 4h
PR unite (30g)
122

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.