Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

ref(measurements): Link to Relay MetricUnit and update wording [INGEST-1131] #573

Merged
merged 1 commit into from
May 3, 2022

Conversation

jan-auer
Copy link
Member

@jan-auer jan-auer commented May 3, 2022

Links to Relay's canonical MetricUnit documentation and updates the notice on custom units. Custom units are in fact supported in ingestion, but SDKs are encouraged not to expose them for the time being where possible. Also, there's now a range of information and fraction units in addition to durations.

This paragraph deliberately doesn't give SDK implementation advice since this document - like all payload docs - are more likely to be consumed by end users.

See getsentry/relay#1256

@jan-auer jan-auer self-assigned this May 3, 2022
@vercel
Copy link

vercel bot commented May 3, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
develop ✅ Ready (Inspect) Visit Preview May 3, 2022 at 6:18PM (UTC)

@@ -27,8 +27,7 @@ Standard measurement keys currently supported are from the following list taken
]
```

Custom measurements need units to be specified. Units currently supported are durations from the list `["ns" , "ms" , "s"]` taken from [here](https://github.com/getsentry/relay/blob/1e45a8817e45408ecbdbd3f0a679a5f5e4885290/relay-metrics/src/protocol.rs#L14-L21). Note that in the future we will extend the available units (for instance, memory units) but we will not implement a generic user-defined unit interface.

Custom measurements need units to be specified. The full list of supported units is specified on [Relay's `MetricUnit`](https://getsentry.github.io/relay/relay_metrics/enum.MetricUnit.html). Sentry's event ingestion supports arbitrary custom units, but many SDKs will not expose a generic user-defined unit interface.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll have to change the measurements json example below to use the full name for ms

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, updated!

@jan-auer jan-auer force-pushed the ref/custom-units-proto branch from 6dbbf97 to befde18 Compare May 3, 2022 18:16
@jan-auer jan-auer merged commit 82deb19 into master May 3, 2022
@jan-auer jan-auer deleted the ref/custom-units-proto branch May 3, 2022 18:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants