Skip to content

Commit

Permalink
Document rate_limiting configuration option (#9833)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielbachhuber authored Nov 11, 2024
1 parent 3ce50e7 commit 9c2b555
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions contents/docs/libraries/js/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -499,6 +499,7 @@ Some of the most relevant options are:
| `persistence`<br/><br/>**Type:** `localStorage` or `sessionStorage` or `cookie` or `memory` or `localStorage+cookie`<br/>**Default:** `cookie` | Determines how PostHog stores information about the user. See [persistence](#persistence) for details. |
| `property_denylist`<br/><br/>**Type:** Array<br/>**Default:** `[]` | A list of properties that should never be sent with `capture` calls. |
| `person_profiles`<br /><br />**Type:** Enum: `always`, `identified_only`<br/>**Default:** `always` | Set whether events should capture identified events and process person profiles |
| `rate_limiting`<br/><br/>**Type:** Object<br/>**Default:** `{ events_per_second: 10, events_burst_limit: events_per_second * 10 }` | Controls event rate limiting to help you avoid accidentally sending too many events. `events_per_second` determines how many events can be sent per second on average (default: 10). `events_burst_limit` sets the maximum events that can be sent at once (default: 10 times the `events_per_second` value). |
| `sanitize_properties`<br/><br/>**Type:** Function<br/>**Default:** `null` | A function that allows you to sanitize or modify the properties that get sent. Example: `sanitize_properties: function(properties, event) { if(properties['$ip']) { properties['$ip'] = null } return properties }` |
| `session_recording`<br/><br/>**Type:** Object<br/>**Default:** [See here.](https://github.com/PostHog/posthog-js/blob/96fa9339b9c553a1c69ec5db9d282f31a65a1c25/src/posthog-core.js#L1032) | Configuration options for recordings. More details [found here](/docs/session-replay/manual) |
| `session_idle_timeout_seconds`<br/><br/>**Type:** Integer<br/>**Default:** `1800` | The maximum amount of time a session can be inactive before it is split into a new session. |
Expand Down

0 comments on commit 9c2b555

Please sign in to comment.