From 550d98cdf9a2da840f5cdd5d4efcb92da3da88e4 Mon Sep 17 00:00:00 2001 From: Neel Shah Date: Thu, 3 Mar 2022 18:34:25 +0100 Subject: [PATCH 1/5] feat(measurements): Add new measurements section to transaction --- .../event-payloads/properties/measurements.mdx | 18 ++++++++++++++++++ src/docs/sdk/event-payloads/transaction.mdx | 2 ++ 2 files changed, 20 insertions(+) create mode 100644 src/docs/sdk/event-payloads/properties/measurements.mdx diff --git a/src/docs/sdk/event-payloads/properties/measurements.mdx b/src/docs/sdk/event-payloads/properties/measurements.mdx new file mode 100644 index 0000000000..7da274d5cf --- /dev/null +++ b/src/docs/sdk/event-payloads/properties/measurements.mdx @@ -0,0 +1,18 @@ +`measurements` + +: _Optional_. An object containing standard/custom measurements with keys signifying the name of the measurement. + +Standard measurement keys currently supported are from the set `"fp" | "lcp" | "fid" | "ttfb" | "ttfb.requesttime"`. + +Custom measurements need units to be specified. Units currently supported are durations from the set `"ns" | "ms" | "s"`. + + +```json +{ + "measurements": { + "lcp": { "value": 100 }, + "fp": { "value": 123 }, + "my.custom.metric": { "value": 456, "unit": "ms" } + } +} +``` diff --git a/src/docs/sdk/event-payloads/transaction.mdx b/src/docs/sdk/event-payloads/transaction.mdx index 10534008ed..685e420938 100644 --- a/src/docs/sdk/event-payloads/transaction.mdx +++ b/src/docs/sdk/event-payloads/transaction.mdx @@ -61,3 +61,5 @@ import "./properties/status.mdx"; ``` import "./properties/spans.mdx"; + +import "./properties/measurements.mdx"; From 2633b1090e0eb4a6a476126e08226d411ed0dcfc Mon Sep 17 00:00:00 2001 From: Neel Shah Date: Thu, 3 Mar 2022 18:52:34 +0100 Subject: [PATCH 2/5] Add fcp and cls --- src/docs/sdk/event-payloads/properties/measurements.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sdk/event-payloads/properties/measurements.mdx b/src/docs/sdk/event-payloads/properties/measurements.mdx index 7da274d5cf..cd9595aad9 100644 --- a/src/docs/sdk/event-payloads/properties/measurements.mdx +++ b/src/docs/sdk/event-payloads/properties/measurements.mdx @@ -2,7 +2,7 @@ : _Optional_. An object containing standard/custom measurements with keys signifying the name of the measurement. -Standard measurement keys currently supported are from the set `"fp" | "lcp" | "fid" | "ttfb" | "ttfb.requesttime"`. +Standard measurement keys currently supported are from the set `"fp" | "fcp" | "lcp" | "cls" | "fid" | "ttfb" | "ttfb.requesttime"`. Custom measurements need units to be specified. Units currently supported are durations from the set `"ns" | "ms" | "s"`. From 99860985d076a107b582bba4c01820c3840a846a Mon Sep 17 00:00:00 2001 From: Neel Shah Date: Thu, 3 Mar 2022 19:10:05 +0100 Subject: [PATCH 3/5] Add mobile keys too; add github links --- .../properties/measurements.mdx | 29 +++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/src/docs/sdk/event-payloads/properties/measurements.mdx b/src/docs/sdk/event-payloads/properties/measurements.mdx index cd9595aad9..a6cb9ed0fb 100644 --- a/src/docs/sdk/event-payloads/properties/measurements.mdx +++ b/src/docs/sdk/event-payloads/properties/measurements.mdx @@ -2,9 +2,34 @@ : _Optional_. An object containing standard/custom measurements with keys signifying the name of the measurement. -Standard measurement keys currently supported are from the set `"fp" | "fcp" | "lcp" | "cls" | "fid" | "ttfb" | "ttfb.requesttime"`. +Standard measurement keys currently supported are from the following list taken from [here](https://github.com/getsentry/sentry/blob/a8c960a933d2ded5225841573d8fc426a482ca9c/static/app/utils/discover/fields.tsx#L654-L676). -Custom measurements need units to be specified. Units currently supported are durations from the set `"ns" | "ms" | "s"`. +```json +[ + // web + "fp", + "fcp", + "lcp", + "fid", + "cls", + "ttfb", + "ttfb.requesttime", + // mobile + "app_start_cold", + "app_start_warm", + "frames_total", + "frames_slow", + "frames_frozen", + "frames_slow_rate", + "frames_frozen_rate", + "stall_count", + "stall_total_time", + "stall_longest_time", + "stall_percentage" +] +``` + +Custom measurements need units to be specified. Units currently supported are durations from the set `"ns" | "ms" | "s"` taken from [here](https://github.com/getsentry/relay/blob/1e45a8817e45408ecbdbd3f0a679a5f5e4885290/relay-metrics/src/protocol.rs#L14-L21). ```json From 1b195d52ebcebfb493743d26f46b5d7508d9228c Mon Sep 17 00:00:00 2001 From: Neel Shah Date: Thu, 3 Mar 2022 19:11:48 +0100 Subject: [PATCH 4/5] List instead of set --- src/docs/sdk/event-payloads/properties/measurements.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sdk/event-payloads/properties/measurements.mdx b/src/docs/sdk/event-payloads/properties/measurements.mdx index a6cb9ed0fb..de6875f480 100644 --- a/src/docs/sdk/event-payloads/properties/measurements.mdx +++ b/src/docs/sdk/event-payloads/properties/measurements.mdx @@ -29,7 +29,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 set `"ns" | "ms" | "s"` taken from [here](https://github.com/getsentry/relay/blob/1e45a8817e45408ecbdbd3f0a679a5f5e4885290/relay-metrics/src/protocol.rs#L14-L21). +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). ```json From 8fe0a2de242603a022fa704bb1d652bc44a41e7b Mon Sep 17 00:00:00 2001 From: Neel Shah Date: Wed, 9 Mar 2022 13:40:08 +0100 Subject: [PATCH 5/5] Remove computed metrics and add future note about units --- src/docs/sdk/event-payloads/properties/measurements.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/src/docs/sdk/event-payloads/properties/measurements.mdx b/src/docs/sdk/event-payloads/properties/measurements.mdx index de6875f480..743ccaf84f 100644 --- a/src/docs/sdk/event-payloads/properties/measurements.mdx +++ b/src/docs/sdk/event-payloads/properties/measurements.mdx @@ -20,16 +20,14 @@ Standard measurement keys currently supported are from the following list taken "frames_total", "frames_slow", "frames_frozen", - "frames_slow_rate", - "frames_frozen_rate", + // react native "stall_count", "stall_total_time", - "stall_longest_time", - "stall_percentage" + "stall_longest_time" ] ``` -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). +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. ```json