From cc4dbbe878e6a3562447d07e9bff3413f7704e32 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Fri, 12 Apr 2024 15:29:27 +0200 Subject: [PATCH 1/4] adds user-agent format --- src/docs/sdk/overview.mdx | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/docs/sdk/overview.mdx b/src/docs/sdk/overview.mdx index c1995fbc0e..eae471df75 100644 --- a/src/docs/sdk/overview.mdx +++ b/src/docs/sdk/overview.mdx @@ -215,6 +215,7 @@ We recommend always sending the following headers: - `content-type` - `content-length` +- `user-agent` The following additional headers are permitted as per CORS policy: @@ -229,6 +230,24 @@ The following additional headers are permitted as per CORS policy: - `content-encoding` - `transfer-encoding` +### User Agent + +All SDKs are expected to report their name and version via the `user-agent` header. +The following format should be used (unless required or recommended differently by the platform, +e.g. for browser SDKs): + +`{sdk-name}/{sdk-version}` + +Additional information about the runtime, operating system, and others can be +appended as comments in parentheses, like so: + +`{sdk-name}/{sdk-version} ({runtime-name} {runtime-version}; {os-name} {os-version})` + +There is no expectation towards the presence or order of fields. The user agent +must not contain PII or otherwise sensitive data. In general it should not contain +any information that is not already present in the payload. + + ## Request Compression SDKs are heavily encouraged to compress the request body before sending it to From 78685e1b0f8dbcdfce612734a694d22541408d63 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Sat, 13 Apr 2024 10:57:23 +0200 Subject: [PATCH 2/4] adds info about semicolon separator --- src/docs/sdk/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sdk/overview.mdx b/src/docs/sdk/overview.mdx index eae471df75..22e12b2a1d 100644 --- a/src/docs/sdk/overview.mdx +++ b/src/docs/sdk/overview.mdx @@ -239,7 +239,7 @@ e.g. for browser SDKs): `{sdk-name}/{sdk-version}` Additional information about the runtime, operating system, and others can be -appended as comments in parentheses, like so: +appended as comments in parentheses, separated by `; ` (semicolon and space), like so: `{sdk-name}/{sdk-version} ({runtime-name} {runtime-version}; {os-name} {os-version})` From 5f016a1960f7c8ee34e720ee863a789362c76545 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Tue, 16 Apr 2024 13:49:42 +0200 Subject: [PATCH 3/4] adds examples for basic user agent --- src/docs/sdk/overview.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/docs/sdk/overview.mdx b/src/docs/sdk/overview.mdx index 22e12b2a1d..827acc18f3 100644 --- a/src/docs/sdk/overview.mdx +++ b/src/docs/sdk/overview.mdx @@ -238,6 +238,12 @@ e.g. for browser SDKs): `{sdk-name}/{sdk-version}` +For example: +- `sentry.python/1.45.0` +- `sentry.php/4.7.0` +- `sentry-ruby/5.17.3` +- `sentry.cocoa/8.24.0` + Additional information about the runtime, operating system, and others can be appended as comments in parentheses, separated by `; ` (semicolon and space), like so: From 01e53ec4b1a3819c09ea814f64c08d9ea57912e4 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Tue, 16 Apr 2024 05:41:18 -0700 Subject: [PATCH 4/4] Update src/docs/sdk/overview.mdx Co-authored-by: Joris Bayer --- src/docs/sdk/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs/sdk/overview.mdx b/src/docs/sdk/overview.mdx index 827acc18f3..247fc92d48 100644 --- a/src/docs/sdk/overview.mdx +++ b/src/docs/sdk/overview.mdx @@ -234,7 +234,7 @@ The following additional headers are permitted as per CORS policy: All SDKs are expected to report their name and version via the `user-agent` header. The following format should be used (unless required or recommended differently by the platform, -e.g. for browser SDKs): +e.g. for browser SDKs, where the user agent header must be set by the browser itself): `{sdk-name}/{sdk-version}`