# Rudderstack Analytics

Integrate Rudderstack Analytics into Redocly project.

With the [`consent`](/docs/realm/config/consent) option on, this integration loads only while the consent state allows the analytics category.
In `opt-in` mode the visitor must accept first.
In `opt-out` mode the category starts on and stays on until the visitor refuses.

## Configuration

| Option | Type | Description |
| --- | --- | --- |
| includeInDevelopment | boolean | Set this option to `true` to enable Rudderstack Analytics in development mode and preview builds. Default: `false`. |
| writeKey | string | **REQUIRED.** Rudderstack write key |
| trackPage | boolean | Set this option to `true` to track page visits. Default: `false`. |
| dataPlaneUrl | string | Set this URL if you need to proxy events through a custom data plane. |
| controlPlaneUrl | string | Set this URL if you are self-hosting the Control Plane |
| sdkURL | string | Set this if you want to serve SDK script from a custom domain |
| loadOptions | object | Rudderstack loading options described in [Rudderstack documentation](https://www.rudderstack.com/docs/sources/event-streams/sdks/rudderstack-javascript-sdk/load-js-sdk/#loading-options) |

## Example

```yaml
analytics:
  rudderstack:
    includeInDevelopment: true
    writeKey: my-write-key
    trackPage: true
    dataPlaneUrl: https://my-data-plane-url.com
    controlPlaneUrl: https://my-control-plane-url.com
    sdkUrl: https://my-custom-sdk-url.com
    loadOptions:
      secureCookie: true
      logLevel: 'INFO'
      useBeacon: true
```

## Resources

- **[Analytics configuration](/docs/realm/config/analytics)** - Explore configuration for popular analytics providers