From 7fe3811bd8c2b38d8caececd2e1173b9a6f02475 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Tue, 8 Nov 2022 20:12:24 +0100 Subject: [PATCH 1/4] Add node and browser sdk transport option docs --- .../common/configuration/options.mdx | 35 +++++++++++++++---- 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/src/platforms/common/configuration/options.mdx b/src/platforms/common/configuration/options.mdx index 8b65ed144d7cc..72acbdf80a077 100644 --- a/src/platforms/common/configuration/options.mdx +++ b/src/platforms/common/configuration/options.mdx @@ -47,10 +47,10 @@ Specifies whether to use global scope management mode. Should be `true` for clie Example scenarios where it should be explicitly set to true: - * Universal Windows platform (UWP) applications - * WinForms applications - * Windows Presentation Foundation (WPF) applications - * Single user console applications +- Universal Windows platform (UWP) applications +- WinForms applications +- Windows Presentation Foundation (WPF) applications +- Single user console applications Defaults to `false`, unless in Blazor WASM, MAUI, Unity, or Xamarin where the default is `true`. @@ -577,13 +577,36 @@ Switches out the transport used to send events. How this works depends on the SD - + + +Options used to configure the transport. This is an object with the following possible optional keys: + + + +- `headers`: An object containing headers to be sent with every request. +- `proxy`: A proxy used for outbound requests. Can be http or https. +- `caCerts`: A single or list of a path to a file or directory, or a buffer of CA certificates +- `httpModule`: A custom HTTP module to use for requests. Defaults to the the native `http` and `https` modules. +- `keepAlive`: Whether to keep the socket alive between requests. Defaults to `false`. + + + + + +- `headers`: An object containing headers to be sent with every request. Used by the SDK's fetch and XHR transports. +- `fetchOptions`: An object containing options to be passed to the `fetch` call. Used by the SDK's fetch transport. + + + + + + When set, a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests unless a separate `https-proxy` is configured. However, not all SDKs support a separate HTTPS proxy. SDKs will attempt to default to the system-wide configured proxy, if possible. For instance, on Unix systems, the `http_proxy` environment variable will be picked up. - + Configures a separate proxy for outgoing HTTPS requests. This value might not be supported by all SDKs. When not supported the `http-proxy` value is also used for HTTPS requests at all times. From c0d59b3ff11692931a6e954a97084becef2131fc Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Thu, 10 Nov 2022 15:47:03 +0100 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --- src/platforms/common/configuration/options.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/platforms/common/configuration/options.mdx b/src/platforms/common/configuration/options.mdx index 72acbdf80a077..50c97a67103de 100644 --- a/src/platforms/common/configuration/options.mdx +++ b/src/platforms/common/configuration/options.mdx @@ -587,11 +587,11 @@ Options used to configure the transport. This is an object with the following po - `proxy`: A proxy used for outbound requests. Can be http or https. - `caCerts`: A single or list of a path to a file or directory, or a buffer of CA certificates - `httpModule`: A custom HTTP module to use for requests. Defaults to the the native `http` and `https` modules. -- `keepAlive`: Whether to keep the socket alive between requests. Defaults to `false`. +- `keepAlive`: Determines whether to keep the socket alive between requests. Defaults to `false`. - + - `headers`: An object containing headers to be sent with every request. Used by the SDK's fetch and XHR transports. - `fetchOptions`: An object containing options to be passed to the `fetch` call. Used by the SDK's fetch transport. From 66cae9316891ddb2639493fca33bd690950a5cf9 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Thu, 10 Nov 2022 16:04:58 +0100 Subject: [PATCH 3/4] Update src/platforms/common/configuration/options.mdx --- src/platforms/common/configuration/options.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/common/configuration/options.mdx b/src/platforms/common/configuration/options.mdx index 50c97a67103de..1773b3501f649 100644 --- a/src/platforms/common/configuration/options.mdx +++ b/src/platforms/common/configuration/options.mdx @@ -585,7 +585,7 @@ Options used to configure the transport. This is an object with the following po - `headers`: An object containing headers to be sent with every request. - `proxy`: A proxy used for outbound requests. Can be http or https. -- `caCerts`: A single or list of a path to a file or directory, or a buffer of CA certificates +- `caCerts`: A a path to a CA certificate, a list of paths to a CA certificate, or a buffer of CA certificates - `httpModule`: A custom HTTP module to use for requests. Defaults to the the native `http` and `https` modules. - `keepAlive`: Determines whether to keep the socket alive between requests. Defaults to `false`. From 8c539835321676af122e18ab2efb5bae175d4ec5 Mon Sep 17 00:00:00 2001 From: Abhijeet Prasad Date: Thu, 10 Nov 2022 17:08:31 +0100 Subject: [PATCH 4/4] Update src/platforms/common/configuration/options.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --- src/platforms/common/configuration/options.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/platforms/common/configuration/options.mdx b/src/platforms/common/configuration/options.mdx index 1773b3501f649..fde81d00d1f30 100644 --- a/src/platforms/common/configuration/options.mdx +++ b/src/platforms/common/configuration/options.mdx @@ -585,7 +585,7 @@ Options used to configure the transport. This is an object with the following po - `headers`: An object containing headers to be sent with every request. - `proxy`: A proxy used for outbound requests. Can be http or https. -- `caCerts`: A a path to a CA certificate, a list of paths to a CA certificate, or a buffer of CA certificates +- `caCerts`: A path or list of paths to a CA certificate, or a buffer of CA certificates. - `httpModule`: A custom HTTP module to use for requests. Defaults to the the native `http` and `https` modules. - `keepAlive`: Determines whether to keep the socket alive between requests. Defaults to `false`.