Skip to content

Clarify ipv6 docs #6235

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.

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
merged 1 commit into from
Mar 14, 2024
Merged
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -218,13 +218,14 @@ analytics.ready(function() {

Segment automatically collects the user's IP address for device-based (iOS, Android, Analytics.js and Xamarin) events.

You can pass a value for `options.context.ip` to prevent the Segment systems from recording the IP address for the request, as in the example below.
> info "IPv6"
> At the moment, Segment doesn't support automatically collecting IPv6 addresses.

You can manually set the IP by passing a value for `options.context.ip` to prevent the Segment systems from recording the IP address for the request, as in the example below.

```js
analytics.track("Order Completed", {}, { context: { ip: "0.0.0.0" }});
```

You must add this override to _every_ Track call to explicitly override IP collection. If you reset this trait in the context object, Segment defaults to the normal IP collection behavior.

> info "IPv6"
> Segment doesn't support collecting IPv6 addresses.