open-telemetry / open-telemetry/opentelemetry-python
Make logging API/SDK timeouts uniform before release
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.6k
- Forks
- 1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 19
Description
Before going stable, there's a chance to review and align the timeout values:
- In traces, export and flush timeouts default to 30 seconds, whereas in metrics they default to 10 seconds. In logging most places use 10, but one-two use 30 seconds instead. They should all get the same value.
- In some methods,
timeoutcan receive aNonevalue where in other places it can only get an int. Whatever decision is taken, all methods should align to that:
def force_flush(self, timeout_millis: int | None = None):
# VS
def force_flush(self, timeout_millis:int = None):
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the timeout definitions and method signatures across the traces, metrics, and logging API/SDK implementations. Compare the default values and whether timeout accepts None, then align the affected methods on one documented choice and verify that all signal implementations follow it before release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, observability
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100