diff --git a/src/platforms/common/configuration/options.mdx b/src/platforms/common/configuration/options.mdx index 8b65ed144d7cc..fde81d00d1f30 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 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`. + + + + + +- `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.