Skip to content
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

📝 Add proxyUrl option documentation #1050

Merged
merged 3 commits into from
Sep 14, 2021
Merged

📝 Add proxyUrl option documentation #1050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e2e6013
📝 Add proxyUrl option documentation
amortemousque Sep 14, 2021
5c12bb0
👌 Add scheme to proxy url
amortemousque Sep 14, 2021
92266ba
Fix format
amortemousque Sep 14, 2021
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
22 changes: 12 additions & 10 deletions packages/logs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,16 +117,17 @@ window.DD_LOGS.init({

The following parameters are available to configure the Datadog browser logs SDK to send logs to Datadog:

| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | --------------- | -------------------------------------------------------------------------------------------------------- |
| `clientToken` | String | Yes | | A [Datadog client token][2]. |
| `site` | String | Yes | `datadoghq.com` | The Datadog site of your organization. US: `datadoghq.com`, EU: `datadoghq.eu` |
| `service` | String | No | | The service name for your application. |
| `env` | String | No | | The application’s environment, for example: prod, pre-prod, staging, etc. |
| `version` | String | No | | The application’s version, for example: 1.2.3, 6c44da20, 2020.02.13, etc. |
| `forwardErrorsToLogs` | Boolean | No | `true` | Set to `false` to stop forwarding console.error logs, uncaught exceptions and network errors to Datadog. |
| `sampleRate` | Number | No | `100` | The percentage of sessions to track: `100` for all, `0` for none. Only tracked sessions send logs. |
| `silentMultipleInit` | Boolean | No | | Prevent logging errors while having multiple init. |
| Parameter | Type | Required | Default | Description |
| --------------------- | ------- | -------- | --------------- | -------------------------------------------------------------------------------------------------------------- |
| `clientToken` | String | Yes | | A [Datadog client token][2]. |
| `site` | String | Yes | `datadoghq.com` | The Datadog site of your organization. US: `datadoghq.com`, EU: `datadoghq.eu` |
| `service` | String | No | | The service name for your application. |
| `env` | String | No | | The application’s environment, for example: prod, pre-prod, staging, etc. |
| `version` | String | No | | The application’s version, for example: 1.2.3, 6c44da20, 2020.02.13, etc. |
| `forwardErrorsToLogs` | Boolean | No | `true` | Set to `false` to stop forwarding console.error logs, uncaught exceptions and network errors to Datadog. |
| `sampleRate` | Number | No | `100` | The percentage of sessions to track: `100` for all, `0` for none. Only tracked sessions send logs. |
| `silentMultipleInit` | Boolean | No | | Prevent logging errors while having multiple init. |
| `proxyUrl` | Boolean | No | | Optional proxy URL (ex: https://www.proxy.com/path), see the full [proxy setup guide][6] for more information. |

Options that must have a matching configuration when using the `RUM` SDK:

Expand Down Expand Up @@ -652,3 +653,4 @@ window.DD_LOGS && DD_LOGS.logger.setHandler(['<HANDLER1>', '<HANDLER2>'])
[3]: https://www.npmjs.com/package/@datadog/browser-logs
[4]: https://github.com/DataDog/browser-sdk/blob/main/packages/logs/BROWSER_SUPPORT.md
[5]: /real_user_monitoring/guide/enrich-and-control-rum-data/
[6]: https://docs.datadoghq.com/real_user_monitoring/faq/proxy_rum_data/
4 changes: 2 additions & 2 deletions packages/rum/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,10 +189,10 @@ The percentage of sessions to track: `100` for all, `0` for none. Only tracked s
**Default**: `false`<br/>
Initialization fails silently if Datadog's RUM is already initialized on the page.

`proxyHost`
`proxyUrl`
: Optional<br/>
**Type**: String<br/>
Optional proxy host (ex: www.proxy.com), see the full [proxy setup guide][7] for more information.
Optional proxy URL (ex: https://www.proxy.com/path), see the full [proxy setup guide][7] for more information.

`allowedTracingOrigins`
: Optional<br/>
Expand Down