Skip to content
Last updated

Rudderstack Analytics

Integrate Rudderstack Analytics into Redocly project.

With the 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

OptionTypeDescription
includeInDevelopmentbooleanSet this option to true to enable Rudderstack Analytics in development mode and preview builds. Default: false.
writeKeystringREQUIRED. Rudderstack write key
trackPagebooleanSet this option to true to track page visits. Default: false.
dataPlaneUrlstringSet this URL if you need to proxy events through a custom data plane.
controlPlaneUrlstringSet this URL if you are self-hosting the Control Plane
sdkURLstringSet this if you want to serve SDK script from a custom domain
loadOptionsobjectRudderstack loading options described in Rudderstack documentation

Example

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

Segment