Ambiguous unit in queue latency
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Open the Python SDK queue instrumentation page at the linked documentation URL and inspect the consumer instrumentation table alongside its code example. Update the latency description to use seconds and identify the value as a float, then verify the rendered documentation is consistent with the example.
Written by the indexing model from the issue text.
Description
SDK
Python SDK
Description
Looking at the page https://docs.sentry.io/platforms/python/tracing/instrumentation/custom-instrumentation/queues-module/ there is an ambiguity about the unit of messaging.message.receive.latency.
In the table under "consumer instrumentation", we read:
Data Attribute Type Description messaging.message.receive.latencynumber The time in milliseconds that a message awaited processing in queue
(emphasis mine)
However, in the code example, we see
now = datetime.now(timezone.utc) message_time = datetime.fromtimestamp(message["timestamp"], timezone.utc) latency = now - message_time
this computation returns a float value in seconds.
Looking at my own instrumented system, I think seconds is correct.
Suggested Solution
Change the description the table to read “seconds” instead of “milliseconds”. I would also include that it's a float, not an int.
- Dominant language
- MDX
- Stars
- 446
- Forks
- 1.7k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 312
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.
More from getsentry/sentry-docs
-
Docs Platform: Android SDKs
Difficulty 1/5 Under an hour Newbie friendliness 95/100
getsentry/sentry-docs#19438 · 1 comment ·
-
Docs Platform: Python SDKs
Difficulty 1/5 Under an hour Newbie friendliness 92/100
getsentry/sentry-docs#19432 · 2 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
getsentry/sentry-docs#19347 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
getsentry/sentry-docs#19182 · 1 comment ·
-
Docs Good First Issue Platform: PHP SDKs
Difficulty 1/5 Under an hour Newbie friendliness 90/100
getsentry/sentry-docs#19177 · 2 comments ·
All issues in getsentry/sentry-docs
Similar issues
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·