Skip to content

Document what the wire format drops: NaN/infinite values, None tags and blank names #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmccoystephenson merged 3 commits into from
Oct 24, 2026
Merged

Document what the wire format drops: NaN/infinite values, None tags and blank names #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e404c0
Document what the wire format drops: NaN/infinite values, None tags a…
dmccoystephenson Oct 24, 2026
1aae4f0
Say the report() docstring leaves a bad value out of the event, not t…
dmccoystephenson Oct 24, 2026
999871a
Re-run CI on the docstring rewording
dmccoystephenson Oct 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,8 +148,11 @@ There is no PyPI package yet; the file is the distribution.
{"application":"roam","name":"command","value":1.0,"tags":{"name":"home","version":"1.4.0"}}
```

`value` is omitted when not given; `tags` always holds at least `version`, and
`install` when the client has an [installation ID](#every-event-carries-a-random-installation-id). The server assigns the
`value` is omitted when not given, and when it is NaN or infinite (JSON has no
such numbers); `tags` always holds at least `version`, and
`install` when the client has an [installation ID](#every-event-carries-a-random-installation-id). A tag whose
key or value is `None` is left out, and every other key and value is sent as a
string. An event with a blank `name` is not sent at all. The server assigns the
timestamp. A `201` is success; anything else is logged at `DEBUG` and dropped.

## Keys
Expand Down
4 changes: 3 additions & 1 deletion trace_client/trace_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,9 @@ def enabled(self) -> bool:
def report(self, name: str, value: Optional[float] = None,
tags: Optional[Mapping[str, str]] = None) -> None:
"""Report that ``name`` happened, with an optional numeric value and
optional string tags. Returns immediately; see the class docstring."""
optional string tags. Returns immediately; see the class docstring.
A blank ``name`` sends nothing. A NaN or infinite ``value``, and any
tag whose key or value is ``None``, is left out of the event."""
if self._queue is None:
return
try:
Expand Down
Loading