Skip to content

Commit 145c2f5

Browse files
authored
Update documentation for event payload (#13591)
1 parent 76912c2 commit 145c2f5

File tree

1 file changed

+12
-1
lines changed
  • develop-docs/sdk/data-model/event-payloads

1 file changed

+12
-1
lines changed

develop-docs/sdk/data-model/event-payloads/sdk.mdx

+12-1
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,14 @@ activated integrations. Each package consists of a `name` in the format
6969
`identifier` should be a checkout link and the `version` should be a Git
7070
reference (branch, tag or SHA).
7171

72+
`settings`
73+
74+
: _Optional_. A collection of settings that are used to control behaviour.
75+
- `infer_ip`: Controls the behaviour of IP address inferrence based on request information. Following values are allowed:
76+
- `auto`: infer the IP address based on available request information. This is equal to [setting the IP address to `{{auto}}`](https://develop.sentry.dev/sdk/data-model/event-payloads/user/#automatic-ip-addresses).
77+
- `never`: Do not infer the IP address from the request. This is the default if an invalid value for `infer_ip` was sent.
78+
- `legacy`: Infer the IP address only if the value is `{{auto}}`. For Javascript and Cocoa it will also infer if `ip_address` is empty. This is the default if no value was sent.
79+
7280
## Example
7381

7482
The following example illustrates the SDK part of the <Link to="/sdk/data-model/event-payloads/">event payload</Link> and omits other
@@ -90,7 +98,10 @@ attributes for simplicity.
9098
"name": "git:https://github.com/getsentry/sentry-cocoa.git",
9199
"version": "4.1.0"
92100
}
93-
]
101+
],
102+
"settings": {
103+
"infer_ip": "auto"
104+
}
94105
}
95106
}
96107
```

0 commit comments

Comments
 (0)