Skip to content

Commit 23e6fa0

Browse files
Add node and browser sdk transport option docs (#5740)
Co-authored-by: Isabel <[email protected]>
1 parent 98303c8 commit 23e6fa0

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

src/platforms/common/configuration/options.mdx

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ Specifies whether to use global scope management mode. Should be `true` for clie
4747

4848
Example scenarios where it should be explicitly set to true:
4949

50-
* Universal Windows platform (UWP) applications
51-
* WinForms applications
52-
* Windows Presentation Foundation (WPF) applications
53-
* Single user console applications
50+
- Universal Windows platform (UWP) applications
51+
- WinForms applications
52+
- Windows Presentation Foundation (WPF) applications
53+
- Single user console applications
5454

5555
Defaults to `false`, unless in Blazor WASM, MAUI, Unity, or Xamarin where the default is `true`.
5656

@@ -577,13 +577,36 @@ Switches out the transport used to send events. How this works depends on the SD
577577

578578
</ConfigKey>
579579

580-
<ConfigKey name="http-proxy" supported={["node", "php", "python", "java", "dotnet", "rust"]}>
580+
<ConfigKey name="transport-options" supported={["javascript", "node"]}>
581+
582+
Options used to configure the transport. This is an object with the following possible optional keys:
583+
584+
<PlatformSection supported={["node"]}>
585+
586+
- `headers`: An object containing headers to be sent with every request.
587+
- `proxy`: A proxy used for outbound requests. Can be http or https.
588+
- `caCerts`: A path or list of paths to a CA certificate, or a buffer of CA certificates.
589+
- `httpModule`: A custom HTTP module to use for requests. Defaults to the the native `http` and `https` modules.
590+
- `keepAlive`: Determines whether to keep the socket alive between requests. Defaults to `false`.
591+
592+
</PlatformSection>
593+
594+
<PlatformSection supported={["javascript"]} notSupported={["node"]}>
595+
596+
- `headers`: An object containing headers to be sent with every request. Used by the SDK's fetch and XHR transports.
597+
- `fetchOptions`: An object containing options to be passed to the `fetch` call. Used by the SDK's fetch transport.
598+
599+
</PlatformSection>
600+
601+
</ConfigKey>
602+
603+
<ConfigKey name="http-proxy" supported={["php", "python", "java", "dotnet", "rust"]}>
581604

582605
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.
583606

584607
</ConfigKey>
585608

586-
<ConfigKey name="https-proxy" supported={["python", "node", "rust"]}>
609+
<ConfigKey name="https-proxy" supported={["python", "rust"]}>
587610

588611
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.
589612

0 commit comments

Comments
 (0)