Skip to content

feat (native): update transport proxy docs #11899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JoshuaMoelans merged 3 commits into from
Nov 25, 2024
Merged

feat (native): update transport proxy docs #11899

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea75b22
feat: add proxy support overview
JoshuaMoelans Nov 21, 2024
79be8c2
added socks proxy code snippet + cleanup
JoshuaMoelans Nov 21, 2024
7e939c0
chore: add highlighting for technical terms
JoshuaMoelans Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions docs/platforms/native/configuration/transports.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,31 @@ The transport is invoked in the same thread as the call to
`sentry_capture_event`. Consider to offload network communication to a
background thread or thread pool to avoid blocking execution.

## Using an HTTP Proxy
## Using a Proxy

The Native SDK allows the configuration of an HTTP proxy through which requests can be tunneled to our backend. This proxy must allow `CONNECT` requests to establish a proxy connection. It can be configured via the following option interface:
The Native SDK allows the configuration of an `HTTP` (`CONNECT`) or `SOCKS5` proxy through which requests can be tunneled to our backend. It can be configured via the following option interface:

```c
sentry_options_t *options = sentry_options_new();
sentry_options_set_http_proxy(options, "http://my.proxy:10010");
sentry_options_set_proxy(options, "http://my.proxy:8080");
sentry_init(options);

/* ... */
```
The same function can also be used for the `SOCKS5` proxy:
```c
sentry_options_t *options = sentry_options_new();
sentry_options_set_proxy(options, "socks5://my.proxy:1080");
sentry_init(options);

/* ... */
```


We support `HTTP` proxies on all platforms, and `SOCKS5` proxies on Linux and macOS. Depending on the platform, the transport provides a fallback in case the proxy is not reachabled. The following table shows the expected behaviour.

| Platform | http-proxy | socks-proxy |
|----------|-----------------------------------------------------|------------------------------------------------------|
| Windows | Internal: fallback <br /> Crashpad: fallback | N/A |
| Linux | Internal: fallback <br /> Crashpad: fallback | Internal: no fallback <br /> Crashpad: no fallback |
| macOS | Internal: no fallback <br /> Crashpad: no fallback | Internal: no fallback <br /> Crashpad: fallback |
Loading