googleapis / googleapis/google-cloud-python

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

Aberta
#15,909 1 comentário 0 reações 1 responsável Reivindicada por @c24t Ver no GitHub
api: spanner
Linguagem predominante
Python
Estrelas
5.4k
Forks
1.8k
Merge médio
2d 23h
PRs com merge (30d)
123

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.